Rocketmakers Bitrot Tool
A tool allowing Rocketmakers to detect bitrot in projects.
The main focus of this tool is to notify about versions becoming outdated over time.
To setup this in your project you will need to:
-
Add yaml extension from vscode marketplace
-
Add the below to .vscode/settings.json in the root of your project
"yaml.schemas": {
"node_modules/bitrot/schema.json": "bitrot.yaml",
},
-
Add bitrot.yaml to the root of your project using node_modules/bitrot/schema.json to validate/help, an example is below:
projects:
- name: 'backend'
path: 'backend'
tags: ['node']
justifications:
- rule: 'pkg:npm/mocha'
reason: 'Not switched to Jest yet'
This can then be ran using npx @rocketmakers/bitrot
which if not installed will run the latest version. If you install bitrot as a package you will be locked to a specific version and will not receive rule updates.