Bug#999497: [Pkg-javascript-devel] Bug#999497: lintian: complain about packages with parts of npm2deb FIX_ME or templates still present

[Jonas Smedegaard]

Quoting Paul Wise (2021-11-12 02:08:26)
> PS: I wonder if there should be a standard prefix for all template
> strings that all packaging tools could use in their templates or
> template strings and then lintian could just check for that prefix.

I fully agree.  I propose to use "FIXME" (i.e. no underscore).  I find 
that to be the more common hint (e.g. is implemented in several tools 
already (except for Rust crates where "FIX_ME" seems more common - 
perhaps that site searches for "FIX" and "ME" as separate words?).

 * https://metacpan.org/search?size=500=FIXME - 169 hits
 * https://metacpan.org/search?size=500=FIX_ME - 0 hits
 * https://www.npmjs.com/search?q=FIXME - 79 hits
 * https://www.npmjs.com/search?q=FIX_ME - 0 hits
 * https://crates.io/search?q=FIXME - 27 hits
 * https://crates.io/search?q=FIX_ME - 2533 hits

On a related note, I find it troublesome that some tools hide the FIXMEs 
placed by other tools - e.g. cme stripping licensecheck FIXMEs :-(

 - Jonas

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

 [x] quote me freely  [ ] ask before reusing  [ ] keep private

signature.asc
Description: signature

Bug#999497: lintian: complain about packages with parts of npm2deb FIX_ME or templates still present

[Paul Wise]

Package: lintian
Version: 2.111.0
Severity: wishlist
X-Debbugs-CC: npm2...@packages.debian.org

npm2deb converts node/npm packages to Debian source packages, in the
process it leaves FIX_ME items and template info in various places in
the Debian source package for the maintainer to clean up before upload.
Sometimes these FIX_ME items even get past the NEW queue (for example
node-winston). I looked at the npm2deb source code and found several
strings that need to be checked for. There may be some more strings
that I missed though. Note that the description_template string could
contain an upstream_description string, so you will need to check for
the prefix and suffix instead of the whole string.

PS: I wonder if there should be a standard prefix for all template
strings that all packaging tools could use in their templates or
template strings and then lintian could just check for that prefix.

https://wiki.debian.org/AutomaticPackagingTools

npm2deb/__init__.py:

self.debian_license = "FIX_ME debian license"
self.debian_author = 'FIX_ME debian author'
args['Description'] = 'FIX_ME write the Debian package description'
self.upstream_license = "FIX_ME upstream license"
self.upstream_version = 'FIX_ME version'
self.upstream_description = 'FIX_ME no upstream package description'
result = 'FIX_ME upstream author'
result = 'FIX_ME repo url'

npm2deb/templates.py:

   description_template = """ Write the short and long descriptions for the 
Debian package as
explained in the Developer's Reference, §6.2.1 – §6.2.3.
.
You can start with the short upstream package description,
“%(upstream_description)s”.
.
Be aware that most upstream package descriptions are not written to
conform with Debian package guidelines. You need to explain the role
of this package for a Debian audience.
.
Node.js is an event-based server-side JavaScript engine.
   """

-- 
bye,
pabs

https://wiki.debian.org/PaulWise


signature.asc
Description: This is a digitally signed message part