@enormora/eslint-config-vue-ts 0.0.4 → 0.0.5

package/package.json

@@ -4,7 +4,7 @@
         "Christian Rackerseder <github@echooff.de>"
     ],
     "dependencies": {
-        "@typescript-eslint/parser": "8.39.0",
+        "@typescript-eslint/parser": "8.40.0",
         "eslint-plugin-vue": "10.4.0",
         "globals": "16.3.0",
         "vue-eslint-parser": "10.2.0"
@@ -14,12 +14,12 @@
     "main": "vue-ts.js",
     "name": "@enormora/eslint-config-vue-ts",
     "peerDependencies": {
-        "@enormora/eslint-config-typescript": "0.0.22"
+        "@enormora/eslint-config-typescript": "0.0.23"
     },
     "repository": {
         "type": "git",
         "url": "git://github.com/enormora/eslint-config.git"
     },
     "type": "module",
-    "version": "0.0.4"
+    "version": "0.0.5"
 }

package/readme.md

@@ -0,0 +1,29 @@
+# `@enormora/eslint-config-vue-ts`
+
+Config preset for Vue with TypeScript, enabling specific rules and compiler settings.
+
+## Install & Setup
+
+Install the `@enormora/eslint-config-vue-ts`, the base preset and the TypeScript package via npm:
+
+```bash
+npm install --save-dev @enormora/eslint-config-base @enormora/eslint-config-typescript @enormora/eslint-config-vue-ts
+```
+
+Create an ESLint configuration file (e.g., `eslint.config.js`) in your project and add the base and react config to the configuration array:
+
+```javascript
+import { baseConfig } from '@enormora/eslint-config-base';
+import { vueConfig } from '@enormora/eslint-config-vue-ts';
+
+export default [
+    {
+        ignores: ['dist/**/*']
+    },
+    baseConfig,
+    {
+        ...vueConfig,
+        files: ['src/**/*.vue']
+    }
+];
+```