@npmcli/template-oss

@npmcli/template-oss

This module bundles the npm CLI team's basics for package development into a single devDependency.

CAUTION: THESE CHANGES WILL OVERWRITE ANY LOCAL FILES AND SETTINGS

package.json patches

These fields will be set in the project's package.json:

{
  "author": "GitHub Inc.",
  "files": ["bin", "lib"],
  "license": "ISC",
  "templateVersion": "1.0.0",
  "scripts": {
    "lint": "eslint '**/*.js'",
    "lintfix": "npm run lint -- --fix",
    "preversion": "npm test",
    "postversion": "npm publish",
    "prepublishOnly": "git push origin --follow-tags",
    "snap": "tap",
    "test": "tap",
    "posttest": "npm run lint",
  }
}

The "templateVersion" field will be set to the version of this package being installed. This is used to determine if the postinstall script should take any action.

Extending

The changes constant located in lib/package.js should contain all patches for the package.json file. Be sure to correctly expand any object/array based values with the original package content.

Static files

Any existing .eslintrc.* files will be removed, unless they also match the pattern .eslintrc.local.*

These files will be copied, overwriting any existing files:

• .eslintrc.js
• .github/workflows/ci.yml
• .gitignore
• LICENSE.md

Extending

Place files in the lib/content/ directory, use only the file name and remove any leading . characters (i.e. .github/workflows/ci.yml becomes ci.yml and .gitignore becomes gitignore).

Modify the content object at the top of lib/content/index.js to include your new file. The object keys are destination paths, and values are source.

Package installation and removal

These packages will be removed:

• eslint-plugin-import
• eslint-plugin-promise
• eslint-plugin-standard
• @npmcli/lint

Afterwards, these packages will be installed as devDependencies:

• eslint
• eslint-plugin-node
• @npmcli/eslint-config
• tap

Extending

Make changes to the removeDeps and devDeps arrays in lib/install.js.