presetter-preset-strict
v7.1.0
Published
An extension of the cjs/esm preset to provide stricter lint rules for typescript projects
Downloads
452
Readme
🏄🏻 A collection of opinionated configurations for a typescript project for presetter
• Quick Start • Project Structure • Customization • Scripts •
presetter-preset-strict is an opinionated preset with stricter rules on eslint and vitest. It's designed to help you get started with a typescript project in a fraction of time you usually take via presetter.
To work with presetter-preset-strict, you'll need another preset like presetter-preset-esm
for ESM support and other basic toolings.
You can check out the additional rules here.
In addition to a set of opinionated configuration files, it also provides a number of essential lifecycle and helper commands.
Quick Start
FULL DOCUMENTATION IS AVAILABLE HERE
1. Bootstrap your project with presetter-preset-strict
On your project root, create a presetter.config.ts
file with the following content:
// presetter.config.ts
import { preset } from 'presetter';
import esm from 'presetter-preset-esm';
import strict from 'presetter-preset-strict';
export default preset('project name', {
// NOTE
// you may need an additional preset like presetter-preset-esm for ESM support and other basic toolings
extends: [esm, strict],
override: {
// override the configuration here
},
});
Then, install your project as usual with npm install
or any package manager you prefer.
2. Develop and run life cycle scripts provided by the preset
At this point, all development packages specified in the preset are installed, and now you can try to run some example life cycle scripts (e.g. run prepare).
Project Structure
After installation, your project file structure should resemble the following, or include more configuration files if you also installed other presets.
Implement your business logic under source
and prepare tests under spec
.
TIPS You can always change the source directory to other (e.g. src) by setting the source
variable in presetter.config.ts
. See the customization section below for more details.
(root)
├─ .git
├─ .husky
├─ .lintstagedrc.json
├─ .npmignore
├─ .prettierrc.json
├─ presetter.config.ts
├─ node_modules
├─ source
│ ├─ <folders>
│ ├─ index.ts
│ ├─ (auxiliary).ts
├─ spec
│ ├─ *.spec.ts
├─ package.json
├─ eslint.config.ts
├─ tsconfig.json
├─ tsconfig.build.json
└─ vitest.config.ts
Customization
By default, this preset exports a handy configuration for a typescript project.
You can further customize (either extending or replacing) the configuration by specifying the changes in the config file presetter.config.ts
.
Script Template Summary
run build
: Transpile source code from typescript and replace any mapped pathsrun clean
: Clean up any previously transpiled coderun develop -- <file path>
: Create a service that run the specified file whenever the source has changedrun test
: Run all testsrun watch
: Rerun all tests whenever the source has changerun coverage
: Run all test with coverage reportrun release
: Bump the version and automatically generate a change logrun release -- --prerelease <tag>
: Release with a prerelease tag