ko-lint-config 0.0.1

package/.eslintrc.js

@@ -0,0 +1,181 @@
+module.exports = {
+    root: true, // 默认情况下，ESLint 会在所有父级目录里寻找配置文件，一直到根目录。如果发现配置文件中有 “root”: true，它就会停止在父级目录中寻找。
+    parser: '@typescript-eslint/parser',
+    parserOptions: {
+        ecmaVersion: 8, // 支持es8语法，但并不意味着同时支持新的 ES8 全局变量或类型
+        sourceType: 'module', // 指定来源的类型，"script" (默认) 或 "module"（如果你的代码是 ECMAScript 模块)
+        // "project": "./tsconfig.json",
+        // 使用的额外的语言特性
+        ecmaFeatures: {
+            jsx: true, // 启用 jsx
+            tsx: true, // 启用 tsx
+            globalReturn: true, // 允许在全局作用域下使用 return 语句
+            impliedStrict: true, // 启用全局 strict mode (如果 ecmaVersion 是 5 或更高)
+        },
+    },
+    settings: {
+        react: {
+            pragma: 'React',
+            version: '16.6.3',
+        },
+    },
+    env: {
+        es6: true, // 启用 ES6 语法支持以及新的 ES6 全局变量或类型
+        node: true, // Node.js 全局变量和 Node.js 作用域
+        browser: true, // 浏览器全局变量
+    },
+    extends: [
+        'standard',
+        'eslint:recommended',
+        'plugin:react/recommended',
+        'plugin:react-hooks/recommended',
+        'plugin:@typescript-eslint/recommended',
+    ],
+    plugins: ['import', 'react', 'jsx-a11y', 'react-hooks', 'dt-react'],
+    globals: {
+        expect: 'readonly',
+        test: 'readonly',
+        describe: 'readonly',
+        beforeEach: 'readonly',
+        afterEach: 'readonly',
+        jest: 'readonly',
+    },
+    // "off" 或 0 - 关闭规则
+    // "warn" 或 1 - 开启规则，使用警告级别的错误：warn (不会导致程序退出)
+    // "error" 或 2 - 开启规则，使用错误级别的错误：error (当被触发的时候，程序会退出)
+    rules: {
+        semi: 0,
+        strict: 0,
+        indent: [
+            // 缩进
+            2,
+            4,
+            {
+                SwitchCase: 1, // 指定 switch-case 语句的缩进级别
+                VariableDeclarator: 1, // 指定 var 变量声明语句的缩进级别
+                outerIIFEBody: 1, // 指定 IIFE（立即调用的函数表达式）的缩进级别
+                MemberExpression: 1, // 指定多行属性链的缩进级别
+                FunctionDeclaration: { parameters: 1, body: 1 }, // 通过传入一个对象来指定函数声明的缩进规则
+                FunctionExpression: { parameters: 1, body: 1 },
+                CallExpression: { arguments: 1 }, // 通过传入一个对象来指定函数调用表达式的缩进规则
+                ArrayExpression: 1, // 指定数组中的元素的缩进级别
+                ObjectExpression: 1, // 指定对象中的属性的缩进级别
+                ImportDeclaration: 1, // 指定 import 语句的缩进级别
+                flatTernaryExpressions: false, // 指定是否需要缩进嵌套在其他三元表达式中的三元表达式
+                ignoreComments: false, // 指定注释是否需要需要与前一行或下一行的节点对齐
+                ignoredNodes: [
+                    'TemplateLiteral *',
+                    'JSXElement',
+                    'JSXElement > *',
+                    'JSXAttribute',
+                    'JSXIdentifier',
+                    'JSXNamespacedName',
+                    'JSXMemberExpression',
+                    'JSXSpreadAttribute',
+                    'JSXExpressionContainer',
+                    'JSXOpeningElement',
+                    'JSXClosingElement',
+                    'JSXFragment',
+                    'JSXOpeningFragment',
+                    'JSXClosingFragment',
+                    'JSXText',
+                    'JSXEmptyExpression',
+                    'JSXSpreadChild',
+                ],
+                offsetTernaryExpressions: true,
+            },
+        ],
+        eqeqeq: 0,
+        'arrow-body-style': 0, // 控制箭头函数的语法形式
+        'comma-dangle': [2, 'only-multiline'], // 当最后一个元素或属性与结束或属性位于不同的行时，允许但不要求尾随逗号
+        'lines-between-class-members': 0, // 方法间是否空行间隔开
+        'space-before-function-paren': [
+            // 函数括号前的空格
+            2,
+            {
+                anonymous: 'always', // 匿名函数表达式，例如 function () {}
+                named: 'never', // 命名函数表达式，例如 function foo () {}
+                asyncArrow: 'always', // 异步箭头函数表达式，例如 async () => {}
+            },
+        ],
+        'one-var': 0, // 可同时定义多个变量，逗号隔开
+        'dot-notation': 0, // 允许方括号表示法 foo['bar']
+        'multiline-ternary': 0, // 三元运算符不强制换行
+        'prefer-regex-literals': 0, // 正则的构造函数
+        'prefer-promise-reject-errors': 0, // reject 仅接收 Error 对象
+
+        'no-mixed-operators': 0, // 允许混合使用不同的运算符
+        'no-return-assign': 0, // return 的代码中有运算
+        'no-useless-constructor': 0, // 空构造函数
+        'no-console': 0,
+        'no-debugger': 2,
+        'no-param-reassign': 2, // 给函数的入参赋值
+        'no-use-before-define': 0, // 使用尚未声明的变量
+
+        // 控制是否可以使用没有在 package.json 内 dependencies, devDependencies, optionalDependencies, peerDependencies, bundledDependencies 中声明的扩展模块
+        'import/no-extraneous-dependencies': 0,
+
+        /**
+         * 是否强制组件中的方法顺序，顺序如下：
+         * 1、静态方法和属性
+         * 2、生命周期方法：displayName, propTypes, contextTypes, childContextTypes, mixins, statics, defaultProps, constructor, getDefaultProps, state, getInitialState, getChildContext, getDerivedStateFromProps, componentWillMount, UNSAFE_componentWillMount, componentDidMount, componentWillReceiveProps, UNSAFE_componentWillReceiveProps, shouldComponentUpdate, componentWillUpdate, UNSAFE_componentWillUpdate, getSnapshotBeforeUpdate, componentDidUpdate, componentDidCatch, componentWillUnmount（按此顺序）。
+         * 3、自定义方法
+         * 4、render方法
+         */
+        'react/sort-comp': 0,
+        'react/display-name': [0],
+        'react/jsx-uses-react': 1, // 防止 require('react') 被 JSX 语法错误的标记为未使用
+        'react/prefer-stateless-function': 0, // 是否强制将无状态的 React 组件编写为纯函数
+        'react/jsx-closing-bracket-location': 0, // 验证 JSX 中右括号的位置是否与开始标签对齐
+        'react/prop-types': [0, { ignore: ['children'] }], // 验证 React 组件中是否缺少 Props 属性
+        'react/jsx-filename-extension': [
+            1,
+            { extensions: ['.tsx', '.js', '.jsx'] },
+        ],
+        'react/react-in-jsx-scope': 0,
+        'react/jsx-closing-tag-location': 0,
+        'react-hooks/rules-of-hooks': 2,
+        'react-hooks/exhaustive-deps': 0,
+
+        'jsx-quotes': 1,
+        'dt-react/jsx-closing-bracket-location': [1, 'line-aligned'],
+        'dt-react/jsx-tag-spacing': [
+            2,
+            {
+                closingSlash: 'never',
+                beforeSelfClosing: 'always',
+                // beforeSelfClosing: 'proportional-always',
+                beforeClosing: 'proportional-always',
+            },
+        ],
+
+        'jsx-a11y/no-static-element-interactions': 0,
+
+        '@typescript-eslint/no-unused-vars': [
+            2,
+            { vars: 'all', args: 'none', ignoreRestSiblings: false },
+        ],
+        '@typescript-eslint/no-explicit-any': 0,
+        '@typescript-eslint/explicit-member-accessibility': 0,
+        '@typescript-eslint/explicit-function-return-type': 0,
+        '@typescript-eslint/no-use-before-define': 0,
+        '@typescript-eslint/no-var-requires': 0,
+        '@typescript-eslint/interface-name-prefix': 0,
+        '@typescript-eslint/no-empty-interface': 0,
+        '@typescript-eslint/ban-types': 0,
+        '@typescript-eslint/no-empty-function': 0, // 允许函数内容为空
+        '@typescript-eslint/no-this-alias': [
+            // 允许 this 别名
+            2,
+            {
+                allowDestructuring: false, // 不允许从 this 中解构，默认值 true
+                allowedNames: ['self', '_this', 'that'], // 允许别名，默认值 []
+            },
+        ],
+
+        'standard/object-curly-even-spacing': 0,
+        // standard 要求 callback 内的值不为具体值
+        'standard/no-callback-literal': 0,
+        'n/no-callback-literal': 0,
+    },
+};

