babel-plugin-prepend-license-header

@accedo/babel-plugin-prepend-license-header

Inspired by babel-plugin-add-header-comment and babel-plugin-banner, an opinionated Babel plugin that prepend the text in the LICENSE file to the transpiled code.

Installation

npm install --save-dev @accedo/babel-plugin-prepend-license-header

Usage

• The babel.config.js should used the shouldPrintComment provided by the plugins.
• Add the following snippet of code to the plugins section of babel.config.js and update accordingly.

plugins: [
  [
    '@accedo/babel-plugin-prepend-license-header',
    {
      licensePath: 'path/to/the/license/file',
      name: '<npm Package Name>',
      description: '<Package Description>',
      version: '<Package Version>'
    }
  ]
]

The updated babel.config.js should look like.

const shouldPrintComment = require('@accedo/babel-plugin-prepend-license-header/shouldPrintComment.js');

module.exports = {
  // ... other options
  shouldPrintComment,

  // ... other options

  plugins: [
    // ... other plugins definitions
    [
      '@accedo/babel-plugin-prepend-license-header',
      {
        licensePath: 'path/to/the/license/file',
        name: '<npm Package Name>',
        description: '<Package Description>',
        version: '<Package Version>'
      }
    ]
  ]
};

And in the transpiled code, the following header will be prepended.

/*******************************************************************************
 * @license
 * <Content of the LICENSE>
 * <will go here>
 * <...>
 *
 * <Package Description> (<npm Package Name>) <Package Version>
 *
 *******************************************************************************/
// Your transpiled code ...