npm-pkgbuild 19.0.8 → 19.1.1

package/README.md

@@ -8,7 +8,6 @@
 [![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 [![Known Vulnerabilities](https://snyk.io/test/github/arlac77/npm-pkgbuild/badge.svg)](https://snyk.io/test/github/arlac77/npm-pkgbuild)
-[![Coverage Status](https://coveralls.io/repos/arlac77/npm-pkgbuild/badge.svg)](https://coveralls.io/github/arlac77/npm-pkgbuild)
 
 ## npm-pkgbuild
 
@@ -99,47 +98,47 @@ See [mf-hosting](https://www.npmjs.com/package/mf-hosting) or [mf-hosting-fronte
     *   [Properties](#properties)
 *   [extractFromPackage](#extractfrompackage)
     *   [Parameters](#parameters-1)
-*   [NPMPackContentProvider](#npmpackcontentprovider)
+*   [BUILDAH](#buildah)
+*   [ContentProvider](#contentprovider)
     *   [Parameters](#parameters-2)
     *   [Properties](#properties-1)
+    *   [asyncIterator](#asynciterator)
+*   [FileContentProvider](#filecontentprovider)
+    *   [Parameters](#parameters-3)
+    *   [asyncIterator](#asynciterator-1)
     *   [name](#name)
 *   [NodeModulesContentProvider](#nodemodulescontentprovider)
-    *   [Parameters](#parameters-3)
+    *   [Parameters](#parameters-4)
     *   [Properties](#properties-2)
-    *   [asyncIterator](#asynciterator)
+    *   [asyncIterator](#asynciterator-2)
     *   [name](#name-1)
-*   [FileContentProvider](#filecontentprovider)
-    *   [Parameters](#parameters-4)
-    *   [asyncIterator](#asynciterator-1)
+*   [NPMPackContentProvider](#npmpackcontentprovider)
+    *   [Parameters](#parameters-5)
+    *   [Properties](#properties-3)
     *   [name](#name-2)
 *   [NFTContentProvider](#nftcontentprovider)
-    *   [Parameters](#parameters-5)
-    *   [asyncIterator](#asynciterator-2)
-    *   [name](#name-3)
-*   [ContentProvider](#contentprovider)
     *   [Parameters](#parameters-6)
-    *   [Properties](#properties-3)
     *   [asyncIterator](#asynciterator-3)
+    *   [name](#name-3)
 *   [DEBIAN](#debian)
     *   [hookMapping](#hookmapping)
     *   [attributes](#attributes)
     *   [prepare](#prepare)
         *   [Parameters](#parameters-7)
-*   [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
-*   [attributes](#attributes-1)
 *   [quoteFile](#quotefile)
     *   [Parameters](#parameters-8)
 *   [RPM](#rpm)
     *   [hookMapping](#hookmapping-1)
-    *   [attributes](#attributes-2)
+    *   [attributes](#attributes-1)
     *   [prepare](#prepare-1)
         *   [Parameters](#parameters-9)
+*   [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
+*   [attributes](#attributes-2)
 *   [OCI](#oci)
 *   [DOCKER](#docker)
     *   [attributes](#attributes-3)
     *   [prepare](#prepare-2)
         *   [Parameters](#parameters-10)
-*   [BUILDAH](#buildah)
 *   [Packager](#packager)
     *   [Parameters](#parameters-11)
     *   [packageName](#packagename)
@@ -249,21 +248,51 @@ Extract package definition from package.json.
 
 Returns **AsyncIterable<[PackageDefinition](#packagedefinition)>**&#x20;
 
-## NPMPackContentProvider
+## BUILDAH
 
-**Extends ContentProvider**
+**Extends DOCKER**
 
-Content from npm pack.
+Use buildah @see <https://buildah.io>
+
+## ContentProvider
+
+Source of package content.
 
 ### Parameters
 
-*   `definitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
-*   `entryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to be set for each entry
+*   `definitions` &#x20;
+*   `entryProperties` &#x20;
 *   `directoryProperties` &#x20;
 
 ### Properties
 
 *   `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+*   `transformer` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Transformer>**&#x20;
+
+### asyncIterator
+
+List all entries.
+
+Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
+
+## FileContentProvider
+
+**Extends ContentProvider**
+
+Content provided form the file system.
+
+### Parameters
+
+*   `definitions` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**&#x20;
+
+    *   `definitions.pattern` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>)**&#x20;
+    *   `definitions.base` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** base directory where to find the files
+*   `entryProperties` &#x20;
+*   `directoryProperties` &#x20;
+
+### asyncIterator
+
+Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
 
 ### name
 
@@ -296,24 +325,21 @@ Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
 
-## FileContentProvider
+## NPMPackContentProvider
 
 **Extends ContentProvider**
 
-Content provided form the file system.
+Content from npm pack.
 
 ### Parameters
 
-*   `definitions` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**&#x20;
-
-    *   `definitions.pattern` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>)**&#x20;
-    *   `definitions.base` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** base directory where to find the files
-*   `entryProperties` &#x20;
+*   `definitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
+*   `entryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to be set for each entry
 *   `directoryProperties` &#x20;
 
-### asyncIterator
+### Properties
 
-Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
+*   `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
 
 ### name
 
@@ -342,27 +368,6 @@ Returns **AsyncIterable\<ContentEntry>** all entries
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
 
-## ContentProvider
-
-Source of package content.
-
-### Parameters
-
-*   `definitions` &#x20;
-*   `entryProperties` &#x20;
-*   `directoryProperties` &#x20;
-
-### Properties
-
-*   `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
-*   `transformer` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Transformer>**&#x20;
-
-### asyncIterator
-
-List all entries.
-
-Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
-
 ## DEBIAN
 
 **Extends Packager**
@@ -389,15 +394,6 @@ Map install hook named from default (arch) to deb.
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)>**&#x20;
 
-## pkgKeyValuePairOptions
-
-Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
-
-## attributes
-
-well known package properties
-<https://www.archlinux.org/pacman/PKGBUILD.5.html>
-
 ## quoteFile
 
 ### Parameters
@@ -431,6 +427,15 @@ Check for rpmbuild presence.
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)>** true when rpmbuild executable is present
 
+## pkgKeyValuePairOptions
+
+Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
+
+## attributes
+
+well known package properties
+<https://www.archlinux.org/pacman/PKGBUILD.5.html>
+
 ## OCI
 
 **Extends Packager**
@@ -460,12 +465,6 @@ Check for docker presence.
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)>** true when docker executable is present
 
-## BUILDAH
-
-**Extends DOCKER**
-
-Use buildah @see <https://buildah.io>
-
 ## Packager
 
 ### Parameters
@@ -495,6 +494,9 @@ Prepares artifact generation.
 #### Parameters
 
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
+
+    *   `options.staging` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**&#x20;
+    *   `options.destination` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**&#x20;
 *   `publishingDetail` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{properties: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object), destination: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), tmpdir: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), staging: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)}>**&#x20;
@@ -557,6 +559,9 @@ Prepares artifact generation.
 #### Parameters
 
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
+
+    *   `options.staging` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**&#x20;
+    *   `options.destination` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**&#x20;
 *   `publishingDetail` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{properties: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object), destination: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), tmpdir: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), staging: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)}>**&#x20;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-pkgbuild",
-  "version": "19.0.8",
+  "version": "19.1.1",
   "publishConfig": {
     "access": "public",
     "provenance": false
@@ -52,7 +52,7 @@
     "tsc:types": "tsc -d --allowJs --declarationDir dist --emitDeclarationOnly ./src/extract-from-package.mjs"
   },
   "dependencies": {
-    "@npmcli/arborist": "^9.1.8",
+    "@npmcli/arborist": "^9.1.9",
     "@vercel/nft": "^1.1.0",
     "aggregate-async-iterator": "^1.2.3",
     "commander": "^14.0.2",
@@ -74,7 +74,7 @@
     "uti": "^8.10.3"
   },
   "devDependencies": {
-    "@types/node": "^24.10.1",
+    "@types/node": "^25.0.0",
     "ava": "^6.4.1",
     "c8": "^10.1.3",
     "documentation": "^14.0.3",

package/src/npm-pkgbuild-cli.mjs

@@ -28,6 +28,7 @@ allInputs.forEach(i => {
 program
   .option("--verbose", "be more verbose", false)
   .option("--dry", "do not execute, only print definitions", false)
+  .option("--staging <dir>","directory where to start packaging process")
   .option("-D --define <a=b>", "define property", (str, former = {}) =>
     Object.assign(former, Object.fromEntries([str.split(/=/)]))
   )

package/src/output/arch.mjs

@@ -261,10 +261,6 @@ package() {
 
     if (options.verbose) {
       console.log(await readFile(join(staging, PKGBUILD), utf8StreamOptions));
-      /*console.log("***", staging, "***");
-      const ls = await execa("ls", ["-lR"], { cwd: staging });
-      console.log(ls.stdout);
-      console.log("*** end ***");*/
     }
 
     if (!options.dry) {
@@ -274,9 +270,14 @@ package() {
         PACKAGER = person(properties.contributors);
       }
 
+      const makePackageOptions = ["--noprogressbar", "-m", "-c", "-f", "-e"];
+      if (options.verbose) {
+        makePackageOptions.push("--log");
+      }
+
       const makepkg = await execa(
         "makepkg",
-        ["--noprogressbar", "-c", "-f", "-e"],
+        makePackageOptions,
         {
           cwd: staging,
           env: { PKGDEST: destination, PACKAGER }

package/src/output/packager.mjs

@@ -198,6 +198,8 @@ export class Packager {
   /**
    * Prepares artifact generation.
    * @param {Object} options
+   * @param {string} [options.staging]
+   * @param {string} [options.destination]
    * @param {Object} [publishingDetail]
    * @returns {Promise<{properties:Object, destination:string, tmpdir:string, staging:string}>}
    */
@@ -212,7 +214,7 @@ export class Packager {
       properties: this.properties,
       destination: options.destination || tmpdir,
       tmpdir,
-      staging: tmpdir
+      staging: options.staging || tmpdir
     };
 
     // @ts-ignore

package/types/output/docker.d.mts

@@ -118,9 +118,6 @@ export class DOCKER extends Packager {
         arch: string;
     }): Promise<boolean>;
     create(sources: any, transformer: any, options: any, publishingDetails: any, expander: any): Promise<string>;
-    publish(artifact: any, publishingDetails: any, logger?: {
-        (...data: any[]): void;
-        (message?: any, ...optionalParams: any[]): void;
-    }): Promise<void>;
+    publish(artifact: any, publishingDetails: any, logger?: (...data: any[]) => void): Promise<void>;
 }
 import { Packager } from "./packager.mjs";

package/types/output/packager.d.mts

@@ -53,10 +53,15 @@ export class Packager {
     /**
      * Prepares artifact generation.
      * @param {Object} options
+     * @param {string} [options.staging]
+     * @param {string} [options.destination]
      * @param {Object} [publishingDetail]
      * @returns {Promise<{properties:Object, destination:string, tmpdir:string, staging:string}>}
      */
-    prepare(options: any, publishingDetail?: any): Promise<{
+    prepare(options: {
+        staging?: string;
+        destination?: string;
+    }, publishingDetail?: any): Promise<{
         properties: any;
         destination: string;
         tmpdir: string;