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.

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

introduce CLI --plugin support #3379

Merged
merged 7 commits into from
Feb 28, 2020
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
1 change: 1 addition & 0 deletions cli/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Basic options:
-m, --sourcemap Generate sourcemap (`-m inline` for inline map)
-n, --name <name> Name for UMD export
-o, --file <output> Single output file (if absent, prints to stdout)
-p, --plugin <plugin> Use the plugin specified (may be repeated)
-v, --version Show version number
-w, --watch Watch files in bundle and rebuild on changes
--amd.id <id> ID for AMD module (default is anonymous)
Expand Down
16 changes: 4 additions & 12 deletions cli/run/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,11 @@ export default function build(
outputOptions: OutputOptions[],
warnings: BatchWarnings,
silent = false
) {
): Promise<unknown> {
const useStdout = !outputOptions[0].file && !outputOptions[0].dir;

const start = Date.now();
const files = useStdout
? ['stdout']
: outputOptions.map(t => relativeId(t.file || t.dir!));
const files = useStdout ? ['stdout'] : outputOptions.map(t => relativeId(t.file || t.dir!));
if (!silent) {
let inputFiles: string | undefined;
if (typeof inputOptions.input === 'string') {
Expand Down Expand Up @@ -61,13 +59,11 @@ export default function build(
process.stdout.write('\n' + tc.cyan(tc.bold('//→ ' + file.fileName + ':')) + '\n');
process.stdout.write(source);
}
return null
return null;
});
}

return Promise.all(outputOptions.map(output => bundle.write(output))).then(
() => bundle
);
return Promise.all(outputOptions.map(output => bundle.write(output))).then(() => bundle);
})
.then((bundle: RollupBuild | null) => {
if (!silent) {
Expand All @@ -79,9 +75,5 @@ export default function build(
printTimings(bundle.getTimings());
}
}
})
.catch((err: Error) => {
warnings.flush();
handleError(err);
});
}
91 changes: 80 additions & 11 deletions cli/run/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { realpathSync } from 'fs';
import * as path from 'path';
import relative from 'require-relative';
import { WarningHandler } from '../../src/rollup/types';
import { InputOptions, WarningHandler } from '../../src/rollup/types';
import mergeOptions, { GenericConfigObject } from '../../src/utils/mergeOptions';
import { getAliasName } from '../../src/utils/relativeId';
import { handleError } from '../logging';
Expand Down Expand Up @@ -107,18 +108,86 @@ async function execute(
} else {
for (const config of configs) {
const warnings = batchWarnings();
const { inputOptions, outputOptions, optionError } = mergeOptions({
command,
config,
defaultOnWarnHandler: warnings.add
});
if (optionError) {
(inputOptions.onwarn as WarningHandler)({ code: 'UNKNOWN_OPTION', message: optionError });
try {
const { inputOptions, outputOptions, optionError } = mergeOptions({
command,
config,
defaultOnWarnHandler: warnings.add
});
if (optionError) {
(inputOptions.onwarn as WarningHandler)({ code: 'UNKNOWN_OPTION', message: optionError });
}
if (command.stdin !== false) {
inputOptions.plugins!.push(stdinPlugin());
}
if (command.plugin) {
const plugins = Array.isArray(command.plugin) ? command.plugin : [command.plugin];
for (const plugin of plugins) {
if (/[={}]/.test(plugin)) {
// -p plugin=value
// -p "{transform(c,i){...}}"
loadAndRegisterPlugin(inputOptions, plugin);
} else {
// split out plugins joined by commas
// -p node-resolve,commonjs,buble
plugin
.split(',')
.forEach((plugin: string) => loadAndRegisterPlugin(inputOptions, plugin));
}
}
}
await build(inputOptions, outputOptions, warnings, command.silent);
} catch (err) {
warnings.flush();
handleError(err);
}
}
}
}

