Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[docs] add output.PreserveModulesRoot to big list of options #3792

Merged
merged 1 commit into from Sep 22, 2020
Merged

[docs] add output.PreserveModulesRoot to big list of options #3792

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/999-big-list-of-options.md
View file
Open in desktop
Expand Up @@ -856,6 +856,30 @@ const main = require('./main.js');
console.log(main.default); // 42
```

#### output.preserveModulesRoot
Type: `string`<br>
CLI: `--preserveModulesRoot <directory-name>`

A directory path to input modules that should be stripped away from [`output.dir`](guide/en/#outputdir) path while [`output.preserveModules`](guide/en#outputpreservemodules) is `true`.

For example, given the following configuration:

```javascript
export default ({
input: [ 'src/module.js', `src/another/module.js` ],
output: [{
format: 'es',
dir: 'dist',
preserveModules: true,
preserveModulesRoot: 'src'
}]
});
```

The `preserveModulesRoot` setting ensures that the input modules will be output to the paths `dist/module.js` and `dist/another/module.js`.

This option is particularly useful while using plugins such as `@rollup/plugin-node-resolve`, which may cause changes in the output directory structure. This can happen when third-party modules are not marked [`external`](guide/en/#external), or while developing in a monorepo of multiple packages that rely on one another and are not marked [`external`](guide/en/#external).

#### output.sourcemap
Type: `boolean | 'inline' | 'hidden'`<br>
CLI: `-m`/`--sourcemap`/`--no-sourcemap`<br>
Expand Down