Skip to content

Commit 67c9722

Browse files
authored
docs(vue): update README instructions (ionic-team#28175)
Issue number: N/A --------- <!-- Please do not submit updates to dependencies unless it fixes an issue. --> <!-- Please try to limit your pull request to one type (bugfix, feature, etc). Submit multiple pull requests if needed. --> ## What is the current behavior? <!-- Please describe the current behavior that you are modifying. --> The instructions doesn't provide clear directory paths for syncing local changes. ## What is the new behavior? <!-- Please describe the behavior or changes that are being added by this PR. --> - The instructions has clear directory paths for syncing local changes. - Updated out of date information. ## Does this introduce a breaking change? - [ ] Yes - [x] No <!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. --> ## Other information <!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. --> N/A
1 parent cd1102b commit 67c9722

File tree

2 files changed

+21
-6
lines changed

2 files changed

+21
-6
lines changed

packages/vue/README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,28 @@ npm run build
2222
cd packages/vue && npm install
2323
```
2424

25-
2. Build `@ionic/vue`:
25+
4. Build `@ionic/vue`:
26+
27+
```shell
28+
npm run build
29+
````
30+
31+
5. Install dependencies in `@ionic/vue-router`:
32+
33+
```shell
34+
cd packages/vue-router && npm install
35+
```
36+
37+
6. Build `@ionic/vue-router`:
2638

2739
```shell
2840
npm run build
2941
````
3042

3143
## Tests
3244

33-
* E2E Tests are found in the `packages/vue/test-app/tests` directory and use Cypress.
34-
* When making changes to `@ionic/vue` or `@ionic/vue-router` you can run `npm run sync` in the `test-app` directory to ensure that the test application is using your built changes. Be sure to build in the `vue` and `vue-router` directories first.
45+
* E2E Tests are found in the `packages/vue/test/base/tests` directory and use Cypress.
46+
* When making changes to `@ionic/vue` or `@ionic/vue-router` you can run `npm run sync` in the [test-app directory](test/README.md#syncing-local-changes) to ensure that the test application is using your built changes. Be sure to build in the `vue` and `vue-router` directories first.
3547
* Tests can be run in headless mode by running `npm run cypress`.
3648
* If you want to open the Cypress test runner, you can run `node_modules/.bin/cypress open`.
3749
* Bug fix and feature PRs should have new tests verifying the PR functionality.
@@ -42,4 +54,4 @@ See our [Contributing Guide](https://github.com/ionic-team/ionic-framework/blob/
4254

4355
## Need Help?
4456

45-
Post your question on the [Ionic Forum](http://forum.ionicframework.com/).
57+
Post your question on the [Ionic Forum](http://forum.ionicframework.com/).

packages/vue/test/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,19 @@ Ionic Framework supports multiple versions of Vue. As a result, we need to verif
66

77
The Vue test app supports syncing your locally built changes for validation.
88

9-
1. Build the `core`, `packages/vue`, and `packages/vue-router` projects using `npm run build`.
9+
1. [Build](../README.md#building) the `core`, `packages/vue`, and `packages/vue-router` projects using `npm run build`.
1010
2. [Build the Vue test app](#test-app-build-structure).
11-
3. Navigate to the built test app.
11+
3. Navigate to the built test app directory (e.g. `packages/vue/test/build/vue3`).
1212
4. Install dependencies using `npm install`.
1313
5. Sync your local changes using `npm run sync`.
1414

1515
From here you can either build the application or start a local dev server. When re-syncing changes, you will need to wipe the build cache in `node_modules/.cache` and restart the dev server/re-build.
1616

1717
## Test App Build Structure
1818

19+
> [!NOTE]
20+
> Please confirm your current directory as `packages/vue/test` before proceeding with any of the following commands.
21+
1922
Unlike other test applications, these test apps are broken up into multiple directories. These directories are then combined to create a single application. This allows us to share common application code, tests, etc so that each app is being tested the same way. Below details the different pieces that help create a single test application.
2023

2124
**apps** - This directory contains partial applications for each version of Vue we want to test. Typically these directories contain new `package.json` files, `jest.config.js` files, and more. If you have code that is specific to a particular version of Vue, put it in this directory.

0 commit comments

Comments
 (0)