package/.prettierrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+    semi: true, // 行末添加分号
+    tabWidth: 4, // tab 缩进，默认 2
+    printWidth: 80, // 换行长度，默认 80
+    singleQuote: true, // 单引号
+    useTabs: false, // 使用 tab 缩进，默认 false 使用空格
+    bracketSpacing: true, // 对象中打印空格 默认 true
+    arrowParens: 'avoid', // 箭头函数参数括号 可选 avoid(一个参数时省略) | always
+    trailingComma: 'es5', // 尾逗号 可选 none | es5 | all
+};

package/.stylelintrc.js

@@ -0,0 +1,29 @@
+module.exports = {
+    files: ['**/*.css', '**/*.scss'],
+    customSyntax: require.resolve('postcss-scss'),
+    extends: 'stylelint-config-standard',
+    plugins: ['stylelint-order', 'stylelint-scss'],
+    rules: {
+        // null 为关闭规则
+        indentation: 4, // 缩进4格
+        'declaration-empty-line-before': 'never', // 第一条属性声明前不允许有空行
+        'selector-class-pattern': '[a-zA-Z]+', // className 的大小写
+        // 规则之前的空行
+        'rule-empty-line-before': [
+            'always',
+            {
+                except: ['inside-block', 'first-nested', 'after-single-line-comment'],
+            },
+        ],
+        'alpha-value-notation': 'number', // 小数显示数字(number)或百分数(percentage)
+        'color-function-notation': 'legacy', // 颜色 rgba 等使用传统逗号隔开
+        'color-hex-case': 'upper', // 颜色十六进制字符大写
+        'selector-list-comma-newline-after': 'always-multi-line',
+        'max-line-length': 300, // 最大宽度
+        'font-family-no-missing-generic-family-keyword': null, // 是否必须包含通用字体
+        'no-descending-specificity': null, // 选择器顺序
+        'keyframes-name-pattern': null, // keyframes 推荐小写+连字符命名
+        'no-empty-source': null, // 空文件
+        'block-no-empty': null, // 空规则
+    },
+};

