feat: add prettier config (#21)

* feat: update prettier config for *.rc file

* feat: *rc, *.json file use 'json-stringify' parser

* feat: add prettier-config

* feat: make prettier parse to json in tsconfig file

* feat: lint @mjolnir/prettier-config

* feat: change prettier config ext

* feat: prettier all files

* feat: add jsonc format files to prettier

* feat: update prettier override

* chore: format tsconfig.json

.commitlintrc.json

@@ -1,3 +1,5 @@
 {
-  "extends": ["@commitlint/config-conventional"]
+  "extends": [
+    "@commitlint/config-conventional"
+  ]
 }

.eslintrc.json

@@ -1,4 +1,7 @@
 {
-  "extends": ["@mjolnir/eslint-config/node", "plugin:prettier/recommended"],
+  "extends": [
+    "@mjolnir/eslint-config/node",
+    "plugin:prettier/recommended"
+  ],
   "rules": {}
 }

.lintstagedrc

@@ -1,4 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/lintstagedrc.schema",
-  "**/*.{js, ts}": ["prettier --write", "eslint --fix", "git add"]
+  "**/*.{js, ts}": [
+    "eslint --fix",
+    "git add"
+  ]
 }

.prettierrc

@@ -1,6 +1 @@
-{
-  "$schema": "http://json.schemastore.org/prettierrc",
-  "printWidth": 80,
-  "singleQuote": true,
-  "arrowParens": "always"
-}
+"@mjolnir/prettier-config"

.vscode/settings.json

@@ -6,6 +6,7 @@
     { "language": "typescriptreact", "autoFix": true }
   ],
   "cSpell.words": [
-    "mjolnir"
+    "mjolnir",
+    "mjolnirjs"
   ]
 }

babel.config.js

@@ -1,6 +1,6 @@
 'use strict';
 
-module.exports = (api) => {
+module.exports = api => {
   api.cache(false);
 
   return {
@@ -10,9 +10,9 @@ module.exports = (api) => {
         '@mjolnir/babel-preset',
         {
           react: false,
-          typescript: false
-        }
-      ]
-    ]
+          typescript: false,
+        },
+      ],
+    ],
   };
 };

lerna.json

@@ -1,9 +1,14 @@
 {
-  "changelog": {
-    "repo": "mjolnirjs/mjolnir",
-    "cacheDir": ".changelog"
-  },
+  "$schema": "http://json.schemastore.org/lerna",
   "npmClient": "yarn",
   "version": "independent",
-  "useWorkspaces": true
+  "useWorkspaces": true,
+  "command": {
+    "version": {
+      "conventionalCommits": true
+    },
+    "publish": {
+      "message": "chore(release): publish"
+    }
+  }
 }

package.json

@@ -13,13 +13,13 @@
     "@commitlint/config-conventional": "^8.1.0",
     "@mjolnir/babel-preset": "link:packages/babel-preset",
     "@mjolnir/eslint-config": "link:packages/eslint-config",
+    "@mjolnir/prettier-config": "link:packages/prettier-config",
     "cross-env": "^5.2.0",
     "eslint": "^6.1.0",
     "eslint-config-prettier": "^6.0.0",
     "eslint-plugin-prettier": "^3.1.0",
     "husky": "^3.0.4",
     "lerna": "^3.15.0",
-    "lerna-changelog": "^0.8.2",
     "lint-staged": "^9.2.4",
     "prettier": "^1.17.1",
     "typescript": "^3.5.3"

packages/babel-preset/index.js

@@ -31,7 +31,7 @@ module.exports = declare((api, opts) => {
     require('@babel/plugin-syntax-dynamic-import'),
     require('@babel/plugin-syntax-import-meta'),
     [require('@babel/plugin-proposal-class-properties'), { loose: true }],
-    require('@babel/plugin-proposal-json-strings')
+    require('@babel/plugin-proposal-json-strings'),
   ];
 
   const presets = [
@@ -40,9 +40,9 @@ module.exports = declare((api, opts) => {
       require('@babel/preset-env'),
       {
         //TODO: how about other opts
-        modules // default to false, webpack takes care of modules
-      }
-    ]
+        modules, // default to false, webpack takes care of modules
+      },
+    ],
   ];
 
   if (typescript) presets.push(require('@babel/preset-typescript'));
