@alexey-ryabov/style-guide 1.0.0-canary.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 datarockets
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,19 @@
+# Style Guide
+
+This repository is the home of my personal style guide, which includes configs
+for popular linting and styling tools.
+
+The following configs are available, and are designed to be used together.
+
+- [Prettier](#prettier)
+- [ESLint](#eslint)
+- [TypeScript](#typescript-1)
+
+## Contributing
+
+Please read [contributing](./CONTRIBUTING.md) guide before creating a pull
+request.
+
+## Acknowledge
+
+Inspired by https://github.com/vercel/style-guide.

package/dist/eslint/configs/base.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The base ESLint config which is shared among all environments.
+ */
+declare const _default: import("eslint/config").Config[];
+export default _default;

package/dist/eslint/configs/base.js

@@ -0,0 +1,25 @@
+// oxlint-disable typescript/no-unsafe-member-access, typescript/no-unsafe-argument
+import { defineConfig } from 'eslint/config';
+import globals from 'globals';
+import * as tseslint from 'typescript-eslint';
+import comments from '@eslint-community/eslint-plugin-eslint-comments/configs';
+import commentsRules from '../rules/comments.js';
+/**
+ * The base ESLint config which is shared among all environments.
+ */
+export default defineConfig(tseslint.configs.base, comments.recommended, {
+    languageOptions: {
+        globals: { ...globals.es2026 },
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+        parserOptions: {
+            projectService: true,
+        },
+    },
+    linterOptions: {
+        reportUnusedDisableDirectives: true,
+    },
+    rules: {
+        ...commentsRules,
+    },
+});

package/dist/eslint/configs/react.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("eslint/config").Config[];
+export default _default;

package/dist/eslint/configs/react.js

@@ -0,0 +1,14 @@
+import eslintReact from '@eslint-react/eslint-plugin';
+import { defineConfig } from 'eslint/config';
+import { TYPESCRIPT_FILES } from '../constants.js';
+import { reactRules, reactTypeCheckedRules } from '../rules/react.js';
+export default defineConfig(eslintReact.configs['recommended-typescript'], {
+    rules: {
+        ...reactRules,
+    },
+}, {
+    files: TYPESCRIPT_FILES,
+    rules: {
+        ...reactTypeCheckedRules,
+    },
+});

package/dist/eslint/configs/storybook.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("eslint/config").Config[];
+export default _default;

package/dist/eslint/configs/storybook.js

@@ -0,0 +1,5 @@
+import { defineConfig } from 'eslint/config';
+import storybook from 'eslint-plugin-storybook';
+export default defineConfig(
+// oxlint-disable-next-line import/no-named-as-default-member
+storybook.configs['flat/recommended']);

package/dist/eslint/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const JAVASCRIPT_FILES: string[];
+export declare const TYPESCRIPT_FILES: string[];

package/dist/eslint/constants.js

@@ -0,0 +1,2 @@
+export const JAVASCRIPT_FILES = ['**/*.{js,jsx,mjs}'];
+export const TYPESCRIPT_FILES = ['**/*.{ts,tsx}'];

package/dist/eslint/rules/comments.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from 'eslint';
+declare const _default: Linter.RulesRecord;
+export default _default;

package/dist/eslint/rules/comments.js

@@ -0,0 +1,19 @@
+export default {
+    /**
+     * `eslint-disable` directive-comments disable ESLint rules in all lines
+     * preceded by the comment. If you forget `eslint-enable` directive-comment,
+     * you may overlook ESLint warnings unintentionally.
+     *
+     * 🚫 Not fixable - https://mysticatea.github.io/eslint-plugin-eslint-comments/rules/disable-enable-pair.html
+     */
+    '@eslint-community/eslint-comments/disable-enable-pair': [
+        'error',
+        { allowWholeFile: true },
+    ],
+    /**
+     * This rule warns directive comments without description.
+     *
+     * 🚫 Not fixable - https://mysticatea.github.io/eslint-plugin-eslint-comments/rules/require-description.html
+     */
+    '@eslint-community/eslint-comments/require-description': 'error',
+};

package/dist/eslint/rules/react.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from 'eslint';
+export declare const reactRules: Linter.RulesRecord;
+export declare const reactTypeCheckedRules: Linter.RulesRecord;

package/dist/eslint/rules/react.js

@@ -0,0 +1,16 @@
+const disabledReactRules = {
+    '@eslint-react/dom/no-missing-button-type': 'off',
+    '@eslint-react/no-array-index-key': 'off',
+    '@eslint-react/set-state-in-effect': 'off',
+};
+export const reactRules = {
+    ...disabledReactRules,
+};
+const disabledReactTypeCheckedRules = {
+    '@eslint-react/dom/no-string-style-prop': 'off',
+    '@eslint-react/dom/no-unknown-property': 'off',
+};
+export const reactTypeCheckedRules = {
+    ...disabledReactTypeCheckedRules,
+    '@eslint-react/no-leaked-conditional-rendering': 'warn',
+};

package/dist/eslint/utils.d.ts

@@ -0,0 +1 @@
+export { includeIgnoreFile } from '@eslint/compat';

package/dist/eslint/utils.js

@@ -0,0 +1 @@
+export { includeIgnoreFile } from '@eslint/compat';

package/dist/oxlint/configs/base.d.ts

@@ -0,0 +1,24 @@
+declare const _default: {
+    categories: {
+        correctness: "error";
+    };
+    plugins: ("eslint" | "unicorn" | "typescript" | "oxc" | "import")[];
+    jsPlugins: string[];
+    options: {
+        typeAware: true;
+        reportUnusedDisableDirectives: "warn";
+    };
+    env: {
+        es2026: true;
+    };
+    rules: {
+        [x: string]: import("oxlint").DummyRule;
+    };
+    overrides: {
+        files: string[];
+        rules: {
+            [k: string]: import("oxlint").DummyRule;
+        };
+    }[];
+};
+export default _default;

package/dist/oxlint/configs/base.js

@@ -0,0 +1,43 @@
+import { defineConfig } from 'oxlint';
+import importRules from '../rules/import.js';
+import standardRules from '../rules/standard.js';
+import stylisticRules from '../rules/stylistic.js';
+import unicornRules from '../rules/unicorn.js';
+import tsdocRules from '../rules/tsdoc.js';
+import typescriptRules from '../rules/typescript.js';
+import { TYPESCRIPT_FILES } from '../constants.js';
+import oxcRules from '../rules/oxc.js';
+export default defineConfig({
+    // There is no recommended configs in Oxlint for now and instead it has
+    // categories for rules so we can enable/disable all rules in a certain
+    // category at once. We only enable `correctness` category and configure
+    // all other rules manually.
+    categories: {
+        correctness: 'error',
+    },
+    plugins: ['oxc', 'eslint', 'unicorn', 'import', 'typescript'],
+    jsPlugins: ['@stylistic/eslint-plugin', 'eslint-plugin-tsdoc'],
+    options: {
+        typeAware: true,
+        reportUnusedDisableDirectives: 'warn',
+    },
+    env: {
+        es2026: true,
+    },
+    rules: {
+        ...oxcRules,
+        ...standardRules,
+        ...stylisticRules,
+        ...importRules,
+        ...unicornRules,
+        ...typescriptRules,
+    },
+    overrides: [
+        {
+            files: TYPESCRIPT_FILES,
+            rules: {
+                ...tsdocRules,
+            },
+        },
+    ],
+});

package/dist/oxlint/configs/browser.d.ts

@@ -0,0 +1,29 @@
+declare const _default: {
+    extends: {
+        categories: {
+            correctness: "error";
+        };
+        plugins: ("eslint" | "unicorn" | "typescript" | "oxc" | "import")[];
+        jsPlugins: string[];
+        options: {
+            typeAware: true;
+            reportUnusedDisableDirectives: "warn";
+        };
+        env: {
+            es2026: true;
+        };
+        rules: {
+            [x: string]: import("oxlint").DummyRule;
+        };
+        overrides: {
+            files: string[];
+            rules: {
+                [k: string]: import("oxlint").DummyRule;
+            };
+        }[];
+    }[];
+    env: {
+        browser: true;
+    };
+};
+export default _default;

package/dist/oxlint/configs/browser.js

@@ -0,0 +1,8 @@
+import { defineConfig } from 'oxlint';
+import baseConfig from './base.js';
+export default defineConfig({
+    extends: [baseConfig],
+    env: {
+        browser: true,
+    },
+});

package/dist/oxlint/configs/next.d.ts

@@ -0,0 +1,17 @@
+declare const _default: {
+    extends: {
+        plugins: ("react" | "jsx-a11y")[];
+        jsPlugins: {
+            name: string;
+            specifier: string;
+        }[];
+        rules: {
+            [k: string]: import("oxlint").DummyRule;
+        };
+    }[];
+    plugins: "nextjs"[];
+    rules: {
+        [k: string]: import("oxlint").DummyRule;
+    };
+};
+export default _default;

package/dist/oxlint/configs/next.js

@@ -0,0 +1,10 @@
+import { defineConfig } from 'oxlint';
+import nextRules from '../rules/next.js';
+import reactConfig from './react.js';
+export default defineConfig({
+    extends: [reactConfig],
+    plugins: ['nextjs'],
+    rules: {
+        ...nextRules,
+    },
+});

package/dist/oxlint/configs/node.d.ts

@@ -0,0 +1,29 @@
+declare const _default: {
+    extends: {
+        categories: {
+            correctness: "error";
+        };
+        plugins: ("eslint" | "unicorn" | "typescript" | "oxc" | "import")[];
+        jsPlugins: string[];
+        options: {
+            typeAware: true;
+            reportUnusedDisableDirectives: "warn";
+        };
+        env: {
+            es2026: true;
+        };
+        rules: {
+            [x: string]: import("oxlint").DummyRule;
+        };
+        overrides: {
+            files: string[];
+            rules: {
+                [k: string]: import("oxlint").DummyRule;
+            };
+        }[];
+    }[];
+    env: {
+        node: true;
+    };
+};
+export default _default;

package/dist/oxlint/configs/node.js

@@ -0,0 +1,8 @@
+import { defineConfig } from 'oxlint';
+import baseConfig from './base.js';
+export default defineConfig({
+    extends: [baseConfig],
+    env: {
+        node: true,
+    },
+});

package/dist/oxlint/configs/react.d.ts

@@ -0,0 +1,11 @@
+declare const _default: {
+    plugins: ("react" | "jsx-a11y")[];
+    jsPlugins: {
+        name: string;
+        specifier: string;
+    }[];
+    rules: {
+        [k: string]: import("oxlint").DummyRule;
+    };
+};
+export default _default;

package/dist/oxlint/configs/react.js

@@ -0,0 +1,9 @@
+import { defineConfig } from 'oxlint';
+import reactRules from '../rules/react.js';
+export default defineConfig({
+    plugins: ['react', 'jsx-a11y'],
+    jsPlugins: [{ name: 'react-js', specifier: 'eslint-plugin-react' }],
+    rules: {
+        ...reactRules,
+    },
+});

package/dist/oxlint/configs/vitest.d.ts

@@ -0,0 +1,4 @@
+declare const _default: {
+    plugins: "vitest"[];
+};
+export default _default;

package/dist/oxlint/configs/vitest.js

@@ -0,0 +1,4 @@
+import { defineConfig } from 'oxlint';
+export default defineConfig({
+    plugins: ['vitest'],
+});

package/dist/oxlint/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const JAVASCRIPT_FILES: string[];
+export declare const TYPESCRIPT_FILES: string[];

package/dist/oxlint/constants.js

@@ -0,0 +1,2 @@
+export const JAVASCRIPT_FILES = ['**/*.{js,jsx,mjs}'];
+export const TYPESCRIPT_FILES = ['**/*.{ts,tsx}'];

package/dist/oxlint/rules/import.d.ts

@@ -0,0 +1,3 @@
+import type { DummyRuleMap } from 'oxlint';
+declare const _default: DummyRuleMap;
+export default _default;

package/dist/oxlint/rules/import.js

@@ -0,0 +1,11 @@
+export default {
+    'import/consistent-type-specifier-style': ['warn', 'prefer-top-level'],
+    'import/first': 'error',
+    'import/no-absolute-path': 'error',
+    'import/no-cycle': process.env.CI ? 'error' : 'off',
+    'import/no-duplicates': 'warn',
+    'import/no-mutable-exports': 'error',
+    'import/no-named-as-default': 'warn',
+    'import/no-named-as-default-member': 'warn',
+    'import/no-self-import': 'error',
+};

package/dist/oxlint/rules/next.d.ts

@@ -0,0 +1,3 @@
+import type { DummyRuleMap } from 'oxlint';
+declare const _default: DummyRuleMap;
+export default _default;

package/dist/oxlint/rules/next.js

@@ -0,0 +1,15 @@
+/**
+ * `jsx-a11y` rules configured for Next.js.
+ */
+const a11yRules = {
+    'jsx-a11y/alt-text': [
+        'warn',
+        {
+            elements: ['img'],
+            img: ['Image'],
+        },
+    ],
+};
+export default {
+    ...a11yRules,
+};

package/dist/oxlint/rules/oxc.d.ts

@@ -0,0 +1,3 @@
+import type { DummyRuleMap } from 'oxlint';
+declare const _default: DummyRuleMap;
+export default _default;

package/dist/oxlint/rules/oxc.js

@@ -0,0 +1,4 @@
+export default {
+    'oxc/approx-constant': 'error',
+    'oxc/no-accumulating-spread': 'warn',
+};

package/dist/oxlint/rules/react.d.ts

@@ -0,0 +1,3 @@
+import type { DummyRuleMap } from 'oxlint';
+declare const _default: DummyRuleMap;
+export default _default;

package/dist/oxlint/rules/react.js

@@ -0,0 +1,13 @@
+export default {
+    'react-js/function-component-definition': 'warn',
+    'react-js/hook-use-state': 'warn',
+    'react-js/jsx-sort-props': ['warn', { reservedFirst: true }],
+    'react-js/no-unstable-nested-components': ['error', { allowAsProps: true }],
+    'react/jsx-boolean-value': 'warn',
+    'react/jsx-curly-brace-presence': 'warn',
+    'react/jsx-fragments': 'warn',
+    'react/jsx-no-constructed-context-values': 'error',
+    'react/jsx-no-useless-fragment': ['warn', { allowExpressions: true }],
+    'react/jsx-pascal-case': 'warn',
+    'react/self-closing-comp': 'warn',
+};

package/dist/oxlint/rules/standard.d.ts

@@ -0,0 +1,3 @@
+import type { DummyRuleMap } from 'oxlint';
+declare const _default: DummyRuleMap;
+export default _default;

package/dist/oxlint/rules/standard.js

@@ -0,0 +1,77 @@
+// TODO: add `object-shorthand` once it's released https://github.com/oxc-project/oxc/commit/0f01fbdf7fd6e65fb7c4402d8214114d283ff7ea
+export default {
+    curly: 'warn',
+    'default-case-last': 'error',
+    'default-param-last': 'error',
+    eqeqeq: 'error',
+    'func-names': ['error', 'as-needed'],
+    'grouped-accessor-pairs': 'error',
+    'guard-for-in': 'error',
+    'no-array-constructor': 'error',
+    'no-await-in-loop': 'error',
+    'no-bitwise': 'error',
+    'no-case-declarations': 'error',
+    'no-console': ['error', { allow: ['warn', 'error', 'info'] }],
+    'no-constant-binary-expression': 'error',
+    'no-constructor-return': 'error',
+    'no-else-return': 'warn',
+    'no-empty': 'error',
+    'no-empty-function': 'error',
+    'no-eval': 'error',
+    'no-extend-native': 'error',
+    'no-extra-bind': 'error',
+    'no-extra-label': 'error',
+    'no-fallthrough': 'error',
+    'no-implicit-coercion': ['warn', { allow: ['!!'] }],
+    'no-implied-eval': 'error',
+    'no-iterator': 'error',
+    'no-label-var': 'error',
+    'no-labels': 'error',
+    'no-lone-blocks': 'error',
+    'no-lonely-if': 'warn',
+    'no-multi-assign': 'error',
+    'no-new': 'error',
+    'no-new-func': 'error',
+    'no-new-wrappers': 'error',
+    'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],
+    'no-promise-executor-return': 'error',
+    'no-proto': 'error',
+    'no-prototype-builtins': 'error',
+    'no-redeclare': 'error',
+    'no-return-assign': 'error',
+    'no-script-url': 'error',
+    'no-self-compare': 'error',
+    'no-sequences': 'error',
+    'no-template-curly-in-string': 'error',
+    'no-unmodified-loop-condition': 'error',
+    'no-unneeded-ternary': 'error',
+    'no-unused-vars': [
+        'error',
+        {
+            args: 'after-used',
+            argsIgnorePattern: '^_',
+            ignoreRestSiblings: false,
+            vars: 'all',
+            varsIgnorePattern: '^_',
+        },
+    ],
+    'no-useless-call': 'error',
+    'no-useless-computed-key': 'warn',
+    'no-useless-concat': 'error',
+    'no-useless-constructor': 'error',
+    'no-useless-rename': 'warn',
+    'no-useless-return': 'warn',
+    'no-var': 'error',
+    'operator-assignment': 'warn',
+    'prefer-const': 'warn',
+    'prefer-exponentiation-operator': 'warn',
+    'prefer-numeric-literals': 'error',
+    'prefer-object-has-own': 'error',
+    'prefer-object-spread': 'warn',
+    'prefer-promise-reject-errors': ['error', { allowEmptyReject: true }],
+    'prefer-rest-params': 'error',
+    'prefer-spread': 'error',
+    'prefer-template': 'warn',
+    'symbol-description': 'error',
+    yoda: 'warn',
+};

package/dist/oxlint/rules/stylistic.d.ts

@@ -0,0 +1,3 @@
+import type { DummyRuleMap } from 'oxlint';
+declare const _default: DummyRuleMap;
+export default _default;

package/dist/oxlint/rules/stylistic.js

@@ -0,0 +1,10 @@
+export default {
+    '@stylistic/padding-line-between-statements': [
+        'warn',
+        // Blank line before `return`
+        { blankLine: 'always', next: 'return', prev: '*' },
+        // Blank line after all directives (e.g. `use strict`)
+        { blankLine: 'always', next: '*', prev: 'directive' },
+        { blankLine: 'any', next: 'directive', prev: 'directive' },
+    ],
+};

package/dist/oxlint/rules/tsdoc.d.ts

@@ -0,0 +1,3 @@
+import type { DummyRuleMap } from 'oxlint';
+declare const _default: DummyRuleMap;
+export default _default;

package/dist/oxlint/rules/tsdoc.js

@@ -0,0 +1,3 @@
+export default {
+    'tsdoc/syntax': 'error',
+};

package/dist/oxlint/rules/typescript.d.ts

@@ -0,0 +1,3 @@
+import type { DummyRuleMap } from 'oxlint';
+declare const _default: DummyRuleMap;
+export default _default;