feat: modified config (tkeel-io#139)

* feat: split config * feat: split config * feat: modified styles * feat: modified styles * feat: modified styles * feat: modified styles * feat: modified styles * feat: modified styles * feat: m * feat: modified config * feat: modified config * feat: modified config * feat: modified config * feat: modified config * feat: modified config * feat: add linters * feat: add linters
tkeel-io · Mar 31, 2022 · f58b56d · f58b56d
1 parent 5fa2c36
commit f58b56d
Show file tree

Hide file tree

Showing 15 changed files with 299 additions and 240 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,8 @@
+node_modules/
+.docusaurus/
+build/
+docs/
+blog/
+.yarn/
+
+!docs/developer_cookbook/tkeel_plugin/create_console.md
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,131 @@
+module.exports = {
+  root: true,
+  parser: '@babel/eslint-parser',
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    requireConfigFile: false,
+  },
+  env: {
+    browser: true,
+    node: true,
+    commonjs: true,
+    'shared-node-browser': true,
+    amd: true,
+    es6: true,
+    es2017: true,
+    es2020: true,
+    es2021: true,
+  },
+  extends: [
+    'airbnb',
+    'airbnb/hooks',
+    'plugin:eslint-comments/recommended',
+    'plugin:promise/recommended',
+    'plugin:unicorn/recommended',
+    'plugin:sonarjs/recommended',
+    'plugin:prettier/recommended',
+  ],
+  rules: {
+    'no-console': process.env.NODE_ENV === 'development' ? 'warn' : 'error',
+    'no-param-reassign': [
+      'error',
+      {
+        props: true,
+        ignorePropertyModificationsFor: [
+          'acc',
+          'accumulator',
+          'e',
+          'ctx',
+          'context',
+          'req',
+          'request',
+          'res',
+          'response',
+          '$scope',
+          'staticContext',
+          'draft',
+        ],
+      },
+    ],
+    'no-useless-call': 'error',
+    'import/no-duplicates': ['error', { considerQueryString: true }],
+    'import/order': [
+      'error',
+      {
+        groups: [
+          'builtin',
+          'external',
+          'internal',
+          ['parent', 'sibling', 'index'],
+          'object',
+          'type',
+          'unknown',
+        ],
+        'newlines-between': 'always',
+        alphabetize: {
+          order: 'asc',
+        },
+        warnOnUnassignedImports: true,
+      },
+    ],
+    'unicorn/filename-case': [
+      'error',
+      {
+        cases: {
+          kebabCase: true,
+          camelCase: true,
+          pascalCase: true,
+        },
+      },
+    ],
+    'unicorn/no-array-for-each': 'off',
+    'unicorn/no-null': 'off',
+    'unicorn/prevent-abbreviations': 'off',
+    'react/jsx-key': 'error',
+    'react/jsx-props-no-spreading': 'off',
+    'react/jsx-uses-react': 'off',
+    'react/react-in-jsx-scope': 'off',
+    'react/require-default-props': [
+      'error',
+      { forbidDefaultForRequired: true, ignoreFunctionalComponents: true },
+    ],
+  },
+  overrides: [
+    {
+      files: ['**/*.js'],
+      rules: {
+        'import/no-extraneous-dependencies': 'off',
+        'unicorn/prefer-module': 'off',
+      },
+    },
+    {
+      files: ['**/*.{ts,tsx}'],
+      parserOptions: {
+        project: './tsconfig.json',
+      },
+      settings: {
+        'import/resolver': {
+          typescript: {
+            alwaysTryTypes: true,
+          },
+        },
+      },
+      extends: [
+        'plugin:@typescript-eslint/recommended',
+        'plugin:@typescript-eslint/recommended-requiring-type-checking',
+        'airbnb-typescript',
+        'plugin:prettier/recommended',
+      ],
+      plugins: ['simple-import-sort'],
+      rules: {
+        'sort-imports': 'off',
+        'import/order': 'off',
+        'simple-import-sort/imports': 'error',
+        'simple-import-sort/exports': 'error',
+        '@typescript-eslint/ban-ts-comment': 'off',
+        '@typescript-eslint/no-floating-promises': 'off',
+      },
+    },
+  ],
+};
diff --git a/.stylelintignore b/.stylelintignore
@@ -0,0 +1,8 @@
+node_modules/
+.docusaurus/
+build/
+docs/
+blog/
+.yarn/
+
+!docs/developer_cookbook/tkeel_plugin/create_console.md
diff --git a/.stylelintrc.js b/.stylelintrc.js
@@ -0,0 +1,21 @@
+module.exports = {
+  plugins: ['stylelint-order'],
+  extends: [
+    'stylelint-config-standard',
+    'stylelint-config-rational-order',
+    'stylelint-config-standard-scss',
+    'stylelint-prettier/recommended',
+  ],
+  rules: {
+    'color-named': ['never', { ignore: ['inside-function'] }],
+    'selector-list-comma-space-after': 'always-single-line',
+    'no-unknown-animations': true,
+    'selector-class-pattern': null,
+  },
+  /*overrides: [
+    {
+      files: ['**!/!*.scss'],
+      extends: ['stylelint-config-standard-scss'],
+    },
+  ],*/
+};
diff --git a/SUMMARY.md b/SUMMARY.md
diff --git a/docusaurus.config.base.js b/docusaurus.config.base.js
@@ -1,60 +1,37 @@
-// @ts-check
-// Note: type annotations allow type checking and IDEs autocompletion
-
-const lightCodeTheme = require('prism-react-renderer/themes/github');
 const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+const lightCodeTheme = require('prism-react-renderer/themes/github');
 
