@entva/styleguide 0.0.0

package/tooling/packages/biome/package-lock.json

@@ -0,0 +1,183 @@
+{
+  "name": "@entva/styleguide",
+  "version": "1.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "@entva/styleguide",
+      "version": "1.0.0",
+      "license": "MIT",
+      "devDependencies": {
+        "@biomejs/biome": "^1.9.4"
+      },
+      "peerDependencies": {
+        "@biomejs/biome": "^1.x.x"
+      }
+    },
+    "node_modules/@biomejs/biome": {
+      "version": "1.9.4",
+      "resolved": "https://registry.npmjs.org/@biomejs/biome/-/biome-1.9.4.tgz",
+      "integrity": "sha512-1rkd7G70+o9KkTn5KLmDYXihGoTaIGO9PIIN2ZB7UJxFrWw04CZHPYiMRjYsaDvVV7hP1dYNRLxSANLaBFGpog==",
+      "dev": true,
+      "hasInstallScript": true,
+      "license": "MIT OR Apache-2.0",
+      "bin": {
+        "biome": "bin/biome"
+      },
+      "engines": {
+        "node": ">=14.21.3"
+      },
+      "funding": {
+        "type": "opencollective",
+        "url": "https://opencollective.com/biome"
+      },
+      "optionalDependencies": {
+        "@biomejs/cli-darwin-arm64": "1.9.4",
+        "@biomejs/cli-darwin-x64": "1.9.4",
+        "@biomejs/cli-linux-arm64": "1.9.4",
+        "@biomejs/cli-linux-arm64-musl": "1.9.4",
+        "@biomejs/cli-linux-x64": "1.9.4",
+        "@biomejs/cli-linux-x64-musl": "1.9.4",
+        "@biomejs/cli-win32-arm64": "1.9.4",
+        "@biomejs/cli-win32-x64": "1.9.4"
+      }
+    },
+    "node_modules/@biomejs/cli-darwin-arm64": {
+      "version": "1.9.4",
+      "resolved": "https://registry.npmjs.org/@biomejs/cli-darwin-arm64/-/cli-darwin-arm64-1.9.4.tgz",
+      "integrity": "sha512-bFBsPWrNvkdKrNCYeAp+xo2HecOGPAy9WyNyB/jKnnedgzl4W4Hb9ZMzYNbf8dMCGmUdSavlYHiR01QaYR58cw==",
+      "cpu": [
+        "arm64"
+      ],
+      "dev": true,
+      "license": "MIT OR Apache-2.0",
+      "optional": true,
+      "os": [
+        "darwin"
+      ],
+      "engines": {
+        "node": ">=14.21.3"
+      }
+    },
+    "node_modules/@biomejs/cli-darwin-x64": {
+      "version": "1.9.4",
+      "resolved": "https://registry.npmjs.org/@biomejs/cli-darwin-x64/-/cli-darwin-x64-1.9.4.tgz",
+      "integrity": "sha512-ngYBh/+bEedqkSevPVhLP4QfVPCpb+4BBe2p7Xs32dBgs7rh9nY2AIYUL6BgLw1JVXV8GlpKmb/hNiuIxfPfZg==",
+      "cpu": [
+        "x64"
+      ],
+      "dev": true,
+      "license": "MIT OR Apache-2.0",
+      "optional": true,
+      "os": [
+        "darwin"
+      ],
+      "engines": {
+        "node": ">=14.21.3"
+      }
+    },
+    "node_modules/@biomejs/cli-linux-arm64": {
+      "version": "1.9.4",
+      "resolved": "https://registry.npmjs.org/@biomejs/cli-linux-arm64/-/cli-linux-arm64-1.9.4.tgz",
+      "integrity": "sha512-fJIW0+LYujdjUgJJuwesP4EjIBl/N/TcOX3IvIHJQNsAqvV2CHIogsmA94BPG6jZATS4Hi+xv4SkBBQSt1N4/g==",
+      "cpu": [
+        "arm64"
+      ],
+      "dev": true,
+      "license": "MIT OR Apache-2.0",
+      "optional": true,
+      "os": [
+        "linux"
+      ],
+      "engines": {
+        "node": ">=14.21.3"
+      }
+    },
+    "node_modules/@biomejs/cli-linux-arm64-musl": {
+      "version": "1.9.4",
+      "resolved": "https://registry.npmjs.org/@biomejs/cli-linux-arm64-musl/-/cli-linux-arm64-musl-1.9.4.tgz",
+      "integrity": "sha512-v665Ct9WCRjGa8+kTr0CzApU0+XXtRgwmzIf1SeKSGAv+2scAlW6JR5PMFo6FzqqZ64Po79cKODKf3/AAmECqA==",
+      "cpu": [
+        "arm64"
+      ],
+      "dev": true,
+      "license": "MIT OR Apache-2.0",
+      "optional": true,
+      "os": [
+        "linux"
+      ],
+      "engines": {
+        "node": ">=14.21.3"
+      }
+    },
+    "node_modules/@biomejs/cli-linux-x64": {
+      "version": "1.9.4",
+      "resolved": "https://registry.npmjs.org/@biomejs/cli-linux-x64/-/cli-linux-x64-1.9.4.tgz",
+      "integrity": "sha512-lRCJv/Vi3Vlwmbd6K+oQ0KhLHMAysN8lXoCI7XeHlxaajk06u7G+UsFSO01NAs5iYuWKmVZjmiOzJ0OJmGsMwg==",
+      "cpu": [
+        "x64"
+      ],
+      "dev": true,
+      "license": "MIT OR Apache-2.0",
+      "optional": true,
+      "os": [
+        "linux"
+      ],
+      "engines": {
+        "node": ">=14.21.3"
+      }
+    },
+    "node_modules/@biomejs/cli-linux-x64-musl": {
+      "version": "1.9.4",
+      "resolved": "https://registry.npmjs.org/@biomejs/cli-linux-x64-musl/-/cli-linux-x64-musl-1.9.4.tgz",
+      "integrity": "sha512-gEhi/jSBhZ2m6wjV530Yy8+fNqG8PAinM3oV7CyO+6c3CEh16Eizm21uHVsyVBEB6RIM8JHIl6AGYCv6Q6Q9Tg==",
+      "cpu": [
+        "x64"
+      ],
+      "dev": true,
+      "license": "MIT OR Apache-2.0",
+      "optional": true,
+      "os": [
+        "linux"
+      ],
+      "engines": {
+        "node": ">=14.21.3"
+      }
+    },
+    "node_modules/@biomejs/cli-win32-arm64": {
+      "version": "1.9.4",
+      "resolved": "https://registry.npmjs.org/@biomejs/cli-win32-arm64/-/cli-win32-arm64-1.9.4.tgz",
+      "integrity": "sha512-tlbhLk+WXZmgwoIKwHIHEBZUwxml7bRJgk0X2sPyNR3S93cdRq6XulAZRQJ17FYGGzWne0fgrXBKpl7l4M87Hg==",
+      "cpu": [
+        "arm64"
+      ],
+      "dev": true,
+      "license": "MIT OR Apache-2.0",
+      "optional": true,
+      "os": [
+        "win32"
+      ],
+      "engines": {
+        "node": ">=14.21.3"
+      }
+    },
+    "node_modules/@biomejs/cli-win32-x64": {
+      "version": "1.9.4",
+      "resolved": "https://registry.npmjs.org/@biomejs/cli-win32-x64/-/cli-win32-x64-1.9.4.tgz",
+      "integrity": "sha512-8Y5wMhVIPaWe6jw2H+KlEm4wP/f7EW3810ZLmDlrEEy5KvBsb9ECEfu/kMWD484ijfQ8+nIi0giMgu9g1UAuuA==",
+      "cpu": [
+        "x64"
+      ],
+      "dev": true,
+      "license": "MIT OR Apache-2.0",
+      "optional": true,
+      "os": [
+        "win32"
+      ],
+      "engines": {
+        "node": ">=14.21.3"
+      }
+    }
+  }
+}

