Registry / devops / rollup-plugin-add-git-msg

rollup-plugin-add-git-msg

library1.1.0jsnpmunverified

Rollup plugin that prepends a banner comment with GIT_TAG and COMMITHASH from the last git commit or tag, along with the repo name, copyright, and compilation date. Current published version is 1.1.0 with no recent updates; appears to be in maintenance mode. Key differentiator: simple, zero-config plugin for adding standard git-based versioning banners to Rollup bundles. Alternatives like rollup-plugin-banner or manual inject plugins offer more flexibility but require more setup.

devops

npm install rollup-plugin-add-git-msg

github ↗package ↗

INSTALL

IMPORT

SIG · ROLLUP-PLUGIN-ADD-

rollup-plugin-add-git-msg

devopsjavascriptv1.1.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–223 runs

build_error

glibc

node 18–223 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

addGitMsg

✓ import addGitMsg from 'rollup-plugin-add-git-msg';

✗ import { addGitMsg } from 'rollup-plugin-add-git-msg';

Default export only; named import will fail.

addGitMsg (CommonJS)

✓ const addGitMsg = require('rollup-plugin-add-git-msg').default;

✗ const addGitMsg = require('rollup-plugin-add-git-msg');

When using require(), the plugin is exported as a CommonJS module with a default export, so you need .default.

addGitMsg (TypeScript)

✓ import addGitMsg from 'rollup-plugin-add-git-msg';

TypeScript handles default imports correctly if esModuleInterop is enabled.

Shows how to import and configure the plugin in a Rollup config file.

import addGitMsg from 'rollup-plugin-add-git-msg'; export default { input: 'src/index.js', output: { file: 'dist/bundle.js', format: 'iife' }, plugins: [ addGitMsg({ copyright: 'MyCompany', showDate: true, showTag: true, showCommitID: true }) ] };

Debug

Known issues

gotchaThe plugin will fail silently if executed outside a git repository—no git info is injected and no error is thrown.

fix

Ensure the build runs inside a git repository. Consider adding a check or using an alternative plugin that throws errors for missing git info.

affects: >=1.0.0

gotchaThe plugin uses synchronous child_process.execSync to run git commands, which blocks the event loop and may cause performance issues in large builds.

fix

For production builds, consider using an asynchronous plugin or running git commands outside the build pipeline.

affects: >=1.0.0

deprecatedPackage has not been updated since 2017. May not work with modern Rollup versions (e.g., Rollup 3+).

fix

Check compatibility with your Rollup version. For Rollup 3+, you may need to use a more recent alternative like rollup-plugin-banner.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Cannot find module 'rollup-plugin-add-git-msg'

Package not installed or missing from node_modules.

fix

Run `npm install --save-dev rollup-plugin-add-git-msg` and ensure it is listed in your package.json.

TypeError: addGitMsg is not a function

Incorrect import style: using named import instead of default import.

fix

Use `import addGitMsg from 'rollup-plugin-add-git-msg';` (no braces) or for CommonJS: `const addGitMsg = require('rollup-plugin-add-git-msg').default;`

Upgrade

Version history

1.1.0latest on npm

Audit

Dependencies

@rollup/pluginutilsrequiredUsed for creating filter patterns and utilities

child_processrequiredSpawns git commands to retrieve tag and commit hash

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/oplinjie/rollup-plugin-add-git-msg ↗

packagehttps://www.npmjs.com/package/rollup-plugin-add-git-msg ↗