Tool designed to facilitate the setup of development configurations. It includes configurations for commonly used tools like Prettier, ESLint, and TS-Config, which can be time-consuming to configure manually.
npx @lgauthier1-packages/dev-config@latest
- FEAT: Copy a simple JSON config for prettier, eslint, and gitignore.
- TECH: Enable eslint and prettier for this repository.
- FEAT: Publish this repository to npm for easy use with npx.
- TECH: Set up a CI/CD pipeline to automatically bump and publish to npm.
- FEAT: Update package.json dependencies & script
- FEAT: Option to enable conventionnal-commit commit hook
- FEAT: Option to enable prettier & eslint pre-commit hook
- FEAT: Add advice after execution
- TECH: Write tests and run tests
- ...
Package deployment is automated based on events on the main branch:
- When a pull request is made to the main branch (or commit), an autobump is triggered (see .github/workflows/xxxxx.yml) that updates the version of the package.json and pushes a tag.
- When a new tag is pushed to the main branch, a package is pushed to the npm registry "lgauthier1-packages".
ℹ️ SETUP:
If you fork this repository, some settings are required to enable the C.I.C.D:
- Add npm
NPM_TOKEN
in https://github.com/{GITHUB_USER}/{YOUR_REPO}/settings/secrets/actions - Add
Read and write permission
in Workflow permissions section https://github.com/{GITHUB_USER}/{YOUR_REPO}/settings/actions