在前端开发中,有时候需要在应用程序的某些部分中显示应用程序的版本号。可以通过手动将版本号硬编码到应用程序中来实现这一点,但是当我们更新应用程序时,需要手动更新此版本号。这种方法很麻烦,而且容易出错。
ember-cli-app-version-file 这个 npm 包为我们提供了一种更好的方法,可以动态生成这些版本号。让我们一起来了解如何使用它!
安装
首先,让我们安装 ember-cli-app-version-file:
npm install ember-cli-app-version-file --save-dev
配置
在你的 ember-cli-build.js
文件中添加下面的配置项:
var app = new EmberApp({ appVersionFileOptions: { enabled: true, versionFilePath: 'my-app-version.txt', canFailBuild: true } });
解释一下每个选项:
enabled
:设置为true
启用版本文件插件,默认值为false
。versionFilePath
:指定版本文件的路径。默认情况下,生成的文件名为:version.json
,存放在/public
目录下,你也可以指定其他路径。canFailBuild
:如果没有版本文件,是否终止构建。默认情况下,此选项被设置为false
,如果没有版本文件,构建将继续。
使用
如果你已经按照上述步骤设置了版本文件插件,那么你可以在应用程序中访问生成的版本文件。版本文件将包含有关应用程序的信息,例如应用程序的名称、版本号、Git 哈希和构建时间。
让我们看一下如何在 Ember 应用程序中访问版本文件(以 Handlebars 模板语言为例):
<aside> {{#with readAsJSON 'my-app-version.txt' as |appVersion|}} <h2>{{appVersion.name}}</h2> <h3>Version {{appVersion.version}} ({{appVersion.sha}})</h3> <p>Build Date: {{appVersion.timestamp}}</p> {{/with}} </aside>
在这个例子中,我们使用 readAsJSON
模板助手从版本文件中读取数据。使用 readAsJSON
模板助手,我们可以将版本信息保存在一个变量或一组变量中,并在应用程序中使用。
示例代码
最后,以下代码是一个完整的实例,展示了如何使用 ember-cli-app-version-file 插件来显示版本信息。
ember-cli-build.js
:
-- -------------------- ---- ------- --- --- - --- ---------- ---------------------- - -------- ----- ---------------- --------------------- ------------- ---- - --- -------------- - -------------
version.json
:
{ "name": "My Awesome App", "version": "1.0.0", "sha": "abc123", "timestamp": "2021-08-31T15:47:00Z" }
index.hbs
:
<h1>{{readAsJSON 'my-app-version.txt' | get 'name'}}</h1> <h2>Version {{readAsJSON 'my-app-version.txt' | get 'version'}}</h2> <h3>({{readAsJSON 'my-app-version.txt' | get 'sha'}})</h3> <p><small>{{readAsJSON 'my-app-version.txt' | get 'timestamp'}}</small></p>
现在你已经有了一个动态的版本文件,每次构建时都会更新,不用担心遗漏或者错误。同时,你也学会了如何使用 Ember 应用程序中的版本信息。让我们在开发中实践吧!
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600556d281e8991b448d3a87