Merge branch 'main' of github.com.:dwightjack/vue-types

Author: dwightjack

.github/workflows/build.yml

@@ -27,20 +27,20 @@ jobs:
           cache: 'pnpm'
           registry-url: 'https://registry.npmjs.org'
       - run: pnpm i
+      - name: Build
+        run: pnpm build
       - name: Lint
-        run: pnpm -r run lint
+        run: pnpm lint
 
       - name: Test
-        run: pnpm -r test
+        run: pnpm test
       - name: Upload code coverage
         uses: paambaati/codeclimate-action@f429536ee076d758a24705203199548125a28ca7 # v9.0.0
         env:
           CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
         with:
           coverageLocations: ${{github.workspace}}/packages/core/coverage/lcov.info:lcov
           prefix: test
-      - name: Build
-        run: pnpm -r run build
       - name: Create Release Pull Request or Publish to npm
         id: changesets
         if: github.ref_name == 'main'

.npmrc

@@ -1 +1 @@
-20.18.1
+22.12.0

.nvmrc

@@ -0,0 +1,11 @@
+/**
+ * @see https://prettier.io/docs/en/configuration.html
+ * @type {import("prettier").Config}
+ */
+export default {
+  printWidth: 80,
+  trailingComma: 'all',
+  arrowParens: 'always',
+  semi: false,
+  singleQuote: true,
+}

.prettierrc.cjs

@@ -5,6 +5,10 @@
   "[ts]": {
     "editor.formatOnSave": false
   },
+  "[markdown]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": "explicit"
   }

.prettierrc.mjs

@@ -3,11 +3,33 @@
 import eslint from '@eslint/js'
 import ts from 'typescript-eslint'
 import prettier from 'eslint-plugin-prettier/recommended'
+import vue from 'eslint-plugin-vue'
+import globals from 'globals'
 
 export default ts.config(
   eslint.configs.recommended,
   ...ts.configs.strict,
   ...ts.configs.stylistic,
+  {
+    extends: [
+      eslint.configs.recommended,
+      ...ts.configs.strict,
+      ...ts.configs.stylistic,
+      ...vue.configs['flat/recommended'],
+    ],
+    files: ['**/*.{ts,vue}'],
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      globals: globals.browser,
+      parserOptions: {
+        parser: ts.parser,
+      },
+    },
+    rules: {
+      'vue/one-component-per-file': 0,
+    },
+  },
   {
     files: ['**/*.ts'],
     rules: {
@@ -16,5 +38,7 @@ export default ts.config(
     },
   },
   prettier,
-  { ignores: ['**/dist', '**/node_modules', '**/shim', '**/*.vue'] },
+  {
+    ignores: ['**/dist', '**/node_modules', '**/shim', '**/*.vue', '**/cache'],
+  },
 )

.vscode/settings.json

@@ -3,17 +3,20 @@
   "description": "VueTypes Monorepo",
   "author": "Marco Solazzi",
   "license": "MIT",
-  "homepage": "https://dwightjack.github.io/vue-types/",
+  "homepage": "https://vue-types.codeful.dev/",
   "type": "module",
   "private": true,
   "packageManager": "[email protected]",
   "engines": {
-    "node": ">=16.16.0",
+    "node": ">=20.0.0",
     "pnpm": "^9.0.0"
   },
   "scripts": {
     "examples:dev": "pnpm --filter=vue-types run build && pnpm --filter=examples start",
     "docs:dev": "pnpm --filter=docs run dev",
+    "build": "pnpm -r build",
+    "lint": "pnpm -r lint",
+    "test": "pnpm -r test",
     "ci:version": "pnpm changeset version && pnpm install --lockfile-only",
     "ci:publish": "git status && pnpm -r publish"
   },
@@ -28,9 +31,12 @@
     "@vitest/coverage-v8": "2.1.8",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-prettier": "5.2.1",
+    "eslint-plugin-vue": "^9.32.0",
+    "globals": "^15.14.0",
     "happy-dom": "15.11.7",
     "lefthook": "1.8.5",
     "prettier": "3.3.3",
+    "publint": "^0.3.4",
     "typescript": "5.6.3",
     "typescript-eslint": "8.15.0",
     "vite": "5.4.12",

