https://github.com/jens-ox/sane-code

Check JS repos for sanity.
https://github.com/jens-ox/sane-code

Last synced: 24 days ago
JSON representation

Check JS repos for sanity.

• Host: GitHub
• URL: https://github.com/jens-ox/sane-code
• Owner: jens-ox
• Created: 2022-06-05T19:19:09.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-07-09T12:46:19.000Z (over 2 years ago)
• Last Synced: 2024-01-24T15:03:40.103Z (10 months ago)
• Language: TypeScript
• Size: 1.1 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Sane Code

Run `npx sane-code` in your repo to check for things like

- JSON Schema validity of your `package.json`, `.eslintrc.js` etc

- unnecessary defaults in config files like `tsconfig.json` or `package.json`

- subjective code smells like `@types/*` in `dependencies` instead of `devDependencies`

- whether or not linting is set up

- if there's only one type of lockfile present

- whether or not the project depends on deprecated packages

- best practices like no hard-pins of dependencies, test script set up

- recommendations like enabling `esModuleInterop` in `tsconfig.json` etc

- unused TypeScript exports

- unused TypeScript symbols

Feel free to open issues if you have suggestions for more checks :relaxed:

## Development

1. Clone the repo

2. Add some checks

3. Run `npm run start` to run the checks on the `sane-code` repo itself