Package Exports

@modyqyw/fabric
@modyqyw/fabric/commitlint
@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 specification for different JavaScript/TypeScript projects.

Node.js 10+ and npm 6+ are required.

Plan

Github | Gitee

Usage

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

# globally
npm i -g @modyqyw/fabric@~1.35.0
# or
# yarn add -g @modyqyw/fabric@~1.35.0

Use @legacy for legacy version, which supports Node.js 10+ and npm6+.

# locally
npm i -D @modyqyw/fabric@legacy
# or
# yarn add -D @modyqyw/fabric@legacy

# globally
npm i -g @modyqyw/fabric@legacy
# or
# yarn add -g @modyqyw/fabric@legacy

CLI (beta)

This is still a beta feature and may cause your project to crash. Please use it in your new projects and give feedback. It will get smarter in the foreseeable future.

CLI is used to config your project easier. Just call it after installing globally.

# in current dir
modyqyw-fabric config
# specify PROJECT_DIR
modyqyw-fabric config ./

Or, you can use scripts in ${PROJECT_DIR}package.json if you install locally.

{
  ...,
  "scripts": {
    ...,
    "config": "modyqyw-fabric config"
  }
}

npm run config
# or
# yarn run config

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/SASS/SCSS - BEM, OOCSS, ACSS, SMACSS

Besides, you can learn naming from some open-source projects, such as Vuetify, MaterialUI, Bootstrap, TailwindCSS and Bulma.

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

Git

Learn about Git, GitFlow and GifLFS.

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 Gitee.

Set up ${PROJECT_DIR}/.gitattributes.

* text=auto

A better ${PROJECT_DIR}/.gitattributes example here.

A ${PROJECT_DIR}/.gitignore example here.

EditorConfig

Learn about EditorConfig.

Set up ${PROJECT_DIR}/.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

Prettier

Learn about Prettier.

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

Set up ${PROJECT_DIR}/.prettierrc.js.

/* eslint-disable import/no-extraneous-dependencies */
const config = require('@modyqyw/fabric/prettier');

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

Set up ${PROJECT_DIR}/package.json.

{
  ...,
  "scripts": {
    ...,
    "lint": "npm run lint:json",
    "lint:json": "prettier ./**/*.json --write"
  }
}

A ${PROJECT_DIR}/.prettierignore example here.

ESLint

Learn about ESLint.

npm i -D eslint@~7.28.0 @babel/core@~7.14.5 @babel/eslint-parser@~7.14.5
# or
# yarn add -D eslint@~7.28.0 @babel/core@~7.14.5 @babel/eslint-parser@~7.14.5

If you are using typescript, additional dependencies are needed.

npm i -D typescript@~4.3.2 @typescript-eslint/eslint-plugin@~4.26.1 @typescript-eslint/parser@~4.26.1
# or
# yarn add -D typescript@~4.3.2 @typescript-eslint/eslint-plugin@~4.26.1 @typescript-eslint/parser@~4.26.1

Set up ${PROJECT_DIR}/.eslintrc.js.

/* eslint-disable import/no-extraneous-dependencies */
// for js and ts
const config = require('@modyqyw/fabric/eslint/native');

// for react17, react-native0.64, taro3, rax1, remax2, umi3 and next10
// with js or ts
// const config = require('@modyqyw/fabric/eslint/react');

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

// for vue2, uni-app and nuxt2, 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,
  plugins: [
    ...config.plugins,
    // write your own plugins here
  ],
  extends: [
    ...config.extends,
    // write your own extends here
  ],
  env: {
    ...config.env,
    // write your own env here
  },
  globals: {
    ...config.globals,
    // write your own globals here
  },
  rules: {
    ...config.rules,
    // write your own rules here
  },
  overrides: [
    ...config.overrides,
    // write your own overrides here
  ],
  settings: {
    ...config.settings,
    // write your own settings here
  },
};

Set up ${PROJECT_DIR}/package.json.

{
  ...,
  "scripts": {
    ...,
    "lint": "npm run lint:script",
    "lint:script": "eslint . --ext .js,.jsx,.ts,.tsx,.vue --fix"
  }
}

When using vue-cli-service, eslint . --ext .js,.jsx,.ts,.tsx,.vue --fix can be replaced with vue-cli-service lint --fix.

A ${PROJECT_DIR}/.eslintignore example here.

Stylelint

Learn about Stylelint.

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

Set up ${PROJECT_DIR}/.stylelintrc.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 sass
// const config = require('@modyqyw/fabric/stylelint/sass');

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

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

Set up ${PROJECT_DIR}/package.json.

