charliez0 / js.org-cleanup Goto Github PK

These are the scripts behind the annual js.org cleanup process.

These scripts operate as a small CLI tool, by running node index.js.

There are four options within the CLI:

• --perfect : Generates a perfectly formatted and sorted cnames_active file
• --main-issue : Initiates the annual cleanup by creating the main cleanup issue
• --main-pr <issueNumber> : Completes the annual cleanup by parsing issue and creating PR
• --validate <filePath> [--fix] : Validates a given cnames_active file for perfect formatting

When using --perfect, --main-issue, or --main-pr, you will need to have a config.json file created in the root of the repository following config.example.json.

If you are using --validate, then no config is needed as this operates against a given local file path rather than using the GitHub API. This option can also be passed a --fix flag after the file path to automatically fix any violations.

js-org-cleanup/simulated-js.org#46

js-org-cleanup/simulated-automatic-contact#12

js-org-cleanup/simulated-js.org#47