package/tooling/packages/biome/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@entva/styleguide",
+  "description": "Shareable styleguide config for biome",
+  "author": "Max Degterev <max@degterev.me>",
+  "license": "MIT",
+  "readmeFilename": "README.md",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/entva/styleguide"
+  },
+  "bugs": "https://github.com/entva/styleguide/issues",
+  "version": "1.0.0",
+  "keywords": [
+    "linter",
+    "config",
+    "eslint",
+    "biome",
+    "styleguide",
+    "typescript"
+  ],
+  "files": [
+    "biome.json"
+  ],
+  "type": "module",
+  "exports": {
+    "./biome": "./biome.json"
+  },
+  "scripts": {
+    "reinstall": "rm -rf node_modules package-lock.json && npm install",
+    "test": "echo \"Not supported by Biome\" && exit 0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.4"
+  },
+  "peerDependencies": {
+    "@biomejs/biome": "^1.x.x"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,31 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true
+  },
+  "include": [
+    "**/*.ts",
+    "**/*.tsx",
+    "**/*.js",
+    "**/*.jsx"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}

package/typescript/README.md

@@ -0,0 +1,66 @@
+# TypeScript Style Guide
+
+ In this document we outline coding preferences specific to TypeScript. Almost everything that is written in the [JavaScript](javascript/README.md) guide applies for TypeScript as well. It is always good to refresh your memory with the official language documentation [here](https://www.typescriptlang.org/docs/handbook/2/basic-types.html) and react specific guide [here](https://react-typescript-cheatsheet.netlify.app/docs/basic/getting-started/function_components).
+
+## Table of Contents
+
+  1. [Use of Any](#any)
+  1. [Use of Enum](#enum)
+  1. [Namespaces](#namespaces)
+  1. [Types vs Interfaces](#interfaces)
+  1. [Global types](#globals)
+  1. [React uses](#react)
+
+
+## Use of Any
+  <a name="any"></a>
+
+  Use of `any` type is generally discouraged because it defeats the purpose of using TypeScript. However, there are some cases where it is necessary to use `any` type. For example, when you are using a third-party library that does not have type definitions, you can use `any` type to get around the type checking. In this case, you should always try to create a type definition for the library and use it instead of `any`.
+
+  When writing generic functions that don't care about the argument type or internal structure prefer using `unknown`. This is a type-safe alternative to `any` that ensures someone using your function must perform some type of checking before using the argument.
+
+**[⬆ back to top](#table-of-contents)**
+
+
+## Use of Enum
+  <a name="enum"></a>
+
+  Using Enums is frowned upon when the same functionality can be accomplished with simple constants. In many cases single values need to be used in arrays or object types and converting enums to other structures becomes repetitive and cumbersome. Try using constants and only switch to enums when clear benefits are present.
+
+**[⬆ back to top](#table-of-contents)**
+
+## Namespaces
+  <a name="namespaces"></a>
+
+  Namespaces is a legacy feature that was introduced before there was a stable module system in place. Use ES Modules import/export statements instead.
+
+**[⬆ back to top](#table-of-contents)**
+
+## Types vs Interfaces
+  <a name="interfaces"></a>
+
+  Almost everything that can be accomplished with Interfaces can be accomplished with Types as well. We prefer using Types because the type declarations are more consistent and explicit this way. Only use an interface when you need the extensibility and you can't accomplish the same thing with simple types. More on the subject [here](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#differences-between-type-aliases-and-interfaces).
+
+**[⬆ back to top](#table-of-contents)**
+
+## Global types
+  <a name="globals"></a>
+
+  Some libraries like React are accompanied with type definitions that inject global types. This is a legacy feature from the times when there was no stable module system in place. This is no longer necessary and should be avoided. Instead, import the types from the library and use them as you would any other type. This way there is a clear dependency between your code and the library.
+
+**[⬆ back to top](#table-of-contents)**
+
+## React uses
+  <a name="react"></a>
+
+  Using React with TypeScript comes with it's own set of challenges. It is beneficial to read [react guide](https://react-typescript-cheatsheet.netlify.app/docs/basic/getting-started/function_components) including the extended hints explanations.
+
+  As a rule of thumb it is best to not use special types unless absolutely necessary and let TypeScript infer the types instead. For defining a React component in TypeScript this works great:
+
+  ```typescript
+  // you can also inline the type declaration; eliminates naming the prop types, but looks repetitive
+  const App = ({ message }: { message: string }) => <div>{message}</div>;
+  ```
+
+**[⬆ back to top](#table-of-contents)**
+

package/typescript/packages/eslint-typescript-base/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Maxim Degterev <max@degterev.me> (https://max.degterev.me)
+
+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/typescript/packages/eslint-typescript-base/README.md

@@ -0,0 +1,27 @@
+# eslint-config-entva-typescript
+
+> Shareable entva typescript styleguide config for eslint.
+
+Extends [`eslint-config-airbnb-typescript`](https://github.com/iamturns/eslint-config-airbnb-typescript).
+
+A shareable config to enforce entva styleguide: https://github.com/entva/styleguide
+
+To see the rules that this config uses, please read the [config itself](./index.js).
+
+## Installation
+
+```bash
+npm install eslint-config-entva-typescript --save-dev
+```
+
+## Usage
+
+If you've installed `eslint-config-entva-typescript` locally within your project, just set your `eslint` config to:
+
+```json
+{
+  "extends": "eslint-config-entva-typescript"
+}
+```
+
+## [MIT License](LICENSE)

package/typescript/packages/eslint-typescript-base/eslint.config.js

@@ -0,0 +1,3 @@
+import baseConfig from './index.js';
+
+export default baseConfig;

package/typescript/packages/eslint-typescript-base/index.js

@@ -0,0 +1,272 @@
+import baseConfig from 'eslint-config-entva-base';
+import importPlugin from 'eslint-plugin-import';
+import globals from 'globals';
+import typescriptEslint from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+import stylisticTs from '@stylistic/eslint-plugin-ts';
+
+export default [
+  ...baseConfig,
+  {
+    files: [
+      '**/*.test.ts',
+      '**/*.spec.ts',
+    ],
+    languageOptions: {
+      globals: {
+        ...globals.jest,
+      },
+    },
+  },
+  {
+    files: ['**/*.{js,mjs,cjs,ts}'],
+    plugins: {
+      import: importPlugin,
+      '@typescript-eslint': typescriptEslint,
+      '@stylistic/ts': stylisticTs,
+    },
+
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+      },
+
+      parser: tsParser,
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+
+      parserOptions: {
+        parser: '@typescript-eslint/parser',
+        project: './tsconfig.json',
+
+        ecmaFeatures: {
+          generators: false,
+          objectLiteralDuplicateProperties: false,
+        },
+      },
+    },
+
+    settings: {
+      'import/parsers': {
+        '@typescript-eslint/parser': ['.ts', '.d.ts'],
+      },
+
+      'import/resolver': {
+        node: {
+          extensions: ['.mjs', '.js', '.json', '.ts', '.d.ts'],
+        },
+      },
+
+      'import/extensions': ['.mjs', '.js', '.json', '.ts', '.d.ts'],
+      'import/external-module-folders': ['node_modules', 'node_modules/@types'],
+      'import/core-modules': [],
+      'import/ignore': ['node_modules', '\\.(coffee|scss|css|less|hbs|svg|json)$'],
+    },
+
+    rules: {
+      '@stylistic/ts/member-delimiter-style': ['error', {
+        multiline: {
+          delimiter: 'comma',
+        },
+
+        singleline: {
+          delimiter: 'comma',
+        },
+      }],
+
+      '@typescript-eslint/no-explicit-any': ['error', {
+        ignoreRestArgs: true,
+      }],
+
+      '@typescript-eslint/naming-convention': ['error', {
+        selector: 'variable',
+        format: ['camelCase', 'PascalCase', 'UPPER_CASE'],
+        leadingUnderscore: 'allowSingleOrDouble',
+      }, {
+        selector: 'function',
+        format: ['camelCase', 'PascalCase'],
+        leadingUnderscore: 'allowSingleOrDouble',
+      }, {
+        selector: 'typeLike',
+        format: ['PascalCase'],
+        leadingUnderscore: 'allowSingleOrDouble',
+      }],
+
+      '@stylistic/ts/brace-style': ['error', '1tbs', {
+        allowSingleLine: true,
+      }],
+
+      '@stylistic/ts/comma-dangle': ['error', {
+        arrays: 'always-multiline',
+        objects: 'always-multiline',
+        imports: 'always-multiline',
+        exports: 'always-multiline',
+        functions: 'always-multiline',
+        enums: 'always-multiline',
+        generics: 'always-multiline',
+        tuples: 'always-multiline',
+      }],
+
+      '@stylistic/ts/comma-spacing': ['error', {
+        before: false,
+        after: true,
+      }],
+
+      'default-param-last': 'off',
+      '@typescript-eslint/default-param-last': ['error'],
+
+      '@typescript-eslint/dot-notation': ['error', {
+        allowKeywords: true,
+        allowPattern: '',
+        allowPrivateClassPropertyAccess: false,
+        allowProtectedClassPropertyAccess: false,
+        allowIndexSignaturePropertyAccess: false,
+      }],
+
+      '@stylistic/ts/func-call-spacing': ['error', 'never'],
+
+      '@stylistic/ts/indent': ['error', 2, {
+        SwitchCase: 1,
+        VariableDeclarator: 1,
+        outerIIFEBody: 1,
+
+        FunctionDeclaration: {
+          parameters: 1,
+          body: 1,
+        },
+
+        FunctionExpression: {
+          parameters: 1,
+          body: 1,
+        },
+
+        CallExpression: {
+          arguments: 1,
+        },
+
+        ArrayExpression: 1,
+        ObjectExpression: 1,
+        ImportDeclaration: 1,
+        flatTernaryExpressions: false,
+
+        ignoredNodes: [
+          'JSXElement',
+          'JSXElement > *',
+          'JSXAttribute',
+          'JSXIdentifier',
+          'JSXNamespacedName',
+          'JSXMemberExpression',
+          'JSXSpreadAttribute',
+          'JSXExpressionContainer',
+          'JSXOpeningElement',
+          'JSXClosingElement',
+          'JSXFragment',
+          'JSXOpeningFragment',
+          'JSXClosingFragment',
+          'JSXText',
+          'JSXEmptyExpression',
+          'JSXSpreadChild',
+        ],
+
+        ignoreComments: false,
+        offsetTernaryExpressions: false,
+      }],
+
+      '@stylistic/ts/keyword-spacing': ['error', {
+        before: true,
+        after: true,
+
+        overrides: {
+          return: {
+            after: true,
+          },
+
+          throw: {
+            after: true,
+          },
+
+          case: {
+            after: true,
+          },
+        },
+      }],
+
+      '@stylistic/ts/lines-between-class-members': ['error', 'always', {
+        exceptAfterSingleLine: false,
+        exceptAfterOverload: true,
+      }],
+
+      '@typescript-eslint/no-array-constructor': ['error'],
+      '@typescript-eslint/no-dupe-class-members': ['error'],
+
+      '@typescript-eslint/no-empty-function': ['error', {
+        allow: ['arrowFunctions', 'functions', 'methods'],
+      }],
+
+      '@typescript-eslint/no-extra-parens': ['off', 'all', {
+        conditionalAssign: true,
+        nestedBinaryExpressions: false,
+        returnAssign: false,
+        ignoreJSX: 'all',
+        enforceForArrowConditionals: false,
+      }],
+
+      '@stylistic/ts/no-extra-semi': ['error'],
+      '@typescript-eslint/no-implied-eval': ['error'],
+      '@typescript-eslint/no-loss-of-precision': ['error'],
+      '@typescript-eslint/no-loop-func': ['error'],
+
+      '@typescript-eslint/no-magic-numbers': ['off', {
+        ignore: [],
+        ignoreArrayIndexes: true,
+        enforceConst: true,
+        detectObjects: false,
+      }],
+
+      '@typescript-eslint/no-redeclare': ['error'],
+      '@stylistic/ts/space-before-blocks': ['error'],
+
+      'no-shadow': 'off',
+      '@typescript-eslint/no-shadow': ['error'],
+
+      '@typescript-eslint/no-unused-expressions': ['error', {
+        allowShortCircuit: false,
+        allowTernary: false,
+        allowTaggedTemplates: false,
+        enforceForJSX: false,
+      }],
+
+      'no-unused-vars': 'off',
+      '@typescript-eslint/no-unused-vars': ['error', {
+        vars: 'all',
+        args: 'after-used',
+        ignoreRestSiblings: true,
+        caughtErrors: 'none',
+      }],
+
+      '@typescript-eslint/no-use-before-define': ['error', {
+        functions: true,
+        classes: true,
+        variables: true,
+      }],
+
+      '@typescript-eslint/no-useless-constructor': ['error'],
+
+      '@stylistic/ts/quotes': ['error', 'single', {
+        avoidEscape: true,
+      }],
+
+      '@stylistic/ts/space-before-function-paren': ['error', {
+        anonymous: 'always',
+        named: 'never',
+        asyncArrow: 'always',
+      }],
+
+      '@typescript-eslint/require-await': ['off'],
+      '@typescript-eslint/return-await': ['error', 'in-try-catch'],
+      '@stylistic/ts/space-infix-ops': ['error'],
+      '@stylistic/ts/object-curly-spacing': ['error', 'always'],
+    },
+  },
+];