2023-4174jamesjenkins/rollup-plugin-prettier

README

rollup-plugin-prettier

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 prettier 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 that override the local config.
    prettier({
      tabWidth: 2,
      singleQuote: false,
    }),
  ],
};

Plugin Options

cwd

default: process.cwd()
type: string
example: prettier({ cwd: '/path/to/dir', tabWidth: 2 })
purpose: The directory prettier will use to find the local config

sourcemap

default: null
type: boolean | 'silent'
example: prettier({ sourcemap: true, tabWidth: 2 })
purpose: Create a sourcemap if the global rollup options don't specify. Set to 'silent' to avoid rollup-plugin-prettier warning. See more below.

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

4.1.2
- Fix a bug where prettier configuration file were not correctly resolved since prettier@^3.1.1 (same as this bug in prettier-vscode, broken since this commit in prettier).
- Dependency upgrades
4.1.1
- Fix support rollup for ^4.0.0, that was intended to be introduced in 4.1.0
- Dependency upgrades
4.1.0
- ~~Support rollup ^4.0.0~~
- Dependency upgrades
4.0.0
- Support prettier ^3.0.0
- Dependency upgrades
3.1.0
- Reformat asynchrnously to prepare support for prettier ^3.0.0
3.0.0
- Support rollup ^3.0.0
2.2.2
- Remove IDE files from published package
2.2.1
- Fix typings
- Dependency updates
2.2.0
- Add typings (#696, thanks @pastelmind!)
- Dependency updates
2.1.0
- Add option to not log warning due to heavy diff computation (#435)
- Dependency updates
2.0.0
- Support node >= 10 (still support node >= 6, but it not tested anymore).
- Update dev dependencies.
1.0.0
- Breaking Change: prettier dependency is now a peer dependency instead of a "direct" dependency: user of the plugin can choose to use prettier 1.x.x or prettier 2.x.x (note that this plugin should be compatible with all versions of prettier).
- Support node >= 6.
- Support rollup >= 1.0.0
- Remove support of deprecated option (sourceMap was deprecated in favor of sourcemap).
0.7.0
- Dependency updates.
- Update rollup peer dependency version.
0.6.0
- Add support for rollup >= 1 (thanks to @Andarist, see #211)
- Various dependency updates.
0.5.0
- Support resolution of prettier config file (see #195).
- Various dependency updates.
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.