makepack 1.3.8 → 1.4.0

package/README.md

@@ -1,147 +1,167 @@
-<p align="center">
-  <a href="https://github.com/devnax/makepack" rel="noopener" target="_blank"><img  src="https://raw.githubusercontent.com/devnax/makepack/main/logo.png" alt="Makepack logo"></a>
-</p>
-
-<h1 align="center">Makepack</h1>
-
-**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.
-
-## Configuration Files
-
-**MakePack** supports loading configuration files for Vite and esbuild. If `vite.config.js` and `esbuild.config.js` exist in the root of the project, they will be automatically loaded when running the respective commands.
-
-
-
-## 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. It will load `vite.config.js` if it exists in the root of the project.
-
-#### Usage
-
-```bash
-makepack serve [options]
-```
-
-#### Options
-
-- `-p, --port <number>`  
-  _Port number_ (optional) (default is `5000`).
-  
-- `-e, --root <file>`  
-  _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. It will load `esbuild.config.js` if it exists in the root of the project.
-
-#### Usage
-
-```bash
-makepack pack [options]
-```
-
-#### Options
-
-- `-e, --entry <file>`  
-  _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
-
+<p align="center">
+  <a href="https://github.com/devnax/makepack" rel="noopener" target="_blank"><img  src="https://raw.githubusercontent.com/devnax/makepack/main/logo.png" alt="Makepack logo"></a>
+</p>
+
+<h1 align="center">Makepack</h1>
+
+**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.
+
+## Configuration Files
+
+Previously, the project used separate configuration files for Vite and esbuild:
+- `vite.config.js`
+- `esbuild.config.js`
+
+These files have been removed and replaced with a single configuration file: `makepack.js`.
+
+## makepack.js
+
+The `makepack.js` file exports a function that takes the previous configuration (`prevConfig`) and returns a new configuration (`newConfig`). This allows you to configure both esbuild and Vite in one place.
+
+### Example Usage
+
+```javascript
+// filepath: /Volumes/Work Space/makepack/makepack.js
+module.exports = function(prevConfig) {
+    const newConfig = {
+        // ...your new configuration here...
+    };
+    return newConfig;
+};
+```
+
+This approach simplifies the configuration process by consolidating it into a single file.
+
+## 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. It will load `vite.config.js` if it exists in the root of the project.
+
+#### Usage
+
+```bash
+makepack serve [options]
+```
+
+#### Options
+
+- `-p, --port <number>`  
+  _Port number_ (optional) (default is `5000`).
+  
+- `-e, --root <file>`  
+  _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. It will load `esbuild.config.js` if it exists in the root of the project.
+
+#### Usage
+
+```bash
+makepack pack [options]
+```
+
+#### Options
+
+- `-e, --entry <file>`  
+  _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).

package/package.json

@@ -1,57 +1,57 @@
-{
-  "name": "makepack",
-  "version": "1.3.8",
-  "type": "module",
-  "description": "A CLI tool to create, build, and manage JavaScript, TypeScript, React, and React-TypeScript libraries for npm projects.",
-  "files": [
-    "src",
-    "package.json",
-    "README.md"
-  ],
-  "categories": [
-    "Other"
-  ],
-  "author": {
-    "name": "Devnax",
-    "email": "devnaxrul@gmail.com"
-  },
-  "bin": "./src/index.js",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/devnax/makepack"
-  },
-  "bugs": {
-    "url": "https://github.com/devnax/makepack/issues"
-  },
-  "homepage": "https://github.com/devnax/makepack#readme",
-  "scripts": {
-    "start": "node ./src/index.js"
-  },
-  "dependencies": {
-    "chalk": "^5.4.1",
-    "commander": "^12.1.0",
-    "esbuild": "^0.24.2",
-    "express": "^4.21.1",
-    "figlet": "^1.8.0",
-    "figures": "^6.1.0",
-    "fs-extra": "^11.2.0",
-    "glob": "^11.0.0",
-    "inquirer": "^12.1.0",
-    "typescript": "^5.7.2",
-    "vite": "^6.0.2",
-    "@vitejs/plugin-react": "^4.3.4"
-  },
-  "keywords": [
-    "CLI",
-    "npm",
-    "library",
-    "JavaScript",
-    "TypeScript",
-    "React",
-    "npm-package"
-  ],
-  "devDependencies": {
-    "react": "^19.0.0",
-    "react-dom": "^19.0.0"
-  }
+{
+  "name": "makepack",
+  "version": "1.4.0",
+  "type": "module",
+  "description": "A CLI tool to create, build, and manage JavaScript, TypeScript, React, and React-TypeScript libraries for npm projects.",
+  "files": [
+    "src",
+    "package.json",
+    "README.md"
+  ],
+  "categories": [
+    "Other"
+  ],
+  "author": {
+    "name": "Devnax",
+    "email": "devnaxrul@gmail.com"
+  },
+  "bin": "./src/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/devnax/makepack"
+  },
+  "bugs": {
+    "url": "https://github.com/devnax/makepack/issues"
+  },
+  "homepage": "https://github.com/devnax/makepack#readme",
+  "scripts": {
+    "start": "node ./src/index.js"
+  },
+  "dependencies": {
+    "chalk": "^5.4.1",
+    "commander": "^12.1.0",
+    "esbuild": "^0.24.2",
+    "express": "^4.21.1",
+    "figlet": "^1.8.0",
+    "figures": "^6.1.0",
+    "fs-extra": "^11.2.0",
+    "glob": "^11.0.0",
+    "inquirer": "^12.1.0",
+    "typescript": "^5.7.2",
+    "vite": "^6.0.2",
+    "@vitejs/plugin-react": "^4.3.4"
+  },
+  "keywords": [
+    "CLI",
+    "npm",
+    "library",
+    "JavaScript",
+    "TypeScript",
+    "React",
+    "npm-package"
+  ],
+  "devDependencies": {
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  }
 }

