Merge pull request #59 from samply/doc/lint

fix: linting should now work after commit

.eslintignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+.eslintrc.cjs

.eslintrc.cjs

@@ -1,38 +1,42 @@
 module.exports = {
-    plugins: ['@typescript-eslint/eslint-plugin', 'eslint-plugin-tsdoc', 'jsdoc'],
+    plugins: [
+        "@typescript-eslint/eslint-plugin",
+        "eslint-plugin-tsdoc",
+        "jsdoc",
+    ],
     extends: [
-      'plugin:@typescript-eslint/recommended',
-      'plugin:svelte/recommended',
-      'plugin:svelte/prettier', 
-      'eslint-config-prettier',
-      'prettier',
-      "plugin:jsdoc/recommended-typescript-error",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:svelte/recommended",
+        "plugin:svelte/prettier",
+        "eslint-config-prettier",
+        "prettier",
+        "plugin:jsdoc/recommended-typescript-error",
     ],
-    parser: '@typescript-eslint/parser',
+    parser: "@typescript-eslint/parser",
     parserOptions: {
-        project: './tsconfig.json',
-        extraFileExtensions: ['.svelte'],
+        project: "./tsconfig.json",
+        extraFileExtensions: [".svelte"],
     },
     overrides: [
-      {
-        files: ['*.svelte'],
-        parser: 'svelte-eslint-parser',
-        parserOptions: {
-            parser: '@typescript-eslint/parser',
-        }
-      }
+        {
+            files: ["*.svelte"],
+            parser: "svelte-eslint-parser",
+            parserOptions: {
+                parser: "@typescript-eslint/parser",
+            },
+        },
     ],
     settings: {
-      'svelte/typescript': import('typescript'),
+        "svelte/typescript": import("typescript"),
     },
     rules: {
-      '@typescript-eslint/no-explicit-any': 'error',
-      '@typescript-eslint/explicit-function-return-type': ['error', { allowExpressions: true }],
-      'svelte/no-at-html-tags': 'off',
-      'jsdoc/check-syntax': 2,
-      "jsdoc/check-param-names": 2,
-
-
+        "@typescript-eslint/no-explicit-any": "error",
+        "@typescript-eslint/explicit-function-return-type": [
+            "error",
+            { allowExpressions: true },
+        ],
+        "svelte/no-at-html-tags": "off",
+        "jsdoc/check-syntax": 2,
+        "jsdoc/check-param-names": 2,
     },
-    ignorePatterns: ['**/dist/**'],
-  };
+};

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit

commitlint.config.cjs

@@ -0,0 +1,7 @@
+module.exports = {
+    extends: ["@commitlint/config-conventional"],
+    rules: {
+        "body-max-line-length": [0, "always"],
+        "footer-max-line-length": [0, "always"],
+    },
+};

docs/LINTING.MD

@@ -0,0 +1,11 @@
+# Liniting
+
+## Installing
+
+npm install --dev
+
+## runing
+
+npm run lint
+
+Note this will only lint staged files, so don't forget to add with git add