README

@modyqyw/fabric

Opinionated shareable specification for different JavaScript/TypeScript projects.

Requires:

Latest Node 12/14/16
Latest npm 6/7/8
Set shamefully-hoist=true in .npmrc if using latest pnpm 6 instead of npm
Set nodeLinker: 'node-modules' in .yarnrc.yml if using latest yarn 2/3 instead of npm
ESLint 8
Stylelint 14
Postcss 8

Check @modyqyw/fabric@3 (deprecated) For ESLint 7, Stylelint 13 and Postcss 7.

Using pnpm in examples below. Check nrm for mirror support.

Usage

# locally
pnpm install -D @modyqyw/fabric@~4.12.0

# globally
pnpm install -g @modyqyw/fabric@~4.12.0

See more about version here.

CLI

CLI is used to config your new projects easier.

# if you install globally
# in current dir
mo-fabric config
# specify PROJECT_DIR
mo-fabric config ./

# if you install locally
# in current dir
./node_modules/.bin/mo-fabric config

CLI will not keep your original configs. Use CLI in old projects on your own risk.

Naming

Naming is very hard and hardly be checked by linters. However, there are still relevant naming suggestions available.

JavaScript/TypeScript - kettannaito/naming-cheatsheet
CSS/LESS/SCSS/SASS - BEM, OOCSS, ACSS, SMACSS, CSS Modules

Besides, you can learn naming from some open-source projects, such as bootstrap, tailwindcss, primer css, bulma, mui, antd, vuetify and element-plus.

In my opinion, simplicity and clarity are the highest priority for naming.

Git

Learn about Git, Git flow, Github flow, Gitlab flow and Gif LFS.

git config --global core.autocrlf false
git config --global init.defaultBranch main

For SSH keys, check Connecting to GitHub with SSH, which also works for other git systems like Gitlab and Gitee.

Set up .gitattributes.

* text=auto

A better .gitattributes example here.

A .gitignore example here.

EditorConfig

Learn about EditorConfig.

Set up .editorconfig.

root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

tsconfig.json

Learn about tsconfig.json.

You should ONLY use this in a new project without tsconfig.json. Extends, then customize.

{
  "extends": "./node_modules/@modyqyw/fabric/tsconfig.base.json",
  "compilerOptions": {
    // set baseUrl
    "baseUrl": ".",
    // on-demand set lib, default ["ESNext"]
    "lib": ["ESNext", "DOM", "DOM.iterable"],
    // on-demand set target, default ESNext
    "target": "ESNext",
    // on-demand set jsx, default preserve
    "jsx": "react-jsx",
    // on-demand set paths, default {}
    "paths": {
      "@/*": ["./src/*"]
    },
    // if you are facing a infer problem
    "preserveSymlinks": true,
    // on-demand set types, default []
    "types": [
      // uni-app
      "@dcloudio/types",
      // element-plus
      "element-plus/global",
      // jest
      "jest",
      // jsdom
      "jsdom",
      // alipay miniprogram
      "mini-types",
      // wechat miniprogram
      "miniprogram-api-typings",
      // node
      "node",
      // type-fest
      "type-fest",
      // unplugin-icons
      "unplugin-icons/types/react",
      "unplugin-icons/types/vue",
      // unplugin-vue2-script-setup
      "unplugin-vue2-script-setup/ref-macros",
      "unplugin-vue2-script-setup/types",
      // vitest
      "vitest",
      "vitest/global",
      // vite-plugin-pages
      "vite-plugin-pages/client",
      "vite-plugin-pages/client-react",
      // vite-plugin-vue-layouts
      "vite-plugin-vue-layouts/client",
      // vite
      "vite/client",
      // vue3 setup
      "vue/macros-global",
      // webpack
      "webpack-env"
    ],
    // on-demand set types, default ESNext
    "target": "ES5"
  },
  // volar, @vue/runtime-dom and vue2
  "vueCompilerOptions": {
    "experimentalCompatMode": 2,
    "experimentalTemplateCompilerOptions": {
      "compatConfig": { "MODE": 2 }
    }
  },
  // ts-node
  // pnpm install -D tsconfig-paths
  "ts-node": {
    "require": ["tsconfig-paths/register"]
  },
  // on-demand set include
  "include": [
    "./**/.*.js",
    "./**/.*.cjs",
    "./**/.*.mjs",
    "./**/*.js",
    "./**/*.cjs",
    "./**/*.mjs",
    "./**/*.jsx",
    "./**/.*.ts",
    "./**/.*.cts",
    "./**/.*.mts",
    "./**/*.ts",
    "./**/*.cts",
    "./**/*.mts",
    "./**/*.tsx",
    "./**/*.vue",
    "./**/*.svelte"
  ],
  // on-demand set exclude
  "exclude": [".cache", ".temp", ".tmp", "dist*", "node_modules"]
}

See tsconfig.base.json for default configs.

