@evaneos/front-config 0.0.1

package/README.md

@@ -0,0 +1,45 @@
+# @evaneos/front-config
+
+@evaneos/front-config is the main resource for shared js/ts/tsx linting and config across Evaneos apps.
+
+## Instal
+
+```shell
+npm install @evaneos/front-config@latest
+```
+
+# Usage
+
+## Eslint
+
+In your `.eslintrc` file, add:
+
+```json
+{
+  "extends": ["@evaneos/front-config/linting/eslint-config"],
+  "parserOptions": {
+    "project": ["./tsconfig.json"]
+  }
+}
+```
+
+## TSConfig
+
+In your `tsconfig.json` file, add:
+
+```json
+{
+  "extends": "@evaneos/front-config/config/tsconfig.json"
+}
+```
+
+## Prettier
+
+In your `.prettierrc` file add:
+
+```js
+module.exports = {
+  ...require("@evaneos/front-config/linting/prettier-config.js"),
+  semi: false,
+};
+```

package/config/tsconfig.json

@@ -0,0 +1,16 @@
+{
+    "compilerOptions": {
+        "target": "es6",
+        "lib": ["dom", "esnext"],
+        "jsx": "react",
+        "noEmit": true,
+        "isolatedModules": true,
+        "strict": true,
+        "noImplicitAny": true,
+        "module": "es2020",
+        "moduleResolution": "node",
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "resolveJsonModule": true
+    }
+}

package/linting/eslint-config-base.js

@@ -0,0 +1,15 @@
+module.exports = {
+    parser: '@babel/eslint-parser',
+    env: {
+        browser: true,
+        es6: true,
+    },
+    extends: [
+        'eslint:recommended',
+        require.resolve('./rules/override'),
+        require.resolve('./rules/react'),
+        require.resolve('./rules/style'),
+        require.resolve('./rules/test'),
+        require.resolve('./rules/prettier'),
+    ],
+};

package/linting/eslint-config.js

@@ -0,0 +1,19 @@
+module.exports = {
+    parser: '@typescript-eslint/parser',
+    plugins: ['@typescript-eslint'],
+    extends: [
+        '@evaneos/eslint-config-base',
+        'plugin:@typescript-eslint/recommended',
+        'plugin:import/typescript',
+        '@evaneos/eslint-config-base/prettier',
+    ],
+    settings: {
+        'import/extensions': [ '.js', '.jsx', '.css', '.ts', '.tsx' ],
+    },
+    rules: {
+        '@typescript-eslint/ban-ts-comment': 0,
+        '@typescript-eslint/camelcase': 0,
+        '@typescript-eslint/no-floating-promises': 'error',
+        '@typescript-eslint/no-unused-vars': [ 'error', { 'ignoreRestSiblings': true } ],
+    },
+};

package/linting/prettier-config.js

@@ -0,0 +1,4 @@
+module.exports = {
+    tabWidth: 4,
+    singleQuote: true,
+};

package/linting/rules/override.js

@@ -0,0 +1,11 @@
+module.exports = {
+    plugins: ['import'],
+    rules: {
+        'import/no-default-export': 2,
+        'no-process-env': 0,
+        'prefer-const': 1,
+        'prefer-destructuring': 1,
+        'prefer-spread': 1,
+        'arrow-body-style': 0,
+    },
+};

package/linting/rules/prettier.js

@@ -0,0 +1,3 @@
+module.exports = {
+    extends: ['eslint-config-prettier'],
+};

package/linting/rules/react.js

@@ -0,0 +1,17 @@
+module.exports = {
+    plugins: ['react-hooks'],
+    extends: ['plugin:react/recommended'],
+    settings: {
+        react: {
+            version: 'detect',
+        },
+        'import/extensions': ['.js', '.jsx', '.css'],
+    },
+    rules: {
+        'react-hooks/exhaustive-deps': 1,
+        'react-hooks/rules-of-hooks': 2,
+        'react/display-name': 0,
+        'react/prop-types': 0,
+        'react/react-in-jsx-scope': 0,
+    },
+};

package/linting/rules/style.js

@@ -0,0 +1,16 @@
+module.exports = {
+    rules: {
+        'import/newline-after-import': 1,
+        'import/no-duplicates': 2,
+        'import/order': [
+            'warn',
+            {
+                alphabetize: {
+                    order: 'asc',
+                    caseInsensitive: true,
+                },
+                'newlines-between': 'always',
+            },
+        ],
+    },
+};

package/linting/rules/test.js

@@ -0,0 +1,8 @@
+module.exports = {
+    overrides: [
+        {
+            files: ['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[jt]s?(x)'],
+            extends: ['plugin:testing-library/react'],
+        }
+    ]
+}

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@evaneos/front-config",
+  "version": "0.0.1",
+  "engines": {
+    "node": ">=v18",
+    "npm": ">=9"
+  },
+  "files": [
+    "linting/*",
+    "config/*",
+    "README.md"
+  ],
+  "scripts": {
+    "prepare": "husky"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.4.0",
+    "@commitlint/config-conventional": "^19.2.2",
+    "commitlint-plugin-function-rules": "^4.0.0",
+    "husky": "^9.1.4"
+  }
+}