feat: add linters and other config

add eslint, prettier, commitlint, husky, std-vs; update package.json scripts closes #2
graasp · Sep 18, 2020 · a65d743 · a65d743
1 parent fba9fba
commit a65d743
Show file tree

Hide file tree

Showing 12 changed files with 1,613 additions and 49 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,5 @@
+build
+public
+coverage
+src/serviceWorker.js
+cypress/integration/examples
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,51 @@
+{
+  "extends": ["react-app", "airbnb", "prettier"],
+  "plugins": ["import", "jsx-a11y", "react"],
+  "env": {
+    "browser": true,
+    "node": true,
+    "mocha": true,
+    "jest": true
+  },
+  "globals": {
+    "cy": true,
+    "Cypress": true
+  },
+  "parser": "babel-eslint",
+  "rules": {
+    "no-underscore-dangle": [
+      "error",
+      {
+        "allow": ["_id", "__REDUX_DEVTOOLS_EXTENSION__"]
+      }
+    ],
+    "jsx-a11y/anchor-is-valid": [
+      "error",
+      {
+        "components": ["Link"],
+        "specialLink": ["to", "hrefLeft", "hrefRight"],
+        "aspects": ["noHref", "invalidHref", "preferButton"]
+      }
+    ],
+    "react/jsx-filename-extension": [
+      1,
+      {
+        "extensions": [".js", ".jsx"]
+      }
+    ],
+    "import/no-named-as-default": 0,
+    "react/static-property-placement": [
+      "error",
+      "property assignment",
+      {
+        "childContextTypes": "static public field",
+        "contextTypes": "static public field",
+        "contextType": "static public field",
+        "defaultProps": "static public field",
+        "displayName": "static public field",
+        "propTypes": "static public field"
+      }
+    ],
+    "react/state-in-constructor": ["error", "never"]
+  }
+}
diff --git a/.huskyrc b/.huskyrc
@@ -0,0 +1,10 @@
+{
+  "hooks": {
+    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+    "post-checkout": "yarn install",
+    "pre-commit": "pretty-quick --staged && yarn lint",
+    "post-commit": "git status",
+    "post-merge": "yarn install",
+    "pre-push": "yarn lint && yarn test:once && yarn build"
+  }
+}
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+save-exact=true
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,6 @@
+{
+  "trailingComma": "all",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true
+}
diff --git a/.versionrc b/.versionrc
@@ -0,0 +1,34 @@
+{
+  "types": [
+    {
+      "type": "feat",
+      "section": "Features"
+    },
+    {
+      "type": "fix",
+      "section": "Bug Fixes"
+    },
+    {
+      "type": "test",
+      "section": "Tests"
+    },
+    {
+      "type": "build",
+      "section": "Build System"
+    },
+    {
+      "type": "docs",
+      "section": "Documentation"
+    },
+    {
+      "type": "ci",
+      "section": "Continuous Integration"
+    },
+    {
+      "type": "chore",
+      "section": "Chores",
+      "hidden": true
+    }
+  ]
+}
+
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };
diff --git a/package.json b/package.json
@@ -14,7 +14,12 @@
     "start": "react-scripts start",
     "build": "react-scripts build",
     "test": "react-scripts test",
-    "eject": "react-scripts eject"
+    "eject": "react-scripts eject",
+    "lint": "eslint .",
+    "prettier:check": "prettier --check 'src/**/*.js'",
+    "prettier:write": "prettier --write 'src/**/*.js'",
+    "hooks:uninstall": "node node_modules/husky/husky.js uninstall",
+    "hooks:install": "node node_modules/husky/husky.js install"
   },
   "eslintConfig": {
     "extends": "react-app"
@@ -30,5 +35,19 @@
       "last 1 firefox version",
       "last 1 safari version"
     ]
+  },
+  "devDependencies": {
+    "@commitlint/cli": "11.0.0",
+    "@commitlint/config-conventional": "11.0.0",
+    "eslint-config-airbnb": "18.2.0",
+    "eslint-config-prettier": "6.11.0",
+    "eslint-plugin-import": "2.22.0",
+    "eslint-plugin-jsx-a11y": "6.3.1",
+    "eslint-plugin-react": "7.20.6",
+    "husky": "4.3.0",
+    "prettier": "2.1.2",
+    "pretty-quick": "3.0.2",
+    "standard-version": "9.0.0",
+    "typescript": "4.0.2"
   }
 }
diff --git a/src/App.js b/src/App.js
@@ -8,7 +8,9 @@ function App() {
       <header className="App-header">
         <img src={logo} className="App-logo" alt="logo" />
         <p>
-          Edit <code>src/App.js</code> and save to reload.
+          Edit
+          <code>src/App.js</code>
+          and save to reload.
         </p>
         <a
           className="App-link"

diff --git a/src/App.test.js b/src/App.test.js
diff --git a/src/setupTests.js b/src/setupTests.js
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		module.exports = { extends: ['@commitlint/config-conventional'] };