docs(vue): update README instructions (#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
This commit is contained in:
Maria Hutt
2023-09-14 09:20:51 -07:00
committed by GitHub
parent cd1102b985
commit 67c97225d0
2 changed files with 21 additions and 6 deletions

View File

@@ -22,7 +22,19 @@ npm run build
cd packages/vue && npm install
```
2. Build `@ionic/vue`:
4. Build `@ionic/vue`:
```shell
npm run build
````
5. Install dependencies in `@ionic/vue-router`:
```shell
cd packages/vue-router && npm install
```
6. Build `@ionic/vue-router`:
```shell
npm run build
@@ -30,8 +42,8 @@ npm run build
## Tests
* E2E Tests are found in the `packages/vue/test-app/tests` directory and use Cypress.
* 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.
* E2E Tests are found in the `packages/vue/test/base/tests` directory and use Cypress.
* 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.
* Tests can be run in headless mode by running `npm run cypress`.
* If you want to open the Cypress test runner, you can run `node_modules/.bin/cypress open`.
* 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/
## Need Help?
Post your question on the [Ionic Forum](http://forum.ionicframework.com/).
Post your question on the [Ionic Forum](http://forum.ionicframework.com/).

View File

@@ -6,9 +6,9 @@ Ionic Framework supports multiple versions of Vue. As a result, we need to verif
The Vue test app supports syncing your locally built changes for validation.
1. Build the `core`, `packages/vue`, and `packages/vue-router` projects using `npm run build`.
1. [Build](../README.md#building) the `core`, `packages/vue`, and `packages/vue-router` projects using `npm run build`.
2. [Build the Vue test app](#test-app-build-structure).
3. Navigate to the built test app.
3. Navigate to the built test app directory (e.g. `packages/vue/test/build/vue3`).
4. Install dependencies using `npm install`.
5. Sync your local changes using `npm run sync`.
@@ -16,6 +16,9 @@ From here you can either build the application or start a local dev server. When
## Test App Build Structure
> [!NOTE]
> Please confirm your current directory as `packages/vue/test` before proceeding with any of the following commands.
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.
**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.