npm-pkgbuild 19.1.1 → 19.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +65 -65
- package/package.json +2 -2
- package/src/npm-pkgbuild-cli.mjs +1 -1
package/README.md
CHANGED
|
@@ -98,47 +98,47 @@ See [mf-hosting](https://www.npmjs.com/package/mf-hosting) or [mf-hosting-fronte
|
|
|
98
98
|
* [Properties](#properties)
|
|
99
99
|
* [extractFromPackage](#extractfrompackage)
|
|
100
100
|
* [Parameters](#parameters-1)
|
|
101
|
-
* [
|
|
102
|
-
* [ContentProvider](#contentprovider)
|
|
101
|
+
* [NPMPackContentProvider](#npmpackcontentprovider)
|
|
103
102
|
* [Parameters](#parameters-2)
|
|
104
103
|
* [Properties](#properties-1)
|
|
105
|
-
* [asyncIterator](#asynciterator)
|
|
106
|
-
* [FileContentProvider](#filecontentprovider)
|
|
107
|
-
* [Parameters](#parameters-3)
|
|
108
|
-
* [asyncIterator](#asynciterator-1)
|
|
109
104
|
* [name](#name)
|
|
110
105
|
* [NodeModulesContentProvider](#nodemodulescontentprovider)
|
|
111
|
-
* [Parameters](#parameters-
|
|
106
|
+
* [Parameters](#parameters-3)
|
|
112
107
|
* [Properties](#properties-2)
|
|
113
|
-
* [asyncIterator](#asynciterator
|
|
108
|
+
* [asyncIterator](#asynciterator)
|
|
114
109
|
* [name](#name-1)
|
|
115
|
-
* [
|
|
116
|
-
* [Parameters](#parameters-
|
|
117
|
-
* [
|
|
110
|
+
* [FileContentProvider](#filecontentprovider)
|
|
111
|
+
* [Parameters](#parameters-4)
|
|
112
|
+
* [asyncIterator](#asynciterator-1)
|
|
118
113
|
* [name](#name-2)
|
|
119
114
|
* [NFTContentProvider](#nftcontentprovider)
|
|
115
|
+
* [Parameters](#parameters-5)
|
|
116
|
+
* [asyncIterator](#asynciterator-2)
|
|
117
|
+
* [name](#name-3)
|
|
118
|
+
* [ContentProvider](#contentprovider)
|
|
120
119
|
* [Parameters](#parameters-6)
|
|
120
|
+
* [Properties](#properties-3)
|
|
121
121
|
* [asyncIterator](#asynciterator-3)
|
|
122
|
-
* [name](#name-3)
|
|
123
122
|
* [DEBIAN](#debian)
|
|
124
123
|
* [hookMapping](#hookmapping)
|
|
125
124
|
* [attributes](#attributes)
|
|
126
125
|
* [prepare](#prepare)
|
|
127
126
|
* [Parameters](#parameters-7)
|
|
127
|
+
* [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
|
|
128
|
+
* [attributes](#attributes-1)
|
|
128
129
|
* [quoteFile](#quotefile)
|
|
129
130
|
* [Parameters](#parameters-8)
|
|
130
131
|
* [RPM](#rpm)
|
|
131
132
|
* [hookMapping](#hookmapping-1)
|
|
132
|
-
* [attributes](#attributes-
|
|
133
|
+
* [attributes](#attributes-2)
|
|
133
134
|
* [prepare](#prepare-1)
|
|
134
135
|
* [Parameters](#parameters-9)
|
|
135
|
-
* [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
|
|
136
|
-
* [attributes](#attributes-2)
|
|
137
136
|
* [OCI](#oci)
|
|
138
137
|
* [DOCKER](#docker)
|
|
139
138
|
* [attributes](#attributes-3)
|
|
140
139
|
* [prepare](#prepare-2)
|
|
141
140
|
* [Parameters](#parameters-10)
|
|
141
|
+
* [BUILDAH](#buildah)
|
|
142
142
|
* [Packager](#packager)
|
|
143
143
|
* [Parameters](#parameters-11)
|
|
144
144
|
* [packageName](#packagename)
|
|
@@ -248,51 +248,21 @@ Extract package definition from package.json.
|
|
|
248
248
|
|
|
249
249
|
Returns **AsyncIterable<[PackageDefinition](#packagedefinition)>** 
|
|
250
250
|
|
|
251
|
-
##
|
|
252
|
-
|
|
253
|
-
**Extends DOCKER**
|
|
254
|
-
|
|
255
|
-
Use buildah @see <https://buildah.io>
|
|
251
|
+
## NPMPackContentProvider
|
|
256
252
|
|
|
257
|
-
|
|
253
|
+
**Extends ContentProvider**
|
|
258
254
|
|
|
259
|
-
|
|
255
|
+
Content from npm pack.
|
|
260
256
|
|
|
261
257
|
### Parameters
|
|
262
258
|
|
|
263
|
-
* `definitions`
|
|
264
|
-
* `entryProperties`
|
|
259
|
+
* `definitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
260
|
+
* `entryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to be set for each entry
|
|
265
261
|
* `directoryProperties`  
|
|
266
262
|
|
|
267
263
|
### Properties
|
|
268
264
|
|
|
269
265
|
* `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
270
|
-
* `transformer` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Transformer>** 
|
|
271
|
-
|
|
272
|
-
### asyncIterator
|
|
273
|
-
|
|
274
|
-
List all entries.
|
|
275
|
-
|
|
276
|
-
Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
|
|
277
|
-
|
|
278
|
-
## FileContentProvider
|
|
279
|
-
|
|
280
|
-
**Extends ContentProvider**
|
|
281
|
-
|
|
282
|
-
Content provided form the file system.
|
|
283
|
-
|
|
284
|
-
### Parameters
|
|
285
|
-
|
|
286
|
-
* `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))** 
|
|
287
|
-
|
|
288
|
-
* `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)>)** 
|
|
289
|
-
* `definitions.base` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** base directory where to find the files
|
|
290
|
-
* `entryProperties`  
|
|
291
|
-
* `directoryProperties`  
|
|
292
|
-
|
|
293
|
-
### asyncIterator
|
|
294
|
-
|
|
295
|
-
Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
|
|
296
266
|
|
|
297
267
|
### name
|
|
298
268
|
|
|
@@ -325,21 +295,24 @@ Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
|
|
|
325
295
|
|
|
326
296
|
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
|
|
327
297
|
|
|
328
|
-
##
|
|
298
|
+
## FileContentProvider
|
|
329
299
|
|
|
330
300
|
**Extends ContentProvider**
|
|
331
301
|
|
|
332
|
-
Content
|
|
302
|
+
Content provided form the file system.
|
|
333
303
|
|
|
334
304
|
### Parameters
|
|
335
305
|
|
|
336
|
-
* `definitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
337
|
-
|
|
306
|
+
* `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))** 
|
|
307
|
+
|
|
308
|
+
* `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)>)** 
|
|
309
|
+
* `definitions.base` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** base directory where to find the files
|
|
310
|
+
* `entryProperties`  
|
|
338
311
|
* `directoryProperties`  
|
|
339
312
|
|
|
340
|
-
###
|
|
313
|
+
### asyncIterator
|
|
341
314
|
|
|
342
|
-
|
|
315
|
+
Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
|
|
343
316
|
|
|
344
317
|
### name
|
|
345
318
|
|
|
@@ -368,6 +341,27 @@ Returns **AsyncIterable\<ContentEntry>** all entries
|
|
|
368
341
|
|
|
369
342
|
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
|
|
370
343
|
|
|
344
|
+
## ContentProvider
|
|
345
|
+
|
|
346
|
+
Source of package content.
|
|
347
|
+
|
|
348
|
+
### Parameters
|
|
349
|
+
|
|
350
|
+
* `definitions`  
|
|
351
|
+
* `entryProperties`  
|
|
352
|
+
* `directoryProperties`  
|
|
353
|
+
|
|
354
|
+
### Properties
|
|
355
|
+
|
|
356
|
+
* `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
357
|
+
* `transformer` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Transformer>** 
|
|
358
|
+
|
|
359
|
+
### asyncIterator
|
|
360
|
+
|
|
361
|
+
List all entries.
|
|
362
|
+
|
|
363
|
+
Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
|
|
364
|
+
|
|
371
365
|
## DEBIAN
|
|
372
366
|
|
|
373
367
|
**Extends Packager**
|
|
@@ -394,6 +388,15 @@ Map install hook named from default (arch) to deb.
|
|
|
394
388
|
|
|
395
389
|
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)>** 
|
|
396
390
|
|
|
391
|
+
## pkgKeyValuePairOptions
|
|
392
|
+
|
|
393
|
+
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
394
|
+
|
|
395
|
+
## attributes
|
|
396
|
+
|
|
397
|
+
well known package properties
|
|
398
|
+
<https://www.archlinux.org/pacman/PKGBUILD.5.html>
|
|
399
|
+
|
|
397
400
|
## quoteFile
|
|
398
401
|
|
|
399
402
|
### Parameters
|
|
@@ -427,15 +430,6 @@ Check for rpmbuild presence.
|
|
|
427
430
|
|
|
428
431
|
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
|
|
429
432
|
|
|
430
|
-
## pkgKeyValuePairOptions
|
|
431
|
-
|
|
432
|
-
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
433
|
-
|
|
434
|
-
## attributes
|
|
435
|
-
|
|
436
|
-
well known package properties
|
|
437
|
-
<https://www.archlinux.org/pacman/PKGBUILD.5.html>
|
|
438
|
-
|
|
439
433
|
## OCI
|
|
440
434
|
|
|
441
435
|
**Extends Packager**
|
|
@@ -465,6 +459,12 @@ Check for docker presence.
|
|
|
465
459
|
|
|
466
460
|
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
|
|
467
461
|
|
|
462
|
+
## BUILDAH
|
|
463
|
+
|
|
464
|
+
**Extends DOCKER**
|
|
465
|
+
|
|
466
|
+
Use buildah @see <https://buildah.io>
|
|
467
|
+
|
|
468
468
|
## Packager
|
|
469
469
|
|
|
470
470
|
### Parameters
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "npm-pkgbuild",
|
|
3
|
-
"version": "19.1.
|
|
3
|
+
"version": "19.1.2",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public",
|
|
6
6
|
"provenance": false
|
|
@@ -74,7 +74,7 @@
|
|
|
74
74
|
"uti": "^8.10.3"
|
|
75
75
|
},
|
|
76
76
|
"devDependencies": {
|
|
77
|
-
"@types/node": "^25.0.
|
|
77
|
+
"@types/node": "^25.0.1",
|
|
78
78
|
"ava": "^6.4.1",
|
|
79
79
|
"c8": "^10.1.3",
|
|
80
80
|
"documentation": "^14.0.3",
|