[Pkg-javascript-devel] add-node-component new option

Yadd yadd at debian.org
Tue Feb 8 17:54:23 GMT 2022


On 08/02/2022 18:42, Jonas Smedegaard wrote:
> Quoting Yadd (2022-02-08 18:05:22)
>> Description: collection of tools to aid packaging Node modules in Debian
> 
> I suggest to use the official name: Node.js
> 
> https://nodejs.org/ and https://en.wikipedia.org/wiki/Node.js agree that
> the technology for which the modules belong is called "Node.js".
> 
> 
>>    The Debian JavaScript Group works on packaging JavaScript libraries for
>>    Debian.
> 
> I suggest to use the official name: Debian JavaScript Maintainers
> 
> https://wiki.debian.org/Javascript/ and https://salsa.debian.org/js-team
> agree that the team is called "Debian JavaScript Maintainers"
> 
> 
>>    This collection contains tools which help the group with
>>    day-to-day work.
> 
> With name changed to "...Maintainers" I suggest to use the (in Debian)
> more commonly used term "team" (rather than "group") to casually refer
> to us.
> 
> 
>>    It provide debhelper files (set dh-sequence-nodejs into build
>>    dependencies) to automatically:
> 
> s/provide/provides/
> 
> 
>>     * link or copy needed modules into node_modules/ directory
>>     * automatically build package and components when build system is
>>       recognized
>>     * launch test
>>     * choose files to install
>>     * build "Provides" value for package with components
>>     * build pkgjs-lock.json and "X-Javascript-Built-Using" value files for
>>       packages built with webpack/browserify
>>     * clean all its stuff during dh_auto_clean step
>>    .
>>    and some utilities:
>>     * add-node-component: manage uscan components
>>     * github-debian-upstream: creates debian/upstream/metadata for GitHub
>>                               source
> 
> The above will look like this in a smaller window:
> 
>   * github-debian-upstream: creates
>     debian/upstream/metadata for GitHub
>                             source
> 
> I doubt that is what you want.
> 
> I recommend to *not* try to align indentation to anything fancy, only to
> bullet-point - like this:
> 
>   * github-debian-upstream: creates debian/upstream/metadata for GitHub
>     source
> 
> Or if you want something arguably fancy then what I do is use semantic
> newlines - like this:
> 
>   * github-debian-upstream:
>     creates debian/upstream/metadata for GitHub source
> 
> Imn fact I would wrap _all_ bullet points after the colon, since
> commonly the trailing part is long, so only few of them fits on same
> line, and it does not hurt to wrap consistently.
> 
> Even better would be to shorten both command names and descriptions so
> that they command name and description could fit on a single line for
> each command.  But I guess that would be a too invasive change.
> 
> Heh - Semantic newlines even have a website nowadays: https://sembr.org/
> 
> 
>>     * debcheck-node-repo: compares vcs repo registered in npm registry
>>                           with the source repo declared in debian/watch
>>     * dh-make-node: build debian/ directory in a source repository of a
>>                     node module
>>     * pkgjs-audit: a "npm audit" that uses Debian dependencies
>>     * pkgjs-depends: find needed dependencies for a node module
>>     * pkgjs-ln: link a Debian dependency into node_modules/
>>     * pkgjs-ls: a "npm ls" that search also in Debian directories
>>     * pkgjs-utils: various little utilities
>>    .
>>    and also:
>>     * a salsa(1) configuration file for JS Team
>>     * "pkg-js-extra" profile for lintian
> 
> Better reuse "Debian JavaScript Maintainers" (not introduce yet another
> name "JS Team").
> 
> 
>   - Jonas

Thanks a lot! All issues fixed now.