-/** @type {import('@docusaurus/types').Config} */
 const config = {
-  baseUrl: '/',
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
 
-  themeConfig:
-    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
-    ({
-      colorMode: {
-        defaultMode: 'light',
-        disableSwitch: true,
-        respectPrefersColorScheme: false,
-      },
-      navbar: {
-        items: [
-          { to: '/getting_started/guide', label: '新手引导', position: 'left' },
-          { to: '/api/Core/tag', label: 'API', position: 'left' },
-        ],
-      },
-      /* footer: {
-        style: 'dark',
-        links: [
-          {
-            title: '文档',
-            items: [
-              {
-                label: '什么是 tKeel',
-                to: '/',
-              },
-              {
-                label: '概念',
-                to: '/internal_concepts/platform',
-              },
-              {
-                label: '新手引导',
-                to: '/getting_started/guide',
-              },
-            ],
-          },
-        ],
-      }, */
-      prism: {
-        theme: lightCodeTheme,
-        darkTheme: darkCodeTheme,
-      },
-    }),
+  themeConfig: {
+    colorMode: {
+      defaultMode: 'light',
+      disableSwitch: true,
+      respectPrefersColorScheme: false,
+    },
+
+    navbar: {
+      items: [
+        {
+          href: 'https://github.com/tkeel-io/tkeel',
+          position: 'right',
+          className: 'header-github-link',
+          'aria-label': 'GitHub repository',
+        },
+      ],
+    },
+
+    prism: {
+      theme: lightCodeTheme,
+      darkTheme: darkCodeTheme,
+    },
+  },
 
   i18n: {
     defaultLocale: 'zh-cn',
-    locales: ['zh-cn'],
+    locales: ['en', 'zh-cn'],
   },
 
   plugins: ['docusaurus-plugin-sass'],

diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -1,17 +1,8 @@
 const { merge } = require('webpack-merge');
 
-const configType = 'tkeel'; // tkeel, qingcloud
-
 const baseConfig = require('./docusaurus.config.base');
 const tkeelConfig = require('./docusaurus.config.tkeel');
-const qingcloudConfig = require('./docusaurus.config.qingcloud');
-
-let config = null;
 
-if (configType === 'qingcloud') {
-  config = merge({}, baseConfig, qingcloudConfig);
-} else {
-  config = merge({}, baseConfig, tkeelConfig);
-}
+const config = merge({}, baseConfig, tkeelConfig);
 
 module.exports = config;
diff --git a/docusaurus.config.qingcloud.js b/docusaurus.config.qingcloud.js