{
  ...,
  "scripts": {
    ...,
    "lint": "npm run lint:style",
    "lint:style": "stylelint ./**/*.{css,less,sass,scss,vue} --fix"
  }
}

A ${PROJECT_DIR}/.stylelintignore example here.

Markdownlint

Learn about Markdown and Markdownlint.

npm i -D markdownlint-cli@~0.27.1
# or
# yarn add -D markdownlint-cli@~0.27.1

Set up ${PROJECT_DIR}/.markdownlint.json.

{
  "MD013": false,
  "MD033": false
}

Set up ${PROJECT_DIR}/package.json.

{
  ...,
  "scripts": {
    ...,
    "lint": "npm run lint:markdown",
    "lint:markdown": "markdownlint . --fix"
  }
}

A ${PROJECT_DIR}/.markdownlintignore example here.

LintMD

Learn about LintMD, which aims at Chinese markdown files.

npm i -D lint-md-cli@~0.1.2
# or
# # yarn add -D lint-md-cli@~0.1.2

Set up ${PROJECT_DIR}/.lintmdrc.

{
  "excludeFiles": [],
  "rules": {
    "no-long-code": [
      "error",
      {
        "length": 80,
        "exclude": ["css", "less", "sass", "scss"]
      }
    ]
  }
}

Set up ${PROJECT_DIR}/package.json.

{
  ...,
  "scripts": {
    ...,
    "lint": "npm run lint:markdown",
    "lint:markdown": "lint-md . --fix"
  }
}

Attention: when I try to migrate to @lint-md/cli, I get an error env: node\r: No such file or directory. If you have any idea, please help me.

LsLint

Learn about LsLint.

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

Set up ${PROJECT_DIR}/.ls-lint.yml.

ls:
  config:
    .js: kebab-case
    .ts: kebab-case
    .config.js: kebab-case
    .config.ts: kebab-case
  build:
    .js: kebab-case
    .ts: kebab-case
    .config.js: kebab-case
    .config.ts: kebab-case
  components:
    .js: PascalCase | kebab-case
    .jsx: PascalCase | kebab-case
    .ts: PascalCase | kebab-case
    .tsx: PascalCase | kebab-case
    .vue: PascalCase | kebab-case
  mock:
    .js: kebab-case
    .ts: kebab-case
  src:
    .js: kebab-case
    .ts: kebab-case
    .d.ts: kebab-case
    .config.js: kebab-case
    .config.ts: kebab-case
    .jsx: kebab-case
    .tsx: kebab-case
    .vue: kebab-case
    .css: kebab-case
    .less: kebab-case
    .sass: kebab-case
    .scss: kebab-case
    .module.css: kebab-case
    .module.less: kebab-case
    .module.sass: kebab-case
    .module.scss: kebab-case
  src/composables:
    .js: camelCase
    .ts: camelCase
  src/hooks:
    .js: camelCase
    .ts: camelCase
  src/**/components:
    .js: PascalCase | kebab-case
    .jsx: PascalCase | kebab-case
    .ts: PascalCase | kebab-case
    .tsx: PascalCase | kebab-case
    .vue: PascalCase | kebab-case
  src/**/test:
    .js: kebab-case
    .ts: kebab-case
    .spec.js: kebab-case
    .spec.ts: kebab-case
    .test.js: kebab-case
    .test.ts: kebab-case
  src/**/__test__:
    .js: kebab-case
    .ts: kebab-case
    .spec.js: kebab-case
    .spec.ts: kebab-case
    .test.js: kebab-case
    .test.ts: kebab-case
  src/**/tests:
    .js: kebab-case
    .ts: kebab-case
    .spec.js: kebab-case
    .spec.ts: kebab-case
    .test.js: kebab-case
    .test.ts: kebab-case
  src/**/__tests__:
    .js: kebab-case
    .ts: kebab-case
    .spec.js: kebab-case
    .spec.ts: kebab-case
    .test.js: kebab-case
    .test.ts: kebab-case
  pages:
    .js: kebab-case
    .ts: kebab-case
    .d.ts: kebab-case
    .config.js: kebab-case
    .config.ts: kebab-case
    .jsx: kebab-case
    .tsx: kebab-case
    .vue: kebab-case
    .css: kebab-case
    .less: kebab-case
    .sass: kebab-case
    .scss: kebab-case
    .module.css: kebab-case
    .module.less: kebab-case
    .module.sass: kebab-case
    .module.scss: kebab-case
  store:
    .js: kebab-case
    .ts: kebab-case
  styles:
    .css: kebab-case
    .less: kebab-case
    .sass: kebab-case
    .scss: kebab-case
    .module.css: kebab-case
    .module.less: kebab-case
    .module.sass: kebab-case
    .module.scss: kebab-case
  typings:
    .js: kebab-case
    .ts: kebab-case
    .d.ts: kebab-case
  types:
    .js: kebab-case
    .ts: kebab-case
    .d.ts: kebab-case
  test:
    .js: kebab-case
    .ts: kebab-case
    .spec.js: kebab-case
    .spec.ts: kebab-case
    .test.js: kebab-case
    .test.ts: kebab-case
  __test__:
    .js: kebab-case
    .ts: kebab-case
    .spec.js: kebab-case
    .spec.ts: kebab-case
    .test.js: kebab-case
    .test.ts: kebab-case
  tests:
    .js: kebab-case
    .ts: kebab-case
    .spec.js: kebab-case
    .spec.ts: kebab-case
    .test.js: kebab-case
    .test.ts: kebab-case
  __tests__:
    .js: kebab-case
    .ts: kebab-case
    .spec.js: kebab-case
    .spec.ts: kebab-case
    .test.js: kebab-case
    .test.ts: kebab-case