package/README.md

@@ -0,0 +1,121 @@
+# [ko-lint-config] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url]
+
+[npm-image]: https://img.shields.io/npm/v/ko-lint-config.svg
+[npm-url]: https://npmjs.org/package/ko-lint-config
+[downloads-image]: https://img.shields.io/npm/dm/ko-lint-config.svg
+[downloads-url]: https://npmjs.org/package/ko-lint-config
+
+<p align="center">
+  English | <a href="./README_CN.md">简体中文 (Simplified Chinese)</a>
+</p>
+
+This module saves time in three ways for you:
+
+- **No configuration** - The easier way to enforce code quality in your
+  project. No configuration rules. It just works.
+- **Automatically format code** - Just run `pnpm lint-fix` and say goodbye to
+  messy or inconsistent code.
+- **Catch style issues & programmer errors early** - Reduce manual review in the code review process, and leave simple things to tools to save time.
+
+No hesitation. No more maintenance `.eslintrc`. Give it a try right now!
+
+## Detailed rules
+- **four spaces are required** – indent
+- **single quotation marks are required for string** – except where escape is need
+- **require keyword followed by space** - ` if (condition) {...}`
+- **requires no spaces after the function name** - ` function name (arg) {...}` except anonymous functions and async ` function (arg) {...} `` async () { ... }`
+- **semicolons are not mandatory**
+- **not mandatory = = =** - the field type returned by the backend cannot be guaranteed
+- **do not force ternary operators to wrap**
+- **allow but do not require trailing commas** - when the last element or attribute is on a different line from the end or attribute
+- **function content is allowed to be empty**
+- **allow this alias** - alias optional `self` `_this` `that', cannot be deconstructed from this
+- **no debugger required**
+- **no console is recommended**
+
+## Install
+
+``` bash
+pnpm add ko-lint-config -D
+```
+
+## Usage
+
+&emsp;&emsp;How to get Code Style Guide: <a href="https://dtstack.yuque.com/rd-center/sm6war/eeyxxe" target="_black">如何引入 Code Style Guide</a>
+
+1、Then, add this to your `.eslintrc.js`、`.prettierrc.js`、`.stylelintrc.js` file:
+
+``` js
+module.exports = {
+  extends: [require.resolve('ko-lint-config')],
+}
+```
+``` js
+const prettier = require('ko-lint-config/.prettierrc')
+
+module.exports = {
+  ...prettier,
+}
+```
+``` js
+module.exports = {
+  extends: [require.resolve('ko-lint-config/.stylelintrc')],
+}
+```
+
+You should not override settings. Because this is a Code Style Guide for group.
+
+2、Add script to `package.json`:
+
+``` json
+"scripts": {
+  "lint": "npx eslint './src/**/*.ts' './src/**/*.tsx'",
+  "lint-fix": "npx eslint './src/**/*.ts' './src/**/*.tsx' --fix",
+  "lint-css": "npx stylelint './src/**/*.scss' './src/**/*.css'",
+  "lint-css-fix": "npx stylelint './src/**/*.scss' './src/**/*.css' --fix"
+},
+```
+
+You can use `pnpm lint-fix` to correct most code style problems.
+
+## How do I disable a eslint rule?
+
+In rare cases, you'll need to break a rule and hide the error generated by `Code Style Guide`.
+
+`ko-lint-config` uses [ESLint](http://eslint.org/) under-the-hood and
+you can hide errors as you normally would if you used ESLint directly. stylelint is same to eslint.
+
+Disable **all rules** on a specific line:
+
+```js
+file = 'I know what I am doing' // eslint-disable-line
+```
+
+Or, disable **only** the `"no-use-before-define"` rule:
+
+```js
+file = 'I know what I am doing' // eslint-disable-line no-use-before-define
+```
+
+Or, disable the `"no-use-before-define"` rule for **multiple lines**:
+
+```js
+/* eslint-disable no-use-before-define */
+console.log('offending code goes here...')
+console.log('offending code goes here...')
+console.log('offending code goes here...')
+/* eslint-enable no-use-before-define */
+```
+
+### Looking for something easier than this?
+
+You can add to your `pnpm lint` script and install eslint plugin for vscode.
+
+
+## Learn more
+
+[Code-Style-Guide](https://github.com/DTStack/Code-Style-Guide)
+
+## License
+
+MIT. Copyright (c) 2022 dt-insight

package/README_CN.md

@@ -0,0 +1,116 @@
+# [eslint-config-dt-insight] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url]
+
+[npm-image]: https://img.shields.io/npm/v/ko-lint-config.svg
+[npm-url]: https://npmjs.org/package/ko-lint-config
+[downloads-image]: https://img.shields.io/npm/dm/ko-lint-config.svg
+[downloads-url]: https://npmjs.org/package/ko-lint-config
+
+<p align="center">
+  简体中文 | <a href="./README.md">English</a>
+</p>
+
+通过以下方式为你的项目节省时间：
+
+- **无须配置规则** - 统一的代码风格，无须配置规则，轻松拥有。
+- **自动代码格式化** - 只需运行 `pnpm lint-fix` 从此和脏乱差的代码说再见。
+- **提前发现风格及程序问题** - 减少 Code Review 过程中的人工审查，简单的事情交给工具做，节约时间。
+
+无须犹豫。再也不用维护 `.eslintrc` 了，开箱即用。
+
+## 细则
+
+- **要求使用四个空格** – 进行缩进
+- **要求字符串使用单引号** – 需要转义的地方除外
+- **要求关键字后加空格** - `if (condition) { ... }`
+- **要求函数名后不加空格** - `function name(arg) { ... }` 匿名函数、async 除外 `function (arg) { ... }` `async () { ... }`
+- **不强制要求有无分号**
+- **不强制使用 ===** - 后端返回的字段类型不敢保证
+- **不强制三元运算符换行**
+- **允许但不要求尾随逗号** - 当最后一个元素或属性与结束或属性位于不同的行时
+- **允许函数内容为空**
+- **允许 this 别名** - 别名可选 `self` `_this` `that`，不可以从 this 解构
+- **要求无 debugger**
+- **建议无 console**
+
+## 安装
+
+``` bash
+pnpm add ko-lint-config -D
+```
+
+## 使用
+
+&emsp;&emsp;<a href="https://dtstack.yuque.com/rd-center/sm6war/eeyxxe" target="_black">如何引入 Code Style Guide</a>
+
+1、在 `.eslintrc.js`、`.prettierrc.js`、`.stylelintrc.js` 文件中:
+
+``` js
+module.exports = {
+  extends: [require.resolve('ko-lint-config')],
+}
+```
+``` js
+const prettier = require('ko-lint-config/.prettierrc')
+
+module.exports = {
+  ...prettier,
+}
+```
+``` js
+module.exports = {
+  extends: [require.resolve('ko-lint-config/.stylelintrc')],
+}
+```
+
+因为这是统一代码风格，所以 `ko-lint-config` 不应该被自定义规则覆盖。
+
+2、在 `package.json` 文件中添加 script:
+
+``` json
+"scripts": {
+  "lint": "npx eslint './src/**/*.ts' './src/**/*.tsx'",
+  "lint-fix": "npx eslint './src/**/*.ts' './src/**/*.tsx' --fix",
+  "lint-css": "npx stylelint './src/**/*.scss' './src/**/*.css'",
+  "lint-css-fix": "npx stylelint './src/**/*.scss' './src/**/*.css' --fix"
+},
+```
+
+你可以使用 `pnpm lint-fix` 来纠正大部分的代码风格问题。
+
+## 如何隐藏某类警告？
+
+很少的情况下你需要绕开 `Code Style Guide` 以隐藏某些警告信息。
+
+`ko-lint-config` 代码规范底层使用的是 [ESLint](http://eslint.org/)。所以如果你想隐藏某些警告，方法和使用 ESLint 时一样，stylelint 同理。
+
+对某一行禁用**所有规则**：
+```js
+file = 'I know what I am doing' // eslint-disable-line
+```
+
+或者，**只禁**用 `"no-use-before-define"` 这条规则：
+```js
+file = 'I know what I am doing' // eslint-disable-line no-use-before-define
+```
+
+或者，对**多行**禁用 `"no-use-before-define"` 这一规则：
+```js
+/* eslint-disable no-use-before-define */
+console.log('offending code goes here...')
+console.log('offending code goes here...')
+console.log('offending code goes here...')
+/* eslint-enable no-use-before-define */
+```
+
+### 使用技巧
+
+可以将 ESLint 的检查放到 `pnpm lint` 命令中，vscode 安装 eslint 插件。
+
+
+## 了解更多
+
+[Code-Style-Guide](https://github.com/DTStack/Code-Style-Guide)
+
+## License
+
+MIT. Copyright (c) 2022 dt-insight

package/index.js

@@ -0,0 +1 @@
+module.exports = require('./.eslintrc')

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "ko-lint-config",
+  "version": "0.0.1",
+  "description": "lint configs about eslint stylelint and prettier",
+  "main": "index.js",
+  "scripts": {
+    "lint": "eslint .",
+    "test": "tape test/*.js"
+  },
+  "keywords": [
+    "code style",
+    "eslint",
+    "eslint config",
+    "prettier",
+    "stylelint",
+    "lint"
+  ],
+  "bugs": {
+    "url": "https://github.com/DTStack/ko/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DTStack/ko"
+  },
+  "homepage": "https://github.com/DTStack/ko",
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.18.0",
+    "@typescript-eslint/parser": "^5.18.0",
+    "eslint": "^8.0.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-dt-react": "^0.0.1",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jest": "^26.1.3",
+    "eslint-plugin-jsx-a11y": "^6.5.1",
+    "eslint-plugin-n": "^15.0.0",
+    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-react": "^7.29.4",
+    "eslint-plugin-react-hooks": "^4.4.0",
+    "eslint-plugin-sort-requires": "^2.1.0",
+    "postcss": "^8.4.12",
+    "postcss-scss": "^4.0.3",
+    "stylelint": "^14.7.1",
+    "stylelint-config-standard": "^25.0.0",
+    "stylelint-order": "^5.0.0",
+    "stylelint-scss": "^4.2.0"
+  },
+  "devDependencies": {
+    "tape": "^5.5.2",
+    "typescript": "^4.6.3"
+  },
+  "engines": {
+    "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+  }
+}

package/pnpm-global/5/node_modules/.pnpm/lock.yaml

@@ -0,0 +1,7 @@
+lockfileVersion: 5.3
+
+specifiers:
+  eslint-plugin-dt-react: ^0.0.1
+
+dependencies:
+  eslint-plugin-dt-react: link:../../../../../../../../pnpm-global/5/node_modules/eslint-plugin-dt-react

package/test/basic.js

@@ -0,0 +1,15 @@
+/* eslint-disable import/no-extraneous-dependencies */
+const config = require('../');
+const test = require('tape');
+
+test('test basic properties of config', function (t) {
+    t.ok(isObject(config.parserOptions));
+    t.ok(isObject(config.env));
+    t.ok(isObject(config.globals));
+    t.ok(isObject(config.rules));
+    t.end();
+});
+
+function isObject(obj) {
+    return typeof obj === 'object' && obj !== null;
+}

package/test/validate-config.js

@@ -0,0 +1,19 @@
+/* eslint-disable import/no-extraneous-dependencies */
+const { ESLint } = require('eslint');
+const test = require('tape');
+
+test('load config in eslint to validate all rule syntax is correct', async function (t) {
+    const eslint = new ESLint();
+    const code = 'const foo = 1\nconst bar = (val) => val + 1\nbar(foo)\n';
+    const [lintResult] = await eslint.lintText(code);
+    t.equal(lintResult.errorCount, 0);
+    t.end();
+});
+
+test('ensure we allow top level await', async function (t) {
+    const eslint = new ESLint();
+    const code = 'const foo = await 1\nconst bar = (val) => val + 2\nawait bar(foo)\n';
+    const [lintResult] = await eslint.lintText(code);
+    t.equal(lintResult.errorCount, 0);
+    t.end();
+});