Generate RunOptions from cli-options (#1138)

Author: raineorshine

.github/CONTRIBUTING.md

@@ -1,3 +1,5 @@
+## Filing an issue
+
 Make sure you read the list of [known issues](https://github.com/raineorshine/npm-check-updates#known-issues) and search for [similar issues](https://github.com/raineorshine/npm-check-updates/issues) before filing an issue.
 
 When filing an issue, please include:
@@ -7,3 +9,13 @@ When filing an issue, please include:
 - npm-check-updates version
 - the relevant package names and their specified versions from your package file
 - ...or the output from `npm -g ls --depth=0` if using global mode
+
+## Design
+
+The _raison d'être_ of npm-check-updates is to upgrade package.json dependencies to the latest versions, ignoring specified versions. Suggested features that do not fit within this objective will be considered out of scope.
+
+npm-check-updates maintains a balance between minimalism and customizability. The default execution with no options will always produce simple, clean output. If you would like to add additional information to ncu's output, you may propose a new value for the `--format` option.
+
+## Adding a new CLI or module option
+
+All of ncu's options are generated from [/src/cli-options.ts](https://github.com/raineorshine/npm-check-updates/blob/main/src/cli-options.ts). You can add a new option to this file and then run `npm run build` to automatically generate README, CLI help text, and Typescript definitions.

.github/ISSUE_TEMPLATE.md

@@ -6,6 +6,26 @@
 
 ## Steps to Reproduce
 
+.ncurc:
+
+<!-- If you use a .ncurc config file, specify it here. ncu options have a dramatic effect on its behavior. -->
+
+```js
+
+```
+
+Dependencies:
+
+<!-- If the suggested upgrades are not what you expect, make sure to List your package.json dependencies here so the issue can be reproduced. -->
+
+```json
+
+```
+
+Steps:
+
+<!-- The exact steps taken to arrive at the unexpected behavior. -->
+
 ## Current Behavior
 
 ## Expected Behavior

README.md

@@ -155,9 +155,10 @@ ncu "/^(?!react-).*$/" # windows
                              continuous integration). (default: 1)
 -f, --filter <matches>       Include only package names matching the given
                              string, wildcard, glob, comma-or-space-delimited
-                             list, or /regex/.
+                             list, /regex/, or predicate function.
 --filterVersion <matches>    Filter on package version using
-                             comma-or-space-delimited list, or /regex/.
+                             comma-or-space-delimited list, /regex/, or
+                             predicate function.
 --format <value>             Enable additional output data, string or
                              comma-delimited list: ownerChanged, repo.
                              ownerChanged: shows if the package owner changed
@@ -195,9 +196,10 @@ ncu "/^(?!react-).*$/" # windows
 -r, --registry <url>         Third-party npm registry.
 -x, --reject <matches>       Exclude packages matching the given string,
                              wildcard, glob, comma-or-space-delimited list,
-                             or /regex/. (default: [])
+                             /regex/, or predicate function. (default: [])
 --rejectVersion <matches>    Exclude package.json versions using
-                             comma-or-space-delimited list, or /regex/.
+                             comma-or-space-delimited list, /regex/, or
+                             predicate function.
 --removeRange                Remove version ranges from the final package
                              version.
 --retry <n>                  Number of times to retry failed requests for
@@ -292,6 +294,10 @@ const upgraded = await ncu.run({
 console.log(upgraded) // { "mypackage": "^2.0.0", ... }
 ```
 
+## Contributing
+
+Contributions are happily accepted. I respond to all PR's and can offer guidance on where to make changes. For contributing tips see [CONTRIBUTING.md](https://github.com/raineorshine/npm-check-updates/blob/main/.github/CONTRIBUTING.md).
+
 ## Known Issues
 
 - If `ncu` prints output that does not seem related to this package, it may be conflicting with another executable such as `ncu-weather-cli` or Nvidia CUDA. Try using the long name instead: `npm-check-updates`.

package.json

@@ -26,9 +26,9 @@
   },
   "main": "build/src/index.js",
   "scripts": {
-    "build": "npm run build:ts && npm run build:readme",
+    "build": "npm run build:ts && npm run build:options",
     "build:ts": "tsc",
-    "build:readme": "node scripts/buildReadme.js",
+    "build:options": "node build/src/scripts/build-options.js && tsc",
     "lint": "cross-env FORCE_COLOR=1 npm-run-all --parallel --aggregate-output lint:*",
     "lint:lockfile": "lockfile-lint",
     "lint:markdown": "markdownlint \"**/*.md\" --ignore node_modules --ignore build --config .markdownlint.js",