zanminkian / git-validator Goto Github PK

• enable '@typescript-eslint/no-explicit-any': 'error'
• enable '@typescript-eslint/no-non-null-assertion': 'error'
• enable '@typescript-eslint/consistent-type-assertions': ['error', { assertionStyle: 'never' }] (should allow as unknown)
• Ban types filed of exports in package.json.
• Use the shortest relative path when import some package.
• Files without extension should raise an error.
• Disable camlecase and enable @typescript-eslint/naming-convention for ts file.
• For monorepo, it should not install package to dependencies in the root package.json.
• add rules to ban export =, import = require() and commonjs (require and module.exports) in ts file. antfu/eslint-config#167
• antfu/eslint-config#159
• ban ++ and --. antfu/eslint-config#182
• block parseInt and parseFloat function. antfu/eslint-config#190
• ban xxx.__proto__, use Object.getPrototype(xxx) instead.
• add curly brackets after all if and for.
• enable no-self-import
• no declaration in ts file. Declaration should only be in *.d.ts file. antfu/eslint-config#217
• ban const enum. check https://www.typescriptlang.org/docs/handbook/enums.html#const-enum-pitfalls
• Ban too-deep parent import. Ban self folder file import via parent path. Importing file from parent folder is reasonable in some case. But Importing file from grandparent folder should be blocked. See no-relative-parent-imports.
• Ban import xxx from './node_modules/xxx'.
• Ban importing files ends with .d.ts, .d.js, .d.
• Prevent to call require or import function and pass a variable. It should pass literal.
• Ban code like +somevar for converting some var to numebr type. We should use Number(somevar) only.
• Enable import/no-relative-packages.
• Correct the space of generic type. See: https://github.com/antfu/eslint-config/blob/main/packages/eslint-plugin-antfu/src/rules/generic-spacing.test.ts.
• When defining a function, we should add a space between the function name and the left bracket. Because it convenient for searching function usage excluding the function definition. antfu/eslint-config#168
• ban public and private descriptor.(protected is useful in ts. And tc39 has no plan of implementing protected keyword.)

Use git-validate lint --fix instead.

@typescript-eslint has bug about extends field in tsconfig.json. We should ask them fix it first.

const map = new Map(); // Unsafe!
const map = new Map<string, number>(); Safe!

const set = new Set() // Unsafe!
const set = new Set<string>() // Safe!

@typescript-eslint/no-unsafe-assignment will help, but is too strict. So we have to find another way.

请问 支持 package.json 在 .git 的子目录下的结构里安装吗

/project
    .git
    /frontend
        package.json   -- 在此安装？

eslint的配置在@git-validator/eslint-config中，是不是只有运行lint命令的时候，配置才生效？如果我在vscode编辑器中下载了vscode-eslint插件，在保存文件时自动校验，那插件能识别到@git-validator/eslint-config的配置吗

• allowArbitraryExtensions
• composite
• inlineSources
• noEmitOnError
• preserveSymlinks
• importHelpers
• moduleDetection

Should work. Not tested. Should test it if I have windows machine.

1. Too many config files in the project root. Not easy enough for newer.
2. Most of Node projects use the same config.
3. Too many packages to install.
4. In summary, too many steps to start up and too messy in the project root.
5. Start committing -> validate the commit message -> validate code/doc/json -> format code/doc/json -> finish committing.

• current project tsconfig

• cli tool builtin tsconfig

Enable rules below when in strict mode:

• enable '@typescript-eslint/no-explicit-any': 'error'
• enable '@typescript-eslint/no-non-null-assertion': 'error'
• enable '@typescript-eslint/consistent-type-assertions': ['error', { assertionStyle: 'never' }] (should allow as unknown)

Just keep it simple.

1. Only lint files those have extension about js ecosystem, like js, ts, vue.
2. Ignore files those have no extension.
3. Ignore file those have an extension that is unsupported, like go, java.

Because prettier will not all curly to the code below

if (xxx)
  console.log(xxx)

欢迎PR

Also we should not use delete as var name

✖ npx git-validator -u:
[error] require() of ES Module /Users/xxx/Desktop/code/practice/getting-started-example/node_modules/.pnpm/[email protected][email protected]/node_modules/prettier-plugin-tailwindcss/dist/index.mjs not supported.
[error] Instead change the require of /Users/xxx/Desktop/code/practice/getting-started-example/node_modules/.pnpm/[email protected][email protected]/node_modules/prettier-plugin-tailwindcss/dist/index.mjs to a dynamic import() which is available in all CommonJS modules.

Not tested. Should test it one day.

• One > N
• Only 2 steps

• Double quote is better than single quote. Because in jsx file or html file, prettier format string used by label to double quote. For example, <div className="xxx"> instead of <div className='xxx'>. So using double quote will make code base consistent.
• Using semi is better than not. In some edge case, user have to add semi, which is not consistent enough.
• Print width 120 is too long maybe. I don't know how much is the best.

1. prevent to install dependencies in monorepo root package.json.
2. ban some fields.
3. dependencies should be used in ts/js file.