function loadAndRegisterPlugin(inputOptions: InputOptions, pluginText: string) {
let plugin: any = null;
let pluginArg: any = undefined;
if (pluginText[0] === '{') {
// -p "{transform(c,i){...}}"
plugin = new Function('return ' + pluginText);
} else {
const match = pluginText.match(/^([@.\/\\\w|^{}|-]+)(=(.*))?$/);
if (match) {
// -p plugin
// -p plugin=arg
pluginText = match[1];
pluginArg = new Function('return ' + match[3])();
} else {
throw new Error(`Invalid --plugin argument format: ${JSON.stringify(pluginText)}`);
}
if (!/^\.|^rollup-plugin-|[@\/\\]/.test(pluginText)) {
// Try using plugin prefix variations first if applicable.
// Prefix order is significant - left has higher precedence.
for (const prefix of ['@rollup/plugin-', 'rollup-plugin-']) {
try {
plugin = require(prefix + pluginText);
break;
} catch (ex) {
// if this does not work, we try requiring the actual name below
}
}
if (command.stdin !== false) {
inputOptions.plugins!.push(stdinPlugin());
}
if (!plugin) {
try {
if (pluginText[0] == '.') pluginText = path.resolve(pluginText);
plugin = require(pluginText);
} catch (ex) {
throw new Error(`Cannot load plugin "${pluginText}"`);
}
await build(inputOptions, outputOptions, warnings, command.silent);
}
}
if (typeof plugin === 'object' && pluginText in plugin) {
// some plugins do not use `export default` for their entry point.
// attempt to use the plugin name as the named import name.
plugin = plugin[pluginText];
}
inputOptions.plugins!.push(
typeof plugin === 'function' ? plugin.call(plugin, pluginArg) : plugin
);
}
4 changes: 2 additions & 2 deletions cli/run/loadConfigFile.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import path from 'path';
import * as path from 'path';
import tc from 'turbocolor';
import * as rollup from '../../src/node-entry';
import { RollupBuild, RollupOutput } from '../../src/rollup/types';
Expand Down Expand Up @@ -73,4 +73,4 @@ export default function loadConfigFile(
return Array.isArray(configs) ? configs : [configs];
});
});
}
}
42 changes: 42 additions & 0 deletions docs/01-command-line-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,7 @@ Many options have command line equivalents. In those cases, any arguments passed
-m, --sourcemap Generate sourcemap (`-m inline` for inline map)
-n, --name <name> Name for UMD export
-o, --file <output> Single output file (if absent, prints to stdout)
-p, --plugin <plugin> Use the plugin specified (may be repeated)
-v, --version Show version number
-w, --watch Watch files in bundle and rebuild on changes
--amd.id <id> ID for AMD module (default is anonymous)
Expand Down Expand Up @@ -268,6 +269,47 @@ The flags listed below are only available via the command line interface. All ot

Print the help document.

#### `-p <plugin>`, `--plugin <plugin>`

Use the specified plugin. There are several ways to specify plugins here:

- Via a relative path:

```
rollup -i input.js -f es -p ./my-plugin.js
```

The file should export a plugin object or a function returning such an object.
- Via the name of a plugin that is installed in a local or global `node_modules` folder:

```
rollup -i input.js -f es -p @rollup/plugin-node-resolve
```

If the plugin name does not start with `rollup-plugin-` or `@rollup/plugin-`, Rollup will automatically try adding these prefixes:

```
rollup -i input.js -f es -p node-resolve
```

- Via an inline implementation:

```
rollup -i input.js -f es -p '{transform: c => "/* TEST */" + c}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo - need a trailing single quote

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like the example doesn't work unless you add a newline - rollup drops the comment otherwise:

-p '{transform: c => "/* TEST */\n" + c}'

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example is a bit more interesting - it's up to you:

-p '{transform: (c, i) => `/* ${i} */\n` + c}'

Copy link
Contributor Author

@kzc kzc Feb 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or perhaps:

-p '{transform: (c, i) => `/* ${JSON.stringify(i)} */\n` + c}'

which would show embedded \0 (nils) for other plugins.

Try running the following and then again without the newline after the comment:

dist/bin/rollup test/cli/samples/plugin/advanced/main.js -p node-resolve,commonjs -p '{transform: (c, i) => `/* ${JSON.stringify(i)} */\n` + c}' --silent

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch. Without the newline, Rollup only keeps the comment if the first line is preserved, which was the case for my test call 😉 With the newline, it is always preserved as it is considered a banner.

I will change to using your example 👍

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. I also consistenly used single quotes around both examples because otherwise, Bash might do variable expansions or let hell break loose when you use backticks...

```

If you want to load more than one plugin, you can repeat the option or supply a comma-separated list of names:

```
rollup -i input.js -f es -p node-resolve -p commonjs,json
```

By default, plugins that export functions will be called with no argument to create the plugin. You can however pass a custom argument as well:

```
rollup -i input.js -f es -p "terser={output: {beautify: true, indent_level: 2}}"`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo - stray trailing backtick