@@ -51,22 +51,22 @@ module.exports = declare((api, opts) => {
     presets.push([
       require('@babel/preset-react'),
       {
-        development: env
-      }
+        development: env,
+      },
     ]);
     if (env === 'production') {
       // Remove PropTypes from production build
       plugins.push([
         require('babel-plugin-transform-react-remove-prop-types'),
         {
-          removeImport: true
-        }
+          removeImport: true,
+        },
       ]);
     }
   }
 
   return {
     presets,
-    plugins
+    plugins,
   };
 });

packages/eslint-config/babel.js

@@ -2,5 +2,5 @@
 
 // for babel env, base on es6 env
 module.exports = {
-  extends: ['./index', './plugins/babel'].map(require.resolve)
+  extends: ['./index', './plugins/babel'].map(require.resolve),
 };

packages/eslint-config/index.js

@@ -5,16 +5,16 @@ module.exports = {
   root: true, // limit ESLint to a specific project
   env: {
     browser: true,
-    es6: true // also enable ecmaVersion: 6
+    es6: true, // also enable ecmaVersion: 6
   },
   parserOptions: {
     ecmaVersion: 2018, // same as 9
     sourceType: 'module', // ECMAScript module
     ecmaFeatures: {
       globalReturn: false,
       impliedStrict: true,
-      jsx: true
-    }
+      jsx: true,
+    },
   },
-  extends: ['./rules', './plugins/import'].map(require.resolve)
+  extends: ['./rules', './plugins/import'].map(require.resolve),
 };

packages/eslint-config/jest.js

@@ -3,5 +3,5 @@
 // for jest env
 module.exports = {
   extends: ['./index', './plugins/jest'].map(require.resolve),
-  rules: {}
+  rules: {},
 };

packages/eslint-config/node.js

@@ -4,5 +4,5 @@
 module.exports = {
   root: true, // limit ESLint to a specific project
   extends: ['./rules', './plugins/node'].map(require.resolve),
-  rules: {}
+  rules: {},
 };

packages/eslint-config/plugins/babel.js

@@ -4,5 +4,5 @@
 module.exports = {
   parser: 'babel-eslint',
   plugins: ['babel'],
-  rules: {}
+  rules: {},
 };

packages/eslint-config/plugins/import.js

@@ -13,6 +13,6 @@ module.exports = {
     // red flags (thus, warnings)
     'import/no-named-as-default': 'warn',
     'import/no-named-as-default-member': 'warn',
-    'import/no-duplicates': 'warn'
-  }
+    'import/no-duplicates': 'warn',
+  },
 };

packages/eslint-config/plugins/jest.js

@@ -3,5 +3,5 @@
 // plugin:jest/recommended: https://github.com/jest-community/eslint-plugin-jest/blob/master/README.md
 module.exports = {
   extends: ['plugin:jest/recommended'],
-  rules: {}
+  rules: {},
 };

packages/eslint-config/plugins/node.js

@@ -5,6 +5,6 @@ module.exports = {
   extends: ['plugin:node/recommended'],
   rules: {
     // commonjs or node env, should use global strict model
-    strict: ['error', 'global']
-  }
+    strict: ['error', 'global'],
+  },
 };

packages/eslint-config/plugins/react-hooks.js

@@ -4,6 +4,6 @@ module.exports = {
   plugins: ['react-hooks'],
   rules: {
     'react-hooks/exhaustive-deps': 'warn',
-    'react-hooks/rules-of-hooks': 'error'
-  }
+    'react-hooks/rules-of-hooks': 'error',
+  },
 };

packages/eslint-config/plugins/react.js

