javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-15 01:03:03 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
ionic-framework/packages/vue
History
Sean Perkins 2bc3b1feae chore(vue): bump vue dev-deps to have generic type (#29718) 
Issue number: Internal

---------

<!-- 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. -->

In v3.2.46 [vue was updated](https://github.com/vuejs/core/pull/3969) to
add support for a generic type argument to the `Plugin` type. In
https://github.com/ionic-team/ionic-framework/pull/29637 Ionic's Vue
plugin was updated to use the generic, but the`@ionic/vue` project is
currently installing v3.2.37.

This results in a local type checking error and build error:
```
(!) Plugin typescript: @rollup/plugin-typescript TS2315: Type 'Plugin_2' is not generic.
src/ionic-vue.ts: (24:24)

24 export const IonicVue: Plugin<[IonicConfig?]> = {
```

## What is the new behavior?
<!-- Please describe the behavior or changes that are being added by
this PR. -->

- Bumps and pins the dev dependency of `vue` to `3.2.46`. There are
other breaking changes that Vue has shipped in minor/patch cycles that
prevents from updating to the latest.
- Resolves the type checking error locally during build of
the`@ionic/vue` package

## Does this introduce a breaking change?

- [ ] Yes
- [x] No

<!--
  If this introduces a breaking change:
1. Describe the impact and migration path for existing applications
below.
  2. Update the BREAKING.md file with the breaking change.
3. Add "BREAKING CHANGE: [...]" to the commit description when merging.
See
https://github.com/ionic-team/ionic-framework/blob/main/docs/CONTRIBUTING.md#footer
for more information.
-->


## Other information

<!-- Any other information that is important to this PR such as
screenshots of how the component looks before and after the change. -->

Validation steps:
1. Checkout the branch
2. Build `core/`
3. In `packages/vue`, install latest pinned dependencies with `npm ci`
4. Sync the changes to the `vue` package with `npm run sync`
5. Open `/packages/vue/src/ionic-vue.ts`
6. Observe: No type errors on L24
7. Run `npm run build`
8. Observe: No build errors
2024-07-16 20:11:49 +00:00
..
scripts
feat(picker): add inline picker (#28689)
2023-12-13 13:03:58 -05:00
src
feat(vue): add optional IonicConfig type parameter to IonicVue plugin (#29637)
2024-06-28 19:02:20 +00:00
test
chore(vue): unpin version (#29657)
2024-06-26 17:39:11 +00:00
types
feat(slides): remove ion-slide, ion-slides, and IonicSwiper module (#25868)
2022-09-01 14:36:17 -05:00
.eslintignore
chore(vue): add eslint and prettier (#26635)
2023-01-18 18:29:25 -05:00
.eslintrc.js
chore(vue): add eslint and prettier (#26635)
2023-01-18 18:29:25 -05:00
.prettierignore
chore(vue): add eslint and prettier (#26635)
2023-01-18 18:29:25 -05:00
CHANGELOG.md
docs(changelog): correct v8.2.5 changelog
2024-07-03 10:33:14 -04:00
package-lock.json
chore(vue): bump vue dev-deps to have generic type (#29718)
2024-07-16 20:11:49 +00:00
package.json
chore(vue): bump vue dev-deps to have generic type (#29718)
2024-07-16 20:11:49 +00:00
README.md
docs(many): update Contributing links (#29498)
2024-05-14 19:48:36 +00:00
rollup.config.mjs
refactor: update to rollup 4 (#28459)
2023-11-07 15:21:46 +00:00
tsconfig.json
chore: packages do not explicitly run tsc (#28450)
2023-11-06 19:23:48 +00:00

README.md

@ionic/vue

Ionic Framework integration for Vue 3 apps.

Building

  1. Install dependencies in @ionic/core:
cd core && npm install
  1. Build @ionic/core. This will generate Vue component bindings in the packages/vue directory:
npm run build
  1. Install dependencies in @ionic/vue:
cd packages/vue && npm install
  1. Build @ionic/vue:
npm run build
  1. Install dependencies in @ionic/vue-router:
cd packages/vue-router && npm install
  1. Build @ionic/vue-router:
npm run build

Tests

  • 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 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.

Contributing

See our Contributing Guide.

Need Help?

Post your question on the Ionic Forum.