npmpackage.info

Gathering detailed insights and metrics for rollup-plugin-version-injector

Other packages similar to rollup-plugin-version-injector

@rollup/plugin-commonjs

28.0.1

Convert CommonJS modules to ES2015

@rollup/plugin-node-resolve

15.3.0

Locate and bundle third-party dependencies in node_modules

@rollup/plugin-babel

6.0.4

Seamless integration between Rollup and Babel.

@rollup/plugin-replace

6.0.1

Replace strings in files while bundling

Gathering detailed insights and metrics for rollup-plugin-version-injector

rollup-plugin-version-injector

rollup.js plugin to auto inject the current version into the source code

1.3.3

TypeScript

259,544 1.3

Installations

npm install rollup-plugin-version-injector

Pull Requests

Open

19

Total

99

Closed

72

Merged

8

Issues

Open

2

Total

10

Closed

8

Releases

v1.3.3

Published on 16 Apr 2021

v1.3.2

Published on 10 Feb 2021

v1.3.1

Published on 10 Feb 2021

v1.3.0

Published on 10 Dec 2020

v1.2.2

Published on 24 Apr 2020

v1.2.1

Published on 24 Apr 2020

View all 12 releases

Developer

djhouseknecht

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

12.22.1

NPM Version

7.10.0 Statistics

13 Stars

35 Commits

4 Forks

2 Watching

21 Branches

2 Contributors

Updated on 23 Nov 2024

Languages

TypeScript (98.21%)

JavaScript (1.79%)

Total Downloads

Cumulative downloads

Total Downloads

259,544

Last day

24.1%

624

Compared to previous day

Last week

46.4%

12,357

Compared to previous week

Last month

362.1%

26,376

Compared to previous month

Last year

0.2%

80,335

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

rollup-plugin-version-injector

A simple rollup.js plugin to inject your application's version number and/or today's date into your built js, html, and css files!

Getting started

Install from npm

1npm i --save-dev rollup-plugin-version-injector

Add it to your rollup.config.js build configuration.

1import versionInjector from 'rollup-plugin-version-injector';
2// or
3const versionInjector = require('rollup-plugin-version-injector');
4
5export default {
6  // other configuration
7  plugins: [
8    versionInjector()
9    // any other plugins
10  ]
11};

Then you can add tags to your source code and it will inject the version where you specified. Example:

src/app.js (example file)

1export class MyApp {
2  getVersion() { 
3    return '[VI]{version} - {date}[/VI]';
4  }
5  // other code
6}

version-injector (VI) will replace that code in your built source to return the following:

build/built-app.js (example build file)

1export class MyApp {
2  getVersion() { 
3    return '1.2.1 - June 9, 2007 17:46:12';
4  }
5  // other code
6}

VI will also inject the version into your files as a comment. Example:

build/index.html (example file)

1<!-- Version: 1.2.1 - June 9, 2007 17:46:12 -->
2<!DOCTYPE html>
3<html lang="en">
4  ...
5</html>

Basic Usage

VI has two uses -- it will Inject the version number and/or today's date into your generated files in:

Defined tags in your source code.
A comment at the top of the file.

VI will replace '{version}' with the version found in your package.json and '{date}' with today's date in the format specified in the configuration.

VI supports injecting the version into all js, html, and css files output by rollup.

Injected in the source code

VI will only look between the configured tagIds. For example, the default tagId is VI so VI is looking for:

1// string in your javascript file
2const VERSION = '[VI]Version: {version} - built on {date}[/VI]';

VI will only replace the '{version}' and '{date}' found within those tagIds.

1// output after VI has run
2const VERSION = 'Version: 1.2.1 - built on June 9, 2007 17:46:12';

You can change the date format, tagId, and which files to look in using the configuration object passed into the versionInjector() function.

As a comment

It will replace the '{version}' and '{date}' found in the configured tag. For example, the default configured tag is:

1tag: 'Version: {version} - {date}'

You can change the date format, tag, and which files to inject the comment into using the configuration object passed into the versionInjector() function.

Configuration

Anything not specified/overwritten in your versionInjector() configuration will use the default configuration.

default config

1{
2  injectInComments: {
3    fileRegexp: /\.(js|html|css)$/,
4    tag: 'Version: {version} - {date}',
5    dateFormat: 'mmmm d, yyyy HH:MM:ss'
6  },
7  injectInTags: {
8    fileRegexp: /\.(js|html|css)$/,
9    tagId: 'VI',
10    dateFormat: 'mmmm d, yyyy HH:MM:ss'
11  },
12  packageJson: './package.json',
13  logLevel: 'info',
14  logger: console,
15  exclude: []
16};

All available date formats can be found at dateformat.

injectInTags

The following properties are available:

1versionInjector({
2  injectInTags: false /* or */ {
3    // Regexp for files to match against
4    fileRegexp: Regex 
5    // string of the tagId to look for
6    // Ex: 'ACK' => VI will look for '[ACK]...[/ACK]'
7    tagId: string 
8    // string of valid dateformat 
9    dateFormat: string 
10  }
11})

Note: The tagId will be wrapped in opening and closing brackets. Example: [tagId][/tagId]

All available date formats can be found at dateformat.

injectInComments

The following properties are available:

1versionInjector({
2  injectInComments: false /* or */ {
3    // Regexp for files to match against
4    fileRegexp: Regex 
5    // string of tag to be injected
6    tagId: string 
7    // string of valid dateformat 
8    dateFormat: string 
9  }
10})

packageJson

This is the relative path to your package.json file from your rollup config file. Default is './package.json'.

logLevel

This is the log levels for verion-injector. Default value is 'info'. Available values are:

'debug', 'info', 'warn', 'error'

logger

Default is the console, but can be any logger you prefer that matches the ILogger interface.

excludes

This is an array of specific files you want to exclude from any processing. This must be the full file name without the path.

Credits

This is essentially a less fancy port of the webpack-auto-inject-version.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

45 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-2h3h-q99f-3fhc
Warn: Project is vulnerable to: GHSA-gmw6-94gg-2rc2
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
Warn: Project is vulnerable to: GHSA-hj9c-8jmm-8c52
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-x2pg-mjhr-2m5x
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q

Score

1.3

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to rollup-plugin-version-injector

Other packages similar to rollup-plugin-version-injector

rollup-plugin-version-injector

Installations

Pull Requests

19

99

72

8

Issues

2

10

8

Releases

Developer

djhouseknecht

Developer Guide

CommonJS

Yes

12.22.1

7.10.0

Statistics

Languages

Total Downloads

259,544

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

rollup-plugin-version-injector

Getting started

Basic Usage

Injected in the source code

As a comment

Configuration

injectInTags

injectInComments

packageJson

logLevel

logger

excludes

Credits

10

0

0

0

0

0

0

0

0

0

1.3

/10