feat: add createAttributesRemover

Mihai Plamadeala · LwveMike · commit 48f9bf37a37b · 2023-10-22T17:34:27.000+03:00
* add example vue app
diff --git a/.gitignore b/.gitignore
@@ -11,3 +11,4 @@ node_modules
 temp
 
 .vscode
+.dist
diff --git a/.node-version b/.node-version
@@ -0,0 +1 @@
+20
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-v20
+20
diff --git a/example/README.md b/example/README.md
@@ -0,0 +1 @@
+TODO(lwvemike) write description for the example
diff --git a/example/index.html b/example/index.html
@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>vue-plugin-remove-attributes example</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>
diff --git a/example/package.json b/example/package.json
@@ -0,0 +1,20 @@
+{
+  "name": "example",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "vue-tsc && vite build",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "vue": "^3.3.4"
+  },
+  "devDependencies": {
+    "@vitejs/plugin-vue": "^4.2.3",
+    "typescript": "^5.0.2",
+    "vite": "^4.4.5",
+    "vue-tsc": "^1.8.5"
+  }
+}
diff --git a/example/src/App.vue b/example/src/App.vue
@@ -0,0 +1,25 @@
+<script setup lang="ts">
+const sectionType = 'main' as const
+const items = ['test', 'maybe-test', 'definitely-a-test']
+</script>
+
+<template>
+  <div>
+    <header data-test="header-test">
+      Header
+    </header>
+    <section :data-test="`${sectionType}-content`">
+      <ul>
+        <li
+          v-for="item in items"
+          :key="item"
+          :data-test="item"
+          v-text="item"
+        />
+      </ul>
+    </section>
+    <footer dataTest="footer-test">
+      Footer
+    </footer>
+  </div>
+</template>
diff --git a/example/src/main.ts b/example/src/main.ts
@@ -0,0 +1,5 @@
+import { createApp } from 'vue'
+import App from './App.vue'
+
+createApp(App)
+  .mount('#app')
diff --git a/example/src/shims-vue.d.ts b/example/src/shims-vue.d.ts
@@ -0,0 +1,6 @@
+declare module '*.vue' {
+  import type { DefineComponent } from 'vue'
+
+  const component: DefineComponent<object, object, any>
+  export default component
+}
diff --git a/example/src/vite-env.d.ts b/example/src/vite-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="vite/client" />
diff --git a/example/tsconfig.json b/example/tsconfig.json
@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "module": "ESNext",
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "preserve",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "rootDir": "."
+  },
+  "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"],
+}
diff --git a/example/vite.config.ts b/example/vite.config.ts
@@ -0,0 +1,15 @@
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+import createAttributesRemover from '../src/index'
+
+export default defineConfig({
+  plugins: [vue({
+    template: {
+      compilerOptions: {
+        nodeTransforms: [
+          createAttributesRemover(['data-test']),
+        ],
+      },
+    },
+  })],
+})
diff --git a/package.json b/package.json
@@ -63,11 +63,15 @@
     "vite": "^4.4.11",
     "vitest": "^0.34.6"
   },
+  "peerDependencies": {
+    "vue": "3.x",
+    "@vue/compiler-core": "3.x"
+  },
   "simple-git-hooks": {
     "pre-commit": "pnpm lint-staged"
   },
   "lint-staged": {
-    "*": "eslint --fix",
-    "**/*.ts": "tsc --noEmit"
+    "**/*.{js,ts,vue}": "eslint --fix",
+    "src/*.ts": "tsc --noEmit"
   }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
diff --git a/src/index.ts b/src/index.ts

Original file line number	Diff line number	Diff line change
`@@ -11,3 +11,4 @@ node_modules`
`11`	`11`	`temp`
`12`	`12`
`13`	`13`	`.vscode`
	`14`	`+.dist`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+TODO(lwvemike) write description for the example`