npmpackage.info

Gathering detailed insights and metrics for npm-pkgbuild

Other packages similar to npm-pkgbuild

mf-hosting-frontend

3.9.4

hosting definitions of frontend projects @MF

mf-hosting-cloudflare

1.0.8

hosting definitions for cloudflare @MF

mf-hosting

2.8.14

hosting definitions @MF

ts-pkgbuild

1.1.9

快速的打包一个 typescript 的 npm 包

Gathering detailed insights and metrics for npm-pkgbuild

npm-pkgbuild - 18.2.12 | npmpackage.info

npm-pkgbuild

create arch, rpm and debian packages from npm

18.2.12

0BSD

JavaScript

131.94 kB

5.3

Installations

npm install npm-pkgbuild

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

>=22.16.0

Node Version

24.2.0

NPM Version

10.9.2 Pull Requests

Open

2

Total

2,487

Closed

169

Merged

2,316

Issues

Open

2

Total

32

Closed

30

Releases

938

v18.2.12

Updated on Jun 23, 2025

v18.2.11

Updated on Jun 12, 2025

v18.2.10

Updated on May 31, 2025

v18.2.9

Updated on May 28, 2025

v18.2.8

Updated on May 23, 2025

v18.2.7

Updated on May 22, 2025

View All 938 releases

Languages

JavaScript

JavaScript (100%)

Developer

arlac77

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

0BSD License

10 Stars

3,760 Commits

4 Forks

3 Watchers

3 Branches

3 Contributors

Updated on Jul 10, 2025

Maintainers

View All 3 Contributors

Package Meta Information

Latest Version

18.2.12

Package Id

npm-pkgbuild@18.2.12

Unpacked Size

131.94 kB

Size

30.82 kB

File Count

NPM Version

10.9.2

Node Version

24.2.0

Published on

Jun 23, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

npm-pkgbuild

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

usage

In a package directory execute

1npm-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

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

You can specify the package content in package.json.

1{
2  "pkgbuild": {
3    "content": {
4      "/some/location/" : { "base": "build" },
5      "/etc/myconfig.json" : "sample-config.json",
6      "/erc/secret" : { "name":  "secret", "mode": "600" },
7      "/opt/myapp": [
8        {
9          "type": "npm-pack"
10        },
11        {
12          "type": "node-modules",
13          "withoutDevelpmentDependencies": true
14        }
15      ]
16    },
17    "hooks" : "pkg/hooks",
18    "output": {
19      "debian" : {},
20      "rpm" : {},
21      "arch" : {}
22    },
23  "dependencies": { "nginx" : ">=1.12" }
24  }
25}

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

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
- prepare
  - Parameters
fields
fields
fields
fields
pkgKeyValuePairOptions
quoteFile
- Parameters
RPM
- hookMapping
- prepare
  - Parameters
OCI
DOCKER
- prepare
  - Parameters
BUILDAH
Packager
- Parameters
- packageName
  - Parameters
- tmpdir
- prepare
  - Parameters
- create
  - Parameters
- workspaceLayout
- prepare
  - Parameters
Packager
- Parameters
- packageName
  - Parameters
- tmpdir
- prepare
  - Parameters
- create
  - Parameters
- workspaceLayout
- prepare
  - Parameters
Field
- Properties
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 https://nodejs.org/dist/latest-v18.x/docs/api/process.html#processargv}

content2Sources

Delivers ContentProviders from pkgbuild.content definition.

Parameters

content Object from pkgbuild.content
dir

Returns Iterable<ContentProvider>

PackageDefinition

Type: Object

Properties

properties Object values describing the package attributes
- properties.dependencies 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

Parameters

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.

Parameters

definitions Object
entryProperties Object to be set for each entry
directoryProperties

Properties

dir string

name

Returns string name of the content provider

NodeModulesContentProvider

Extends ContentProvider

Content from node_modules. Requires .npmrc or NPM_TOKEN environment

Parameters

definitions
entryProperties
directoryProperties

Properties

withoutDevelpmentDependencies boolean

asyncIterator

List all entries.

Returns AsyncIterable<(ContentEntry | CollectionEntry)> all entries

name

Returns string name of the content provider

FileContentProvider

Extends ContentProvider

Content provided form the file system.

Parameters

definitions (Object | string)
- definitions.pattern (string | Array<string>)
- definitions.base string base directory where to find the files
entryProperties
directoryProperties

asyncIterator

