Hans a6f80e4fe7 Various QoL with TSLint and Docs (#12655)
* docs: add README files to all root folders

Except benchmark and tools.

* refactor: move rules/ directory to etc/

And fix a linting error that was found while updating tslint usage

* ci: lint errors out if TSLint shows a warning

This is not a warning from the code itself, but from TSLint. For example,
if a rule was missing, TSLint will just ignore the rule, show something on
STDOUT and not fail.

This fixes CI where local rules were missing for unknown reasons. It will
now fail CI when that happens, which is the correct behaviour.
2018-10-23 11:59:16 -07:00
..
ng
2018-06-05 18:50:06 -07:00

/bin Folder

This folder includes binaries that are linked when globally linking this repository.

Each file in this directory follows this pattern:

  1. JavaScript only.
  2. Requires ../lib/bootstrap-local.js to bootstrap TypeScript and Node integration.
  3. Requires ../lib/packages and use the package metadata to find the binary script for the package the script is bootstrapping.
  4. Call out main, or simply require the file if it has no export.

devkit-admin does not follow this pattern as it needs to setup logging and run some localized logic.

In order to add a new script, you should make sure it's in the root package.json, so people linking this repo get a reference to the script.