Package Exports

@modyqyw/fabric
@modyqyw/fabric/eslint
@modyqyw/fabric/eslint/functional
@modyqyw/fabric/eslint/index
@modyqyw/fabric/eslint/json
@modyqyw/fabric/eslint/miniprogram
@modyqyw/fabric/eslint/next
@modyqyw/fabric/eslint/nuxt
@modyqyw/fabric/eslint/react
@modyqyw/fabric/eslint/solid
@modyqyw/fabric/eslint/svelte
@modyqyw/fabric/eslint/typescript
@modyqyw/fabric/eslint/vanilla
@modyqyw/fabric/eslint/vue
@modyqyw/fabric/eslint/vue2
@modyqyw/fabric/eslint/yaml
@modyqyw/fabric/package.json
@modyqyw/fabric/prettier
@modyqyw/fabric/stylelint
@modyqyw/fabric/stylelint/css
@modyqyw/fabric/stylelint/index
@modyqyw/fabric/stylelint/less
@modyqyw/fabric/stylelint/miniprogram
@modyqyw/fabric/stylelint/scss
@modyqyw/fabric/stylelint/svelte
@modyqyw/fabric/stylelint/vue
@modyqyw/fabric/tsconfig.base.json

Readme

@modyqyw/fabric

English | 简体中文

Opinionated shareable specification for different JavaScript/TypeScript projects.

Requires:

Latest Node LTS and matching pnpm / npm / yarn
Set shamefully-hoist=true in .npmrc or use --shamefully-hoist when using pnpm 6 / 7
Set legacy-peer-deps=true in .npmrc or use --legacy-peer-deps when using npm 7 / 8
Set nodeLinker: 'node-modules' in .yarnrc.yml when using yarn 2 / 3
Use new JSX transform and hooks for React projects
Use Composition API for Vue projects

Using pnpm below. Check nrm and npmmirror for mirror support.

Usage

# locally
pnpm install -D @modyqyw/fabric@5

# globally
pnpm install -g @modyqyw/fabric@5

See more about versions in node-semver.

Naming

Naming is very hard and hardly be checked by linters. Simplicity and clarity should be the highest priority for naming.

Following an existing specification is a good choice.

For JavaScript / TypeScript
- kettannaito/naming-cheatsheet
For CSS / LESS / SCSS
- BEM
- CSS Modules
- OOCSS
- ACSS
- SMACSS
Helpful Open Source Projects
- bootstrap
- tailwindcss
- mui
- antd
- vuetify
- element-plus

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.

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 that doesn't have tsconfig.json and is using a bundler like Webpack, Vite, etc.

See tsconfig/bases and @vue/tsconfig for more examples.

{
  "extends": "@modyqyw/fabric/tsconfig.base.json",
  "compilerOptions": {
    // on-demand set baseUrl
    "baseUrl": ".",
    // on-demand set module, default ESNext
    "module": "CommonJS",
    // on-demand set preserveValueImports, default true
    "preserveValueImports": false,
    // 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 for path aliases, default {}
    "paths": {
      "@/*": ["./src/*"]
    },
    // if you are facing a infer problem
    "preserveSymlinks": true,
    // on-demand set types, default []
    "types": [
      // uni-app
      "@dcloudio/types",
      // alipay miniprogram
      "@mini-types/alipay",
      // element-plus
      "element-plus/global",
      // element-pro-components
      "element-pro-components/types/components",
      // jest
      "jest",
      // jsdom
      "jsdom",
      // 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/types",
      "unplugin-vue2-script-setup/ref-macros",
      // vitest
      "vitest",
      // 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 script setup
      "vue/macros-global",
      // webpack
      "webpack-env"
    ]
  },
  // 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",
    "**/.*.ts",
    "**/.*.cts",
    "**/.*.mts",
    "**/*.js",
    "**/*.cjs",
    "**/*.mjs",
    "**/*.jsx",
    "**/*.ts",
    "**/*.cts",
    "**/*.mts",
    "**/*.tsx",
    "**/*.vue",
    "**/*.svelte"
  ],
  // on-demand set exclude
  "exclude": [".cache", ".temp", ".tmp", "cache", "temp", "tmp", "dist*", "node_modules"]
}

See tsconfig.base.json for default configs.

Prettier

Learn about Prettier. Prettier is always required to handle code styles.

pnpm install -D prettier@2

Set up .prettierrc.cjs.

module.exports = {
  ...require('@modyqyw/fabric/prettier'),
};

ESLint

Learn about ESLint.

pnpm install -D eslint@8 @babel/core@7 @babel/eslint-parser@7

Additional dependencies are needed if you are using TypeScript.

pnpm install -D typescript@4 @typescript-eslint/eslint-plugin@5 @typescript-eslint/parser@5

Set up .eslintrc.cjs.

