Merge pull request #2 from sourceallies/require-at-least-node-20

Updates to require at least Node 20.

Author: Sid-Blommers

.github/workflows/ci.yml

@@ -12,13 +12,13 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x, 20.x, 22.x]
+        node-version: [20.x, 22.x, 24.x]
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
+      uses: actions/setup-node@v6
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'

.github/workflows/publish.yml

@@ -4,24 +4,28 @@ on:
   release:
     types: [created]
 
+permissions:
+  contents: read
+  id-token: write
+  
 jobs:
   publish:
     runs-on: ubuntu-latest
 
-    permissions:
-      contents: read
-      id-token: write
-
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
-    - name: Use Node.js 20.x
-      uses: actions/setup-node@v4
+    - name: Use Node.js 24.x
+      uses: actions/setup-node@v6
       with:
-        node-version: 20.x
+        node-version: 24.x
         registry-url: 'https://registry.npmjs.org'
         cache: 'npm'
 
+    # Ensure npm 11.5.1 or later is installed
+    - name: Update npm
+      run: npm install -g npm@latest
+
     - name: Install dependencies
       run: npm ci
 
@@ -32,6 +36,4 @@ jobs:
       run: npm run build
 
     - name: Publish to NPM
-      run: npm publish --provenance --access public
-      env:
-        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      run: npm publish --access public

.nvmrc

@@ -0,0 +1 @@
+24.11.1

README.md

@@ -48,6 +48,32 @@ Build the TypeScript source to JavaScript:
 npm run build
 ```
 
+### Local testing of stub functions using another project
+
+Ensure package is not already installed in the project testing the changes.
+
+```bash
+npm uninstall @sourceallies/vue-testing-library-stubs
+```
+
+Ensure Vue Testing Library Stubs project is using the same node version as the project testing the changes.
+
+```bash
+node -v
+```
+
+Create a symlink for the project testing the changes to connect to.
+
+```bash
+npm link
+```
+
+In project testing the changes link the package
+
+```bash
+npm link @sourceallies/vue-testing-library-stubs
+```
+
 The compiled output will be in the `dist/` directory.
 
 ### Project Structure
@@ -70,7 +96,7 @@ Create a simple stub component for testing:
 
 ```typescript
 import { mount } from '@vue/test-utils';
