https://github.com/devnax/validex
https://github.com/devnax/validex
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/devnax/validex
- Owner: devnax
- Created: 2022-01-01T07:33:19.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-05T13:14:43.000Z (over 1 year ago)
- Last Synced: 2025-04-14T08:41:24.380Z (about 1 year ago)
- Language: JavaScript
- Size: 563 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Makepack
**MakePack** is a command-line interface (CLI) tool that helps you to quickly set up, build, and manage JavaScript, TypeScript, React, and React-TypeScript libraries for use in npm projects. With just a few simple commands, you can generate your own libraries, start a development server, or build and publish your project to the npm repository.
## Installation
To install **MakePack** globally, run the following command:
```bash
npm install -g makepack
```
This will allow you to use the `makepack` command anywhere in your terminal.
## Commands
### `create`
The `create` command is used to create a new library project. It initializes the project structure, configures essential files, and sets up the environment for you to start working on your library.
#### Usage
```bash
makepack create
```
#### Description
- Creates a new library project by setting up the necessary configurations and boilerplate files.
This command will guide you through the initial setup for your library.
---
### `serve`
The `serve` command starts a development server for your library, providing you with a live-reload environment where you can test and iterate on your library in real-time.
#### Usage
```bash
makepack serve [options]
```
#### Options
- `-p, --port `
_Port number_ (optional) (default is `5000`).
- `-e, --root `
_Root file_ (optional) (default is `serve.jsx` or `serve.tsx`). The entry point for your application. Specify the main JavaScript/TypeScript file to start the server.
#### Description
- Starts a local development server for testing and debugging your library.
Example:
```bash
makepack serve --port 4000 --root src/index.ts
```
---
### `pack`
The `pack` command is used to build your library and optionally publish it to the npm repository. This command compiles your code into a distributable format and prepares it for sharing with others.
#### Usage
```bash
makepack pack [options]
```
#### Options
- `-e, --entry `
_Entry file or directory_ (default is `src/**/*.{tsx,ts,js,jsx}`).
Specify the entry file or use a glob pattern to select the files to include in your library.
- `-p, --publish`
_Publish the project to the npm repository_ (default is `false`).
Add this flag if you want to publish the library to npm after building it.
#### Description
- Builds the project by compiling and bundling your library.
- Optionally publishes the library to the npm repository.
Example:
```bash
makepack pack --entry src/index.ts --publish
```
This will compile the project from `src/index.ts` and then publish the library to npm.
---
## Example Workflow
1. Create a new project:
```bash
makepack create
```
2. Start the server for development:
```bash
makepack serve --port 4000 --root index.tsx
```
3. Once you're ready to build and publish your library:
```bash
makepack pack --entry src/**/*.{tsx,ts,js,jsx} --publish
```
This will build your library and publish it to npm.
## 🤝 Contributing
Contributions are welcome! Please check out the [contribution guidelines](https://github.com/devnax/makepack).
---
## 📄 License
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
---
## 📞 Support
For help or suggestions, feel free to open an issue on [GitHub](https://github.com/devnax/makepack/issues) or contact us via [devnaxrul@gmail.com](mailto:devnaxrul@gmail.com).