Next steps on Support levels in Package.json

[mhdawson]

• Make sure we follow our own guidelines in publishing of tool
• Get input from 2 of the 'friendly' module owners
• Update or replace tool in pkgs repo to support agreed structure
• Minimal command in support tool to to show support info for package dependencies
• Add support info to modules within the Node.js org.
• Evangelise and get additional input
  • Blog outlining the support levels and how to use tool to validate
• Final review and promote to 'docs' from drafts
• blog on adding tool to your CI
• PRs to modules to add in information
• tool to scan dependencies and provide more comprehensive report on support information
• facilitate/document how to put badges with support info elements on your package readme.
• submit feedback top in npm/feedback repo suggesting that support information be shown on the npm page.

[Eomm]

Make sure we follow our own guidelines in publishing of tool

I'll try to do a checklist to check that all is in place.

blog on adding tool to your CI
tool to scan dependencies and report on support information

A new feature for the cli tool!
Starting from the idea of @ljharb, there are some tools like license-checker --production --onlyAllow='MIT;ISC;BSD-3-Clause;BSD-2-Clause'
or licensee that can be integrated in a script in the package.json and run when necessary by CI
in order to check that the dependencies don't change license (or support level for our case).

PRs to modules to add in information

Big like!

move the tool over to the node repo?

I agree, so working on it will be more productive.
Can I proceed? @mhdawson I think we need to sync from for permissions and/or timings

create url on website that generates svg for readme that reports your level and has link to the pages which describe the levels.

The website could to do:

• a page to create the code snippet for the badge gettin a npm-module as input (so it will check the existing package.json)
• a page to list the support attributes of the direct dependencies of the module

Example built with https://shields.io/

![support backing](https://img.shields.io/badge/support%20backing-HOBBY-blue.svg)
![support target](https://img.shields.io/badge/support%20target-ABANDONED-red.svg)
![support response-def](https://img.shields.io/badge/support%20response--ref-REGULAR--7-yellow.svg)

Talk to package phobia to see if you would information from the new fields. Icon with link to our site that scan dependencies.

After build the site should be easy to add a link to that site if the maintainer agree with our intents.

[ghinks]

Just had a look at the tool, great job @Eomm. Has someone contacted the package phobia folks if not I can.

[Eomm]

Make sure we follow our own guidelines in publishing of tool

These are the steps accomplish by the tool:

• Version (v1.0.0)
• License (MIT)
• Support level in package.json (added)
• Publish (.npmignore)
• Testing (tap + coveralls)
• CI (travis win+linux LTS)
• Deprecated

Has someone contacted the package phobia folks

Nope

[ghinks]

I have just raised an issue with the package phobia team asking for a contact name for the package maintenance team.

[ghinks]

ok, I have a response from the package phobia team. Steven Styfle is our contact. I want to be more precise with our ask. Could I get some clarity on the request we want from the package phobia team. Are we asking them to display badges that represent our package support levels? @Eomm ?

eg

[Eomm]

My idea is that, after we build a site as listed in this issue, we could add an icon in that site that link directly to us:

Example

[ghinks]

understood.
:)

[ghinks]

@Eomm please feel free to enter the conversation with Steven at package phobia at issue 308 on the phobia github repo.

[Eomm]

Regarding this bullet point:

move the tool over to the node repo?

there is this PR nodejs/admin#343

[Eomm]

Regarding:

create url on website that generates svg for readme that reports your level and has link
to the pages which describe the levels.

I made this poc:
https://package-badge.herokuapp.com/ repo

I will list the badges we should provide 👍

[styfle]

Perhaps you could utilize https://badgen.net if you want to create badges.

[Eomm]

Yeah, the target is like that site: from a package's name get the package.jscon, read the new support tag and build the badges!

The badge is only a "nice to have" in order to build the really useful stuff:

• check the supports levels of your package + dependencies
• spread the knowledge of this initiative (a new green badge in the readme is great 😃)

[Eomm]

Updated the poc (IDK why the badges are always grenn..)

• valid: https://package-badge.herokuapp.com/backing/package-compliant
• doesn't have support: https://package-badge.herokuapp.com/backing/fastify
• doesn't have support + scoped module: https://package-badge.herokuapp.com/backing/@sindresorhus/df

@nodejs/package-maintenance someone could help me to build a draft gui?
I think that is necessary:

• one page as a description of this WG + link to this repo
• one static page that generates a markdown snipper with the url as above
• one page that shows the support tag status for all the dependencies (this API is missing right now)

Here the repo: https://github.com/Eomm/package-badge/tree/poc

[TheHollidayInn]

I gave it a shot: Eomm/package-badge#1. Feel free to disregard if I'm way off :P

[mhdawson]

With travel I'll probably only get to moving the repo after JSConfEU.

On another note I got some good feedback that end users would find this useful as part of a presentation at the PowerUP19 conference this week.

[Eomm]

move the tool over to the node repo?

Done: https://github.com/nodejs/package-compliant

Invited nodejs-foundation to npm also

Now we should update it when we will define the new file format of the support file

[mhdawson]

@Eomm, thanks !

[mhdawson]

List of modules to get support info into #413

[mhdawson]

I'll start with node-addon-api