Prettier

Learn about Prettier.

pnpm install -D prettier@~2.5.1

Set up .prettierrc.cjs.

const { prettier } = require('@modyqyw/fabric');

module.exports = {
  ...prettier,
};

ESLint

Learn about ESLint.

pnpm install -D eslint@~8.8.0 @babel/core@~7.17.2 @babel/eslint-parser@~7.17.0

If you are using typescript, additional dependencies are needed.

pnpm install -D typescript@~4.5.5 @typescript-eslint/eslint-plugin@~5.11.0 @typescript-eslint/parser@~5.11.0

Set up .eslintrc.cjs.

const { eslint } = require('@modyqyw/fabric');

module.exports = {
  // vanilla
  ...eslint.vanilla,

  // vanilla + prettier
  // ...eslint.vanillaPrettier,

  // react17
  // ...eslint.react,

  // react17 + prettier
  // ...eslint.reactPrettier,

  // vue2
  // ...eslint.vue2,

  // vue2 + prettier
  // ...eslint.vue2Prettier,

  // vue2 + typescript
  // ...eslint.vue2Typescript,

  // vue2 + typescript + prettier
  // ...eslint.vue2TypescriptPrettier,

  // vue3
  // ...eslint.vue3,

  // vue3 + prettier
  // ...eslint.vue3Prettier,

  // vue3 + typescript
  // ...eslint.vue3Typescript,

  // vue3 + typescript + prettier
  // ...eslint.vue3TypescriptPrettier,

  // svelte
  // ...eslint.svelte,

  // svelte + prettier
  // ...eslint.sveltePrettier,

  // svelte + typescript
  // ...eslint.svelteTypescript,

  // svelte + typescript + prettier
  // ...eslint.svelteTypescriptPrettier,
};

Set up package.json. Use .gitignore as the ignore pattern file here.

{
  ...,
  "scripts": {
    ...,
    "lint": "pnpm run lint:eslint",
    "lint:eslint": "eslint . --fix --ext=.js,.cjs,.mjs,.jsx,.ts,.cts,.mts,.tsx,.vue,.svelte --ignore-path=.gitignore"
  }
}

You should declare paths in tsconfig.json if you are using path aliases.

Stylelint

Learn about Stylelint.

pnpm install -D stylelint@~14.4.0

Set up .stylelintrc.cjs.

const { stylelint } = require('@modyqyw/fabric');

module.exports = {
  // css
  ...stylelint.css,

  // css + prettier
  // ...stylelint.cssPrettier,

  // less
  // ...stylelint.less,

  // less + prettier
  // ...stylelint.lessPrettier,

  // scss / sass
  // ...stylelint.scss,

  // scss / sass + prettier
  // ...stylelint.scssPrettier,
};

Set up package.json. Use .gitignore as the ignore pattern file here.

{
  ...,
  "scripts": {
    ...,
    "lint": "pnpm run lint:stylelint",
    "lint:stylelint": "stylelint \"./**/*.{css,less,scss,sass,vue,svelte}\" --fix --allow-empty-input --ignore-path=.gitignore"
  }
}

Markdownlint

Learn about Markdown and Markdownlint.

pnpm install -D markdownlint-cli@~0.31.1

Set up .markdownlint.json.

{
  "MD003": false,
  "MD013": false,
  "MD022": false,
  "MD024": false,
  "MD025": false,
  "MD033": false
}

Set up package.json. Use .gitignore as the ignore pattern file here.

{
  ...,
  "scripts": {
    ...,
    "lint": "pnpm run lint:markdownlint",
    "lint:markdownlint": "markdownlint . --fix --ignore-path=.gitignore"
  }
}

Commitlint

Learn about Commitlint and Conventional Commits.

pnpm install -D @commitlint/cli@~16.1.0

Set up .commitlintrc.cjs.

const { commitlint } = require('@modyqyw/fabric');

module.exports = {
  ...commitlint,
};

Commitizen

Learn about Commitizen.

pnpm install -D commitizen@~4.2.4

Set up package.json.

{
  ...,
  "scripts": {
    ...,
    "commit": "git-cz"
  },
  "config": {
    "commitizen": {
      "path": "./node_modules/@commitlint/cz-commitlint"
    }
  }
}

LintStaged

Learn about LintStaged.

pnpm install -D lint-staged@~12.3.3

Set up .lintstagedrc.cjs.

module.exports = {
  '*.md': 'markdownlint --fix',
  '*.{js,cjs,mjs,jsx,ts,cts,mts,tsx,vue,svelte}': 'eslint --fix',
  '*.{css,less,scss,sass,vue,svelte}': 'stylelint --fix',
};

Husky

Learn about Husky.

pnpm install -D is-ci@~3.0.1 husky@~7.0.4

npx husky install

Set up package.json.

{
  ...,
  "scripts": {
    ...,
    "prepare": "is-ci || husky install"
  }
}

