Improve Prettier DX (#500)

ark120202 · Perryvw · commit 1dd715c32e7a · 2019-03-30T12:22:02.000+01:00
* Add fix instructions on Prettier check failure

* Enforce LF EOL only on CI

* Fix quotes in jest config
diff --git a/.prettierrc.js b/.prettierrc.js
@@ -0,0 +1,11 @@
+const isCI = require("is-ci");
+
+/** @type {import("prettier").Options} */
+module.exports = {
+    printWidth: 100,
+    tabWidth: 4,
+    trailingComma: "all",
+    proseWrap: "always",
+    endOfLine: isCI ? "lf" : "auto",
+    overrides: [{ files: ["**/*.md", "**/*.yml", "**/.*.yml"], options: { tabWidth: 2 } }],
+};
diff --git a/jest.config.js b/jest.config.js
@@ -1,6 +1,6 @@
 const isCI = require("is-ci");
 
-/** @type {Partial<import('@jest/types').Config.DefaultOptions>} */
+/** @type {Partial<import("@jest/types").Config.DefaultOptions>} */
 module.exports = {
     testMatch: ["**/test/**/*.spec.ts"],
     collectCoverageFrom: ["<rootDir>/src/**/*", "!<rootDir>/src/lualib/**/*"],
diff --git a/package.json b/package.json
@@ -23,7 +23,7 @@
         "pretest": "ts-node --transpile-only ./build_lualib.ts",
         "test": "jest",
         "lint": "npm run lint:tslint && npm run lint:prettier",
-        "lint:prettier": "prettier --check **/*.{js,ts,yml,json}",
+        "lint:prettier": "prettier --check **/*.{js,ts,yml,json} || (echo 'Run `npm run lint:prettier -- --write` or `yarn lint:prettier --write` to fix it.' && exit 1)",
         "lint:tslint": "tslint -p . && tslint -p test && tslint src/lualib/*.ts",
         "release-major": "npm version major",
         "release-minor": "npm version minor",
@@ -34,25 +34,6 @@
     "bin": {
         "tstl": "./dist/tstl.js"
     },
-    "prettier": {
-        "endOfLine": "lf",
-        "printWidth": 100,
-        "proseWrap": "always",
-        "tabWidth": 4,
-        "trailingComma": "all",
-        "overrides": [
-            {
-                "files": [
-                    "**/*.md",
-                    "**/*.yml",
-                    "**/.*.yml"
-                ],
-                "options": {
-                    "tabWidth": 2
-                }
-            }
-        ]
-    },
     "engines": {
         "node": ">=8.5.0"
     },
