pkgjs-utils(1p)

pkgjs-utils1p

Nodejs package utilities

Usage

  $ cd node-glob
  $ pkgjs-utils main
    # prints: glob
  $ pkgjs-main
    # alias for pkgjs-utils main
  $ pkgjs-utils components_list
    # prints:
    #  globalyzer
    #  globrex
    #  tiny-glob
    #  types-glob
  $ pkgjs-utils modules_list
    # prints:
    #  globalyzer
    #  globrex
    #  tiny-glob
    #  @types/glob
  $ pkgjs-utils pjson .
    # prints: { <package.json content, serialized> }
  $ pkgjs-pjson .
    # alias for pkgjs-utils pjson .
  $ cd ../node-jest
  $ pkgjs-pjson packages/jest-diff
    # prints: { <packages/jest-diff/package.json content, serialized> }
  $ pkgjs-pjson packages/jest-diff version
    # prints: 27.2.5
  $ pkgjs-utils pjson . scripts test
    # prints: jest
  $ pkgjs-utils pjson packages/jest-diff scripts test
  $ pkgjs-utils ln webpack
    # prints: 'webpack linked into node_modules
  $ pkgjs-utils ln @types/node
    # prints: '@types/node' linked into node_modules
  $ pkgjs-ln @types/node
    # same as pkgjs-utils ln @types/node
  $ pkgjs-utils normalize_name @types/node
    # prints: types-node
  $ pkgjs-utils root_components_list (only components installed in nodejs dir)
  $ pkgjs-utils root_modules_list (same with module names)
  $ pkgjs-utils ordered_components_list (components in build order)

Overview

Collection of little commands to read <component>/package.json overridden by debian/nodejs/<component>/* files.

Available commands

link_test_modules

Link modules that are in the debian/tests/test_modules directory into "node_modules".

link_external_modules

Link Debian modules listed into debian/nodejs/extlinks into "node_modules" and copy modules listed into debian/nodejs/extcopies into "node_modules".

link_internal_modules

In multi-modules package (with uscan components and/or lerna/workspace), link these modules into "node_modules", except the "main" module.

link_build_modules

Link modules that are in the debian/build_modules directory into "node_modules".

clean_test_modules

Drop links created by link_test_modules.

clean_external_modules

Drop links/copies created by link_external_modules.

clean_internal_modules

Drop links created by link_internal_modules.

clean_build_modules

Drop links created by link_build_modules.

ln

Link the given Debian module into "node_modules".

If "-t" option is set, try to link the corresponding typescript declarations. For example:

    $ pkgjs-ln -t glob; pkgjs-ln -t abab

creates "node_modules/@types/glob" and "node_modules/abab".

components_list

Print the list of components (directories) without the "main" module.

modules_list

Print the NPM names of components without the "main" module.

pjson

Reads the package.json or package.yaml of the given directory. If no arguments are given, it prints the serialized JSON content. If arguments are given, it tries to follow keys. For example:

    $ pkgjs-pjson packages/foo scripts run

write the content of the subkey "run" of the key "scripts".

main

Print the NPM name of the "main" module.

packages_list

Print the list of binary packages from "debian/control".

normalize_name

Convert a NPM module name into a Debian compatible name. Examples:

    $ pkgjs-utils normalize_name @types/glob
    type-glob
    $ pkgjs-utils normalize_name @types/babel__type
    types-babel-type
    $ pkgjs-utils normalize_name require_optional
    require-optional
-h --help
-v --version

Releases

2 releases since Debian 12 (Bookworm); the text changed 1 time.

  1. 12
  2. 13

Author

Yadd <[email protected]>

From dh-nodejs 0.15.23 in Debian 13 (Trixie). Parsed by carta from the page's man source.