npm-pkgbuild 8.3.9 → 8.3.12

package/README.md

@@ -67,7 +67,7 @@ content as provided by npm pack
 content of all (production) dependencies
 
 options:
-    - withoutDevelpmentDependencies when to stip away dev dependencies
+    - withoutDevelpmentDependencies when to stip away dev dependencies (defaults to true)
 
 
 # API
@@ -76,40 +76,49 @@ options:
 
 ### Table of Contents
 
-*   [ContentProvider](#contentprovider)
-    *   [asyncIterator](#asynciterator)
-*   [FileContentProvider](#filecontentprovider)
-    *   [Parameters](#parameters)
-    *   [name](#name)
-*   [NodeModulesContentProvider](#nodemodulescontentprovider)
-    *   [Parameters](#parameters-1)
-    *   [name](#name-1)
-*   [NPMPackContentProvider](#npmpackcontentprovider)
-    *   [Parameters](#parameters-2)
-    *   [name](#name-2)
-*   [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
-*   [fields](#fields)
-*   [fields](#fields-1)
-*   [fields](#fields-2)
-*   [hookMapping](#hookmapping)
-*   [hookMapping](#hookmapping-1)
-*   [Field](#field)
-    *   [Properties](#properties)
-*   [Packager](#packager)
-    *   [Parameters](#parameters-3)
-    *   [tmpdir](#tmpdir)
-    *   [execute](#execute)
-        *   [Parameters](#parameters-4)
-*   [decodePassword](#decodepassword)
-    *   [Parameters](#parameters-5)
-*   [extractFunctions](#extractfunctions)
-    *   [Parameters](#parameters-6)
-*   [fieldProvider](#fieldprovider)
-    *   [Parameters](#parameters-7)
-*   [Expander](#expander)
-    *   [Parameters](#parameters-8)
-*   [copyEntries](#copyentries)
-    *   [Parameters](#parameters-9)
+- [usage](#usage)
+- [content providers](#content-providers)
+- [files (default)](#files-default)
+  - [npm-pack](#npm-pack)
+  - [node-modules](#node-modules)
+- [API](#api)
+    - [Table of Contents](#table-of-contents)
+  - [ContentProvider](#contentprovider)
+    - [asyncIterator](#asynciterator)
+  - [FileContentProvider](#filecontentprovider)
+    - [Parameters](#parameters)
+    - [name](#name)
+  - [NodeModulesContentProvider](#nodemodulescontentprovider)
+    - [Parameters](#parameters-1)
+    - [name](#name-1)
+  - [NPMPackContentProvider](#npmpackcontentprovider)
+    - [Parameters](#parameters-2)
+    - [name](#name-2)
+  - [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
+  - [fields](#fields)
+  - [fields](#fields-1)
+  - [fields](#fields-2)
+  - [hookMapping](#hookmapping)
+  - [hookMapping](#hookmapping-1)
+  - [Field](#field)
+    - [Properties](#properties)
+  - [Packager](#packager)
+    - [Parameters](#parameters-3)
+    - [tmpdir](#tmpdir)
+    - [execute](#execute)
+      - [Parameters](#parameters-4)
+  - [decodePassword](#decodepassword)
+    - [Parameters](#parameters-5)
+  - [extractFunctions](#extractfunctions)
+    - [Parameters](#parameters-6)
+  - [fieldProvider](#fieldprovider)
+    - [Parameters](#parameters-7)
+  - [Expander](#expander)
+    - [Parameters](#parameters-8)
+  - [copyEntries](#copyentries)
+    - [Parameters](#parameters-9)
+- [install](#install)
+- [license](#license)
 
 ## ContentProvider
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-pkgbuild",
-  "version": "8.3.9",
+  "version": "8.3.12",
   "publishConfig": {
     "access": "public"
   },
@@ -40,7 +40,7 @@
     "lint:docs": "documentation lint ./src/**/*.mjs"
   },
   "dependencies": {
-    "@npmcli/arborist": "^5.0.4",
+    "@npmcli/arborist": "^5.0.5",
     "aggregate-async-iterator": "^1.1.10",
     "commander": "^9.1.0",
     "content-entry": "^4.1.9",

package/src/content/file-content-provider.mjs

@@ -30,11 +30,6 @@ export class FileContentProvider extends ContentProvider {
     } else {
       this.definitions = { pattern: ["**/*"], ...definitions };
       this.definitions.pattern = asArray(this.definitions.pattern);
-      /*
-      if(entryProperties && entryProperties.destination && !entryProperties.destination.endsWith('/')) {
-      	entryProperties.destination += '/';
-      }
-*/
     }
 
     this.entryProperties = entryProperties;

package/src/content/node-modules-content-provider.mjs

@@ -214,6 +214,6 @@ const toBeSkipped = new RegExp(
       "chains and topics\\.md",
       "build_detect_platform"
     ].join("|") +
-    ")$|(node_modules/(@types|node-addon-api|node-gyp)|(win32|android|darwin)-(ia32|x64|arm|arm64))",
+    ")$|(node_modules/(@types|node-addon-api)|(node_modules/node-gyp$)|(win32|android|darwin)-(ia32|x64|arm|arm64))",
   "i"
 );

package/src/extract-from-package.mjs

@@ -28,78 +28,78 @@ export const archMapping = Object.fromEntries(
  * @param {string} dir
  * @returns {Object}
  */
-export async function extractFromPackage(pkg, dir) {
+export async function extractFromPackage(json, dir) {
   const properties = Object.fromEntries(
     ["name", "version", "description", "homepage", "license"]
-      .map(key => [key, pkg[key]])
+      .map(key => [key, json[key]])
       .filter(([k, v]) => v !== undefined)
   );
 
-  if (pkg.bugs) {
-    if (pkg.bugs.url) {
-      properties.bugs = pkg.bugs.url;
+  if (json.bugs) {
+    if (json.bugs.url) {
+      properties.bugs = json.bugs.url;
     }
   }
 
-  Object.assign(properties, pkg.config);
+  Object.assign(properties, json.config);
 
   if (properties.name) {
     properties.name = properties.name.replace(/^\@\w+\//, "");
   }
 
   properties.access = "private";
-  if (pkg.publishConfig) {
-    properties.access = pkg.publishConfig.access;
+  if (json.publishConfig) {
+    properties.access = json.publishConfig.access;
   }
 
-  if (pkg.contributors) {
-    properties.maintainer = pkg.contributors.map(
+  if (json.contributors) {
+    properties.maintainer = json.contributors.map(
       c => `${c.name} <${c.email}>`
     )[0];
   }
 
-  if (pkg.repository) {
-    if (typeof pkg.repository === "string") {
-      properties.source = pkg.repository;
+  if (json.repository) {
+    if (typeof json.repository === "string") {
+      properties.source = json.repository;
     } else {
-      if (pkg.repository.url) {
-        properties.source = pkg.repository.url;
+      if (json.repository.url) {
+        properties.source = json.repository.url;
       }
     }
   }
 
   const context = createContext({ properties });
 
-  let dependencies = { ...pkg.engines };
+  let dependencies = { ...json.engines };
   let sources = [];
   let output = {};
   let arch = new Set();
 
-  const processPkg = (pkg, dir, modulePath) => {
-    if (pkg.pkg) {
-      const pkgbuild = pkg.pkg;
+  const processPkg = (json, dir, modulePath) => {
+    const pkg = json.pkg;
 
-      if (pkgbuild.abstract || !modulePath) {
-        if (pkg.cpu) {
-          for (const a of asArray(pkg.cpu)) {
-            arch.add(npmArchMapping[a]);
-          }
+    if (pkg) {
+      if (json.cpu) {
+        for (const a of asArray(json.cpu)) {
+          arch.add(npmArchMapping[a]);
         }
+      }
 
-        if (pkgbuild.arch) {
-          for (const a of asArray(pkgbuild.arch)) {
+      if (pkg.abstract || !modulePath) {
+        if (pkg.arch) {
+          for (const a of asArray(pkg.arch)) {
             arch.add(a);
           }
         }
 
-        Object.assign(output, pkgbuild.output);
+        Object.assign(output, pkg.output);
 
-        Object.entries(pkgbuild)
+        Object.entries(pkg)
           .filter(([k, v]) => typeof v === "string")
           .forEach(([k, v]) => (properties[k] = v));
 
-        if (pkgbuild.content && !modulePath) {
-          Object.entries(pkgbuild.content).forEach(
+        if (pkg.content && !modulePath) {
+          Object.entries(pkg.content).forEach(
             ([destination, definitions]) => {
               destination = context.expand(destination);
               definitions = context.expand(definitions);
@@ -126,18 +126,18 @@ export async function extractFromPackage(pkg, dir) {
           );
         }
       }
-      Object.assign(dependencies, pkgbuild.depends);
+      Object.assign(dependencies, pkg.depends);
     }
   };
 
-  await packageWalker(async (pkg, base, modulePath) => {
+  await packageWalker(async (json, base, modulePath) => {
     if (modulePath.length > 0) {
-      processPkg(pkg, base, modulePath);
+      processPkg(json, base, modulePath);
     }
     return true;
   }, dir);
 
-  processPkg(pkg, dir);
+  processPkg(json, dir);
 
   if (arch.size > 0) {
     properties.arch = [...arch].filter(a => a === npmArchMapping[hostArch]);

package/src/npm-pkgbuild-cli.mjs

@@ -128,6 +128,7 @@ program
         if (options.verbose) {
           console.log(output.properties);
           console.log(`sources: ${sources.join("\n  ")}`);
+          console.log(`dependencies: ${JSON.stringify(dependencies)}`);
         }
 
         const fileName = await output.execute(

package/src/util.mjs

@@ -144,7 +144,7 @@ export function fieldProvider(properties, fields) {
 
 /**
  * Copy content from source into destinationDirectory.
- * destination paths a generated without leading '/'
+ * Destination paths a generated without leading '/' (as for as entry names too).
  * @param {AsyncIterator<ContentEntry>} source
  * @param {string} destinationDirectory
  * @param {Expander} expander