An open API service indexing awesome lists of open source software.

https://github.com/kurone-kito/builder-config

⚙️ My configuration for the TypeScript, Vite, ...and others; since 2023.3
https://github.com/kurone-kito/builder-config

empty yet

Last synced: 11 months ago
JSON representation

⚙️ My configuration for the TypeScript, Vite, ...and others; since 2023.3

Awesome Lists containing this project

README

          

# 📄 PNPM project template

## Features

- PNPM
- TypeScript
- Biome
- Commitlint with Husky
- Visual Studio Code / Vim ready
- CI configurations
- CodeRabbit
- Dependabot
- GitHub Actions

## how to use this template

You can create a new project by using `degit` or the “Use this template”
button on GitHub.

```sh
npx degit kurone-kito/pnpm-project-template my-project
cd my-project
pnpm install
```

After generating the project, update `package.json` fields such as `name`
and `author` so that they reflect your project information.

### Example settings

#### Monorepo

Add package directories to `pnpm-workspace.yaml`:

```yaml
packages:
- packages/*
```

#### Non-monorepo

Remove `pnpm-workspace.yaml` if you do not need workspace support.

## System Requirements

- Node.js: Any of the following versions
- Iron LTS (`^20.11.x`)
- Jod LTS `^22.x.x` or
- Latest `>=24.x.x`

Note that this template includes `.node-version`, `.nvmrc`, and
`.tool-versions` files with specific Node.js versions. These files
currently list `20.19.2`, so update them and this section as needed when
you start a new project.

## Install the dependencies

```sh
corepack enable
pnpm install
```

## Linting

```sh
pnpm run lint
pnpm run lint:fix # Lint and auto-fix
```

## Testing

```sh
pnpm run test
```

Currently, the command works as an alias for the `pnpm run lint` command.
Set up your own testing framework and replace this script as needed.

## Cleaning

```sh
pnpm run clean
```

## Rules for Development

Welcome to contribute to this repository! For more details,
please refer to [CONTRIBUTING.md](.github/CONTRIBUTING.md).

## LICENSE

MIT