-import { getStub } from 'vue-testing-library-stubs';
+import { getStub } from '@sourceallies/vue-testing-library-stubs';
 
 const wrapper = mount(MyParentComponent, {
   global: {
@@ -88,7 +114,7 @@ expect(wrapper.text()).toContain('ChildComponent-stub');
 
 ```typescript
 import { render, screen } from '@testing-library/vue';
-import { getStub } from 'vue-testing-library-stubs';
+import { getStub } from '@sourceallies/vue-testing-library-stubs';
 
 render(MyParentComponent, {
   global: {
@@ -110,7 +136,7 @@ Test components that pass props to child components:
 
 ```typescript
 import { mount } from '@vue/test-utils';
-import { getStubWithProps } from 'vue-testing-library-stubs';
+import { getStubWithProps } from '@sourceallies/vue-testing-library-stubs';
 
 const wrapper = mount(MyParentComponent, {
   global: {
@@ -129,7 +155,7 @@ expect(wrapper.text()).toContain('count-42');
 
 ```typescript
 import { render, screen } from '@testing-library/vue';
-import { getStubWithProps } from 'vue-testing-library-stubs';
+import { getStubWithProps } from '@sourceallies/vue-testing-library-stubs';
 
 render(MyParentComponent, {
   global: {
@@ -152,7 +178,7 @@ Test components that listen to child component events:
 
 ```typescript
 import { mount } from '@vue/test-utils';
-import { getEmittingStub } from 'vue-testing-library-stubs';
+import { getEmittingStub } from '@sourceallies/vue-testing-library-stubs';
 
 const wrapper = mount(MyParentComponent, {
   global: {
@@ -176,7 +202,7 @@ expect(wrapper.emitted('save')?.[0]).toEqual([{ id: 123 }]);
 ```typescript
 import { render, screen } from '@testing-library/vue';
 import userEvent from '@testing-library/user-event';
-import { getEmittingStub } from 'vue-testing-library-stubs';
+import { getEmittingStub } from '@sourceallies/vue-testing-library-stubs';
 
 const { emitted } = render(MyParentComponent, {
   global: {
@@ -203,7 +229,7 @@ Combine props and event emission:
 
 ```typescript
 import { mount } from '@vue/test-utils';
-import { getEmittingStubWithProps } from 'vue-testing-library-stubs';
+import { getEmittingStubWithProps } from '@sourceallies/vue-testing-library-stubs';
 
 const wrapper = mount(MyParentComponent, {
   global: {
@@ -233,7 +259,7 @@ expect(wrapper.emitted('update')?.[0]).toEqual([{ newValue: 'test' }]);
 ```typescript
 import { render, screen } from '@testing-library/vue';
 import userEvent from '@testing-library/user-event';
-import { getEmittingStubWithProps } from 'vue-testing-library-stubs';
+import { getEmittingStubWithProps } from '@sourceallies/vue-testing-library-stubs';
 
 const { emitted } = render(MyParentComponent, {
   global: {
@@ -269,7 +295,7 @@ Test components with multiple event handlers:
 
 ```typescript
 import { mount } from '@vue/test-utils';
-import { getMultiEmittingStubWithProps, type EmittedEvent } from 'vue-testing-library-stubs';
+import { getMultiEmittingStubWithProps, type EmittedEvent } from '@sourceallies/vue-testing-library-stubs';
 
 const events: EmittedEvent[] = [
   { name: 'save', value: { id: 1 } },
@@ -302,7 +328,7 @@ expect(wrapper.emitted('cancel')?.[0]).toEqual([undefined]);
 ```typescript
 import { render, screen } from '@testing-library/vue';
 import userEvent from '@testing-library/user-event';
-import { getMultiEmittingStubWithProps, type EmittedEvent } from 'vue-testing-library-stubs';
+import { getMultiEmittingStubWithProps, type EmittedEvent } from '@sourceallies/vue-testing-library-stubs';
 
 const events: EmittedEvent[] = [
   { name: 'save', value: { id: 1 } },
@@ -339,7 +365,7 @@ Test parent components that call child validation methods:
 
 ```typescript
 import { mount } from '@vue/test-utils';
-import { getExposedValidateStub } from 'vue-testing-library-stubs';
+import { getExposedValidateStub } from '@sourceallies/vue-testing-library-stubs';
 
 const wrapper = mount(MyFormComponent, {
   global: {
@@ -357,7 +383,7 @@ expect(wrapper.text()).toContain('InputComponent-stub-validated-true');
 
 ```typescript
 import { render, screen } from '@testing-library/vue';
-import { getExposedValidateStub } from 'vue-testing-library-stubs';
+import { getExposedValidateStub } from '@sourceallies/vue-testing-library-stubs';
 
 render(MyFormComponent, {
   global: {
@@ -379,7 +405,7 @@ Test components that use child component's exposed functions:
 
 ```typescript
 import { mount } from '@vue/test-utils';
-import { getTemplateComponentForExposedFunction } from 'vue-testing-library-stubs';
+import { getTemplateComponentForExposedFunction } from '@sourceallies/vue-testing-library-stubs';
 
 const props = { value: 'test', enabled: true };
 
@@ -402,7 +428,7 @@ await wrapper.find('button').trigger('click');
 ```typescript
 import { render, screen } from '@testing-library/vue';
 import userEvent from '@testing-library/user-event';
-import { getTemplateComponentForExposedFunction } from 'vue-testing-library-stubs';
+import { getTemplateComponentForExposedFunction } from '@sourceallies/vue-testing-library-stubs';
 
 const props = { value: 'test', enabled: true };