Cheers,
Yadd
-------------- next part --------------
Source: pkg-js-tools
Maintainer: Debian Javascript Maintainers <pkg-javascript-devel at lists.alioth.debian.org>
Uploaders: Yadd <yadd at debian.org>
Section: devel
Testsuite: autopkgtest-pkg-perl
Priority: optional
Build-Depends: debhelper-compat (= 13)
Build-Depends-Indep: devscripts
 , git <!nocheck>
 , help2man
 , libdebian-copyright-perl <!nocheck>
 , libdebian-source-perl <!nocheck>
 , libipc-run-perl <!nocheck>
 , libjson-perl <!nocheck>
 , libregexp-assemble-perl <!nocheck>
 , libtest-output-perl <!nocheck>
 , libyaml-perl <!nocheck>
 , nodejs:any | nodejs (<<12.22.5~dfsg-4~) <!nocheck>
 , node-types-node <!nocheck>
 , perl
Standards-Version: 4.6.0
Vcs-Browser: https://salsa.debian.org/js-team/pkg-js-tools
Vcs-Git: https://salsa.debian.org/js-team/pkg-js-tools.git
Homepage: https://salsa.debian.org/js-team/pkg-js-tools
Rules-Requires-Root: no

Package: pkg-js-tools
Architecture: all
Depends: ${misc:Depends}
 , ${perl:Depends}
 , debhelper
 , libdebian-copyright-perl
 , libdebian-source-perl
 , libipc-run-perl
 , libjson-perl
 , libyaml-perl
 , nodejs:any | nodejs (<<12.22.5~dfsg-4~)
Recommends: devscripts
 , libdpkg-perl
Suggests: autodep8
 , autopkgtest
 , git-buildpackage
 , libconfig-inifiles-perl
 , libconfig-model-dpkg-perl
 , libconfig-model-perl
 , lintian (>= 2.58.0~)
 , node-semver
 , npm
Provides: dh-sequence-nodejs (= ${binary:Version})
Multi-Arch: foreign
Breaks: nodejs-dev (<<10.15.0~dfsg-10)
Description: collection of tools to aid packaging Node.js modules in Debian
 The Debian JavaScript Maintainers work on packaging JavaScript libraries
 for Debian. This collection contains tools which help the tam with
 day-to-day work.
 .
 It provides debhelper files (set dh-sequence-nodejs into build
 dependencies) to automatically:
  * link or copy needed modules into node_modules/ directory
  * automatically build package and components when build system is
    recognized
  * launch test
  * choose files to install
  * build "Provides" value for package with components
  * build pkgjs-lock.json files and "X-Javascript-Built-Using" value for
    packages built with webpack/browserify
  * clean all its stuff during dh_auto_clean step
 .
 and some utilities:
  * add-node-component:
    manage uscan components
  * debcheck-node-repo:
    compares vcs repo registered in npm registry with the source repo
    declared in debian/watch
  * dh-make-node:
    build debian/ directory in a source repository of a Node.js module
  * github-debian-upstream:
    creates debian/upstream/metadata for GitHub source
  * nodepath:
    show the path and/or the package of a Node.js module
  * pkgjs-audit:
    a "npm audit" that uses Debian dependencies
  * pkgjs-depends:
    find needed dependencies for a Node.js module
  * pkgjs-ln:
    link a Debian dependency into node_modules/
  * pkgjs-ls:
    a "npm ls" that search also in Debian directories
  * pkgjs-utils:
    various little utilities
 .
 and also:
  * a salsa(1) configuration file for Debian JavaScript Maintainers
  * "pkg-js-extra" profile for lintian

Package: pkg-js-autopkgtest
Architecture: all
Multi-Arch: foreign
Depends: ${misc:Depends}
 , libjson-perl
 , pkg-js-tools (= ${binary:Version})
Description: collection of autopkgtest scripts for Node.js packages
 This package contains test runners to be used with the autopkgtest
 infrastructure for Node.js packages.
 .
 Simply set "Testsuite: autopkgtest-pkg-nodejs" in debian/control to use it.
 .
 See /usr/share/doc/pkg-js-autopkgtest/README.md
 for information on the tests and how to tweak them.


More information about the Pkg-javascript-devel mailing list