Troplo/webpack-auto-inject-version
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
No description
41 commits 1 branch 0 tags 880 KiB
JavaScript 100%
Find a file
radswiat c45db96b59 Remove some consoles
2017-04-12 23:43:48 +01:00
demo Add InjectAsComment tag option 2017-04-12 23:40:22 +01:00
dist Add InjectAsComment tag option 2017-04-12 23:40:22 +01:00
src Remove some consoles 2017-04-12 23:43:48 +01:00
tools Fix eslint issues 2017-04-12 22:32:39 +01:00
.babelrc Fix eslint issues 2017-04-12 22:32:39 +01:00
.editorconfig Add editor config, fix unnecessary .default suffix 2017-04-12 22:11:59 +01:00
.eslintrc Fix eslint issues 2017-04-12 22:32:39 +01:00
.gitignore Finilize new version 2017-04-11 00:11:09 +01:00
.npmignore Remove demo/ from npm 2017-04-12 21:54:57 +01:00
package.json Update version 2017-04-12 23:40:59 +01:00
README.md Add InjectAsComment tag option 2017-04-12 23:40:22 +01:00

README.md

Auto inject version - Webpack plugin

Adds version from package.json into every single file as top comment block.

Install

$ npm install webpack-auto-inject-version --save-dev

Table of Contents

What it does
How to use
Available options
Output examples Change log

What it does

Auto Inject Version (AIV) can:

  • inject version from package.json into every bundle file as a comment ( at the top )
  • inject version from package.json into any place in your HTML by special tag [AIV]{version}[/AIV]
  • inject version from package.json into any place in CSS/JS file by special tag [AIV]{version}[/AIV]
  • auto increase package.json version by --env.major, --env.minor, --env.patch passed into webpack

How to use

It's easy to set it up, all you need is:

  • use WebpackAutoInject in webpack plugins
  • pass config as a parameter, or leave it blank as all options are "on" by default.

Example ( in webpack.conf.js )

var WebpackAutoInject = require('webpack-auto-inject-version');
...
module.exports = {
    ...
    plugins: [
        new WebpackAutoInject({
            // options
            // example:
            components: {
                AutoIncreaseVersion: false
            }
        })
    ]
}

Available options

components.AutoIncreaseVersion

Auto increase package.json number.
This option requires extra argument to be sent to webpack build.
It happens before anything else to make sure that your new version is injected into your files.
Arguments: --env.major --env.minor --env.patch

Example for package.json run type, npm run start => ( 1.2.10 to 2.0.0 )

 "version" : "1.2.10",
 "scripts": {
    "start": "webpack --env.major"
 }

Default: true

components.InjectByTag

Inject version number into your file
Version will replace the <{version}> tag.

<span>My awesome project | [AIV]{version}[/AIV]</span>

var version = '[AIV]{version}[/AIV]';

Default: true

components.InjectAsComment

This will inject your version as a comment into any css,js,html file.
You can change what is injected into the file by changing componentsOptions.InjectAsComment.tag. Currently only 2 tags are supported:

  • {version}
  • {date} ( current date ) Example:
  ...
  plugins: [
    ...
    new WebpackAutoInject({
      PACKAGE_JSON_PATH: './package.json',
      components: {
        ...
        InjectAsComment: true
      },
      componentsOptions: {
        ...
        InjectAsComment: {
          tag: 'Build version: {version} - {date}' // default
        }
    })
  ]

Default: true

Output-examples

AIV can inject version number for all your bundle files (css,js,html).

// [AIV] Build version: 1.0.10
/******/ (function(modules) { // webpackBootstrap
/******/ 	// The module cache
/******/ 	var installedModules = {};



Example html:

<!-- [AIV] Build version: 1.0.10 -->
<!DOCTYPE html>
<html lang="en">

Change log

[0.5.13] - 12/04/2017

  • Tag from InjectAsComment can now be configured by options ( componentsOptions.InjectAsComment.tag )
  • Default tag template for InjectAsComment has change

[0.5.12] - 12/04/2017

  • Fix dependency missing issue
  • Remove export as object with .default as a class