如何知道npm包中的脚本选项

Question

例如，我通过npm init&amp；npm安装tailwindcss。之后，我在package.json中制作了一个类似"build-css": "tailwindcss build src/styles.css -o public/styles.css"的脚本(我只是从stuckoverflow中复制粘贴它(。现在关注-o，开发者如何知道顺风有-o选项。我检查了node-module/tailwindcss/script/build.js，但我目前还没有了解到这一点(我的意思是，我发现了0条线索(。请说明一下。我们有一些标准化或不成文的规则，npm包的创建者遵循吗？

Answer 1

package.json中的scripts字段定义了在npm上下文中使用npm run运行的命令。这允许您使用不同npm包提供的命令行界面，而无需全局安装它们。这些CLI中的许多还公开了--help标志或help命令。

要从未全局安装的npm软件包运行CLI，可能需要使用npx。在您的情况下，您可以运行：

npx tailwindcss

它告诉您有一个CCD_ 8命令可以为您提供更多信息。

$ npx tailwindcss                                                                                                                                            

tailwindcss 2.1.2

Usage:
tailwind <command> [options]

Commands:
help [command]            More information about the command.
init [file]               Creates Tailwind config file. Default: tailwind.config.js
build <file> [options]    Compiles Tailwind CSS file.

如果您能够轻松阅读node_modules文件夹中的源代码，还可以找到有关这些命令和运行的代码的更多信息。要查找CLI的定义位置，可以检查node_modules/tailwindcss/package.json，它定义了一个bin键。在这种情况下，它表明tailwindcss命令来自lib/cli.js。转换代码时，可以四处查找lib/cli/commands/build.js，其中包含build命令的选项。

const options = [{
usage: '-o, --output <file>',
description: 'Output file.'
}, {
usage: '-c, --config <file>',
description: 'Tailwind config file.'
}, {
usage: '--no-autoprefixer',
description: "Don't add vendor prefixes using autoprefixer."
}];

如果软件包是开源的，您可以在网上找到原始的、未转换的源代码。在Tailwind的案例中，他们有一个Github repo，您可以在其中查看build命令的原始源代码。