Package Exports

@modyqyw/fabric
@modyqyw/fabric/eslint/native
@modyqyw/fabric/prettier
@modyqyw/fabric/stylelint/scss

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@modyqyw/fabric) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@modyqyw/fabric

Shareable configs for different projects.

Github | Gitee

Usage

Install the dependency first.

npm i -D @modyqyw/fabric@~1.3.0
# or
# yarn add -D @modyqyw/fabric@~1.3.0

Then follow the corresponding guides.

Prettier

npm i -D prettier@~2.2.1
# or
# yarn add -D prettier@~2.2.1

// ${PROJECT_DIR}/prettier.config.js
/* eslint-disable import/no-extraneous-dependencies */
const config = require("@modyqyw/fabric/prettier");

module.exports = {
  ...config,
  // write your own rules here
};

ESLint

npm i -D eslint@~7.14.0
# or
# yarn add -D eslint@~7.14.0

// ${PROJECT_DIR}/.eslintrc.js
/* eslint-disable import/no-extraneous-dependencies */
// for js and ts
const config = require("@modyqyw/fabric/eslint/native");

// for react, react-native, taro3 and rax, with js or ts
// const config = require("@modyqyw/fabric/eslint/react");

// for vue2 and uni-app, with js
// const config = require("@modyqyw/fabric/eslint/vue2");

// for vue2 and uni-app, with ts
// const config = require("@modyqyw/fabric/eslint/vue2-typescript");

// for vue3 and uni-app, with js
// const config = require("@modyqyw/fabric/eslint/vue3");

// for vue3 and uni-app, with ts
// const config = require("@modyqyw/fabric/eslint/vue3-typescript");

module.exports = {
  ...config,
  rules: {
    ...config.rules,
    // write your own rules here
  },
};

Stylelint

npm i -D stylelint@~13.8.0
# or
# yarn add -D stylelint@~13.8.0

// ${PROJECT_DIR}/stylelint.config.js
/* eslint-disable import/no-extraneous-dependencies */
// for css
const config = require("@modyqyw/fabric/stylelint/css");

// for less
// const config = require("@modyqyw/fabric/stylelint/less");

// for scss
// const config = require("@modyqyw/fabric/stylelint/scss");

module.exports = {
  ...config,
  rules: {
    ...config.rules,
    // write your own rules here
  },
};

Using extends is also ok.

// ${PROJECT_DIR}/stylelint.config.js
module.exports = {
  extends: ["@modyqyw/fabric/stylelint/css"],
  // extends: ["@modyqyw/fabric/stylelint/less"],
  // extends: ["@modyqyw/fabric/stylelint/scss"],
  rules: {
    // write your own rules here
  },
};

Commitlint

npm i -D @commitlint/cli@~11.0.0
# or
# yarn add -D @commitlint/cli@~11.0.0

// ${PROJECT_DIR}/commitlint.config.js
/* eslint-disable import/no-extraneous-dependencies */
const config = require("@modyqyw/fabric/commitlint");

module.exports = {
  ...config
};

LsLint

npm i -D @ls-lint/ls-lint@~1.9.2
# or
# yarn add -D @ls-lint/ls-lint@~1.9.2

# ${PROJECT_DIR}/.ls-lint.yml
ls:
  src/**:
    .js: kebab-case
    .jsx: kebab-case | PascalCase
    .ts: kebab-case
    .tsx: kebab-case | PascalCase
    .vue: kebab-case | PascalCase
    .css: kebab-case
    .less: kebab-case
    .scss: kebab-case
  pages/**:
    .js: kebab-case
    .jsx: kebab-case | PascalCase
    .ts: kebab-case
    .tsx: kebab-case | PascalCase
    .vue: kebab-case | PascalCase
  views/**:
    .js: kebab-case
    .jsx: kebab-case | PascalCase
    .ts: kebab-case
    .tsx: kebab-case | PascalCase
    .vue: kebab-case | PascalCase
  styles/**:
    .css: kebab-case
    .less: kebab-case
    .scss: kebab-case

ignore:
  - .git
  - node_modules

EditorConfig

root = true

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

Husky & LintStaged

npm i -D husky@~4.3.0 lint-staged@~10.5.2
# or
# yarn add -D husky@~4.3.0 lint-staged@~10.5.2

{
  ...,
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
      "pre-commit": "lint-staged"
    }
  },
  "lint-staged": {
    "./src/**/*.{css,less,scss,vue}": [
      "stylelint --fix"
    ],
    "./styles/**/*.{css,less,scss,vue}": [
      "stylelint --fix"
    ],
    "./src/**/*.{js,jsx,ts,tsx,vue}": [
      "eslint --fix"
    ],
    "./views/**/*.{js,jsx,ts,tsx,vue}": [
      "eslint --fix"
    ],
    "./pages/**/*.{js,jsx,ts,tsx,vue}": [
      "eslint --fix"
    ],
    ".": [
      "ls-lint"
    ]
  }
}

VSCode

Install plugins.
- Prettier
- ESLint
- Stylelint
- Vetur
Set up Settings.json. Then F1 => File: Save.

{
  "css.validate": false,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true,
    "source.fixAll.stylelint": true
  },
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.formatOnSave": true,
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "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",
    "*.nvue": "vue",
    "*.ux": "vue"
  },
  "less.validate": false,
  "scss.validate": false,
  "[vue]": {
    "editor.defaultFormatter": "octref.vetur"
  }
}

License

MIT