Skip to content

documented configuration options #97

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

documented configuration options #97

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7aa0f76
documented configuration options
FND Mar 22, 2019
89c321c
merged examples into and extended descriptions
FND May 10, 2019
004c92d
re-ordered options, putting less frequently used ones towards the bottom
FND May 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,40 @@ faucet-pipeline-js
[faucet-pipeline](http://faucet-pipeline.org) plugin for bundling JavaScript
modules, along with extensions for ESNext, JSX and TypeScript

note that this repository comprises multiple packages; those residing within
`pkg` are merely meta-packages to simplify dependency management for users


Features and Configuration
--------------------------

supported global features:

* compacting
* Browserslist, determining transpilation targets
* source maps (inline)
* fingerprinting - NB: can be overriden with bundle-specific configuration

bundle-specific configuration:

| option | description | permitted values |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `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 |
| `target` (required) | references the target bundle (e.g. `"./dist/bundle.js"`) | relative file path |
| `format` | determines the bundle format | `iife` (default), `esm`, `umd`, `amd` or `commonjs` - all case-insensitive |
| `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) | |
| `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 |
| `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` |
| `esnext` | if truthy, activates ESNext transpilation (typically determined by Browserslist) <br> requires faucet-pipeline-esnext | |
| `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 |
| `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"] }`) | |
| `jsx` | if truthy, activates JSX transpilation (automatically adding `.jsx` file extensions) <br> additionally accepts the same options as `esnext` <br> requires faucet-pipeline-jsx | |
| `jsx.pragma` | determines the function to use for JSX expressions (e.g. `jsx: { pragma: "createElement" }`) | |
| `jsx.fragment` | determines the function to use for JSX fragments (e.g. `jsx: { fragment: "Fragment" }`) | |
| `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 | |
| `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 |
| `extensions` | additional file extensions for loading modules (e.g. `[".es"]`) | |


Contributing
------------
Expand Down