npm-pkgbuild 7.25.3 → 7.25.4

package/README.md

@@ -28,7 +28,192 @@ The resulting pkg will contain the package dist content and all production depen
 
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-## 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)
+*   [Field](#field)
+    *   [Properties](#properties)
+*   [Packager](#packager)
+    *   [Parameters](#parameters-3)
+    *   [tmpdir](#tmpdir)
+    *   [execute](#execute)
+        *   [Parameters](#parameters-4)
+*   [hookMapping](#hookmapping)
+*   [extractFunctions](#extractfunctions)
+    *   [Parameters](#parameters-5)
+*   [fieldProvider](#fieldprovider)
+    *   [Parameters](#parameters-6)
+*   [Expander](#expander)
+    *   [Parameters](#parameters-7)
+*   [copyEntries](#copyentries)
+    *   [Parameters](#parameters-8)
+
+## ContentProvider
+
+Source of package content.
+
+### asyncIterator
+
+List all entries.
+
+Returns **asyncIterator\<ContentEntry>** 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))** 
+
+    *   `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)>)** 
+    *   `definitions.base` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** base directory where to find the files
+*   `entryProperties`  
+
+### name
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
+
+## NodeModulesContentProvider
+
+**Extends ContentProvider**
+
+Content from node_modules
+
+### Parameters
+
+*   `definitions`  
+*   `entryProperties`  
+
+### name
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
+
+## NPMPackContentProvider
+
+**Extends ContentProvider**
+
+Content from npm pack.
+
+### Parameters
+
+*   `definitions`  
+*   `entryProperties`  
+
+### name
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
+
+## pkgKeyValuePairOptions
+
+## fields
+
+well known package properties
+<https://www.archlinux.org/pacman/PKGBUILD.5.html>
+
+## fields
+
+*   **See**: <https://www.debian.org/doc/debian-policy/ch-controlfields.html>
+*   **See**: <https://linux.die.net/man/5/deb-control>
+
+## fields
+
+*   **See**: <https://rpm-packaging-guide.github.io>
+
+## Field
+
+Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
+
+### Properties
+
+*   `alias` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** interchangeable field name
+*   `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+*   `default` **any** 
+*   `mandatory` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
+
+## Packager
+
+### Parameters
+
+*   `properties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+
+### tmpdir
+
+Create tmp directory.
+
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** directory path
+
+### execute
+
+Execute package generation
+
+#### Parameters
+
+*   `sources`  
+*   `transformer`  
+*   `dependencies`  
+*   `options`  
+*   `expander`  
+
+## hookMapping
+
+map install hook named from arch to rpm
+
+## extractFunctions
+
+Extract shell functions from a given text
+
+### Parameters
+
+*   `source` **AsyncIterator<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** 
+
+Returns **AsyncIterator\<FunctionDecl>** 
+
+## fieldProvider
+
+### Parameters
+
+*   `properties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+*   `fields` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+
+Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
+
+## Expander
+
+Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
+
+### Parameters
+
+*   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+
+## copyEntries
+
+Copy content from source into destinationDirectory.
+
+### Parameters
+
+*   `source` **AsyncIterator\<ContentEntry>** 
+*   `destinationDirectory` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+*   `expander` **[Expander](#expander)**  (optional, default `v=>v`)
+*   `attributes` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<ContentEntryAttribute>** 
 
 # install
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-pkgbuild",
-  "version": "7.25.3",
+  "version": "7.25.4",
   "publishConfig": {
     "access": "public"
   },
@@ -41,9 +41,9 @@
     "@npmcli/arborist": "^4.3.0",
     "aggregate-async-iterator": "^1.1.9",
     "commander": "^9.0.0",
-    "content-entry": "^4.1.3",
-    "content-entry-filesystem": "^4.0.5",
-    "content-entry-transform": "^1.3.8",
+    "content-entry": "^4.1.4",
+    "content-entry-filesystem": "^4.0.6",
+    "content-entry-transform": "^1.3.9",
     "execa": "^6.0.0",
     "expression-expander": "^7.0.14",
     "globby": "^13.1.0",