chore: add example

Author: Codennnn

package.json

@@ -3,7 +3,7 @@
   "version": "0.5.0",
   "description": "A collection of configuration files containing prettier, eslint, stylelint",
   "keywords": [
-    "code style",
+    "code lint",
     "eslint",
     "stylelint",
     "prettier"

src/stylelint.ts

@@ -15,6 +15,8 @@ module.exports = {
         ignoreAtRules: ['tailwind'],
       },
     ],
+    'color-function-notation': 'legacy',
+    'alpha-value-notation': 'number',
     'selector-class-pattern':
       '^(?:(?:o|c|u|t|s|is|has|_|js|qa)-)?[a-zA-Z0-9]+(?:-[a-zA-Z0-9]+)*(?:__[a-zA-Z0-9]+(?:-[a-zA-Z0-9]+)*)?(?:--[a-zA-Z0-9]+(?:-[a-zA-Z0-9]+)*)?(?:\\[.+\\])?$',
   },

ts-example/.editorconfig

@@ -0,0 +1,15 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+insert_final_newline = false
+trim_trailing_whitespace = false

ts-example/.eslintrc.js

@@ -0,0 +1,33 @@
+module.exports = {
+  root: true,
+  extends: [require.resolve('../lib/eslint'), 'plugin:tailwind/recommended'],
+  rules: {
+    'import/no-unresolved': [2, { ignore: ['^@/'] }],
+    'react/react-in-jsx-scope': 0,
+    '@typescript-eslint/no-var-requires': 0,
+    '@typescript-eslint/no-non-null-assertion': 0,
+    '@typescript-eslint/no-use-before-define': 2,
+    '@typescript-eslint/explicit-module-boundary-types': 0,
+    '@typescript-eslint/consistent-type-imports': [
+      2,
+      {
+        prefer: 'type-imports',
+        disallowTypeAnnotations: true,
+      },
+    ],
+  },
+  settings: {
+    react: {
+      version: 'detect',
+    },
+  },
+  ignorePatterns: [
+    'public',
+    'build',
+    'dist',
+    'yarn*',
+    '!.eslintrc.js',
+    '!.prettierrc.js',
+    '!.stylelintrc.js',
+  ],
+}

ts-example/.gitignore

@@ -0,0 +1,26 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+.vscode
+.eslintcache

ts-example/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn lint-staged

ts-example/.prettierrc.js

@@ -0,0 +1,5 @@
+const prettier = require('../lib/prettier')
+
+module.exports = {
+  ...prettier,
+}

ts-example/.stylelintrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  extends: [require.resolve('../lib/stylelint')],
+  ignoreFiles: ['build/**/*.css'],
+  overrides: [
+    {
+      files: ['**/*.scss'],
+      customSyntax: 'postcss-scss',
+    },
+  ],
+}

ts-example/README.md

@@ -0,0 +1,44 @@
+<div align="center">
+
+<img width="150" src="./img/logo.png">
+
+# Portal
+
+**你心中理想的管理系统模板**
+
+<img width="32" src="./img/badge-react.png">
+<img width="32" src="./img/badge-ts.png">
+
+</div>
+
+## 界面一览
+
+![](./img/screenshot-1.png)
+![](./img/screenshot-2.png)
+![](./img/screenshot-3.png)
+
+## 安装依赖
+
+```bash
+yarn install # 或使用简写 yarn
+```
+
+## 启动项目
+
+```bash
+yarn start
+```
+
+## 代码格式
+
+在 VS Code 中添加以下配置，将为你在保存文件是自动格式化代码。
+
+```json
+{
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true,
+    "source.fixAll.stylelint": true
+  }
+}
+```

ts-example/config/dev.js

@@ -0,0 +1,3 @@
+module.exports = {
+  APP_ROUTER_MODE: '"history"',
+}