1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
|
Description: Help md format fixes
These changes are useful to make a nicer man page
Forwarded: not-needed
Reviewed-By: Yadd <yadd@debian.org>
Last-Update: 2022-04-28
--- a/cli/help.md
+++ b/cli/help.md
@@ -1,9 +1,13 @@
-rollup version __VERSION__
-=====================================
+rollup(1) -- module bundler for JavaScript
+=========================================================
-Usage: rollup [options] <entry file>
+SYNOPSIS
+--------
-Basic options:
+rollup [options] <entry file>
+
+OPTIONS
+-------
-c, --config <filename> Use this config file (if argument is used but value
is unspecified, defaults to rollup.config.js)
@@ -93,24 +97,34 @@
--watch.onStart <cmd> Shell command to run on `"START"` event
--watch.skipWrite Do not write files to disk when watching
-Examples:
+EXAMPLES
+--------
-# use settings in config file
+* use settings in config file
+```
rollup -c
+```
-# in config file, process.env.INCLUDE_DEPS === 'true'
-# and process.env.BUILD === 'production'
+* in config file, process.env.INCLUDE_DEPS === 'true'
+and process.env.BUILD === 'production'
+```
rollup -c --environment INCLUDE_DEPS,BUILD:production
+```
-# create CommonJS bundle.js from src/main.js
+* create CommonJS bundle.js from src/main.js
+```
rollup --format=cjs --file=bundle.js -- src/main.js
+```
-# create self-executing IIFE using `window.jQuery`
-# and `window._` as external globals
+* create self-executing IIFE using `window.jQuery`
+and `window._` as external globals
+```
rollup -f iife --globals jquery:jQuery,lodash:_ \
-i src/app.js -o build/app.js -m build/app.js.map
+```
-Notes:
+NOTES
+-----
* When piping to stdout, only inline sourcemaps are permitted
|