A turnkey template and testing playground for the lib-config-ts monorepo.
Important
These configuration files are designed to be extended, not replaced. To ensure stability and receive future updates from the libraries, keep the core imports intact and add your project-specific settings in the "Overrides" sections.
We recommend using Node version lts/krypton -> v24.14.1.
| Package | Config File | Purpose |
|---|---|---|
@vbetsch/config-eslint |
eslint.config.mjs | Linting with Type Safety |
@vbetsch/config-jest |
jest.config.mjs | Testing with SWC support |
@vbetsch/config-prettier |
.prettierrc.mjs | Code Formatting |
@vbetsch/config-tsconfig |
tsconfig.json tsconfig.build.json | TS Compilation & Build |
Utility Templates:
This repository is pre-configured. To start a new project:
- Clone this repository.
- Clean up: Remove example files in
src/andtests/. - Customize
package.json: Modify as you want. Keep only the@vbetschpackages you actually need. - Run
npm installcommand. - Configure & Override:
- Docstrings: These define the configuration chapters.
- Single comments: These are optional examples or overrides. Feel free to uncomment, modify, or add your own rules here to suit your project.
To ensure you have the latest stable versions and a clean environment:
npm cache clean --force
npm install -D @vbetsch/config-eslint@latest @vbetsch/config-jest@latest @vbetsch/config-prettier@latest @vbetsch/config-tsconfig@latest --prefer-onlineValidate your setup by running the following commands in order:
npm run start:dev # Check development execution
npm run prettier # Format code
npm run jest # Run tests
npm run tsconfig # Type-check
npm run eslint # Lint code
npm run tsconfig:build # Run production build
npm run start:prod # Check production executionContributions are welcome! To get started, please ensure you have an approved issue before submitting a PR.