如何在 package-scripts.js 中注释以显示在 package.json 中？

Question

Goal

I want to display comments of my nps commands from package-scripts.js in my package.json like this:

Tried

I actually don't know where the content of this overlay ("Run by the 'npm test' command") is coming from (vscode, npm, nps?). I've looked up all of their GitHub repositories without success.

I've tried to add comments the following way with no results:

// package-scripts.js  
module.exports = {
  scripts: {
    /** Build image */
    build: "docker build"
  }
}

// package.json
{
  scripts: {
    "build": "nps build"
  }
}

Is it possible at all? How is the shown comment made?

Answer 1

This seems to work with:

• json schemas in your vscode settings or
• switching to jsonc mode in vscode

Both are documented here: https://code.visualstudio.com/docs/languages/json .

I suggest to extend the package.json schema https://json.schemastore.org/package to fit your needs, but i don't have any experience with displaying comments as tooltips in vscode.