Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kurone-kito/yarn-project-boilerplate
📄 The boilerplate of the Yarn project with PnP; since 2022.4
https://github.com/kurone-kito/yarn-project-boilerplate
boilerplate-template commitlint eslint example-project prettier template-project typescript yarn-berry
Last synced: 19 days ago
JSON representation
📄 The boilerplate of the Yarn project with PnP; since 2022.4
- Host: GitHub
- URL: https://github.com/kurone-kito/yarn-project-boilerplate
- Owner: kurone-kito
- License: mit
- Created: 2022-04-12T10:49:37.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T23:05:17.000Z (about 2 months ago)
- Last Synced: 2024-10-17T01:38:36.558Z (about 1 month ago)
- Topics: boilerplate-template, commitlint, eslint, example-project, prettier, template-project, typescript, yarn-berry
- Language: JavaScript
- Homepage:
- Size: 6.85 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.ja.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.ja.md
Awesome Lists containing this project
README
# 📄 Yarn project boilerplate
## Features
- Yarn (berry) with PnP
- TypeScript
- ESLint
- Prettier
- Commitlint with Husky
- Visual Studio Code / Vim ready
- CI configurations
- CodeRabbit
- Dependabot
- GitHub Actions
## System Requirements
- Node.js
- Hydrogen LTS (`^18.20.4`)
- Iron LTS (`^20.10`)
- `>=22`
## Install the dependencies
```sh
corepack enable
yarn install
```
## Linting
```sh
yarn run lint
yarn run lint:fix # Lint and auto-fix
```
## Testing
```sh
yarn run test
```
Currently, the command works as an alias for the `yarn run lint` command.
## Cleaning
```sh
yarn run clean
```
## Migrate to NPM
```sh
# 1. Remove all untracked files
git clean -fdx
# 2. Patch to the project
patch -p1 < patches/migrate-to-npm.patch
# 3. Remove some files
npm x -y -- rimraf .yarn .yarnrc.yml yarn.lock
# 4. Install the dependencies
npm install
# (Optional) 5. Commit the changes
git add -A
git commit -m 'chore: migrate to NPM'
```
## Rules for Development
Welcome to contribute to this repository! For more details,
please refer to [CONTRIBUTING.md](.github/CONTRIBUTING.md).
Introduce commit message validation at commit time.
The “**[Conventional Commits](https://www.conventionalcommits.org/ja/)**”
rule is applied to discourage committing messages that violate conventions.
## LICENSE
MIT