Merge pull request #26 from connorabbas/develop

ESLint

Author: connorabbas

.devcontainer/devcontainer.json

@@ -21,7 +21,8 @@
                 "Vue.volar",
                 "bradlc.vscode-tailwindcss",
                 "shd101wyy.markdown-preview-enhanced",
-                "formulahendry.auto-rename-tag"
+                "formulahendry.auto-rename-tag",
+                "pmneo.tsimporter"
             ],
             "settings": {
                 "terminal.integrated.shell.linux": "/bin/sh"

.github/workflows/eslint.yml

@@ -0,0 +1,25 @@
+name: ESLint
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  eslint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+          cache: 'npm'
+      
+      - name: Install Dependencies
+        run: npm ci
+      
+      - name: Run ESLint
+        run: npm run lint

.gitignore

@@ -12,6 +12,7 @@ dist
 dist-ssr
 *.local
 !Dockerfile.local
+components.d.ts
 
 # Editor directories and files
 .vscode/*

README.md

@@ -141,6 +141,9 @@ An alternative to using the [Laravel, Inertia.js, & PrimeVue Starter Kit](https:
         ->name('password.update');
     ```
 
+## TypeScript
+TypeScript is configured and ready for use if desired, but is not required.
+
 ## Theme
 This starter kit provides a light/dark mode and custom theme functionality provided by the powerful PrimeVue theming system, using styled mode and custom design token values.
 

eslint.config.js

@@ -0,0 +1,54 @@
+// https://eslint.org/docs/latest/use/configure/
+// https://eslint.vuejs.org/user-guide/
+// https://typescript-eslint.io/rules/?=recommended
+
+import eslint from '@eslint/js';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import eslintPluginVue from 'eslint-plugin-vue';
+import globals from 'globals';
+import typescriptEslint from 'typescript-eslint';
+
+export default typescriptEslint.config(
+    { ignores: ['*.d.ts', '**/coverage', '**/dist'] },
+    {
+        files: ['**/*.js'],
+        ...eslint.configs.recommended,
+        languageOptions: {
+            ecmaVersion: 'latest',
+            sourceType: 'module',
+            globals: {
+                ...globals.browser,
+                process: 'readonly',
+                module: 'readonly',
+                require: 'readonly',
+                window: 'readonly',
+            },
+        },
+    },
+    {
+        files: ['**/*.{ts,vue}'],
+        extends: [
+            eslint.configs.recommended,
+            ...typescriptEslint.configs.recommended,
+            ...eslintPluginVue.configs['flat/recommended'],
+        ],
+        languageOptions: {
+            ecmaVersion: 'latest',
+            globals: {
+                ...globals.browser,
+            },
+            sourceType: 'module',
+            parserOptions: {
+                parser: typescriptEslint.parser,
+            },
+        },
+        rules: {
+            'vue/require-default-prop': 'off',
+            'vue/attribute-hyphenation': 'off',
+            'vue/multi-word-component-names': 'off',
+            'vue/block-lang': 'off',
+            '@typescript-eslint/no-explicit-any': 'off',
+        },
+    },
+    eslintConfigPrettier
+);