# file_version

> i一个简单的版本号替换包

Latest version **1.1.2** (published 2017-08-31) · ISC license · 0 weekly downloads

## Install

```sh
npm install file_version
pnpm add file_version
yarn add file_version
bun add file_version
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2017-08-31 |
| First published | 2017-07-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | youzhej |
| Maintainers | youzhej |
| Keywords | file, version |

## Links

- npm: https://www.npmjs.com/package/file_version
- Repository: https://github.com/YouzheJ/file_version
- Homepage: https://github.com/YouzheJ/file_version#readme
- Issues: https://github.com/YouzheJ/file_version/issues
- npm.io page: https://npm.io/package/file_version

## Dependencies (2)

- [lodash](https://npm.io/package/lodash.md) ^4.17.4
- [file_io](https://npm.io/package/file_io.md) ^1.0.0

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.1.2 (latest) — 2017-08-31
- 1.1.1 — 2017-08-31
- 1.1.0 — 2017-08-31
- 1.0.10 — 2017-07-18
- 1.0.9 — 2017-07-18
- 1.0.8 — 2017-07-18
- 1.0.7 — 2017-07-18
- 1.0.6 — 2017-07-18
- 1.0.5 — 2017-07-18
- 1.0.4 — 2017-07-18
- 1.0.3 — 2017-07-18
- 1.0.2 — 2017-07-18
- 1.0.1 — 2017-07-18
- 1.0.0 — 2017-07-18

## README

一个简单的版本替换npm包

---

#### 使用场景


> 在jsp等页面中需要对引入的文件进行版本控制


注意：此包需要搭配 assests-webpack-plugin 结合使用

#### 具体使用流程（一个简单的例子）

- 安装

```bash
npm install assets-webpack-plugin --save-dev
npm install file_version --save-dev
```

- 配置 webpack.config.js

```javascript
// 加载依赖
var AssetsPlugin = require('assets-webpack-plugin');
var AssetsReplaceVersion = require('file_version');
```

```javascript
// 配置plugins
plugins: [
    new AssetsPlugin({
      filename: 'public/asset.js',
      processOutput: function (assets) { 
        /* 
        * 由于 AssetsReplaceVersion 直接读取文件内容
        * 此处请不要进行修改
        */
        return JSON.stringify(assets);
      }
    }),
    new AssetsReplaceVersion({
      filename: 'public/asset.js',   // 必选项
      includePath: 'public/include', // 必选项 请确保include中没有文件夹，否则读取失败
      // filter: 'public',              
      /* 可选项 过滤规则
                可以是字符串或者数组
                可以是路径或文件名(请确保与文件中的一致)
      */
    })
    ...
]
```

- jsp

```jsp
// 在jsp中引入带有版本信息的html片段
<%@ include file="public/include/header.html" %>
```

- header.html

```html
// 待替换的目标文件
// 此处，存放在include文件夹中
<script src="build/js/bundle.js?v=b02348e10dd02f729e9c"></script>
<link rel="stylesheet" type="text/css" href="static/css/style.css?v=b02348e10dd02f729e9c">
```

- assets.js

```javascript
// 由 assets-webpack-plugin 生成
{"main":{"js":"build/js/bundle.js?v=b02348e10dd02f729e9c", "css":"static/css/style.css?v=b02348e10dd02f729e9c"}}
```

> 以上面的例子为例： 使用webpack进行打包后，assets-webpack-plugin会先生成一个记录各文件版本信息的assets.js文件，然后 file-version 会读取 assets.js中的json字符串，然后遍历include中的文件，替换相应的字段。

### 注意：

- html片段文件存放在include(可随意命名)文件夹中，并且此文件夹不能包含其他文件夹，否则会读取失败

#### 由于插件功能简单，适用场景有限

---
_Source: https://npm.io/package/file_version · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._