From be3da4656e555727691fac8af521588dc6b069ce Mon Sep 17 00:00:00 2001 From: Ryan Christian Date: Thu, 21 Oct 2021 11:28:21 -0500 Subject: [PATCH 1/2] fix: Ensuring CLI & docs match up with each other --- README.md | 3 +-- src/prog.js | 37 +++++++++++++++++++------------------ 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index fc8e9112..55731506 100644 --- a/README.md +++ b/README.md @@ -329,14 +329,13 @@ Options --define Replace constants with hard-coded values (use @key=exp to replace an expression) --alias Map imports to different modules --compress Compress output using Terser - --no-compress Disable output compressing --strict Enforce undefined global context and add "use strict" --name Specify name exposed in UMD and IIFE builds --cwd Use an alternative working directory (default .) --sourcemap Generate source map (default true) --raw Show raw byte size (default false) --jsx A custom JSX pragma like React.createElement (default: h) - --jsxImportSource Specify the automatic import source for JSX like preact + --jsxImportSource Declares the module specifier to be used for importing jsx factory functions --tsconfig Specify the path to a custom tsconfig.json --generateTypes Whether or not to generate types, if `types` or `typings` is set in `package.json` then it will default to be `true` --css Where to output CSS: "inline" or "external" (default: "external") diff --git a/src/prog.js b/src/prog.js index e07a7d66..4f48a573 100644 --- a/src/prog.js +++ b/src/prog.js @@ -46,39 +46,40 @@ export default handler => { .option('--target', 'Specify your target environment (node or web)', 'web') .option('--external', `Specify external dependencies, or 'none'`) .option('--globals', `Specify globals dependencies, or 'none'`) - .example('microbundle --globals react=React,jquery=$') + .example('--globals react=React,jquery=$') .option('--define', 'Replace constants with hard-coded values') - .example('microbundle --define API_KEY=1234') + .example('--define API_KEY=1234') .option('--alias', `Map imports to different modules`) - .example('microbundle --alias react=preact') + .example('--alias react=preact') .option('--compress', 'Compress output using Terser', null) .option('--strict', 'Enforce undefined global context and add "use strict"') .option('--name', 'Specify name exposed in UMD builds') .option('--cwd', 'Use an alternative working directory', '.') .option('--sourcemap', 'Generate source map') - .option('--css', 'Where to output CSS: "inline" or "external"', 'external') - .option( - '--workers', - 'Bundle module workers - see https://git.io/J3oSF', - false, - ) - .option( - '--css-modules', - 'Turns on css-modules for all .css imports. Passing a string will override the scopeName. eg --css-modules="_[hash]"', - null, - ) - .example("microbundle --no-sourcemap # don't generate sourcemaps") + .example("watch --no-sourcemap # don't generate sourcemaps") .option('--raw', 'Show raw byte size', false) + .option('--jsx', 'A custom JSX pragma like React.createElement', 'h') .option( - '--jsx', - 'A custom JSX pragma like React.createElement (default: h)', + '--jsxImportSource', + 'Declares the module specifier to be used for importing jsx factory functions', ) .option('--tsconfig', 'Specify the path to a custom tsconfig.json') + .example('build --tsconfig tsconfig.build.json') .option( '--generateTypes', 'Whether or not to generate types , if `types` or `typings` is set in `package.json` then it will default to be `true`', ) - .example('microbundle build --tsconfig tsconfig.build.json'); + .option('--css', 'Where to output CSS: "inline" or "external"', 'external') + .option( + '--css-modules', + 'Turns on css-modules for all .css imports. Passing a string will override the scopeName. eg --css-modules="_[hash]"', + null, + ) + .option( + '--workers', + 'Bundle module workers - see https://git.io/J3oSF', + false, + ); prog .command('build [...entries]', '', { default: true }) From 3fbbbc38d4896f7b77e10881ed4f9c3d1563bb48 Mon Sep 17 00:00:00 2001 From: Ryan Christian Date: Thu, 21 Oct 2021 11:42:38 -0500 Subject: [PATCH 2/2] docs: Adding changeset --- .changeset/tame-horses-type.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/tame-horses-type.md diff --git a/.changeset/tame-horses-type.md b/.changeset/tame-horses-type.md new file mode 100644 index 00000000..620146de --- /dev/null +++ b/.changeset/tame-horses-type.md @@ -0,0 +1,5 @@ +--- +'microbundle': patch +--- + +Added missing CLI doc for 'jsxImportSource' and correcting the Examples section of the '--help' output