Set up .husky/commit-msg hook.

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

npx --no-install commitlint --edit $1

Set up .husky/pre-commit hook.

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

npx --no-install lint-staged

Finally use chmod.

chmod +x .git/hooks/*
chmod +x .husky/*

Deploy

Experience has proven that automation is the best option. You may want to try packages below, sorted according to alphabetical order.

VSCode

Install plugins.
- ESLint
- markdownlint
- Prettier
- Sass
- Stylelint - 1.x version
- Svelte - For svelte
- Tailwind CSS IntelliSense - For TailwindCSS
- Volar - For vue3 and vue2, extra configs required if for vue2
- Vetur - For vue2
- uni-helper - If you are dealing with uni-*
- WindiCSS IntelliSense - For TailwindCSS / WindiCSS
Set up Settings.json.

{
  "css.validate": false,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.rulers": [{ "column": 100 }],
  "editor.tabSize": 2,
  "editor.wordWrap": "on",
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "svelte",
    "typescript",
    "typescriptreact",
    "vue"
  ],
  "files.eol": "\n",
  "files.associations": {
    "*.wxml": "html",
    "*.wxs": "javascript",
    "*.wxss": "css",
    "*.axml": "html",
    "*.sjs": "javascript",
    "*.acss": "css",
    "*.swan": "html",
    "*.ttml": "html",
    "*.ttss": "css",
    "*.jxml": "html",
    "*.jxss": "css",
    "*.wpy": "vue",
    "*.json": "jsonc",
    "*.json5: "jsonc",
    "*.nvue": "vue",
    "*.ux": "vue"
  },
  "less.validate": false,
  "scss.validate": false,
  "stylelint.snippet": ["css", "less", "scss", "sass", "vue", "svelte"],
  "stylelint.validate": ["css", "less", "scss", "sass", "vue", "svelte"],
  "[html]": {
    "editor.formatOnSave": true
  },
  "[javascript]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.eslint": true
    }
  },
  "[javascriptreact]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.eslint": true
    }
  },
  "[typescript]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.eslint": true
    }
  },
  "[typescriptreact]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.eslint": true
    }
  },
  "[css]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.stylelint": true
    }
  },
  "[less]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.stylelint": true
    }
  },
  "[scss]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.stylelint": true
    }
  },
  "[sass]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.stylelint": true
    }
  },
  "[svelte]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.eslint": true,
      "source.fixAll.stylelint": true
    }
  },
  "[vue]": {
    "editor.defaultFormatter": "octref.vetur",
    "editor.codeActionsOnSave": {
      "source.fixAll.eslint": true,
      "source.fixAll.stylelint": true
    }
  },
  "[json]": {
    "editor.formatOnSave": true
  },
  "[jsonc]": {
    "editor.formatOnSave": true
  },
  "[markdown]": {
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
      "source.fixAll.markdownlint": true
    }
  },
  "[yaml]": {
    "editor.formatOnSave": true
  }
}

If you are using Volar, remember to disable / remove Vetur and "editor.defaultFormatter": "octref.vetur".

If you are using TailwindCSS / WindiCSS, "editor.formatOnSave": true may be a better choice.

Migrate

Migrate 4.x from 3.x

Upgrade your node version to latest 12, 14 or 16.
Upgrade your npm version to latest 6, 7 or 8.
Upgrade your eslint version to latest 7 or 8.
Upgrade your stylelint version to latest 14.
Upgrade your prettier version to latest 2.
Upgrade your postcss version to latest 8.
Split Prettier. You can use ESLint/Stylelint with/without Prettier now. Default without Prettier.
Add tsconfig.json support.
Update CLI to match above changes. Use mo-fabric instead of modyqyw-fabric.

Migrate 3.x from 2.x

Upgrade your node version to ^12.22.6, ^14.17.6 or ^16.8.0.
Upgrade your npm version to ^6.14.15 or ^7.21.0.
Support CommonJS require and ESM import.
Prettier/ESLint/Stylelint/Commitlint config changed.

const { prettier, eslint, stylelint, commitlint } = require('@modyqyw/fabric');

import { prettier, eslint, stylelint, commitlint } from '@modyqyw/fabric';
...

Use eslint.vanilla instead of eslint.native.
Use stylelint.scss instead of stylelint.sass.

Migrate 2.x from 1.x

Just upgrade your node and dependencies versions.

Examples

See dependency graph.

Acknowledge

Sorted according to alphabetical order.

License

MIT

Usage no npm install needed!

README

@modyqyw/fabric

Usage

CLI

Naming

Git

EditorConfig

tsconfig.json

Prettier

ESLint

Stylelint

Markdownlint

Commitlint

Commitizen

LintStaged

Husky

Deploy

VSCode

Migrate

Migrate 4.x from 3.x

Migrate 3.x from 2.x

Migrate 2.x from 1.x

Examples

Acknowledge

License