feat(configurations): split prettier configuration, update dependencies, improve build process

Author: weirdpattern

.eslintignore

@@ -0,0 +1,3 @@
+/specs/samples/**
+/coverage/**
+/node_modules/**

.gitattributes

@@ -0,0 +1 @@
+* text eol=lf

.npmignore

@@ -0,0 +1,10 @@
+**/*
+!src
+!index.js
+!react.js
+!prettier.js
+!prettier-react.js
+!package.json
+!CHANGELOG.md
+!README.md
+!LICENSE

.npmrc

@@ -0,0 +1 @@
+package-lock = false

CHANGELOG.md

@@ -1,3 +1,24 @@
+# v2.0.0
+[link](https://github.com/weirdpattern/eslint-config-typescript/compare/v1.1.0...v2.0.0)
+
+This release contains **breaking changes**
+
+* Move from manual configurations to `plugin:*/recommended`
+* Split prettier configuration in two
+  * prettier.js will hold prettier + typescript configurations
+  * prettier-react.js will hold prettier + typescript + react configurations
+* Update dependencies
+* Remove prettier and react from peer-dependencies
+  * The dependencies are still required when using prettier and react configurations, but these way at least the user won't get the warning.
+  * This comes handy when working on typescript projects that don't use react.
+
+# v1.1.0
+[link](https://github.com/weirdpattern/eslint-config-typescript/compare/v1.0.2...v1.1.0)
+
+* Simplified eslint configurations
+* Simplified build configurations
+* Add new typescript rules
+
 # v1.0.2
 [link](https://github.com/weirdpattern/eslint-config-typescript/compare/v1.0.1...v1.0.2)
 

README.md

@@ -26,18 +26,20 @@ A few ESLint plugins are supported as well:
     "typescript",
     "typescript/react",
     "typescript/prettier"
+    "typescript/prettier-react"
   ]
 }
 ```
 
+Note: `typescript/prettier-react` will automatically import `typescript\prettier`.
+
 ## Example configuration
 Using default prettier configurations:
 ```json
 {
   "extends": [
     "typescript",
-    "typescript/react",
-    "typescript/prettier"
+    "typescript/prettier"    
   ],
   "plugins": ["filenames", "jest"],
   "env": {    
@@ -55,13 +57,13 @@ Using default prettier configurations:
 }
 ```
 
-Using specific prettier configurations:
+Using specific react configurations:
 ```json
 {
   "extends": [
     "typescript",
     "typescript/react",
-    "typescript/prettier"
+    "typescript/prettier-react"
   ],
   "plugins": ["filenames", "jest"],
   "env": {    
@@ -80,8 +82,7 @@ Using specific prettier configurations:
       {
         "semi": false,
         "tabWidth": 4,
-        "singleQuote": true,
-        "parser": "typescript"
+        "singleQuote": true
       }
     ]
   }

index.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2017, WeirdPattern
+ * Copyright (c) 2019, Patricio Trevino
  * All rights reserved.
  *
  * This source code is licensed under the MIT-style license found in the

package.json

@@ -1,67 +1,56 @@
 {
   "license": "MIT",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "name": "eslint-config-typescript",
-  "description": "An opinionated set of ESLint rules for TypeScript projects",
+  "description": "A base set of recommended ESLint rules for TypeScript projects",
   "author": "Patricio Trevino <patricio@weirdpattern.com>",
   "repository": {
     "type": "git",
     "url": "https://www.github.com/weirdpattern/eslint-config-typescript.git"
   },
-  "files": [
-    "src/",
-    "index.js",
-    "prettier.js",
-    "react.js"
-  ],
   "keywords": [
     "eslint",
     "config",
     "eslintconfig",
+    "eslint-config",
     "typescript",
     "prettier",
     "react"
   ],
   "devDependencies": {
-    "@types/node": "^10.3.6",
+    "@typescript-eslint/eslint-plugin": "^1.0.0",
+    "@typescript-eslint/parser": "^1.0.0",
     "create-react-class": "^15.6.3",
-    "eslint": "^5.0.0",
-    "eslint-config-prettier": "^2.9.0",
+    "cross-spawn": "^6.0.5",
+    "eslint": "^5.12.1",
+    "eslint-config-prettier": "^3.6.0",
     "eslint-plugin-filenames": "^1.3.2",
-    "eslint-plugin-prettier": "^2.6.1",
-    "eslint-plugin-react": "^7.10.0",
-    "eslint-plugin-typescript": "^0.12.0",
-    "husky": "^0.14.3",
-    "jest": "^23.2.0",
-    "lint-staged": "^7.2.0",
-    "prettier": "^1.13.6",
-    "typescript": "^2.9.2",
-    "typescript-eslint-parser": "^16.0.0"
+    "eslint-plugin-jsdoc": "^4.0.1",
+    "eslint-plugin-prettier": "^3.0.1",
+    "eslint-plugin-react": "^7.12.4",
+    "husky": "^1.3.1",
+    "jest": "^23.6.0",
+    "lint-staged": "^8.1.0",
+    "prettier": "^1.16.0",
+    "typescript": "^3.2.4"
   },
   "peerDependencies": {
-    "eslint": "*",
-    "eslint-config-prettier": "*",
-    "eslint-plugin-prettier": "*",
-    "eslint-plugin-react": "*",
-    "eslint-plugin-typescript": "*",
-    "prettier": "*",
-    "typescript": "*",
-    "typescript-eslint-parser": "*"
+    "@typescript-eslint/eslint-plugin": ">=1.0.0",
+    "@typescript-eslint/parser": ">=1.0.0",
+    "eslint": ">=5.0.0",
+    "typescript": ">=3.2.1"
   },
   "scripts": {
-    "format": "npm run format:root && npm run format:src && npm run format:specs",
-    "format:root": "prettier --write ./*.js",
-    "format:src": "prettier --write ./src/{,**}/*.js",
-    "format:specs": "prettier --write ./specs/{,**}/*.js",
-    "lint": "npm run lint:root && npm run lint:src && npm run lint:specs",
-    "lint:root": "eslint ./*.js",
-    "lint:src": "eslint ./src/{,**}/*.js",
-    "lint:specs": "eslint ./specs/{,**}/*.js",
+    "lint": "eslint .",
     "test": "jest",
-    "test:verbose": "jest --verbose",
     "test:coverage": "jest --coverage",
     "test:spec": "eslint --format json",
-    "precommit": "lint-staged && npm test"
+    "test:verbose": "jest --verbose"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged && npm test"
+    }
   },
   "lint-staged": {
     "*.js{,x}": [
@@ -70,8 +59,8 @@
     ]
   },
   "eslintConfig": {
-    "extends": ["eslint:recommended", "prettier"],
-    "plugins": ["prettier", "filenames"],
+    "extends": ["eslint:recommended", "plugin:jsdoc/recommended", "prettier"],
+    "plugins": ["prettier", "filenames", "jsdoc"],
     "parserOptions": {
       "sourceType": "module",
       "ecmaVersion": 2015,
@@ -84,35 +73,16 @@
       "node": true,
       "jest": true
     },
+    "settings": {
+      "jsdoc": {
+        "allowOverrideWithoutParam": true,
+        "allowImplementsWithoutParam": true,
+        "allowAugmentsExtendsWithoutParam": true
+      }
+    },
     "rules": {
       "semi": "error",
-      "no-undef": "off",
-      "no-unused-vars": "off",
-      "require-jsdoc": "error",
-      "no-console": [
-        "error",
-        {
-          "allow": ["warn", "error"]
-        }
-      ],
-      "valid-jsdoc": [
-        "error",
-        {
-          "preferType": {
-            "any": "*",
-            "Boolean": "boolean",
-            "Number": "number",
-            "Object": "object",
-            "String": "string",
-            "return": "returns"
-          },
-          "requireReturnType": true,
-          "requireParamDescription": true,
-          "requireReturnDescription": true
-        }
-      ],
       "quotes": ["error", "double", { "avoidEscape": true }],
-      "jsx-quotes": ["error", "prefer-single"],
       "filenames/match-exported": ["error", "kebab"],
       "prettier/prettier": "error"
     }
@@ -131,7 +101,7 @@
     "resetModules": true,
     "collectCoverage": false,
     "collectCoverageFrom": [
-      "{index,prettier,react}.{j,t}s{,x}",
+      "{index,prettier,prettier-react,react}.{j,t}s{,x}",
       "src/*.{j,t}s{,x}",
       "!**/*.min.js",
       "!**/static/**",

prettier-react.js

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2019, Patricio Trevino
+ * All rights reserved.
+ *
+ * This source code is licensed under the MIT-style license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/* eslint-disable filenames/match-exported */
+
+"use strict";
+
+const configuration = require("./src/prettier");
+configuration.extends.push("prettier/react");
+
+module.exports = configuration;
+
+/* eslint-enable filenames/match-exported */

prettier.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2017, WeirdPattern
+ * Copyright (c) 2019, Patricio Trevino
  * All rights reserved.
  *
  * This source code is licensed under the MIT-style license found in the