简介
在前端开发中,我们经常需要查看当前项目版本信息。如果每次都手动修改版本号,显然不太方便,也容易出错。因此,我们可以通过使用一个 npm 包 built-version 来自动化生成版本号。
安装
使用 npm 安装 built-version:
npm install built-version --save-dev
使用
引入
使用 require 或 import 引入 built-version:
const builtVersion = require('built-version'); // 或 import builtVersion from 'built-version';
生成版本号
调用 builtVersion() 方法生成版本号,将其赋值给 version 变量。如:
const version = builtVersion();
该方法默认根据 package.json 中的 version 字段生成版本号,也可以传入自定义版本号作为参数,如:
const version = builtVersion('1.0.0');
使用版本号
我们可以将生成的版本号用于打包时的文件名或者代码中的版本信息的显示。例如,在 Webpack 配置中,我们可以这样使用版本号:
-- -------------------- ---- ------- ----- ------- - --------------- -------------- - - ------- - --------- --------------------------- -- --- -- -- --- -
这样打包出来的文件名就会包含版本号。
其它选项
built-version 还提供了其他选项:
- cwd:指定项目根目录,默认为当前工作目录。
- key:指定从 package.json 中读取版本号的键名,默认为 version。
- fallbackVersion:如果无法读取到版本号,则返回该值,默认为 "0.0.0"。
可以像这样传入选项:
const version = builtVersion({ cwd: '/path/to/project', key: 'appVersion', fallbackVersion: '1.0.0', });
示例
以下是一个简单示例,演示了如何使用 built-version 自动生成版本号并应用于代码中:
const builtVersion = require('built-version'); const version = builtVersion(); console.log(`当前项目版本号为 ${version}`);
运行上述代码,将会输出类似以下内容:
当前项目版本号为 1.0.0
总结
使用 npm 包 built-version 可以方便地自动生成项目版本号,避免手动修改版本号过程中的错误。使用 built-version,我们还可以在打包时自动为文件名添加版本号等操作。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066c8eccdc64669dde5621