npm-packlist 7.0.4 → 8.0.1

package/README.md

@@ -30,9 +30,11 @@ arborist.loadActual().then((tree) => {
 This uses the following rules:
 
 1. If a `package.json` file is found, and it has a `files` list,
-   then ignore everything that isn't in `files`.  Always include the
+   then ignore everything that isn't in `files`.  Always include the root
    readme, license, licence and copying files, if they exist, as well
-   as the package.json file itself.
+   as the package.json file itself. Non-root readme, license, licence and
+   copying files are included by default, but can be excluded using the 
+   `files` list e.g. `"!readme"`.
 2. If there's no `package.json` file (or it has no `files` list), and
    there is a `.npmignore` file, then ignore all the files in the
    `.npmignore` file.

package/lib/index.js

@@ -38,13 +38,22 @@ const defaults = [
 ]
 
 const strictDefaults = [
-  // these are forcibly included at all levels
+  // these are forcibly excluded
+  '/.git',
+]
+
+const allLevels = [
+  // these are included by default but can be excluded by package.json files array
   '!/readme{,.*[^~$]}',
   '!/copying{,.*[^~$]}',
   '!/license{,.*[^~$]}',
   '!/licence{,.*[^~$]}',
-  // these are forcibly excluded
-  '/.git',
+]
+
+const rootOnly = [
+  /^!.*readme/i,
+  /^!.*copying/i,
+  /^!.*licen[sc]e/i,
 ]
 
 const normalizePath = (path) => path.split('\\').join('/')
@@ -132,6 +141,7 @@ class PackWalker extends IgnoreWalker {
       // known required files for this directory
       this.injectRules(strictRules, [
         ...strictDefaults,
+        ...allLevels,
         ...this.requiredFiles.map((file) => `!${file}`),
       ])
     }
@@ -284,9 +294,11 @@ class PackWalker extends IgnoreWalker {
     const ignores = []
     const strict = [
       ...strictDefaults,
+      ...allLevels,
       '!/package.json',
       '/.git',
       '/node_modules',
+      '.npmrc',
       '/package-lock.json',
       '/yarn.lock',
       '/pnpm-lock.yaml',
@@ -296,14 +308,15 @@ class PackWalker extends IgnoreWalker {
     if (files) {
       for (let file of files) {
         // invert the rule because these are things we want to include
-        if (file.startsWith('/')) {
+        if (file.startsWith('./')) {
           file = file.slice(1)
-        } else if (file.startsWith('./')) {
-          file = file.slice(2)
         } else if (file.endsWith('/*')) {
-          file = file.slice(0, -2)
+          file = file.slice(0, -1)
         }
         const inverse = `!${file}`
+
+        this.excludeNonRoot(file)
+
         try {
           // if an entry in the files array is a specific file, then we need to include it as a
           // strict requirement for this package. if it's a directory or a pattern, it's a default
@@ -312,7 +325,7 @@ class PackWalker extends IgnoreWalker {
           // if we have a file and we know that, it's strictly required
           if (stat.isFile()) {
             strict.unshift(inverse)
-            this.requiredFiles.push(file)
+            this.requiredFiles.push(file.startsWith('/') ? file.slice(1) : file)
           } else if (stat.isDirectory()) {
             // otherwise, it's a default ignore, and since we got here we know it's not a pattern
             // so we include the directory contents
@@ -352,6 +365,20 @@ class PackWalker extends IgnoreWalker {
     this.injectRules(strictRules, strict, callback)
   }
 
+  // excludes non root files by checking if elements from the files array in
+  // package.json contain an ! and readme/license/licence/copying, and then
+  // removing readme/license/licence/copying accordingly from strict defaults
+  excludeNonRoot (file) {
+    // Find the pattern
+    const matchingPattern = rootOnly.find(regex => regex.test(file))
+
+    if (matchingPattern) {
+      // Find which index matches the pattern and remove it from allLevels
+      const indexToRemove = allLevels.findIndex(element => matchingPattern.test(element))
+      allLevels.splice(indexToRemove, 1)
+    }
+  }
+
   // custom method: after we've finished gathering the files for the root package, we call this
   // before emitting the 'done' event in order to gather all of the files for bundled deps
   async gatherBundles () {

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "npm-packlist",
-  "version": "7.0.4",
+  "version": "8.0.1",
   "description": "Get a list of the files to add from a folder into an npm package",
   "directories": {
     "test": "test"
   },
   "main": "lib/index.js",
   "dependencies": {
-    "ignore-walk": "^6.0.0"
+    "ignore-walk": "^6.0.4"
   },
   "author": "GitHub Inc.",
   "license": "ISC",
@@ -18,7 +18,7 @@
   "devDependencies": {
     "@npmcli/arborist": "^6.0.0 || ^6.0.0-pre.0",
     "@npmcli/eslint-config": "^4.0.0",
-    "@npmcli/template-oss": "4.10.0",
+    "@npmcli/template-oss": "4.21.2",
     "mutate-fs": "^2.1.1",
     "tap": "^16.0.1"
   },
@@ -28,7 +28,7 @@
     "snap": "tap",
     "postsnap": "npm run lintfix --",
     "eslint": "eslint",
-    "lint": "eslint \"**/*.js\"",
+    "lint": "eslint \"**/*.{js,cjs,ts,mjs,jsx,tsx}\"",
     "lintfix": "npm run lint -- --fix",
     "npmclilint": "npmcli-lint",
     "postlint": "template-oss-check",
@@ -55,6 +55,7 @@
   },
   "templateOSS": {
     "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
-    "version": "4.10.0"
+    "version": "4.21.2",
+    "publish": true
   }
 }