Merge pull request #8 from TessavWalstijn/develop

Release v1.0.1
TessavWalstijn · Jul 24, 2024 · 324afed · 324afed
2 parents 5f43d66 + bfaeedc
commit 324afed
Show file tree

Hide file tree

Showing 12 changed files with 1,128 additions and 1,314 deletions.
diff --git a/.eslintrc b/.eslintrc
diff --git a/.prettierrc b/.prettierrc
@@ -1,10 +1,4 @@
 {
   "semi": false,
-  "singleQuote": true,
-  "arrowParens": "always",
-  "bracketSameLine": true,
-  "tabWidth": 2,
-  "useTabs": false,
-  "printWidth": 80,
-  "trailingComma": "all"
+  "singleQuote": true
 }
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -5,6 +5,6 @@
     "dbaeumer.vscode-eslint",
     "esbenp.prettier-vscode",
     "rvest.vs-code-prettier-eslint",
-    "squeeble.mint-it",
+    "squeeble.mint-it"
   ]
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,33 @@
+<!-- Following https://changelog.md/ -->
+
+# Vue3 TypeScript Template Changelog
+
+## Release [v1.0.1](https://github.com/TessavWalstijn/vue3-ts.template/releases/tag/v1.0.1) - 2024-07-24
+
+### Added
+
+- Simplified Prettier config
+
+### Changed
+
+- [ESLint v9.0.0](https://eslint.org/blog/2024/04/eslint-v9.0.0-released/)
+
+### Removed
+
+- ESLint rule "@typescript-eslint/no-explicit-any"
+
+### Security
+
+- Updated packages
+
+## Release [v1.0.0](https://github.com/TessavWalstijn/vue3-ts.template/releases/tag/v1.0.0) - 2023-12-16
+
+First release
+
+### Added
+
+- Fully ESM
+- Fully TypeScript
+- SCSS included
+- Linting ready with ESLint and Prettier
+
diff --git a/README.md b/README.md
@@ -1,5 +1,6 @@
 # vue3-ts.template
-Template for Vue3, TS, ESLint + Prettier 
+
+Template for Vue3, TS, ESLint + Prettier
 
 > NOTE: This project is fully ESM
 
@@ -22,11 +23,10 @@ nvm install lts/hydrogen
 nvm use lts/hydrogen
 ```
 
-Make sure you have the modern yarn installed
+Make sure you have the modern yarn enabled
 
 ```bash
 corepack enable
-yarn set version 4.0.2
 ```
 
 Installing packageges used by this project:

diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,63 @@
+import typescriptEslint from '@typescript-eslint/eslint-plugin'
+import vue from 'eslint-plugin-vue'
+import globals from 'globals'
+import parser from 'vue-eslint-parser'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import js from '@eslint/js'
+import { FlatCompat } from '@eslint/eslintrc'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+})
+
+export default [
+  ...compat.extends(
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+    'plugin:vue/vue3-essential',
+    'plugin:vue/vue3-recommended',
+    '@vue/eslint-config-typescript',
+    'prettier',
+  ),
+  {
+    plugins: {
+      '@typescript-eslint': typescriptEslint,
+      vue,
+    },
+    languageOptions: {
+      globals: {
+        ...Object.fromEntries(
+          Object.entries(globals.browser).map(([key]) => [key, 'off']),
+        ),
+      },
+      parser: parser,
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+    },
+    rules: {
+      indent: ['error', 2],
+      'linebreak-style': ['error', 'unix'],
+      quotes: ['error', 'single'],
+      semi: ['error', 'never'],
+      '@typescript-eslint/no-unused-vars': 'warn',
+      '@typescript-eslint/explicit-member-accessibility': 0,
+      '@typescript-eslint/explicit-function-return-type': 0,
+      '@typescript-eslint/indent': 0,
+      'vue/no-v-html': 0,
+      'vue/no-template-shadow': 0,
+      'vue/attribute-hyphenation': [
+        'warn',
+        'never',
+        {
+          ignore: ['custom-prop'],
+        },
+      ],
+    },
+  },
+]
diff --git a/index.html b/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="UTF-8" />

diff --git a/package.json b/package.json
@@ -6,33 +6,36 @@
   "author": "TessavWalstijn <[email protected]>",
   "license": "GPL-3.0",
   "type": "module",
-  "packageManager": "yarn@4.0.2",
+  "packageManager": "yarn@4.3.1",
   "scripts": {
     "dev": "vite",
     "build": "vue-tsc && vite build",
     "preview": "vite preview",
-    "lint": "eslint \"src/**/*.{vue,js,jsx,cjs,mjs,ts,tsx,cts,mts}\"",
+    "lint": "prettier --check . && eslint \"src/**/*.{vue,js,jsx,cjs,mjs,ts,tsx,cts,mts}\"",
     "lint:fix": "yarn lint:format && yarn lint:es-fix",
     "lint:es-fix": "eslint --fix \"src/**/*.{vue,js,jsx,cjs,mjs,ts,tsx,cts,mts}\"",
     "lint:format": "prettier --ignore-path .gitignore --write \"src/**/*.{vue,js,jsx,cjs,mjs,ts,tsx,cts,mts}\""
   },
   "dependencies": {
-    "typescript": "5.1.6",
-    "vue": "^3.3.4",
-    "vue-tsc": "^1.8.10"
+    "typescript": "5.5.4",
+    "vue": "^3.4.33",
+    "vue-tsc": "^2.0.28"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^6.6.0",
-    "@typescript-eslint/parser": "^6.6.0",
-    "@vitejs/plugin-vue": "^4.3.4",
-    "@vue/eslint-config-typescript": "^11.0.3",
-    "eslint": "^8.48.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-prettier": "^5.0.0",
-    "eslint-plugin-vue": "^9.17.0",
-    "prettier": "^3.0.3",
-    "sass": "^1.66.1",
-    "vite": "^4.4.9",
-    "vue-tsc-eslint-hook": "^1.8.10"
+    "@eslint/eslintrc": "^3.1.0",
+    "@eslint/js": "^9.7.0",
+    "@typescript-eslint/eslint-plugin": "^7.17.0",
+    "@typescript-eslint/parser": "^7.17.0",
+    "@vitejs/plugin-vue": "^5.1.0",
+    "@vue/eslint-config-typescript": "^13.0.0",
+    "eslint": "^9.7.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-vue": "^9.27.0",
+    "globals": "^15.8.0",
+    "prettier": "^3.3.3",
+    "sass": "^1.77.8",
+    "vite": "^5.3.4",
+    "vue-tsc-eslint-hook": "^1.8.27"
   }
 }
diff --git a/src/components/HelloWorld/HelloWorld.scss b/src/components/HelloWorld/HelloWorld.scss
@@ -1,3 +1,3 @@
 .read-the-docs {
   color: #888;
-}
+}
diff --git a/src/types/.gitkeep b/src/types/.gitkeep
diff --git a/src/types/todo.ts b/src/types/todo.ts
@@ -0,0 +1,6 @@
+/**
+ * This type can be used as an any.
+ * Due to being it an unknown you need stricter typechecking and casting
+ * That can make it easier to identify the type
+ */
+export type tTODO = unknown