@ddddurk/configs v1.0.2

@ddddurk/configs

Configs for using commitlint, eslint, husky, lint-staged, prettier, typescript, with yarn.

Installation

yarn add @commitlint/cli @commitlint/config-conventional @ddddurk/configs @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-simple-import-sort eslint-plugin-unused-imports husky lint-staged prettier typescript -D

Setup

1. Create prepare script to initialize husky in package.json:

{
  "scripts": {
    "prepare": "husky install"
  }
}

2. Run prepare script:

yarn prepare

Usage

commitlint

1. Create .commitlintrc.js:

module.exports = {
  ...require("@ddddurk/configs/commitlint.json")
};

2. Create .husky/commit-msg:

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx --no -- commitlint --edit ${1}

eslint and prettier

1. Create .d-eslint.js:

module.exports = require("@ddddurk/configs/eslint.json");

2. Create .prettierrc.js:

module.exports = {
  ...require("@ddddurk/configs/prettier.json")
};

3. Create .eslintrc.js:

module.exports = {
  extends: ["./.d-eslint", "prettier"]
};

4. Create .lintstagedrc.js:

module.exports = {
  ...require("@ddddurk/configs/lint-staged.json")
};

5. Create lint script in package.json:

{
  "scripts": {
    "lint": "eslint --fix './**/*.{js,json,jsx,ts,tsx}' && prettier --write .",
    "prepare": "husky install"
  }
}

6. Create .husky/pre-commit:

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx lint-staged

typescript

1. Create tsconfig.json:

{
  "extends": "@ddddurk/configs/tsconfig.json"
}