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

问题描述 投票:0回答:2

目标

我想在我的

package-scripts.js
中显示来自
package.json
的nps命令的注释,如下所示:
desired comment in package.json

试过

我实际上不知道这个覆盖层的内容(“通过‘npm test’命令运行”)来自哪里(vscode、npm、nps?)。我查过了他们所有的 GitHub 存储库,但没有成功。

我尝试通过以下方式添加评论,但没有结果:

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

有可能吗?显示的评论是如何做出的?

npm package.json jsdoc npm-scripts
2个回答
0
投票

这似乎适用于:

  • vscode 设置中的 json 架构或
  • 在 vscode 中切换到 jsonc 模式

两者均记录于此:https://code.visualstudio.com/docs/languages/json

我建议扩展 package.json 架构 https://json.schemastore.org/package 以满足您的需求,但我没有任何在 vscode 中将注释显示为工具提示的经验。


0
投票

我创建了这个 VS Code 扩展,当您将鼠标悬停在包脚本上时,它会显示注释。如果您能尝试一下并提供反馈,我将不胜感激。谢谢你。

https://marketplace.visualstudio.com/items?itemName=yingmin.package-scripts-hover

© www.soinside.com 2019 - 2024. All rights reserved.