module.exports = {
  extends: [
    // vanilla is always required
    require.resolve('@modyqyw/fabric/eslint/vanilla'),

    // typescript
    // require.resolve('@modyqyw/fabric/eslint/typescript'),

    // react
    // require.resolve('@modyqyw/fabric/eslint/react'),

    // next
    // require.resolve('@modyqyw/fabric/eslint/next'),

    // vue3
    // require.resolve('@modyqyw/fabric/eslint/vue'),

    // vue2
    // require.resolve('@modyqyw/fabric/eslint/vue2'),

    // nuxt
    // require.resolve('@modyqyw/fabric/eslint/nuxt'),

    // svelte
    // require.resolve('@modyqyw/fabric/eslint/svelte'),

    // solid
    // require.resolve('@modyqyw/fabric/eslint/solid'),

    // json, jsonc, json5
    // require.resolve('@modyqyw/fabric/eslint/json'),

    // yaml, yml
    // require.resolve('@modyqyw/fabric/eslint/yaml'),

    // functional
    // require.resolve('@modyqyw/fabric/eslint/functional'),

    // miniprogram
    // require.resolve('@modyqyw/fabric/eslint/miniprogram'),
  ],
};

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,.yaml,.yml,.json,.jsonc,.json5 --ignore-path=.gitignore"
  }
}

Stylelint

Learn about Stylelint.

pnpm install -D stylelint@14

Set up .stylelintrc.cjs.

module.exports = {
  extends: [
    // css is always required
    '@modyqyw/fabric/stylelint/css',

    // less
    // '@modyqyw/fabric/stylelint/less',

    // scss
    // '@modyqyw/fabric/stylelint/scss',

    // vue
    // '@modyqyw/fabric/stylelint/vue',

    // svelte
    // '@modyqyw/fabric/stylelint/svelte',

    // miniprogram
    // '@modyqyw/fabric/stylelint/miniprogram',
  ],
};

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

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

Markdownlint

Learn about Markdown and Markdownlint.

pnpm install -D markdownlint-cli

Set up .markdownlint.json.

{
  "MD001": false,
  "MD003": false,
  "MD013": false,
  "MD022": false,
  "MD024": false,
  "MD025": false,
  "MD033": false,
  "MD036": false,
  "MD050": 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@17 @commitlint/config-conventional@17

Set up .commitlintrc.cjs.

module.exports = {
  extends: ['@commitlint/config-conventional'],
};

Commitizen

Learn about Commitizen.

pnpm install -D commitizen@4 @commitlint/prompt@17

Set up package.json.

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

LintStaged

Learn about LintStaged.

pnpm install -D lint-staged@12

Set up .lintstagedrc.cjs.

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

Husky

Learn about Husky.

pnpm install -D is-ci@3 husky@7

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
- Svelte - For svelte
- Tailwind CSS IntelliSense - For TailwindCSS
- Volar - For Vue 3 and Vue 2, extra configs required if for Vue 2
- uni-helper - For uni-*
- UnoCSS - For UnoCSS
- WindiCSS IntelliSense - For TailwindCSS / WindiCSS
Set up Settings.json.

{
  "css.validate": false,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.formatOnSave": true,
  "editor.rulers": [{ "column": 100 }],
  "editor.tabSize": 2,
  "editor.wordWrap": "on",
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "svelte",
    "typescript",
    "typescriptreact",
    "vue",
    "yaml",
    "json",
    "jsonc",
    "json5"
  ],
  "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", "vue", "svelte"],
  "stylelint.validate": ["css", "less", "scss", "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
    }
  },
  "[svelte]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.eslint": true,
      "source.fixAll.stylelint": true
    }
  },
  "[vue]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.eslint": true,
      "source.fixAll.stylelint": true
    }
  },
  "[json]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.eslint": true
    }
  },
  "[jsonc]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.eslint": true
    }
  },
  "[json5]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.eslint": true
    }
  },
  "[markdown]": {
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
      "source.fixAll.markdownlint": true
    }
  },
  "[yaml]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.eslint": true
    }
  },
  "[yml]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.eslint": true
    }
  }
}

Migrate

Migrate 5.x from 4.x

Upgrade your node version to latest LTS.
Upgrade your pnpm / npm / yarn version to match your node version.
Upgrade your eslint version to latest 8.
Upgrade your stylelint version to latest 14.
Upgrade your prettier version to latest 2.
Upgrade your postcss version to latest 8.
Prettier is always required.
CLI is removed. It is not needed in most cases, and not a necessity in other cases. You can always follow README to config your project, or just use your own config.
Commitlint config is removed. Use @commitlint/config-conventional directly.
SASS support is removed. SCSS is more popular.
Update your React projects with new JSX transform and hooks.
Update your Vue projects with Composition API.

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

Performance

Sometimes you may find Prettier requires too much time. Check this comment and see if it helps.

Examples

See dependency graph.

Acknowledge

Sorted according to alphabetical order.

License

MIT