Skip to content

Commit 89c321c

Browse files
FNDFND
committed
merged examples into and extended descriptions
1 parent 7aa0f76 commit 89c321c

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

‎README.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,23 +24,23 @@ supported global features:
2424

2525
bundle-specific configuration:
2626

27-
| option | description | permitted values | examples |
28-
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
29-
| `source` (required) | references the entry-point module | file path <br> non-relative file paths are interpeted as identifiers for third-party packages | `"./src/index.js"` |
30-
| `target` (required) | references the target bundle | relative file path | `"./dist/bundle.js"` |
31-
| `compact` | activates bundle compression <br> NB: only takes effect if compacting is activated globally (typically via `--compact`) | `compact` (default), `minify` or `mangle` | |
32-
| `sourcemaps` | if truthy, activates inline source-map generation <br> NB: only takes effect if source maps are activated globally (typically via `--sourcemaps`) | `false` suppresses source maps | |
33-
| `format` | determines the bundle format | `iife` (default), `esm`, `umd`, `amd` or `commonjs` - all case-insensitive | |
34-
| `exports` | determines the bundle's API; the value exported by `source` (if any) | | `"MYLIB"`, for IIFEs |
35-
| `extensions` | additional file extensions for loading modules | | `[".jsx"]` |
36-
| `externals` | determines which modules/packages to exclude from the bundle | an object whose key refers to the respective module/package name, the value refers to a corresponding global variable | `{ jquery: "jQuery" }` |
37-
| `esnext` | if truthy, activates ESNext transpilation (typically determined by Browserslist) | | |
38-
| `esnext.browserslist` | custom Browserslist entry selection | the name of the Browserslist group to select <br> `false` suppresses automatic configuration via Browserslist | `esnext: { browserslist: "legacy" }` |
39-
| `esnext.exclude` | modules/packages for which to skip transpilation <br> this might be useful when importing distributions already optimized for ES5, for example | | `esnext: { exclude: ["jquery"] }` |
40-
| `jsx` | if truthy, activates JSX transpilation <br> additionally accepts the same options as `esnext` | | |
41-
| `jsx.pragma` | determines the function to use for JSX expressions | | `jsx: { pragma: "createElement" }` |
42-
| `jsx.fragment` | determines the function to use for JSX fragments | | `jsx: { fragment: "Fragment" }` |
43-
| `typescript` | if truthy, activates TypeScript transpilation <br> anything other than `true` will be passed through as TypeScript compiler options | | |
27+
| option | description | permitted values |
28+
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
29+
| `source` (required) | references the entry-point module (e.g. `"./src/index.js"`) | file path <br> non-relative file paths are interpeted as identifiers for third-party packages |
30+
| `target` (required) | references the target bundle (e.g. `"./dist/bundle.js"`) | relative file path |
31+
| `compact` | activates bundle compression <br> NB: only takes effect if compacting is activated globally (typically via `--compact`) <br> certain options require faucet-pipeline-jsmin | `compact` (default), `minify` or `mangle` |
32+
| `sourcemaps` | if truthy, activates inline source-map generation <br> NB: only takes effect if source maps are activated globally (typically via `--sourcemaps`) | `false` suppresses source maps |
33+
| `format` | determines the bundle format | `iife` (default), `esm`, `umd`, `amd` or `commonjs` - all case-insensitive |
34+
| `exports` | determines the bundle's API; the name of the value exported by the `source` module, if any (e.g. `"MYLIB"`, which would become a global variable for IIFEs) | |
35+
| `extensions` | additional file extensions for loading modules (e.g. `[".es"]`) | |
36+
| `externals` | determines which modules/packages to exclude from the bundle (e.g. `{ jquery: "jQuery" }`) | an object whose key refers to the respective module/package name, the value refers to a corresponding global variable |
37+
| `esnext` | if truthy, activates ESNext transpilation (typically determined by Browserslist) <br> requires faucet-pipeline-esnext | |
38+
| `esnext.browserslist` | custom Browserslist entry selection (e.g. `esnext: { browserslist: "legacy" }`) | the name of the Browserslist group to select <br> `false` suppresses automatic configuration via Browserslist |
39+
| `esnext.exclude` | modules/packages for which to skip transpilation <br> this might be useful when importing distributions already optimized for ES5, for example (e.g. `esnext: { exclude: ["jquery"] }`) | |
40+
| `jsx` | if truthy, activates JSX transpilation (automatically adding `.jsx` file extensions) <br> additionally accepts the same options as `esnext` <br> requires faucet-pipeline-jsx | |
41+
| `jsx.pragma` | determines the function to use for JSX expressions (e.g. `jsx: { pragma: "createElement" }`) | |
42+
| `jsx.fragment` | determines the function to use for JSX fragments (e.g. `jsx: { fragment: "Fragment" }`) | |
43+
| `typescript` | if truthy, activates TypeScript transpilation (automatically adding `.ts` file extensions) <br> anything other than `true` will be passed through as TypeScript compiler options <br> requires faucet-pipeline-typescript | |
4444

4545

4646
Contributing

0 commit comments

Comments
 (0)