https://github.com/hojas/frontend-project-starter

A starter template for frontend project with commit lint.
https://github.com/hojas/frontend-project-starter

project starter template

Last synced: 11 days ago
JSON representation

A starter template for frontend project with commit lint.

• Host: GitHub
• URL: https://github.com/hojas/frontend-project-starter
• Owner: hojas
• License: mit
• Created: 2023-06-06T03:52:53.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-20T10:05:49.000Z (about 1 year ago)
• Last Synced: 2024-12-06T12:14:34.076Z (2 months ago)
• Topics: project, starter, template
• Language: Shell
• Homepage:
• Size: 623 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# frontend-project-starter

A starter template for frontend project with commit lint.

## Features

- [x] ESLint

- [x] StyleLint

- [x] commitlint

- [x] husky

- [x] lint-staged

- [x] commitizen

- [x] conventional-changelog

## Init commitlint

https://commitlint.js.org/#/guides-local-setup

```shell

$ pnpm add -D @commitlint/{config-conventional,cli}

$ echo "module.exports = { extends: ['@commitlint/config-conventional'] }" > commitlint.config.js

```

## Init husky

https://typicode.github.io/husky/getting-started.html

```shell

$ pnpm dlx husky-init && pnpm install

$ pnpm husky add .husky/commit-msg 'pnpm commitlint --edit "$1"'

```

Edit `.husky/pre-commit`:

```shell

#!/usr/bin/env sh

. "$(dirname -- "$0")/_/husky.sh"

pnpm lint-staged --allow-empty "$1"

```

## Init cz

http://commitizen.github.io/cz-cli/

```shell

$ pnpm add -D commitizen cz-conventional-changelog

```

Touch `.czrc`:

```json

{

  "path": "cz-conventional-changelog"

}

```

Touch file `.husky/prepare-commit-msg`:

```shell

#!/usr/bin/env sh

. "$(dirname -- "$0")/_/husky.sh"

exec < /dev/tty && pnpm cz --hook || true

```