```

#### `-v`/`--version`

Print the installed version number.
Expand Down
2 changes: 2 additions & 0 deletions src/utils/mergeOptions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ export const commandAliases: { [key: string]: string } = {
m: 'sourcemap',
n: 'name',
o: 'file',
p: 'plugin',
v: 'version',
w: 'watch'
};
Expand Down Expand Up @@ -158,6 +159,7 @@ export default function mergeOptions({
Object.keys(commandAliases),
'config',
'environment',
'plugin',
'silent',
'stdin'
),
Expand Down
5 changes: 5 additions & 0 deletions test/cli/samples/plugin/absolute/_config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = {
description: 'CLI --plugin /absolute/path',
skipIfWindows: true,
command: `echo 'console.log(VALUE);' | rollup -p "\`pwd\`/my-plugin={VALUE: 'absolute', ZZZ: 1}"`
};
1 change: 1 addition & 0 deletions test/cli/samples/plugin/absolute/_expected.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
console.log("absolute");
14 changes: 14 additions & 0 deletions test/cli/samples/plugin/absolute/my-plugin.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
module.exports = function(options) {
if (options === void 0) options = {};
return {
transform(code) {
// dumb search and replace for test purposes
for (var key in options) {
const rx = new RegExp(key, 'g');
const value = JSON.stringify(options[key]);
code = code.replace(rx, value);
}
return code;
}
};
};
5 changes: 5 additions & 0 deletions test/cli/samples/plugin/advanced/_config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = {
description: 'advanced CLI --plugin functionality with rollup config',
skipIfWindows: true,
command: `rollup -c -p node-resolve,commonjs -p "terser={output: {beautify: true, indent_level: 2}}"`
};
17 changes: 17 additions & 0 deletions test/cli/samples/plugin/advanced/_expected/cjs.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
"use strict";

Object.defineProperty(exports, "__esModule", {
value: !0
});

var t = function() {
function t(t) {
this.x = t;
}
return t.prototype.output = function() {
var t;
t = this.x, console.log(t);
}, t;
}();

new t(123).output(), exports.Bar = t;
13 changes: 13 additions & 0 deletions test/cli/samples/plugin/advanced/_expected/es.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
var t = function() {
function t(t) {
this.x = t;
}
return t.prototype.output = function() {
var t;
t = this.x, console.log(t);
}, t;
}();

new t(123).output();

export { t as Bar };
4 changes: 4 additions & 0 deletions test/cli/samples/plugin/advanced/main.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import {Foo} from "foo";
var foo = new Foo(123);
foo.output();
export {Foo as Bar};
10 changes: 10 additions & 0 deletions test/cli/samples/plugin/advanced/node_modules/foo/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions test/cli/samples/plugin/advanced/node_modules/print/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 18 additions & 0 deletions test/cli/samples/plugin/advanced/rollup.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
const buble = require('rollup-plugin-buble');

export default {
input: 'main.js',
plugins: [
buble()
],
output: [
{
file: '_actual/cjs.js',
format: 'cjs'
},
{
file: '_actual/es.js',
format: 'esm'
}
]
};
4 changes: 4 additions & 0 deletions test/cli/samples/plugin/basic/_config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
module.exports = {
description: 'basic CLI --plugin functionality',
command: `rollup main.js -f cjs --plugin rollup-plugin-buble`
};
14 changes: 14 additions & 0 deletions test/cli/samples/plugin/basic/_expected.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
'use strict';

Object.defineProperty(exports, '__esModule', { value: true });

var Bar = function Bar(x) {
this.x = value;
};
Bar.prototype.value = function value () {
return this.x;
};
var bar = new Bar(123);
console.log(bar.value());

exports.Bar = Bar;
10 changes: 10 additions & 0 deletions test/cli/samples/plugin/basic/main.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
export class Bar {
constructor(x) {
this.x = value;
}
value() {
return this.x;
}
}
var bar = new Bar(123);
console.log(bar.value());
10 changes: 10 additions & 0 deletions test/cli/samples/plugin/cannot-load/_config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
const { assertStderrIncludes } = require('../../../../utils.js');

module.exports = {
description: 'unknown CLI --plugin results in an error',
skipIfWindows: true,
command: `echo "console.log(123);" | rollup --plugin foobar`,
error(err) {
assertStderrIncludes(err.message, '[!] Error: Cannot load plugin "foobar"');
}
};
10 changes: 10 additions & 0 deletions test/cli/samples/plugin/invalid-argument/_config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
const { assertStderrIncludes } = require('../../../../utils.js');

module.exports = {
description: 'invalid CLI --plugin argument format',
skipIfWindows: true,
command: `echo "console.log(123);" | rollup --plugin 'foo bar'`,
error(err) {
assertStderrIncludes(err.message, '[!] Error: Invalid --plugin argument format: "foo bar"');
}
};
5 changes: 5 additions & 0 deletions test/cli/samples/plugin/object/_config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = {
description: 'CLI --plugin object',
skipIfWindows: true,
command: `echo 'console.log(42);' | rollup -f cjs -p '{transform: c => c + String.fromCharCode(10) + c}'`
};