如何查询npm包的可执行脚本参数?以tailwindcss的-o参数为例
关于Tailwind CLI
-o参数的说明及参数查询方法 -o是--output参数的缩写,作用是指定Tailwind CSS编译产物的输出路径,你给出的示例命令tailwindcss build src/styles.css -o public/styles.css,就是将src/styles.css作为编译入口,经过Tailwind规则处理后,把最终生成的CSS文件输出到public/styles.css。
如何查询Tailwind支持的所有可用参数
不需要翻阅node_modules内的源码,所有CLI类的npm包都有标准的参数查询方式:
- 直接在项目根目录的终端执行
npx tailwindcss --help,即可输出Tailwind CLI所有全局参数、子命令的说明 - 如果要单独查询某个子命令的专属参数,比如你用到的
build子命令,可以执行npx tailwindcss build --help,就能直接看到-o, --output <path>对应参数的完整说明
npm CLI工具的通用行业约定
几乎所有提供命令行调用能力的npm包,都遵循统一的开发约定:
- 单个横杠+单个字母为参数缩写(比如
-o),双横杠+完整单词为参数全称(比如--output) - 默认支持
-h/--help参数输出帮助文档,支持-v/--version参数输出当前包的版本号 - 多子命令结构的CLI工具,每个子命令都支持后缀
--help查询该子命令的专属入参说明
你之前在build.js里找不到参数相关逻辑是正常的,CLI工具的参数解析逻辑一般会放在专门的CLI入口文件中,且大多会借助commander、yargs这类专门的参数解析库实现,普通开发者无需翻阅源码,用--help就能获取全部可用参数信息。
内容的提问来源于stack exchange,提问作者Bapi
相关产品推荐
相关产品推荐