@@ -2,5 +2,5 @@
 
 module.exports = {
   plugins: ['react'],
-  rules: {}
+  rules: {},
 };

packages/eslint-config/plugins/typescript.js

@@ -6,7 +6,7 @@ module.exports = {
   extends: [
     'plugin:@typescript-eslint/eslint-recommended',
     'plugin:@typescript-eslint/recommended',
-    'plugin:import/typescript'
+    'plugin:import/typescript',
   ],
-  rules: {}
+  rules: {},
 };

packages/eslint-config/react.js

@@ -2,5 +2,5 @@
 
 // for react env
 module.exports = {
-  extends: ['./plugins/react', './plugins/react-hooks'].map(require.resolve)
+  extends: ['./plugins/react', './plugins/react-hooks'].map(require.resolve),
 };

packages/eslint-config/rules/index.js

@@ -8,7 +8,7 @@ module.exports = {
     './errors',
     './es6',
     './style',
-    './variables'
+    './variables',
   ].map(require.resolve),
-  rules: {}
+  rules: {},
 };

packages/eslint-config/rules/recommend.js

@@ -2,5 +2,5 @@
 
 // eslint:recommended: https://eslint.org/docs/rules
 module.exports = {
-  extends: ['eslint:recommended']
+  extends: ['eslint:recommended'],
 };

packages/eslint-config/typescript.js

@@ -2,5 +2,5 @@
 
 // for typescript env, base on es6 env
 module.exports = {
-  extends: ['./index', './plugins/typescript'].map(require.resolve)
+  extends: ['./index', './plugins/typescript'].map(require.resolve),
 };

packages/mjolnir-cli/.babelrc.js

@@ -6,8 +6,8 @@ module.exports = {
       {
         react: false,
         typescript: true,
-        modules: "commonjs"
-      }
-    ]
-  ]
+        modules: 'commonjs',
+      },
+    ],
+  ],
 };

packages/mjolnir-cli/.eslintrc.json

@@ -0,0 +1,7 @@
+{
+  "extends": [
+    "@mjolnir/eslint-config/typescript",
+    "plugin:prettier/recommended"
+  ],
+  "rules": {}
+}

packages/mjolnir-cli/tsconfig.json

@@ -2,11 +2,13 @@
   "compilerOptions": {
     "module": "es6",
     "target": "es5",
-    "lib": ["esnext"],
+    "lib": [
+      "esnext"
+    ],
     "declaration": true,
     "outDir": "dist",
     "esModuleInterop": true,
     "moduleResolution": "node",
-    "strict": true,
+    "strict": true
   }
 }

packages/prettier-config/README.md

@@ -0,0 +1,21 @@
+# @mjolnir/prettier-config
+
+## install
+`yarn add @mjolnir/prettier-config -D`
+
+## useage
+
+add it in your `package.json`:
+```
+{
+  "prettier": "@mjolnir/prettier-config"
+}
+```
+
+if you want to extends the configuration and overwrite some properties, import the file in a `.prettierrc.js` file and export the modifications:
+
+```js
+module.exports = {
+  ...require("@mjolnir/prettier-config");
+}
+```

packages/prettier-config/index.js

@@ -0,0 +1,34 @@
+'use strict';
+
+module.exports = {
+  singleQuote: true,
+  trailingComma: 'all',
+  htmlWhitespaceSensitivity: 'ignore',
+  overrides: [
+    {
+      files: ['.*rc', '*.json'],
+      options: {
+        parser: 'json-stringify',
+      },
+    },
+    {
+      // special file use jsonc format
+      files: [
+        '.vscode/*.json',
+        'jsconfig.json',
+        'tsconfig.json',
+        'tsconfig.*.json',
+        'tsconfig-*.json',
+        'tsconfig.json',
+        '.babelrc',
+        '.eslintrc',
+        '.eslintrc.json',
+        'tslint.json',
+        'tslint.*.json',
+      ],
+      options: {
+        parser: 'json',
+      },
+    },
+  ],
+};