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

[Jonas Smedegaard]

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

-- 
 * Jonas Smedegaard - idealist & Internet-arkitekt
 * Tlf.: +45 40843136  Website: http://dr.jones.dk/

 [x] quote me freely  [ ] ask before reusing  [ ] keep private
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: signature
URL: <http://alioth-lists.debian.net/pipermail/pkg-javascript-devel/attachments/20220208/306a1041/attachment.sig>