ignore:
  - ./src/.next
  - ./src/.nuxt
  - ./src/.rax
  - ./src/.umi
  - ./src/App.js
  - ./src/App.ts
  - ./src/App.jsx
  - ./src/App.tsx
  - ./src/App.vue
  - ./src/App.css
  - ./src/App.less
  - ./src/App.sass
  - ./src/App.scss

Set up ${PROJECT_DIR}/package.json.

{
  ...,
  "scripts": {
    ...,
    "lint": "npm run lint:ls",
    "lint:ls": "ls-lint ."
  }
}

Commitlint

Learn about Commitlint.

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

Set up ${PROJECT_DIR}/.commitlintrc.js.

/* eslint-disable import/no-extraneous-dependencies */
const config = require('@modyqyw/fabric/commitlint');

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

You may also want to try conventional-changelog or semantic-release.

Commitizen

Learn about Commitizen.

npm i -D commitizen@~4.2.4
# or
# yarn add -D commitizen@~4.2.4

Set up ${PROJECT_DIR}/package.json.

{
  ...,
  "scripts": {
    ...,
    "commit": "cz"
  },
  "config": {
    "commitizen": {
      "path": "./node_modules/cz-conventional-changelog"
    }
  }
}

You may also want to try conventional-changelog or semantic-release.

LintStaged

Learn about LintStaged.

npm install -D lint-staged@~10.5.4
# or
# yarn add -D lint-staged@~10.5.4

Set up ${PROJECT_DIR}/.lintstagedrc.js.

module.exports = {
  '*.json': 'prettier --write',
  '*.{css,less,sass,scss,vue}': 'stylelint --fix',
  '*.{js,jsx,ts,tsx,vue}': 'eslint --fix',
  '*.{md,markdown}': 'markdownlint --fix && lint-md --fix',
};

When using vue-cli-service, eslint --fix can be replaced with vue-cli-service lint --fix.

Husky

Learn about Husky.

npm install -D is-ci@~3.0.0 husky@~6.0.0
# or
# yarn add -D is-ci@~3.0.0 husky@~6.0.0

npx husky install

Set up ${PROJECT_DIR}/package.json.

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

Set up ${PROJECT_DIR}/.husky/commit-msg hook.

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

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

Set up ${PROJECT_DIR}/.husky/pre-commit hook.

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

npx --no-install ls-lint . && npx --no-install lint-staged

Finally use chmod.

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

If you want to use husky@4, steps are shown below.

npm i -D husky@~4.3.8
# or
# yarn add -D husky@~4.3.8

Set up ${PROJECT_DIR}/package.json.

{
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
      "pre-commit": "ls-lint . && lint-staged"
    }
  }
}

VSCode

Install plugins.
- ESLint
- language-stylus
- markdownlint
- Prettier
- Sass
- Stylelint
- Vetur
- uni-helper - If you are dealing with uni-*
Set up Settings.json. Then F1 => File: Save.

{
  "css.validate": false,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true,
    "source.fixAll.markdownlint": true,
    "source.fixAll.stylelint": true
  },
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.formatOnSave": true,
  "editor.rulers": [{ "column": 80 }],
  "editor.tabSize": 2,
  "editor.wordWrap": "on",
  "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",
    "*.nvue": "vue",
    "*.ux": "vue"
  },
  "less.validate": false,
  "scss.validate": false,
  "[vue]": {
    "editor.defaultFormatter": "octref.vetur"
  }
}

Acknowledge

Sorted according to alphabetical order.

License

MIT