在发布脚本之前,我在package.json下有许多脚本来编译coffeescript,typescript和仅供开发人员使用的命令-一旦发布,就没有任何意义。
我想知道在package.json下是否有删除某些脚本的过程?考虑到发布包时,它还会发布package.json。
在发布包之前是否可以删除脚本?
发布脚本后,我会删除很多打字稿和coffeescript源文件(因为它们已经被编译),所以我没有构建的脚本对于已发布的软件包毫无意义。
这可行吗?还是我应该考虑另一种方式?
最佳答案
简短的答案。
“在发布程序包之前,是否可以删除脚本?”
npm不包含从package.json
删除脚本的内置功能。
解决方案的长答案。
“这可行吗?还是我应该考虑另一种方式?”
有一些称为Pre and Post hooks的内置功能,尽管可以以相当自定义的方式使用,但可以满足您的要求。相关的钩子是prepublish
和postpublish
,并在documentation中进行了如下描述;
prepublish:在打包和发布程序包之前,以及在本地npm install
上,不带任何参数的情况下运行...
发布后:在发布包后运行。
解决方案的概要是:
在项目prepublish
中使用package.json
脚本来调用自定义nodejs脚本。该nodejs脚本执行以下操作:
读取原始的package.json
数据并将其缓存。
从scripts
的package.json
部分删除特定的脚本/键。
将修改后的数据写回到原始的package.json
。
在项目postpublish
中使用package.json
脚本来调用另一个自定义的nodejs脚本。该辅助nodejs脚本执行以下操作:
将package.json
的内容恢复为原始状态。
代码示例/要点。
以下nodejs脚本将执行上面第一点中提到的任务。我们将其命名为cleanse-pkg.js
。
cleanse-pkg.js
const fs = require('fs');
const path = require('path');
// Define absolute paths for original pkg and temporary pkg.
const ORIG_PKG_PATH = path.resolve(__dirname, '../package.json');
const CACHED_PKG_PATH = path.resolve(__dirname, '../../cached-package.json');
// Obtain original `package.json` contents.
const pkgData = require(ORIG_PKG_PATH);
if (process.argv.length <= 2) {
throw new Error('Missing npm scripts key/name argument(s)');
}
// Get list of arguments passed to script.
const scriptsToRemove = process.argv[2].split(',');
const devDepsToRemove = process.argv[3] ? process.argv[3].split(',') : [];
// Write/cache the original `package.json` data to `cached-package.json` file.
fs.writeFile(CACHED_PKG_PATH, JSON.stringify(pkgData), function (err) {
if (err) throw err;
});
// Remove the specified named scripts from the scripts section.
scriptsToRemove.forEach(function (scriptName) {
delete pkgData.scripts[scriptName];
});
// Remove the specified named pkgs from the devDependencies section.
devDepsToRemove.forEach(function (pkgName) {
delete pkgData.devDependencies[pkgName];
});
// Overwrite original `package.json` with new data (i.e. minus the specific data).
fs.writeFile(ORIG_PKG_PATH, JSON.stringify(pkgData, null, 2), function (err) {
if (err) throw err;
});
以下辅助nodejs脚本将执行上面第二点提到的任务。我们将此命名为
restore-pkg.js
。restore-pkg.js
const fs = require('fs');
const path = require('path');
// Define absolute paths for original pkg and temporary pkg.
const ORIG_PKG_PATH = path.resolve(__dirname, '../package.json');
const CACHED_PKG_PATH = path.resolve(__dirname, '../../cached-package.json');
// Obtain original/cached contents from `cached-package.json`.
const pkgData = JSON.stringify(require(CACHED_PKG_PATH), null, 2) + '\n';
// Write data from `cached-package.json` back to original `package.json`.
fs.writeFile(ORIG_PKG_PATH, pkgData, function (err) {
if (err) throw err;
});
// Delete the temporary `cached-package.json` file.
fs.unlink(CACHED_PKG_PATH, function (err) {
if (err) throw err;
});
实施和使用。
prepublish
和postpublish
脚本在项目package.json
中定义如下:人为设计的原始package.json
{
...
"scripts": {
"keep": ... ,
"a": ... ,
"b": ... ,
"prepublish": "node .scripts/cleanse-pkg \"a,b,prepublish,postpublish\"",
"postpublish": "node .scripts/restore-pkg"
},
...
}
注意
\"a,b,prepublish,postpublish\"
脚本中的prepublish
部分。这定义了传递给cleanse-pkg.js
的参数(即,它列出了发布前要删除的每个脚本的名称)。每个要删除的命名脚本都必须是;以单个字符串形式提供,用逗号分隔,并且不能包含空格。cleanse-pkg.js
和restore-pkg.js
都位于名为.scripts
的隐藏文件夹中,该文件夹本身位于项目目录的顶层(即与项目package.json
处于同一级别)。可以根据需要将两个nodejs脚本重新定位,并在相应的npm-script中根据需要重新定义它们的路径。鉴于上面的人为设计的
package.json
,最终发布的tarball中的实际package.json
内容如下:结果/已发布的package.json
{
...
"scripts": {
"keep": ...
},
...
}
devDependencies部分中的软件包。
也许项目
devDependencies
的package.json
部分中列出了一些软件包,您也希望将它们从已发布的package.json
中删除。(注意:但是,当用户通过npm-registry安装时,不会下载devDependencies部分中列出的所有软件包)。
但是,也许您还是想删除它们。如果这是必需的,则
cleanse-pkg.js
还接受可选的第二个参数。此参数类似于第一个参数,其中每个要从devDependencies
节中删除的命名包都必须是;以单个字符串形式提供,用逗号分隔,并且不能包含空格。假设这次的原始
package.json
如下所示:人为设计的原始package.json
{
...
"scripts": {
"keep": ... ,
"a": ... ,
"b": ... ,
"prepublish": "node .scripts/cleanse-pkg \"a,b,prepublish,postpublish\" \"x,z\"",
"postpublish": "node .scripts/restore-pkg"
},
"devDependencies": {
"x": "^1.0.2",
"y": "^0.8.1",
"z": "^0.8.1"
},
...
}
请注意,在
\"x,z\"
脚本中添加了第二个prepublish
自变量,以指定要从devDependecies
节中忽略的软件包。这次,考虑到上面的人为设计的
package.json
,最终发布的tarball中的实际package.json
内容将如下所示:结果/已发布的package.json
{
...
"scripts": {
"keep": ...
},
"devDependencies": {
"y": "^0.8.1"
},
...
}
跑步
此解决方案假定npm publish将使用以下方法之一运行:
从项目目录中开始,没有任何参数。例如。
npm publish
。指定项目
package.json
的路径。例如。 npm publish path/to/package.json
。通过提供gzip压缩的tar归档文件的URL或文件路径,该归档文件中包含一个带有
package.json
文件的单个文件夹,将无法正常工作。补充笔记
为防止两个实用程序nodejs脚本(
cleanse-pkg.js
和restore-pkg.js
)都发布,应将它们添加到项目.npmignore文件中。给定上述两个文件的位置,您可以在.scripts
中添加.npmignore
条目。实用程序nodejs脚本
cleanse-pkg.js
和restore-pkg.js
定义:原始
package.json
文件的绝对路径。临时
cached-package.json
文件应写入的绝对路径。目前,此文件已从项目目录上一级/外部保存,以避免被发布。如果选择将
cleanse-pkg.js
和restore-pkg.js
存储到与上述位置不同的位置,则需要在两个文件中根据需要重新定义以下代码段中的路径。const ORIG_PKG_PATH = path.resolve(__dirname, '../package.json');
const CACHED_PKG_PATH = path.resolve(__dirname, '../../cached-package.json');
关于npm - npm发布-从package.json中删除脚本?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/48802204/