Add vite project with example app for development

rethinc · Apr 12, 2024 · 606010c · 606010c
commit 606010c
Show file tree

Hide file tree

Showing 12 changed files with 16,598 additions and 0 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,41 @@
+{
+  "root": true,
+  "env": {
+    "node": true,
+    "vue/setup-compiler-macros": true
+  },
+  "parser": "vue-eslint-parser",
+  "parserOptions": {
+    "parser": "@typescript-eslint/parser"
+  },
+  "plugins": [
+    "@typescript-eslint",
+    "prettier",
+    "import"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:vue/vue3-recommended",
+    "prettier"
+  ],
+  "rules": {
+    "prettier/prettier": "error",
+    "import/order": [
+      "error",
+      {
+        "groups": ["builtin", "external", "internal", "parent", "sibling", "index"],
+        "newlines-between": "never"
+      }
+    ]
+  },
+  "overrides": [
+    {
+      "files": ["*.vue","*.ts", "*.js", "*.mjs"]
+    }
+  ],
+  "ignorePatterns": ["node_modules", "dist", "coverage"],
+  "settings": {
+    "import/internal-regex": "^@/"
+  }
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+node_modules
+dist
+.idea
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+20.12.0
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1,5 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "es5"
+}
diff --git a/README.md b/README.md
@@ -0,0 +1,63 @@
+# vite-plugin-vue-examples
+
+## Development
+
+Install nvm [https://github.com/nvm-sh/nvm#installing-and-updating](https://github.com/nvm-sh/nvm#installing-and-updating)
+
+Install and initialize node with version used in project
+```
+nvm install
+npm install
+```
+
+Run example app locally
+```
+npm run dev
+```
+
+Build app locally (bundle will be created in `/dist` folder)
+```
+npm run build
+```
+
+Check code format issues
+```
+npm run lint
+```
+
+Fix automatically fixable format/lint issues
+```
+npm run fix
+```
+
+Check typescript types
+```
+npm run check-types
+```
+
+Run vitest test runner in watch mode
+```
+npm run test
+```
+
+Check format/lint issues, typescript types and run tests
+```
+npm run verify
+```
+
+### Dependencies
+
+Check for updated dependencies
+```
+npx npm-check-updates
+```
+
+Update version in package.json
+```
+npx npm-check-updates -u
+```
+
+Updated modules and package-lock file
+```
+npm update
+```
diff --git a/example/App.vue b/example/App.vue
@@ -0,0 +1,3 @@
+<template>
+  <h1>Example App for vite-plugin-vue-examples</h1>
+</template>
diff --git a/example/main.ts b/example/main.ts
@@ -0,0 +1,4 @@
+import { createApp } from 'vue'
+import App from './App.vue'
+
+createApp(App).mount('#app')
diff --git a/index.html b/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>Vite Plugin Vue Examples</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="example/main.ts"></script>
+  </body>
+</html>