fix: add explicit error when files is missing from package.json (oc…

…lif#1577) (oclif#1578) * fix: add explicit error when `files` is missing from package.json (oclif#1577) If `files` is missing from the package.json, `oclif manifest` would throw an unhelpful error ``` TypeError: Cannot read properties of undefined (reading 'find') ``` This makes sure that the user knows how to fix the issue * chore: compilation error --------- Co-authored-by: Mathieu Dutour <[email protected]>
appfolio · Oct 15, 2024 · 2ebfb00 · 2ebfb00
1 parent 000aa0b
commit 2ebfb00
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/commands/manifest.ts b/src/commands/manifest.ts
@@ -96,6 +96,15 @@ export default class Manifest extends Command {
       await plugin.load()
     }
 
+    if (!Array.isArray(plugin.pjson.files)) {
+      this.error('The package.json has to contain a "files" array', {
+        ref: 'https://docs.npmjs.com/cli/v10/configuring-npm/package-json#files',
+        suggestions: [
+          'Add a "files" property in the package.json listing the paths to the files that should be included in the published package',
+        ],
+      })
+    }
+
     const dotfile = plugin.pjson.files.find((f: string) => f.endsWith('.oclif.manifest.json'))
     const file = path.join(plugin.root, `${dotfile ? '.' : ''}oclif.manifest.json`)