@petbee/eslint-config 1.0.1-alpha-1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Petbee
+
+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,37 @@
+# `@petbee/prettier-config`
+
+This package provides Petbees's `.prettierrc` shared config.
+
+## Installation
+
+Give that you already have `prettier` installed, run:
+
+```bash
+yarn add -D @petbee/prettier-config
+```
+
+## Usage
+
+After installing the module, add it to your `.prettierrc` configuration file:
+
+```jsonc
+"@petbee/prettier-config"
+```
+
+Or add it to your `package.json`:
+
+```json
+{
+  ...
+  "prettier": "@petbee/prettier-config"
+  ...
+}
+```
+
+Differently from `eslint`, `prettier` shared presets are not extensible, so if you want to override some property, which is not encouraged, you'll need to use the `.prettierrc.js` file.
+
+For more information about configuring `prettier`, please check the [Prettier configuration documentation](https://prettier.io/docs/en/configuration.html).
+
+## References
+
+- [`prettier` options documentation](https://prettier.io/docs/en/options.html)

package/index.js

@@ -0,0 +1,74 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module',
+    warnOnUnsupportedTypeScriptVersion: false,
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:react/recommended',
+    'prettier',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  rules: {
+    // Don't require a weird naming convention for interfaces
+    '@typescript-eslint/interface-name-prefix': 'off',
+
+    // Allow inferring types for functions
+    '@typescript-eslint/explicit-function-return-type': 'off',
+
+    // Allow inferring types for exported things
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+
+    // Don't allow "any" at all
+    '@typescript-eslint/no-explicit-any': 'error',
+
+    // Make sure we are awaiting or explicitly voiding all Promises
+    '@typescript-eslint/no-floating-promises': 'error',
+
+    // Allow using functions that are defined later in the file (fine thanks to hoisting)
+    '@typescript-eslint/no-use-before-define': [
+      'error',
+      { functions: false, classes: false, variables: true },
+    ],
+
+    // This rule makes no difference - ' and " are fine, > and } are already compile errors
+    'react/no-unescaped-entities': 'off',
+
+    // Disable validation of prop types, because we use TS instead and it gets confused
+    'react/prop-types': 'off',
+
+    // Make sure comments are starting with an uppercase letter, to encourage correct grammar
+    'capitalized-comments': [
+      'warn',
+      'always',
+      {
+        ignorePattern: 'prettier|c8',
+        ignoreConsecutiveComments: true,
+      },
+    ],
+
+    // Disable specific syntax features
+    'no-restricted-syntax': [
+      'error',
+      // Don't allow TS enums at all, since they have multiple unintuitive footguns
+      {
+        selector: 'TSEnumDeclaration',
+        message:
+          'Unexpected enum. Use a literal string union or a const object instead.',
+      },
+    ],
+  },
+  settings: {
+    react: {
+      version: 'detect',
+    },
+  },
+}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@petbee/eslint-config",
+  "version": "1.0.1-alpha-1.0",
+  "description": "Petbee's eslint config",
+  "keywords": [
+    "eslint",
+    "config",
+    "petbee"
+  ],
+  "homepage": "https://github.com/petbee/typescript",
+  "license": "MIT",
+  "main": "index.js",
+  "files": [
+    "index.js"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/petbee/typescript.git",
+    "directory": "packages/eslint-config"
+  },
+  "scripts": {
+    "format": "prettier --ignore-path='.gitignore' --list-different --write .",
+    "format:check": "prettier --ignore-path='.gitignore' --check .",
+    "lint": "eslint --ignore-path='.gitignore' '{src,tests}/**/*.{ts,tsx}'"
+  },
+  "eslintConfig": {
+    "extends": "./eslint-config.js"
+  },
+  "prettier": "@petbee/prettier-config",
+  "bugs": {
+    "url": "https://github.com/petbee/typescript/issues"
+  },
+  "dependencies": {
+    "@typescript-eslint/eslint-plugin": "6.10.0",
+    "@typescript-eslint/parser": "6.10.0",
+    "eslint-config-prettier": "9.0.0",
+    "eslint-plugin-react": "7.33.2"
+  },
+  "peerDependencies": {
+    "eslint": "^8.0.0",
+    "typescript": "^4.0.0 || ^5.0.0"
+  },
+  "devDependencies": {
+    "@petbee/prettier-config": "2.0.2",
+    "@types/react": "18.2.37",
+    "eslint": "8.53.0",
+    "prettier": "3.0.3",
+    "react": "18.2.0",
+    "typescript": "5.2.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "c88132ca3b4e5269d65060a0f49ae7f2cbff9173"
+}