Returns AsyncIterable<(ContentEntry | CollectionEntry)> all entries

name

Returns string name of the content provider

NFTContentProvider

Extends ContentProvider

Content provided form the file system.

Parameters

definitions (Object | string)
- definitions.pattern (string | Array<string>)
- definitions.base string base directory where to find the files
entryProperties
directoryProperties

asyncIterator

Returns AsyncIterable<ContentEntry> all entries

name

Returns string name of the content provider

ContentProvider

Source of package content.

Parameters

definitions
entryProperties
directoryProperties

Properties

dir string
transformer Array<Transformer>

asyncIterator

List all entries.

Returns AsyncIterable<(ContentEntry | CollectionEntry)> all entries

DEBIAN

Extends Packager

Create .deb packages

hookMapping

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

prepare

Parameters

options Object
variant Object
- variant.arch string

Returns Promise<boolean>

fields

See: https://www.debian.org/doc/debian-policy/ch-controlfields.html
See: https://linux.die.net/man/5/deb-control

fields

well known package properties https://www.archlinux.org/pacman/PKGBUILD.5.html

fields

See: https://rpm-packaging-guide.github.io

fields

See: https://docs.docker.com/engine/reference/builder/

pkgKeyValuePairOptions

Type: Object

quoteFile

Parameters

name

RPM

Extends Packager

Produce rpm packages.

hookMapping

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

prepare

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

prepare

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 https://buildah.io

Packager

Parameters

properties

packageName

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

Parameters

name string

Returns string package name in the target eco-system

tmpdir

Create tmp directory.

Returns Promise<string> directory path

prepare

Prepares artifact generation.

Parameters

options Object
publishingDetail Object?

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

create

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

workspaceLayout

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

prepare

Parameters

options Object
variant Object

Returns Promise<boolean>

Packager

Base Packager

Parameters

properties Object

packageName

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

Parameters

name string

Returns string package name in the target eco-system

tmpdir

Create tmp directory.

Returns Promise<string> directory path

prepare

Prepares artifact generation.

Parameters

options Object
publishingDetail Object?

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

create

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

workspaceLayout

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

prepare

Parameters

options Object
variant Object

Returns Promise<boolean>

Field

Type: Object

Properties

alias string interchangeable field name
type string
default any
mandatory boolean

copyNodeModules

Parameters

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

PublishingDetail

Type: Object

Properties

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

createPublishingDetails

Parameters

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

Parameters

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

utf8StreamOptions

Type: BufferEncoding

decodePassword

Decode a password

Parameters

password string

Returns string plaintext password

FunctionDecl

Type: Object

Properties

name string
body string

extractFunctions

Extract shell functions from a given text.

Parameters

source AsyncIterable<string>

Returns AsyncIterable<FunctionDecl>

fieldProvider

Parameters

properties Object
fields Object

Returns Function

Expander

Type: Function

Parameters

path string

Returns string

copyEntries

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

Parameters

source AsyncIterable<ContentEntry>
destinationDirectory string
expander Expander (optional, default v=>v)

install

With npm do:

1npm install npm-pkgbuild

license

BSD-2-Clause

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

9

SAST

Determines if the project uses static code analysis.

9

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/auto_approve.yml:7: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/auto_approve.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:88: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql_analysis.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/codeql_analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql_analysis.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/codeql_analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql_analysis.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/codeql_analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql_analysis.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/codeql_analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr_labeler.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/pr_labeler.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update_package_lock.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/update_package_lock.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update_package_lock.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/update_package_lock.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update_package_lock.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/update_package_lock.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update_readme_api.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/update_readme_api.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update_readme_api.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/update_readme_api.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update_readme_api.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/arlac77/npm-pkgbuild/update_readme_api.yml/master?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/update_package_lock.yml:30
Info: 0 out of 13 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 5 third-party GitHubAction dependencies pinned
Info: 5 out of 6 npmCommand dependencies pinned

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

5.3

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to npm-pkgbuild

Other packages similar to npm-pkgbuild

npm-pkgbuild

Installations

Developer Guide

Yes

ESM

>=22.16.0

24.2.0

10.9.2

Pull Requests

2

2,487

169

2,316

Issues

2

32

30

Releases

Languages

Developer

arlac77

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

npm-pkgbuild

usage

upload package

content providers

files (default)

npm-pack

node-modules

shared configuration

API

Table of Contents

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

prepare

Parameters

fields

fields