WIP - Commitlint, Editorconfig, ESLint, Prettier with NX (#7)

* (chore): init commit for opening a wip pr

* feat(commitlint): added the configs and dependencies required for commitlint

* feat(husky): added husky install to an npm prepare script

required for husky to work

* refactor(web-sdk prettier): now loading the prettier config from a global config directory

the new config extends a base config, now prettier is installed in root and removed from web-sdk

* refactor(eslint): moved eslint to root, now extending the config from a base config

eslint configs are now within the config directory

* refactor(editorconfig): moved editorconfig to the root of the monorepo

* build(web-sdk deps): removed commitlint deps since they are now root level

* refactor(eslint plugins): moved general eslint plugins and configs such as ts and prettier to root

* revert(root/local packages): readded eslint and prettier to web-sdk's deps

* refactor(config directory): refactored package-specific configs to higher level i.e svelte

this change would allow a number of packages to share a single broad config and still have their own
package specific overrides.

Author: Omri-Levy

sdks/web-sdk/.czrc .czrc

@@ -0,0 +1 @@
+module.exports = require('./packages/config/prettierrc.base.cjs');

sdks/web-sdk/.editorconfig .editorconfig

@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };

sdks/web-sdk/.husky/commit-msg .husky/commit-msg

@@ -3,17 +3,13 @@
     "default": {
       "runner": "nx/tasks-runners/default",
       "options": {
-        "cacheableOperations": [
-          "build"
-        ]
+        "cacheableOperations": ["build"]
       }
     }
   },
   "targetDefaults": {
     "build": {
-      "outputs": [
-        "{projectRoot}/dist"
-      ]
+      "outputs": ["{projectRoot}/dist"]
     }
   },
   "defaultBase": "main"

.prettierrc.cjs

@@ -7,12 +7,26 @@
     "web-sdk:dev": "pnpm exec nx dev web-sdk",
     "web-sdk:build": "pnpm exec nx build web-sdk",
     "web-sdk:example": "pnpm exec nx example web-sdk",
+    "web-sdk:format": "pnpm exec nx format web-sdk",
+    "web-sdk:lint": "pnpm exec nx lint web-sdk",
+    "web-sdk:lint:fix": "pnpm exec nx lint:fix web-sdk",
+    "format": "pnpm exec nx run-many --target=format",
+    "lint": "pnpm exec nx run-many --target=lint",
+    "lint:fix": "pnpm exec nx run-many --target=lint:fix",
     "start:backoffice:dev": "echo \"Error: no test specified\" && exit 1",
     "start:workflow-builder:dev": "echo \"Error: no test specified\" && exit 1",
-    "start:web-ui:dev": "echo \"Error: no test specified\" && exit 1"
+    "start:web-ui:dev": "echo \"Error: no test specified\" && exit 1",
+    "commit": "git add . && git-cz",
+    "prepare": "husky install"
   },
   "license": "ISC",
   "devDependencies": {
-    "nx": "15.0.2"
+    "@commitlint/cli": "^17.1.2",
+    "@commitlint/config-conventional": "^17.1.0",
+    "commitizen": "^4.2.5",
+    "editorconfig": "^1.0.1",
+    "husky": "^8.0.1",
+    "nx": "15.0.2",
+    "prettier": "^2.7.1"
   }
 }

commitlint.config.cjs

@@ -0,0 +1,18 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+    'prettier',
+  ],
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+  },
+  env: {
+    es6: true,
+  },
+  plugins: ['@typescript-eslint'],
+  ignorePatterns: ['node_modules', '.eslintrc.cjs'],
+};

nx.json

@@ -0,0 +1,29 @@
+const { env, plugins, extends: extendsRest, ...base } = require('./eslintrc.base.cjs');
+
+module.exports = {
+  ...base,
+  extends: [
+    'plugin:storybook/recommended',
+    // Make sure the prettier config is always last
+    ...extendsRest,
+  ],
+  env: {
+    ...env,
+    browser: true,
+  },
+  overrides: [
+    {
+      files: ['*.svelte'],
+      processor: 'svelte3/svelte3',
+    },
+  ],
+  settings: {
+    'svelte3/typescript': require('typescript'),
+    'svelte3/ignore-styles': () => true,
+  },
+  plugins: [
+    'svelte3',
+    // Make sure plugins that have to be last are always last
+    ...plugins,
+  ],
+};

package.json

@@ -0,0 +1,6 @@
+module.exports = {
+  semi: true,
+  trailingComma: 'all',
+  singleQuote: true,
+  arrowParens: 'avoid',
+};

packages/config/eslintrc.base.cjs

@@ -0,0 +1,9 @@
+module.exports = {
+  ...require('./prettierrc.base.cjs'),
+  plugins: ['prettier-plugin-svelte'],
+  svelteSortOrder: 'options-scripts-markup-styles',
+  svelteStrictMode: false,
+  svelteBracketNewLine: true,
+  svelteIndentScriptAndStyle: true,
+  svelteAllowShorthand: true,
+};