Add scripts to CONTRIBUTING

Author: SleeplessByte

CONTRIBUTING.md

@@ -107,10 +107,89 @@ like.
 
 Find all _technical_ details in [the doc about 📝 Comments][docs-comments].
 
+## Tools
 
-[issue-discussion]: https://github.com/exercism/javascript-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3A%22discussion%22%3Aspeech_balloon%3A
-[issue-new-exercise]: https://github.com/exercism/javascript-analyzer/labels/new%20exercise%20%3Asparkles%3A
-[sample-resistor-color]: https://github.com/exercism/javascript-analyzer/issues/13
+We use various tools to maintain this repository and this analyzer. In order
+to contribute to the _code_ of this track, you'll need NodeJS (LTS or higher)
+installed, with some of the [`bin/*`][file-bin] files having extra dependencies,
+as listed in their file-level commentary.
+
+### `analyze` (.sh, .bat)
+
+```shell
+./bin/analyze.sh two-fer ~/folder/to/solution -dcp
+```
+
+This runs the analyzer using `two-fer` as exercise and a path to a solution.
+Most scripts, including this one, accept a wide range of flags to change or
+enhance the behaviour, as coded in [`execution_options.ts`][file-execution-options].
+
+Run with the `-h` / `--help` flag to get a list of flags and their description.
+
+```shell
+./bin/analyze.sh --help
+```
+
+You'll most likely want `-dcp` (`--debug`,`--console` and `--pretty`) during 
+development, which enables console output (instead of `stdout`/`stderr`) and 
+shows `logger.log` as well as `logger.error` and `logger.fatal`. It will also
+format the output JSON with 2 space indentation, both in the output file and
+the console.
+
+If you wish to _preview_ the actual messages, pass in `--noTemplates` to use
+the analyzer `Comment`Factories to generate actual messages. If the comment
+factories are kept in-sync with `website-copy`, it will be the exact same
+output as on the site.
+
+### `batch` (.sh, .bat)
+
+```shell
+./bin/batch.sh two-fer -cp
+```
+
+Runs all the fixtures in `~/test/fixtures/two-fer` through the analyzer, giving
+a summary at the end with all results. This places an `analysis.json` in the
+source fixture folder.
+
+You'll most likely want `-cp`  (`--console` and `--pretty`) during development, 
+which enables console output (instead of `stdout`/`stderr`) and formats the 
+output JSON with 2 space indentation.
+
+If you wish to _preview_ the actual messages, pass in `--noTemplates` to use
+the analyzer `Comment`Factories to generate actual messages. If the comment
+factories are kept in-sync with `website-copy`, it will be the exact same
+output as on the site.
+
+### `remote` (.sh, .bat)
+
+```shell
+./bin/remote.sh https://exercism.io/tracks/javascript/exercises/two-fer/solutions/df3bb5d7131c44ea9c62206cc8d6c225 -dcp --dry
+```
+
+You need the [`exercism` cli][cli] in order for this to work. It takes an 
+_exercism solution url_. and downloads it using the `exercism` cli. It then
+runs the analyzer on it. 
+
+You'll most likely want `-dcp --dry` (`--debug`, `--pretty`, `--console` and 
+`dry run`) during development, which enables console output (instead of 
+`stdout`/`stderr`), shows `logger.log` as well as `logger.error` and 
+`logger.fatal`, pretty prints the JSON output and disables writing the output 
+to `analysis.json`.
+
+You can pass the following type of URLs:
+
+- Published solutions: `/tracks/javascript/exercises/<slug>/<id>`
+- Mentor solutions: `/mentor/solutions/<id>`
+- Your solutions: `/my/solutions/<id>`
+- Private solutions: `/solutions/<id>`
+
+If you wish to _preview_ the actual messages, pass in `--noTemplates` to use
+the analyzer `Comment`Factories to generate actual messages. If the comment
+factories are kept in-sync with `website-copy`, it will be the exact same
+output as on the site.
+
+[ast-explorer]: https://astexplorer.net/
+[cli]: https://github.com/exercism/cli
 [contributing-javascript]: https://github.com/exercism/javascript/blob/master/CONTRIBUTING.md
 [contributing-typescript]: https://github.com/exercism/typescript/
 [contributing-typescript-analyzer]: https://github.com/exercism/typescript-analyzer/blob/master/CONTRIBUTING.md
@@ -121,5 +200,9 @@ Find all _technical_ details in [the doc about 📝 Comments][docs-comments].
 [docs-comments]: /docs/comments.md
 [docs-interface]: https://github.com/exercism/automated-mentoring-support/blob/master/docs/interface.md
 [docs-guidelines]: https://github.com/exercism/automated-mentoring-support/blob/master/docs/guidelines.md
+[file-bin]: https://github.com/exercism/javascript-analyzer/tree/master/bin
+[file-execution-options]: https://github.com/exercism/javascript-analyzer/blob/master/src/utils/execution_options.ts
+[issue-discussion]: https://github.com/exercism/javascript-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3A%22discussion%22%3Aspeech_balloon%3A
+[issue-new-exercise]: https://github.com/exercism/javascript-analyzer/labels/new%20exercise%20%3Asparkles%3A
 [mentor-notes]: https://github.com/exercism/website-copy/tree/master/tracks/javascript/exercises
-[ast-explorer]: https://astexplorer.net/
+[sample-resistor-color]: https://github.com/exercism/javascript-analyzer/issues/13