eslint.config.mjs

@@ -1,5 +1,87 @@
 # vue-types
 
+## 6.0.0
+
+### Major Changes
+
+- 306173f: #### Drop Vue 2 support
+
+  Vue 2 reached End of Life (EOL) on December 31st, 2023. By dropping Vue 2 compatibility we can deliver a smaller package and make the source code more maintainable.
+
+  If you're unable to update to Vue 3, please use [email protected]
+
+  #### Removed `VueTypes.extend` method
+
+  `VueTypes.extend` was deprecated in v5. In v6 this method has been removed. Please migrate your code to use ES6+ `extends` feature.
+
+  Example:
+
+  Using `VueTypes.extend` (old):
+
+  ```js
+  import VueTypes from 'vue-types'
+
+  export const VueTypesProject = VueTypes.extend([
+    {
+      name: 'maxLength',
+      type: String,
+      validator: (max, v) => v.length <= max,
+    },
+    {
+      name: 'positive',
+      getter: true,
+      type: Number,
+      validator: (v) => v > 0,
+    },
+  ])
+  ```
+
+  Using ES6+ `extends` (new):
+
+  ```js
+  import VueTypes, { toType } from 'vue-types'
+
+  export class VueTypesProject extends VueTypes {
+    static maxLength(max) {
+      return toType('maxLength', {
+        type: String,
+        validator: (v) => String(v).length <= max,
+      })
+    }
+
+    static get positive() {
+      return toType('positive', {
+        type: Number,
+        validator: (v) => v > 0,
+      })
+    }
+  }
+  ```
+
+  #### Package format review:
+
+  - ESM and CJS builds target is ESNext (browsers with support for the latest JavaScript features).
+  - UMD builds target is ES2016 (aligned with [Vue 3 browser support](https://vuejs.org/about/faq#what-browsers-does-vue-support))
+
+  If you're using a bundler, you should not encounter any issue.
+
+  If you are directly referencing or importing a specific file in the `dist` or `shim` folder, you might need to update its path as described in the following table:
+
+  | Old (v5)                   | New (v6)            |
+  | -------------------------- | ------------------- |
+  | `dist/vue-types.m.js`      | `dist/index.mjs`    |
+  | `dist/vue-types.modern.js` | `dist/index.mjs`    |
+  | `dist/vue-types.cjs`       | `dist/index.cjs`    |
+  | `dist/vue-types.umd.js`    | `dist/index.umd.js` |
+  | `dist/shim.m.js`           | `dist/shim.mjs`     |
+  | `dist/shim.modern.js`      | `dist/shim.mjs`     |
+  | `dist/shim.cjs`            | `dist/shim.cjs`     |
+  | `dist/shim.umd.js`         | `dist/shim.umd.js`  |
+  | `shim/index.m.js`          | `dist/shim.mjs`     |
+  | `shim/index.modern.js`     | `dist/shim.mjs`     |
+  | `shim/index.cjs`           | `dist/shim.cjs`     |
+  | `shim/index.umd.js`        | `dist/shim.umd.js`  |
+
 ## 5.1.3
 
 ### Patch Changes

package.json

@@ -8,8 +8,8 @@ export function checkRequired(type: any) {
 
 // Vue.js does keep the context for validators, so there is no `this`
 export const forceNoContext = <T extends (..._args: any[]) => any>(
-  validator: T,
-): T => validator.bind(undefined)
+  validator?: T,
+): T => validator?.bind(undefined) as T
 
 export function getDescriptors<T extends Record<string, any>>(type: T): T {
   const descriptors = {} as { [P in keyof T]: any }
@@ -25,10 +25,10 @@ export function getExpectDescriptors<T extends Record<string, any>>(
   const descriptors = {} as { [P in keyof T]: any }
   Object.getOwnPropertyNames(type).forEach((key) => {
     const descr = Object.getOwnPropertyDescriptor(type, key)
-    if (typeof descr.get === 'function') {
+    if (typeof descr?.get === 'function') {
       descr.get = expect.any(Function) as any
     }
-    if (typeof descr.value === 'function') {
+    if (typeof descr?.value === 'function') {
       descr.value = expect.any(Function) as any
     }
     descriptors[key as keyof T] = descr