1.0.3 • Published 5 months ago
@shinlms404/prettier-config v1.0.3
@shinlms404/prettier-config
My Prettier config preset
Tip: For an enhanced development experience, it's recommended to use this Prettier configuration in conjunction with @shinlms404/eslint-config. Check out the eslint-config repository for more details.
Installation
npm install @shinlms404/prettier-config --save-dev
Usage
In your project's prettier.config.js
file:
import prettierConfigs from '@shinlms404/prettier-config'
export default prettierConfigs()
Customs Rules
Name | Description | Default |
---|---|---|
sortPackageJson | Sort the keys of a package.json | true |
organizeImports | The import can automatically sort and remove unused imports | true |
Features
- Opinionated Prettier configuration
- Supports TypeScript
- Integrates with eslint for a consistent code style
Configuration
This configuration includes the following plugins:
Scripts
Tip: You need to install
@antfu/ni
andpnpm
first, otherwise some of the scripts may not work!
Install
npm install @antfu/ni -g
npm install pnpm -g
npm run build
: Build the project using tsupnpm run lint
: Run ESLintnpm run lint:fix
: Run ESLint with the --fix optionnpm run prepack
: Run nr buildnpm run prepare
: Set up simple-git-hooksnpm run release
: Bump the version and publish to npmnpm run stub
: Build a TypeScript stub using tsupnpm run test
: Run vitest for testingnpm run typecheck
: Run TypeScript type checkingnpm run watch
: Watch for changes using tsup
Contributing
Feel free to open issues and submit pull requests. Contributions are welcome!
License
This project is licensed under the MIT License - see the LICENSE file for details.