This is a template repository I created for my projects. You can freely use it if you find it conventient. PRs welcome!
I hate the monotony. I am so tired of repetitive steps of setting up new repositories. All those copy-pastes of .github/, tsconfig.json and the others, ESLint config and package.json updates, and all the other mundane stuff literally drive me crazy. π‘
To help myself, I decided to create this repository. It is intended to be used for Node projects with TypeScript but I hope it can be extended for other purposes as well. PRs and ideas are welcome!
- β all things that need to be ignored are ignored
- π set up for TypeScript
- β no semicolons (they will be added upon transpilation anyway, why bother?)
- π testing with AVA (coverage with
yarn test:coverincluded) - β coverage is set up to be at least 80%
- β linting with XO
- π± linting commits with commitlint set up for gitmoji
- βοΈ git hooks for formatting staged files + linting commit messages (on
commit message) and linting + coverage testing (onpre-push) - π formatting with XO and Prettier
- π no config files (all configuration in
package.json) - π Basic docs provided (MIT license, Code of Conduct, Contributing, Getting Started, Codeowners, Funding, PR template, Bug and Feature issue templates, Security)
- π Workflows for GitHub Actions set up for linting and test coverage
Things below are the things I need myself. If you think something else can be provided, let me know by creating a feature request issue.
- Automated way to change project name, description (and, hopefully, author)