/rollup-plugin-prettier

Run prettier formatter with rollup

Primary LanguageJavaScriptMIT LicenseMIT

rollup-plugin-prettier

Greenkeeper badge Build Status Npm version

Rollup plugin that can be used to run prettier on the final bundle.

How to use

Install the plugin with NPM:

npm install --save-dev rollup-plugin-prettier

Then add it to your rollup configuration:

const path = require('path'); const prettier = require('rollup-plugin-prettier');

module.exports = {
  input: path.join(__dirname, 'src', 'index.js'),

  output: {
    file: path.join(__dirname, 'dist', 'bundle.js'),
  },

  plugins: [
    // Run plugin with prettier options.
    prettier({
      tabWidth: 2,
      singleQuote: false,
    }),
  ],
};

Source Maps

If source map is enabled in the global rollup options, then a source map will be generated on the formatted bundle (except if sourcemap are explicitely disabled in the prettier options).

Note that this may take some time since prettier package is not able to generate a sourcemap and this plugin must compute the diff between the original bundle and the formatted result and generate the corresponding sourcemap: for this reason, sourcemap are disabled by default.

Here is an example:

const path = require('path');
const prettier = require('rollup-plugin-prettier');

module.exports = {
  input: path.join(__dirname, 'src', 'index.js'),

  output: {
    file: path.join(__dirname, 'dist', 'bundle.js'),
    sourcemap: true,
  },

  plugins: [
    prettier({
      sourceMap: true, // Can also be disabled/enabled here.
    }),
  ],
};

ChangeLogs

  • 0.4.0
    • Add compatibility with rollup >= 0.53 with output sourcemap option (see rollup #1583).
    • Avoid side-effect and do not change the plugin options (see 032be5).
    • Various dependency updates.
  • 0.3.0
    • Support new sourcemap (lowercase) option of rollup.
    • Sourcemap can now be activated/disabled in the plugin options.
  • 0.2.0
    • Dependency update (magic-string)
  • 0.1.0 First release

License

MIT License (MIT)

Contributing

If you find a bug or think about enhancement, feel free to contribute and submit an issue or a pull request.