@hearthsim/eslint-config-typescript-react 1.0.0

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,29 @@
+name: Publish to NPM
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+      - run: yarn install --frozen-lockfile
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+          registry-url: https://registry.npmjs.org/
+      - run: yarn publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_HEARTHSIM_TOKEN}}

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2022, Benedict Etzel
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,55 @@
+# @hearthsim/eslint-config-typescript-react
+
+This repository contains the HearthSim common ESLint configuration with Typescript and React support.
+
+For a version **without** React support use [@HearthSim/eslint-config-typescript](https://github.com/HearthSim/eslint-config-typescript) instead.
+
+## Setup
+
+1. Install
+
+```bash
+$ yarn add -D eslint @hearthsim/eslint-config-typescript-react
+```
+
+2. Install ESLint plugins  
+Plugins are resolved relative to the final project and must thus installed explicitly as part of the project:
+
+```bash
+$ yarn add -D \
+              @typescript-eslint/eslint-plugin@5.4.0 \
+              eslint-plugin-import@2.25.3 \
+              eslint-plugin-jest@25.2.4 \
+              eslint-plugin-react@7.27.1 \
+              eslint-plugin-react-hooks@4.3.0
+```
+
+3. Configure ESLint:
+
+Create or update your`.eslintrc.js`:
+```js
+module.exports = {
+	root: true,
+	extends: ["@hearthsim/eslint-config-typescript-react"],
+	env: {
+		browser: true,
+	},
+};
+```
+
+4. Add the scripts to your `package.json`:
+
+```json
+{
+	"scripts": {
+		"lint:eslint": "eslint --cache ./"
+	}
+}
+
+```
+
+## Philosophy
+
+### Zero tolerance for Errors false positives
+   If a rule is not able to handle the ways we legitimately use it, it needs to be downgraded to a warning. 
+   Errors are reserved for critical  issues that can directly introduce security risks, break the application or lead to severe performance penalties. 

package/index.js

@@ -0,0 +1,34 @@
+module.exports = {
+	plugins: ["@typescript-eslint", "import"],
+	extends: [
+		"@hearthsim/eslint-config-typescript",
+		"plugin:react/recommended",
+		"plugin:react-hooks/recommended",
+	],
+	settings: {
+		react: {
+			version: "detect",
+		},
+	},
+	rules: {
+		// we don't use this
+		"react/display-name": "off",
+		// not great, but otherwise we get false positives with <Trans> (localization)
+		"react/jsx-key": "warn",
+		// The following rule is very sensible, enforcing noopener is critical. However, we're usually okay with
+		// exposing the referrer. Unfortunately it can't handle styled-components anchors, and cannot always detect
+		// internal links.
+		"react/jsx-no-target-blank": [
+			"warn",
+			{
+				allowReferrer: true,
+			},
+		],
+		// our build chain can handle literals
+		"react/no-unescaped-entities": "off",
+		// doesn't work reliably with typescript (`FC<Props>` vs. `{} :Props`)
+		"react/prop-types": "off",
+		// we shouldn't usually have to worry about this
+		"react/react-in-jsx-scope": "off",
+	},
+};

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@hearthsim/eslint-config-typescript-react",
+  "version": "1.0.0",
+  "description": "HearthSim's presets for ESLint, with Typescript and React support.",
+  "repository": "git@github.com:HearthSim/eslint-config-typescript-react.git",
+  "author": "Benedict Etzel <benedict@hearthsim.net>",
+  "homepage": "https://github.com/HearthSim/eslint-config-typescript-react#readme",
+  "license": "ISC",
+  "scripts": {
+    "format": "prettier --write *.js"
+  },
+  "peerDependencies": {
+    "@typescript-eslint/eslint-plugin": "5.4.0",
+    "eslint": "^6.8.0 || ^7.2.0 || ^8.0.0",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-jest": "^25.2.4",
+    "eslint-plugin-react": "^7.27.1",
+    "eslint-plugin-react-hooks": "^4.3.0",
+    "prettier": ">=2.0.0",
+    "typescript": ">=2.8.0"
+  },
+  "dependencies": {
+    "@hearthsim/eslint-config-typescript": "^2.0.0",
+    "@typescript-eslint/parser": "5.4.0",
+    "eslint-config-prettier": "^8.3.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.0.0",
+    "prettier": "^2.2.1",
+    "typescript": "^4.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "prettier": {
+    "useTabs": true,
+    "trailingComma": "all"
+  }
+}