package/src/actions/create/files/gitignore.js

@@ -1,6 +1,6 @@
-export default (args) => {
-   return {
-      content: `node_modules\n${args.outdir}`,
-      filename: ".gitignore"
-   }
+export default (args) => {
+   return {
+      content: `node_modules\n${args.outdir}`,
+      filename: ".gitignore"
+   }
 }

package/src/actions/create/files/makepack.js

@@ -1,19 +1,19 @@
-export default (args) => {
-   const makepack = {
-      "template": `${args.template}`,
-      "serve": {
-         "port": 3000,
-         "entry": `${args.rootdir}/${args.entry}`
-      },
-      "build": {
-         "entry": `${args.rootdir}/**/*.{tsx,ts,js,jsx}`,
-         "outdir": `${args.outdir}`,
-         "esbuild": {
-         }
-      },
-   }
-   return {
-      content: `const makepack = ${JSON.stringify(makepack, null, 2)}\nexport default makepack\n`,
-      filename: "makepack.js"
-   }
-}
+export default (args) => {
+   const makepack = {
+      "template": `${args.template}`,
+      "serve": {
+         "port": 3000,
+         "entry": `${args.rootdir}/${args.entry}`
+      },
+      "build": {
+         "entry": `${args.rootdir}/**/*.{tsx,ts,js,jsx}`,
+         "outdir": `${args.outdir}`,
+         "esbuild": {
+         }
+      },
+   }
+   return {
+      content: `const makepack = ${JSON.stringify(makepack, null, 2)}\nexport default makepack\n`,
+      filename: "makepack.js"
+   }
+}

package/src/actions/create/files/package-json.js

@@ -1,43 +1,60 @@
-export default (args) => {
-   let dependencies = {}
-   let devDependencies = {
-      "makepack": "latest"
-   }
-
-   if (args.template.includes("react")) {
-      dependencies["react"] = "^19.0.0"
-      dependencies["react-dom"] = "^19.0.0"
-   } else {
-      devDependencies["react"] = "^19.0.0"
-      devDependencies["react-dom"] = "^19.0.0"
-   }
-
-   if (args.template.includes("typescript")) {
-      devDependencies["typescript"] = "^4.4.2"
-      devDependencies["@types/react"] = "^19.0.2"
-      devDependencies["@types/react-dom"] = "^19.0.2"
-   }
-
-   let main = args.entry.split('.')
-   main.pop()
-
-   const json = {
-      name: args.dirname,
-      version: "1.0.0",
-      description: "",
-      main: `./${main.join(".")}.js`,
-      scripts: {
-         "start": "makepack serve",
-         "pack": "makepack pack",
-         "publish:pack": "makepack pack -p",
-      },
-      dependencies,
-      devDependencies,
-      keywords: [],
-   }
-
-   return {
-      content: JSON.stringify(json, null, 3),
-      filename: "package.json"
-   }
+export default (args) => {
+   let dependencies = {}
+   let devDependencies = {
+      "makepack": "latest"
+   }
+
+   if (args.template.includes("react")) {
+      dependencies["react"] = "^19.0.0"
+      dependencies["react-dom"] = "^19.0.0"
+   } else {
+      devDependencies["react"] = "^19.0.0"
+      devDependencies["react-dom"] = "^19.0.0"
+   }
+
+   if (args.template.includes("typescript")) {
+      devDependencies["typescript"] = "^4.4.2"
+      devDependencies["@types/react"] = "^19.0.2"
+      devDependencies["@types/react-dom"] = "^19.0.2"
+   }
+
+   let main = args.entry.split('.')
+   main.pop()
+
+   const json = {
+      name: args.dirname,
+      version: "1.0.0",
+      description: "",
+      main: `./${main.join(".")}.js`,
+      scripts: {
+         "start": "makepack serve",
+         "pack": "makepack pack",
+         "publish:pack": "makepack pack -p",
+      },
+      dependencies,
+      devDependencies,
+      keywords: [],
+      exports: {
+         ".": {
+            "types": "./types/index.d.ts",
+            "import": "./esm/index.js",
+            "require": "./cjs/index.js"
+         },
+         "./*": {
+            "types": "./types/*.d.ts",
+            "import": "./esm/*.js",
+            "require": "./cjs/*.js"
+         },
+         "./types/*": "./types/*.d.ts",
+         "./esm/*": "./esm/*.js",
+         "./esm/*.js": "./esm/*.js",
+         "./cjs/*": "./cjs/*.js",
+         "./cjs/*.js": "./cjs/*.js"
+      }
+   }
+
+   return {
+      content: JSON.stringify(json, null, 3),
+      filename: "package.json"
+   }
 }

package/src/actions/create/files/project-js.js

@@ -1,13 +1,13 @@
-export default (args) => {
-  const content = `
-function add(a, b) {
-  return a + b;
-}
-
-export default add
-  `
-  return {
-    content,
-    filename: `${args.rootdir}/${args.entry}`
-  }
+export default (args) => {
+  const content = `
+function add(a, b) {
+  return a + b;
+}
+
+export default add
+  `
+  return {
+    content,
+    filename: `${args.rootdir}/${args.entry}`
+  }
 }