npm-pkgbuild

Create ArchLinux, RPM, Debian and Docker packages from npm packages.

usage

In a package directory execute

``shell
npm-pkgbuild --rpm --debian --arch --content /destination:build --publish /some/directory
`

This will create a arch, rpm and a debian package of the build dir.

upload package

`shell
npm-pkgbuild --arch --content build --publish 'https://my.package-service.com/binaries/linux/{{type}}/{{access}}/{{arch}}'
`

You can specify the package content in package.json.

`json
{
"pkgbuild": {
"content": {
"/some/location/" : { "base": "build" },
"/etc/myconfig.json" : "sample-config.json",
"/erc/secret" : { "name": "secret", "mode": "600" },
"/opt/myapp": [
{
"type": "npm-pack"
},
{
"type": "node-modules",
"withoutDevelpmentDependencies": true
}
]
},
"hooks" : "pkg/hooks",
"output": {
"debian" : {},
"rpm" : {},
"arch" : {}
},
"dependencies": { "nginx" : ">=1.12" }
}
}
`

content providers

Defining where the package content should come from.

files (default)

content from the file system

npm-pack

content as provided by npm pack

node-modules

content of all (production) dependencies

options:
\- withoutDevelpmentDependencies when to stip away dev dependencies (defaults to true)

shared configuration

You can import common configuration from other packages.
See mf-hosting or mf-hosting-frontend modules.

API

$3

* allInputs
* allOutputs
* npmArchMapping
* content2Sources
* Parameters
* PackageDefinition
* Properties
* extractFromPackage
* Parameters
* NPMPackContentProvider
* Parameters
* Properties
* name
* NodeModulesContentProvider
* Parameters
* Properties
* asyncIterator
* name
* FileContentProvider
* Parameters
* asyncIterator
* name
* NFTContentProvider
* Parameters
* asyncIterator
* name
* ContentProvider
* Parameters
* Properties
* asyncIterator
* DEBIAN
* hookMapping
* attributes
* prepare
* Parameters
* pkgKeyValuePairOptions
* attributes
* quoteFile
* Parameters
* RPM
* hookMapping
* attributes
* prepare
* Parameters
* OCI
* DOCKER
* attributes
* prepare
* Parameters
* BUILDAH
* Packager
* Parameters
* packageName
* Parameters
* hookContent
* dependencyExpression
* Parameters
* tmpdir
* prepare
* Parameters
* create
* Parameters
* workspaceLayout
* prepare
* Parameters
* Packager
* Parameters
* packageName
* Parameters
* hookContent
* dependencyExpression
* Parameters
* tmpdir
* prepare
* Parameters
* create
* Parameters
* workspaceLayout
* prepare
* Parameters
* Field
* Properties
* deleteKey
* Parameters
* copyNodeModules
* Parameters
* PublishingDetail
* Properties
* createPublishingDetails
* Parameters
* publish
* Parameters
* utf8StreamOptions
* decodePassword
* Parameters
* FunctionDecl
* Properties
* extractFunctions
* Parameters
* fieldProvider
* Parameters
* Expander
* Parameters
* copyEntries
* Parameters

allInputs

All content providers (input)

allOutputs

All output formats

npmArchMapping

Node architecture name to os native arch name mapping
{@see

content2Sources

Delivers ContentProviders from pkgbuild.content definition.

$3

* content Object from pkgbuild.content
* dir

Returns Iterable<ContentProvider>

PackageDefinition

Type: Object

$3

* properties Object values describing the package attributes

* properties.dependencies Object
* properties.replaces Object
* properties.conficts Object
* sources Array<ContentProvider> content providers
* output Object package type
* variant Object identifier of the variant

* variant.name string name of the variant
* variant.arch string name of the architecture

extractFromPackage

Extract package definition from package.json.

* for each architecture deliver a new result
* if no architecture is given one result set is provided nethertheless
* architectures are taken from cpu (node arch ids) and from pkgbuild.arch (raw arch ids)
* architecture given in a variant definition are used to restrict the set of avaliable architectures

$3

* options Object (optional, default {})

* options.dir string? where to look for package.json
* options.verbose boolean? log
* env Object as delared in process.env (optional, default {})

Returns AsyncIterable<PackageDefinition>

NPMPackContentProvider

Extends ContentProvider

Content from npm pack.

$3

* definitions Object
* entryProperties Object to be set for each entry
* directoryProperties

$3

* dir string

$3

Returns string name of the content provider

NodeModulesContentProvider

Extends ContentProvider

Content from node\_modules.
Requires .npmrc or NPM\_TOKEN environment

$3

* definitions
* entryProperties
* directoryProperties

$3

* withoutDevelpmentDependencies boolean

$3

List all entries.

Returns AsyncIterable<(ContentEntry | CollectionEntry)> all entries

$3

Returns string name of the content provider

FileContentProvider

Extends ContentProvider

Content provided form the file system.

$3

* definitions (Object | string)
* entryProperties
* directoryProperties

$3

Returns AsyncIterable<(ContentEntry | CollectionEntry)> all entries

$3

Returns string name of the content provider

NFTContentProvider

Extends ContentProvider

Content provided form the file system.

$3

* definitions (Object | string)
* entryProperties Object?
* directoryProperties Object?

$3

Returns AsyncIterable\ all entries

$3

Returns string name of the content provider

ContentProvider

Source of package content.

$3

* definitions Object
* entryProperties Object?
* directoryProperties Object?

$3

* dir string

$3

List all entries.

Returns AsyncIterable<(ContentEntry | CollectionEntry)> all entries

DEBIAN

Extends Packager

Create .deb packages

$3

Map install hook named from default (arch) to deb.

$3

* See:
* See:

$3

#### Parameters

* options Object
* variant Object

* variant.arch string

Returns Promise<boolean>

pkgKeyValuePairOptions

Type: Object

attributes

well known package properties


quoteFile

$3

* name

RPM

Extends Packager

Produce rpm packages.

$3

Map install hook named from default (arch) to rpm.

$3

* See:

$3

Check for rpmbuild presence.

#### Parameters

* options Object
* variant Object

* variant.arch string

Returns Promise<boolean> true when rpmbuild executable is present

OCI

Extends Packager

Low level OCI compatible packager

DOCKER

Extends Packager

docker image build

$3

* See:

$3

Check for docker presence.

#### Parameters

* options Object
* variant Object

* variant.arch string

Returns Promise<boolean> true when docker executable is present

BUILDAH

Extends DOCKER

Use buildah @see

Packager

$3

* properties

$3

What is the package name in the package eco-system.

#### Parameters

* name string

Returns string package name in the target eco-system

$3

Generate hook content entries

Returns AsyncIterable\

$3

Forms an expression string form name and expression.
If tere is no valid exression name only is delivered.

#### Parameters

* name string
* expression (string | boolean | undefined)

Returns string

$3

Create tmp directory.

Returns Promise<string> directory path

$3

Prepares artifact generation.

#### Parameters

* options Object

* options.staging string?
* options.destination string?
* publishingDetail Object?

Returns Promise<{properties: Object, destination: string, tmpdir: string, staging: string}>

$3

Execute package generation.

#### Parameters

* sources Object
* transformer Array<Object>
* publishingDetails Array<PublishingDetail>
* options Object
* expander function (string): string?

Returns Promise<string> identifier of the resulting package

$3

Returns {named: object, others: Array<string>}

$3

#### Parameters

* options Object
* variant Object

Returns Promise<boolean>

Packager

Base Packager

$3

* properties Object

$3

What is the package name in the package eco-system.

#### Parameters

* name string

Returns string package name in the target eco-system

$3

Generate hook content entries

Returns AsyncIterable\

$3

Forms an expression string form name and expression.
If tere is no valid exression name only is delivered.

#### Parameters

* name string
* expression (string | boolean | undefined)

Returns string

$3

Create tmp directory.

Returns Promise<string> directory path

$3

Prepares artifact generation.

#### Parameters

* options Object

* options.staging string?
* options.destination string?
* publishingDetail Object?

Returns Promise<{properties: Object, destination: string, tmpdir: string, staging: string}>

$3

Execute package generation.

#### Parameters

* sources Object
* transformer Array<Object>
* publishingDetails Array<PublishingDetail>
* options Object
* expander function (string): string?

Returns Promise<string> identifier of the resulting package

$3

Returns {named: object, others: Array<string>}

$3

#### Parameters

* options Object
* variant Object

Returns Promise<boolean>

Field

Type: Object

$3

* alias string interchangeable field name
* type string
* default any
* mandatory boolean

deleteKey

$3

* object object
* key string

copyNodeModules

$3

* source string
* dest string
* options Object (optional, default defaultOptions)

PublishingDetail

Type: Object

$3

* url string
* properties Object
* scheme string
* username string?
* password string?

createPublishingDetails

$3

* locations Array<string> (optional, default [])
* properties Object?

* properties.PKGBUILD_PUBLISH string?
* properties.arch string?
* properties.access string?
* properties.type string?
* properties.username string?

Returns Array<PublishingDetail>

publish

$3

* artifactIdentifier string
* publishingDetail PublishingDetail?
* properties Object?
* logger function (any): void (optional, default console.log)

utf8StreamOptions

Type: BufferEncoding

decodePassword

Decode a password

$3

* password string

Returns string plaintext password

FunctionDecl

Type: Object

$3

* name string
* body string

extractFunctions

Extract shell functions from a given text.

$3

* source AsyncIterable<string>

Returns AsyncIterable<FunctionDecl>

fieldProvider

$3

* properties Object
* attributes Object

Returns Function

Expander

Type: Function

$3

* path string

Returns string

copyEntries

Copy content from source into destinationDirectory.
Destination paths a generated without leading '/' (as for entry names too).

$3

* source AsyncIterable\
* destinationDirectory string
* expander Expander (optional, default v=>v)

install

With npm do:

`shell
npm install npm-pkgbuild
``

license

BSD-2-Clause