基于NPM Scripts替代Gulp的项目配置与本地NPM依赖咨询

Great to see you using NPM Scripts as a Gulp alternative—solid choice! Let’s walk through the two most straightforward ways to add your local module to this project:

Method 1: Direct Relative Path (Simple & Static) #

This works best if your local module is in a fixed location relative to your project, and you don’t need real-time updates as you modify the module.

1. First, confirm your local module has a valid package.json (it needs at least a name and version field—NPM requires this to recognize it as a module).
2. Open your project’s package.json and add the module to either dependencies or devDependencies (pick devDependencies if it’s only for development use). Use a file: prefix followed by the relative path to your module’s root folder:

   {
     "scripts": {
       "process": "./process.js",
       "prepare": "./prepare.sh $npm_package_config_source $npm_config_env",
       "config": "npm run prepare && npm run process"
     },
     "config": {
       "source": "https://myurl"
     },
     "devDependencies": {
       "fs": "0.0.1-security",
       "my-local-module": "file:../path/to/your-module"
     }
   }
   

   Replace ../path/to/your-module with the actual relative path (e.g., ./src/my-custom-module if it’s a subfolder in your project).
3. Run npm install in your project root. NPM will create a symlink to your local module in node_modules, making it available for require/import just like any other package.

Method 2: npm link (For Active Development) #

If you’re still working on the local module and want changes to show up in your project instantly (no need to reinstall every time), use npm’s linking feature:

1. Link your module globally: Navigate to your local module’s root directory in the terminal and run:

   npm link
   

   This creates a global symlink pointing to your module.
2. Link to your project: Go back to your project’s root and run:

   npm link my-local-module
   

   Replace my-local-module with the exact name from your module’s package.json. Now your project’s node_modules will have a symlink to the global one, which points to your local code.
3. Optional but recommended: Add the module to your project’s package.json (using the file: path method above) so other developers can install it correctly (they’ll just need to have the module in the same relative path, or adjust the path themselves).

Quick Tips #

• To use the module in your process.js or other files, require it like any regular NPM package:

  const myCustomModule = require('my-local-module');
  

• If you ever need to unlink the module (e.g., to switch to a published version), run npm unlink my-local-module in your project, and npm unlink in the module’s directory.

内容的提问来源于stack exchange，提问作者mannuk