Compare commits

...

105 Commits

Author SHA1 Message Date
Liam DeBeasi
2020bb264a chore: build 2024-03-28 15:38:05 -04:00
Liam DeBeasi
c59394cbf7 chore: sync with main 2024-03-28 15:36:38 -04:00
Liam DeBeasi
4f649d1b4d chore: install deps 2024-03-15 20:29:37 -04:00
Liam DeBeasi
7c70b8a7c2 chore: sync with main 2024-03-15 20:28:22 -04:00
Liam DeBeasi
9d27d7cc21 chore: sync with main 2024-03-07 23:03:32 +00:00
Brandy Carney
53e31cd7a2 docs(contributing): update screenshot commands (#28992) 2024-02-07 16:51:41 -05:00
Maria Hutt
72416324e3 chore(angular, react, vue): update readmes for pnpm usage (#28958) 2024-02-02 14:29:31 -08:00
Sean Perkins
fb48489803 chore(test-apps): improve developer message with test apps (#28917)
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. -->

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

- Improves the developer message when generating a test app to include
the next steps to running the test app.

## 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/.github/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. -->
2024-01-31 11:34:57 -05:00
Sean Perkins
4ed6c60a69 chore(angular,react,vue): copy css with build.watch (#28934)
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. -->

CSS is not copied from the `core/` package when running each respective
framework package in watch mode.

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

- Copies the global styles from the `core/` package to each respective
framework package when running the build in watch mode.

Note: This does not register a file watcher to copy CSS updates after
the initial command is ran. This just avoids a scenario of the global
styles being updated and the developer _not_ running a `pnpm build`
prior to running `pnpm build.watch` and the global styles not being
reflected in the framework 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/.github/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. -->
2024-01-31 11:34:40 -05:00
Liam DeBeasi
ac251c75fb Merge remote-tracking branch 'origin/main' into workspace-test 2024-01-29 14:06:08 -05:00
Sean Perkins
589c24a4fe chore: update pnpm lock 2024-01-29 10:57:28 -05:00
Sean Perkins
c0875573be Merge remote-tracking branch 'origin/main' into workspace-test 2024-01-29 10:55:53 -05:00
Liam DeBeasi
e35fe27803 chore: update e2e app lockfiles 2024-01-25 13:28:34 -05:00
Liam DeBeasi
b8464e1938 chore: update lockfile 2024-01-25 13:16:50 -05:00
Liam DeBeasi
14c8e826c2 chore: fix package.json merge conflict 2024-01-25 13:16:22 -05:00
Liam DeBeasi
594925ea78 chore: sync 2024-01-25 13:15:39 -05:00
Sean Perkins
55f9cba9fc fix: react-router test app package resolution 2023-12-28 16:22:25 -05:00
Sean Perkins
529ae0c80d fix: react test app package resolution
The file:../ resolution was causing each navigation to result in a reload of the entire app.
2023-12-28 16:05:08 -05:00
Sean Perkins
43777d18cd chore: update react test app lock file 2023-12-28 14:40:48 -05:00
Sean Perkins
f12335114d chore: update lock file 2023-12-28 14:32:35 -05:00
Sean Perkins
8156a00144 Merge remote-tracking branch 'origin/main' into workspace-test 2023-12-28 14:32:10 -05:00
Sean Perkins
7862856213 fix: exclude optimization in react, but include cjs dep 2023-12-28 14:14:16 -05:00
Sean Perkins
5226bbd5d2 fix: vite dep optimization issue with react test app and pnpm 2023-12-28 13:58:49 -05:00
Sean Perkins
7bb19b83bf chore: update contributing guide for pnpm 2023-12-26 16:06:24 -05:00
Liam DeBeasi
3a7f8b65fe add type package 2023-12-19 12:29:24 -05:00
Liam DeBeasi
29f5ba0535 test(react-router): add history types 2023-12-19 12:08:49 -05:00
Liam DeBeasi
ff34ff0274 test(react): add correct jest types 2023-12-19 12:07:01 -05:00
Liam DeBeasi
ae39ce8682 chore: sync with main 2023-12-19 11:58:49 -05:00
Liam DeBeasi
c0bc9739e0 test(react): fix e2e test apps 2023-12-19 11:57:25 -05:00
Liam DeBeasi
75bf909f58 add missing file 2023-12-19 11:53:28 -05:00
Liam DeBeasi
8174bc6325 test(angular): fix test apps 2023-12-19 11:53:16 -05:00
Liam DeBeasi
9e901309f2 history is a dependency 2023-12-19 11:50:05 -05:00
Liam DeBeasi
5053e53749 fix dep install 2023-12-19 11:43:05 -05:00
Liam DeBeasi
3ce7dcedb8 Remove file 2023-12-19 11:41:19 -05:00
Liam DeBeasi
f6ef93c777 test(angular): use file protocol for deps 2023-12-19 11:41:02 -05:00
Liam DeBeasi
3f49f16e06 test(vue): vue3 test app uses file 2023-12-19 11:37:57 -05:00
Liam DeBeasi
40122929bc chore: update 2023-12-19 11:34:34 -05:00
Liam DeBeasi
c44bfa07dd test(react-router): use file protocol for test app 2023-12-19 11:26:17 -05:00
Liam DeBeasi
252c91f492 refactor: remove test apps from workspace 2023-12-19 11:19:14 -05:00
Liam DeBeasi
d9e5b4aafb remove sync commands 2023-12-18 22:49:06 -05:00
Liam DeBeasi
622fcc0093 add history dep to react router 2023-12-18 22:41:03 -05:00
Liam DeBeasi
75fe3f4280 update react router tests to use workspace deps 2023-12-18 22:29:55 -05:00
Liam DeBeasi
e4e6d4525a react router test apps use pnpm 2023-12-18 22:29:11 -05:00
Liam DeBeasi
effc3f2fea remove extra — 2023-12-18 22:26:50 -05:00
Liam DeBeasi
1dfa61a9b8 install deps before creating test app 2023-12-18 22:19:53 -05:00
Liam DeBeasi
cd7563119b use pnpm commands 2023-12-18 22:09:10 -05:00
Liam DeBeasi
1a85f0e6c5 add react-router test app to pnpm workspace 2023-12-18 22:00:35 -05:00
Liam DeBeasi
8e9677ed46 run tests with pnpm 2023-12-18 22:00:09 -05:00
Liam DeBeasi
e7a573682c update pnpm lock 2023-12-18 21:58:08 -05:00
Liam DeBeasi
f9f0dc0ecb Revert "Revert "temporarily revert jest 29 change""
This reverts commit 129c424531.
2023-12-18 21:57:43 -05:00
Liam DeBeasi
7da50be0b9 stable lock file 2023-12-18 20:19:25 -05:00
Liam DeBeasi
5f3b88dbf7 angular test app live reload 2023-12-18 20:16:15 -05:00
Liam DeBeasi
05a535433c live reload with vue and react 2023-12-18 20:12:21 -05:00
Liam DeBeasi
2980a37463 try new way of setting token 2023-12-18 19:41:14 -05:00
Liam DeBeasi
129c424531 Revert "temporarily revert jest 29 change"
This reverts commit c84c0ce5cd.
2023-12-18 19:33:08 -05:00
Liam DeBeasi
c0a3301994 remove dist path for angular-server 2023-12-18 19:26:46 -05:00
Liam DeBeasi
1a0ee06fe0 add angular cli as dev dep 2023-12-18 18:40:02 -05:00
Liam DeBeasi
1fb4841468 revert old change 2023-12-18 18:37:19 -05:00
Liam DeBeasi
dc6c7d029e update testing library 2023-12-18 18:29:05 -05:00
Liam DeBeasi
00aa03764d remove unused file 2023-12-18 18:25:38 -05:00
Liam DeBeasi
e064babfbd update pnpm lock 2023-12-18 18:14:59 -05:00
Liam DeBeasi
c84c0ce5cd temporarily revert jest 29 change 2023-12-18 18:11:53 -05:00
Liam DeBeasi
091eaa0c1a try another fix 2023-12-18 18:09:40 -05:00
Liam DeBeasi
0c9472ad17 fix react tests 2023-12-18 17:42:33 -05:00
Liam DeBeasi
9bad82a0c4 use pnpm exec for playwright 2023-12-18 17:31:05 -05:00
Liam DeBeasi
4e94176b34 chore: sync 2023-12-18 17:05:43 -05:00
Liam DeBeasi
1a4baba30d skip git checks 2023-11-03 13:15:58 -04:00
Liam DeBeasi
eb5a489ee4 git diff test 2023-11-03 13:11:45 -04:00
Liam DeBeasi
4129444b2f chore: install pnpm 2023-11-03 13:07:04 -04:00
Liam DeBeasi
c07b1cf924 update public script 2023-11-03 13:04:48 -04:00
Liam DeBeasi
fcd633f7a3 chore: update release process to use pnpm 2023-11-03 13:02:10 -04:00
Liam DeBeasi
91000ddcec chore: remove — — 2023-11-03 12:26:38 -04:00
Liam DeBeasi
670849088e chore: fix screenshot tests maybe 2023-11-03 12:17:36 -04:00
Liam DeBeasi
cc3dd4984f chore(angular-server): restore core build on CI 2023-11-03 12:09:03 -04:00
Liam DeBeasi
57661355f4 chore(angular): fix eslint pattern 2023-11-03 12:07:45 -04:00
Liam DeBeasi
d852ee5b72 chore: pass flags correctly 2023-11-03 11:53:44 -04:00
Liam DeBeasi
647320dd4b chore: update scripts to use pnpm 2023-11-03 11:45:21 -04:00
Liam DeBeasi
f4c3ee8673 chore(react): update testing library dep 2023-11-03 11:37:07 -04:00
Liam DeBeasi
02ad14d837 chore(react): install jest-environment-jsdom as dev dep 2023-11-03 11:01:01 -04:00
Liam DeBeasi
ea3c544bcb chore(ci): core prerelease builds with pnpm 2023-11-03 10:48:51 -04:00
Liam DeBeasi
ed28f1a86e chore(angular): remove sync script 2023-11-03 10:46:34 -04:00
Liam DeBeasi
83c2ea2616 chore(ci): build angular and angular-server with pnpm 2023-11-03 10:46:07 -04:00
Liam DeBeasi
f9ca2f2f77 chore(react, react-router): remove sync script 2023-11-03 10:44:04 -04:00
Liam DeBeasi
e53be3946a chore(ci): build react and react router with pnpm 2023-11-03 10:43:34 -04:00
Liam DeBeasi
9427951e80 chore(vue, vue-router): remove sync scripts 2023-11-03 10:42:16 -04:00
Liam DeBeasi
be1c9421dd chore(ci): build vue and vue router 2023-11-03 10:41:18 -04:00
Liam DeBeasi
0fa25899f0 chore(ci): build core with pnpm 2023-11-02 17:52:46 -04:00
Liam DeBeasi
054e03beb6 chore(core): add fast-deep-equal devdep 2023-11-02 17:51:21 -04:00
Liam DeBeasi
fcf536ae87 Merge remote-tracking branch 'origin/rollup-watch' into workspace-test 2023-11-02 17:22:37 -04:00
Liam DeBeasi
4492d985f5 clean up commands 2023-11-02 17:21:23 -04:00
Liam DeBeasi
8dffb5fc3b refactor(angular, angular-server): add watch commands 2023-11-02 17:20:47 -04:00
Liam DeBeasi
1218eada08 prevent accidental npm installs 2023-11-02 17:11:09 -04:00
Liam DeBeasi
3fbdd8d47e refactor(vue): extend type from correct package 2023-11-02 17:08:01 -04:00
Liam DeBeasi
d264042d6d refactor(angular): add correct dependencies 2023-11-02 16:42:57 -04:00
Liam DeBeasi
0c88cb00f9 refactor(angular): update devdeps to 14.3.0 2023-11-02 16:38:25 -04:00
Liam DeBeasi
b2b9ff6712 remove package lock 2023-11-02 16:38:19 -04:00
Liam DeBeasi
14b94f4269 refactor: add pnpm and workspace 2023-11-02 16:37:57 -04:00
Liam DeBeasi
6e3fd70bf0 refactor: add watch command 2023-11-01 17:23:30 -04:00
Liam DeBeasi
d1507fbfdb Merge branch 'main' into rollup-ts 2023-11-01 17:00:59 -04:00
Liam DeBeasi
36aed8c90d typo 2023-11-01 14:34:30 -04:00
Liam DeBeasi
1175b258e7 remove line 2023-11-01 14:33:34 -04:00
Liam DeBeasi
5ac163e4bd refactor(react-router): use ts rollup plugin 2023-11-01 13:20:10 -04:00
Liam DeBeasi
9721d3d877 refactor(react): use ts rollup plugin 2023-11-01 13:18:42 -04:00
Liam DeBeasi
266cebdff6 refactor(vue-router): use ts rollup plugin 2023-11-01 13:16:09 -04:00
Liam DeBeasi
4dd069282b refactor(vue): use ts rollup plugin 2023-11-01 13:16:00 -04:00
100 changed files with 99794 additions and 300523 deletions

View File

@@ -4,56 +4,53 @@ Thanks for your interest in contributing to the Ionic Framework! :tada:
- [Contributing Etiquette](#contributing-etiquette)
- [Creating an Issue](#creating-an-issue)
* [Creating a Good Code Reproduction](#creating-a-good-code-reproduction)
- [Creating a Good Code Reproduction](#creating-a-good-code-reproduction)
- [Creating a Pull Request](#creating-a-pull-request)
* [Requirements](#requirements)
* [Setup](#setup)
* [Core](#core)
+ [Modifying Components](#modifying-components)
+ [Preview Changes](#preview-changes)
+ [Lint Changes](#lint-changes)
+ [Modifying Documentation](#modifying-documentation)
+ [Modifying Tests](#modifying-tests)
- [Requirements](#requirements)
- [Setup](#setup)
- [Core](#core)
- [Modifying Components](#modifying-components)
- [Preview Changes](#preview-changes)
- [Lint Changes](#lint-changes)
- [Modifying Documentation](#modifying-documentation)
- [Modifying Tests](#modifying-tests)
- [Screenshot Tests](#screenshot-tests)
+ [Building Changes](#building-changes)
* [Angular, React, and Vue](#angular-react-and-vue)
+ [Modifying Files](#modifying-files)
+ [Preview Changes](#preview-changes-1)
+ [Lint Changes](#lint-changes-1)
+ [Modifying Tests](#modifying-tests-1)
+ [Building Changes](#building-changes-1)
* [Submit Pull Request](#submit-pull-request)
- [Building Changes](#building-changes)
- [Angular, React, and Vue](#angular-react-and-vue)
- [Modifying Files](#modifying-files)
- [Preview Changes](#preview-changes-1)
- [Lint Changes](#lint-changes-1)
- [Modifying Tests](#modifying-tests-1)
- [Building Changes](#building-changes-1)
- [Submit Pull Request](#submit-pull-request)
- [Commit Message Guidelines](#commit-message-guidelines)
* [Commit Message Format](#commit-message-format)
* [Revert](#revert)
* [Type](#type)
* [Scope](#scope)
* [Subject](#subject)
* [Body](#body)
* [Footer](#footer)
* [Examples](#examples)
- [Commit Message Format](#commit-message-format)
- [Revert](#revert)
- [Type](#type)
- [Scope](#scope)
- [Subject](#subject)
- [Body](#body)
- [Footer](#footer)
- [Examples](#examples)
- [License](#license)
## Contributing Etiquette
Please see our [Contributor Code of Conduct](https://github.com/ionic-team/ionic-framework/blob/main/CODE_OF_CONDUCT.md) for information on our rules of conduct.
## Creating an Issue
* If you have a question about using the framework, please ask on the [Ionic Forum](http://forum.ionicframework.com/) or in the [Ionic Discord](https://ionic.link/discord).
- If you have a question about using the framework, please ask on the [Ionic Forum](http://forum.ionicframework.com/) or in the [Ionic Discord](https://ionic.link/discord).
* It is required that you clearly describe the steps necessary to reproduce the issue you are running into. Although we would love to help our users as much as possible, diagnosing issues without clear reproduction steps is extremely time-consuming and simply not sustainable.
- It is required that you clearly describe the steps necessary to reproduce the issue you are running into. Although we would love to help our users as much as possible, diagnosing issues without clear reproduction steps is extremely time-consuming and simply not sustainable.
* The issue list of this repository is exclusively for bug reports and feature requests. Non-conforming issues will be closed immediately.
- The issue list of this repository is exclusively for bug reports and feature requests. Non-conforming issues will be closed immediately.
* Issues with no clear steps to reproduce will not be triaged. If an issue is labeled with "needs: reply" and receives no further replies from the author of the issue for more than 14 days, it will be closed.
- Issues with no clear steps to reproduce will not be triaged. If an issue is labeled with "needs: reply" and receives no further replies from the author of the issue for more than 14 days, it will be closed.
* If you think you have found a bug, or have a new feature idea, please start by making sure it hasn't already been [reported](https://github.com/ionic-team/ionic-framework/issues?utf8=%E2%9C%93&q=is%3Aissue). You can search through existing issues to see if there is a similar one reported. Include closed issues as it may have been closed with a solution.
* Next, [create a new issue](https://github.com/ionic-team/ionic-framework/issues/new/choose) that thoroughly explains the problem. Please fill out the populated issue form before submitting the issue.
- If you think you have found a bug, or have a new feature idea, please start by making sure it hasn't already been [reported](https://github.com/ionic-team/ionic-framework/issues?utf8=%E2%9C%93&q=is%3Aissue). You can search through existing issues to see if there is a similar one reported. Include closed issues as it may have been closed with a solution.
- Next, [create a new issue](https://github.com/ionic-team/ionic-framework/issues/new/choose) that thoroughly explains the problem. Please fill out the populated issue form before submitting the issue.
## Creating a Good Code Reproduction
@@ -69,42 +66,43 @@ Without a reliable code reproduction, it is unlikely we will be able to resolve
### How to Create a Reproduction
* Create a new Ionic application using one of our starter templates. The `blank` starter application is a great choice for this. You can create one using the following Ionic CLI command: `ionic start myApp blank`
* Add the minimum amount of code needed to recreate the issue you are experiencing. Do not include anything that is not required to reproduce the issue. This includes any 3rd party plugins you have installed.
* Publish the application on GitHub and include a link to it when [creating an issue](#creating-an-issue).
* Be sure to include steps to reproduce the issue. These steps should be clear and easy to follow.
- Create a new Ionic application using one of our starter templates. The `blank` starter application is a great choice for this. You can create one using the following Ionic CLI command: `ionic start myApp blank`
- Add the minimum amount of code needed to recreate the issue you are experiencing. Do not include anything that is not required to reproduce the issue. This includes any 3rd party plugins you have installed.
- Publish the application on GitHub and include a link to it when [creating an issue](#creating-an-issue).
- Be sure to include steps to reproduce the issue. These steps should be clear and easy to follow.
### Benefits of Creating a Reproduction
* **Uses the latest version of Ionic:** By creating a new Ionic application, you are ensuring that you are testing against the latest version of the framework. Sometimes the issues you are experiencing have already been resolved in a newer version of the framework!
* **Minimal surface area:** By removing code that is not needed in order to reproduce the issue, it makes it easier to identify the cause of the issue.
* **No secret code needed:** Creating a minimal reproduction of the issue prevents you from having to publish any proprietary code used in your project.
* **Get help fixing the issue:** If we can reliably reproduce an issue, there is a good chance we will be able to address it.
- **Uses the latest version of Ionic:** By creating a new Ionic application, you are ensuring that you are testing against the latest version of the framework. Sometimes the issues you are experiencing have already been resolved in a newer version of the framework!
- **Minimal surface area:** By removing code that is not needed in order to reproduce the issue, it makes it easier to identify the cause of the issue.
- **No secret code needed:** Creating a minimal reproduction of the issue prevents you from having to publish any proprietary code used in your project.
- **Get help fixing the issue:** If we can reliably reproduce an issue, there is a good chance we will be able to address it.
## Creating a Pull Request
Before creating a pull request, please read our requirements that explains the minimal details to have your PR considered and merged into the codebase.
### Requirements
1. PRs must reference an existing issue that describes the issue or feature being submitted.
2. PRs must have a reproduction app or the issue must include a reproduction app to verify changes against.
3. PRs must include tests covering the changed behavior or a description of why tests cannot be written.
> Note: We appreciate you taking the time to contribute! Before submitting a pull request, please take the time to comment on the issue you are wanting to resolve. This helps us prevent duplicate effort or advise if the team is already addressing the issue.
* Looking for an issue to fix? Look through our issues with the [help wanted](https://github.com/ionic-team/ionic-framework/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) label!
- Looking for an issue to fix? Look through our issues with the [help wanted](https://github.com/ionic-team/ionic-framework/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) label!
### Setup
1. [Download the installer](https://nodejs.org/) for the LTS version of Node.js. This is the best way to also [install npm](https://blog.npmjs.org/post/85484771375/how-to-install-npm#_=_).
2. Fork this repository.
3. Clone your fork.
4. Create a new branch from main for your change.
5. Navigate into the directory of the package you wish to modify (core, angular, etc.).
6. Run `npm install` to install dependencies for this package.
7. Follow the steps for the specific package below.
1. [Download the installer](https://nodejs.org/) for the LTS version of Node.js.
2. Install pnpm following the [installation instructions](https://pnpm.io/installation).
3. Fork this repository.
4. Clone your fork.
5. Create a new branch from main for your change.
6. Navigate into the directory of the package you wish to modify (core, angular, etc.).
7. Run `pnpm install` to install dependencies for this package.
- If you prefer to install all dependencies (core, angular, etc.) at once, run `pnpm -r install` from the root of the repository.
8. Follow the steps for the specific package below.
### Core
@@ -120,12 +118,11 @@ Before creating a pull request, please read our requirements that explains the m
8. After the build is finished, commit the changes. Please follow the [commit message format](#commit-message-format) for every commit.
9. [Submit a Pull Request](#submit-pull-request) of your changes.
#### Preview Changes
##### Previewing in this repository
1. Run `npm start` from within the `core` directory.
1. Run `pnpm start` from within the `core` directory.
2. A browser should open at `http://localhost:3333/`.
3. From here, navigate to one of the component's tests to preview your changes.
4. If a test showing your change doesn't exist, [add a new test or update an existing one](#modifying-tests).
@@ -133,7 +130,7 @@ Before creating a pull request, please read our requirements that explains the m
##### Previewing in an external app
We can use `npm pack` to test Ionic Framework changes in an external app outside of this repository. Follow the below steps based on your framework.
We can use `pnpm pack` to test Ionic Framework changes in an external app outside of this repository. Follow the below steps based on your framework.
###### JavaScript
@@ -141,128 +138,112 @@ Run the following commands to build the core directory and pack the changes:
```bash
cd core
npm i
npm run build
npm pack --pack-destination ~
pnpm install
pnpm build
pnpm pack --pack-destination ~
```
Then, in your Ionic Framework JavaScript app, run the following command to use the built package with the `.tgz` file that was created:
```bash
npm install file:/~/ionic-core-7.0.1.tgz
pnpm install file:/~/ionic-core-7.0.1.tgz
```
###### Angular
Run the following commands to build the core & angular directories and pack the changes:
```bash
cd core
npm i
npm run build
npm pack --pack-destination ~
pnpm install
pnpm build
pnpm pack --pack-destination ~
cd ../packages/angular
npm i
npm run sync
npm run build
pnpm build
cd dist/
npm pack --pack-destination ~
pnpm pack --pack-destination ~
```
Then, in your Ionic Framework Angular app, run the following commands to use the built packages with the `.tgz` files that were created:
```bash
rm -rf .angular/
npm install file:/~/ionic-core-7.0.1.tgz
npm install file:/~/ionic-angular-7.0.1.tgz
pnpm install file:/~/ionic-core-7.0.1.tgz
pnpm install file:/~/ionic-angular-7.0.1.tgz
```
###### React
Run the following commands to build the core & react directories and pack the changes:
```bash
cd core
npm i
npm run build
npm pack --pack-destination ~
pnpm install
pnpm build
pnpm pack --pack-destination ~
cd ../packages/react
npm i
npm run sync
npm run build
npm pack --pack-destination ~
pnpm build
pnpm pack --pack-destination ~
cd ../react-router
npm i
npm run sync
npm run build
npm pack --pack-destination ~
pnpm build
pnpm pack --pack-destination ~
```
Then, in your Ionic Framework React app, run the following commands to use the built packages with the `.tgz` files that were created:
```bash
npm install file:/~/ionic-core-7.0.1.tgz
npm install file:/~/ionic-react-7.0.1.tgz
npm install file:/~/ionic-react-router-7.0.1.tgz
pnpm install file:/~/ionic-core-7.0.1.tgz
pnpm install file:/~/ionic-react-7.0.1.tgz
pnpm install file:/~/ionic-react-router-7.0.1.tgz
```
##### Vue
Run the following commands to build the core & vue directories and pack the changes:
```bash
cd core
npm i
npm run build
npm pack --pack-destination ~
pnpm install
pnpm build
pnpm pack --pack-destination ~
cd ../packages/vue
npm i
npm run sync
npm run build
npm pack --pack-destination ~
pnpm build
pnpm pack --pack-destination ~
cd ../vue-router
npm i
npm run sync
npm run build
npm pack --pack-destination ~
pnpm build
pnpm pack --pack-destination ~
```
Then, in your Ionic Framework Vue app, run the following commands to use the built packages with the `.tgz` files that were created:
```bash
npm install file:/~/ionic-core-7.0.1.tgz
npm install file:/~/ionic-vue-7.0.1.tgz
npm install file:/~/ionic-vue-router-7.0.1.tgz
pnpm install file:/~/ionic-core-7.0.1.tgz
pnpm install file:/~/ionic-vue-7.0.1.tgz
pnpm install file:/~/ionic-vue-router-7.0.1.tgz
```
#### Lint Changes
1. Run `npm run lint` to lint the TypeScript and Sass.
2. If there are lint errors, run `npm run lint.fix` to automatically fix any errors. Repeat step 1 to ensure the errors have been fixed, and manually fix them if not.
3. To lint and fix only TypeScript errors, run `npm run lint.ts` and `npm run lint.ts.fix`, respectively.
4. To lint and fix only Sass errors, run `npm run lint.sass` and `npm run lint.sass.fix`, respectively.
1. Run `pnpm lint` to lint the TypeScript and Sass.
2. If there are lint errors, run `pnpm lint.fix` to automatically fix any errors. Repeat step 1 to ensure the errors have been fixed, and manually fix them if not.
3. To lint and fix only TypeScript errors, run `pnpm lint.ts` and `pnpm lint.ts.fix`, respectively.
4. To lint and fix only Sass errors, run `pnpm lint.sass` and `pnpm lint.sass.fix`, respectively.
#### Modifying Documentation
- Changes to manually written documentation should be made in the `ionic-docs` repo: https://github.com/ionic-team/ionic-docs/tree/main/docs
- In your `ionic-docs` PR, please add a link back to the related `ionic-framework` PR.
- Changes to auto generated documentation should be made in the `ionic-framework` repo. These can be done in the same PR as your fix or feature.
- Run `npm run build` and commit all updates to ensure your changes make it into the generated documentation.
- Run `pnpm build` and commit all updates to ensure your changes make it into the generated documentation.
- `Usage`: update the component's usage examples in the component's `usage/` directory.
- `Properties`, `Events`, or `Methods`: update the component's TypeScript file (`*.tsx`).
- `CSS Custom Properties`: update the component's main Sass file (`*.scss`).
#### Modifying Tests
1. Locate the test to modify inside the `test/` folder in the component's directory.
@@ -277,43 +258,47 @@ See [Ionic's E2E testing guide](../core/src/utils/test/playwright/docs/README.md
1. If the test exists in screenshot, there will be a file named `e2e.ts` in the directory of the test.
2. A screenshot test can be added by including this file and adding one or more `test()` calls that include a call to `page.compareScreenshot()`. See [Stencil end-to-end testing](https://stenciljs.com/docs/end-to-end-testing) and existing tests in `core/` for examples.
3. **Important:** each `test()` should have only one screenshot (`page.compareScreenshot()`) call **or** it should check the expect at the end of each test. If there is a mismatch it will fail the test which will prevent the rest of the test from running, i.e. if the first screenshot fails the remaining screenshot calls would not be called _unless_ they are in a separate test or all of the expects are called at the end.
4. To run screenshot locally, use the following command: `npm run test.screenshot`.
- To run screenshot for a specific test, pass the path to the test or a string to search for.
- For example, running all `alert` tests: `npm run test.screenshot alert`.
- Or, running the basic `alert` tests: `npm run test.screenshot src/components/alert/test/basic/e2e.ts`.
4. To run screenshot locally, use the following command: `pnpm test.e2e`.
- To run screenshot for a specific test, pass the path to the test or a string to search for.
- For example, running all `alert` tests: `pnpm test.e2e alert`.
- Or, running the basic `alert` tests: `pnpm test.e2e src/components/alert/test/basic/e2e.ts`.
#### Building Changes
1. Once all changes have been made and the documentation has been updated, run `npm run build` inside of the `core` directory. This will add your changes to any auto-generated files, if necessary.
1. Once all changes have been made and the documentation has been updated, run `pnpm build` inside of the `core` directory. This will add your changes to any auto-generated files, if necessary.
2. Review the changes and, if everything looks correct, [commit](#commit-message-format) the changes.
3. Make sure the build has finished before committing. If you made changes to the documentation, properties, methods, or anything else that requires an update to a generate file, this needs to be committed.
4. After the changes have been pushed, publish the branch and [create a pull request](#creating-a-pull-request).
> [!WARNING]
> If you are receiving errors about missing packages, you may need to run `pnpm install --force` to force the installation of the missing packages.
### Angular, React, and Vue
#### Modifying Files
1. Locate the files inside the relevant root directory:
- Angular: [`/packages/angular/src`](/packages/angular/src)
- React: [`/packages/react/src`](/packages/react/src)
- Vue: [`/packages/vue/src`](/packages/vue/src)
- Angular: [`/packages/angular/src`](/packages/angular/src)
- React: [`/packages/react/src`](/packages/react/src)
- Vue: [`/packages/vue/src`](/packages/vue/src)
2. Make your changes to the files. If the change is overly complex or out of the ordinary, add comments so we can understand the changes.
3. Run lint on the directory and make sure there are no errors.
4. Build the project.
4. Build the project with `pnpm build`.
- If you prefer to build all packages (core, angular, etc.) at once, run `pnpm -r build` from the root of the repository.
5. After the build is finished, commit the changes. Please follow the [commit message format](#commit-message-format) for every commit.
6. [Submit a Pull Request](#submit-pull-request) of your changes.
#### Preview Changes
##### Previewing in this repository
Follow the steps in the test directory for each framework:
- Angular: [`/packages/angular/test`](/packages/angular/test/README.md)
- React: [`/packages/react/test`](/packages/react/test/README.md)
- Vue: [`/packages/vue/test`](/packages/vue/test/README.md)
- Angular: [`/packages/angular/test`](/packages/angular/test/README.md)
- React: [`/packages/react/test`](/packages/react/test/README.md)
- Vue: [`/packages/vue/test`](/packages/vue/test/README.md)
##### Previewing in an external app
@@ -321,25 +306,29 @@ Follow the steps to [preview changes in core](#preview-changes).
#### Lint Changes
1. Run `npm run lint` to lint the TypeScript in the relevant directory:
- Angular: [`/packages/angular/src`](/packages/angular/src)
- React: [`/packages/react/src`](/packages/react/src)
- Vue: [`/packages/vue/src`](/packages/vue/src)
2. If there are lint errors, run `npm run lint.fix` to automatically fix any errors. Repeat step 1 to ensure the errors have been fixed, and manually fix them if not.
1. Run `pnpm lint` to lint the TypeScript in the relevant directory:
- Angular: [`/packages/angular/src`](/packages/angular/src)
- React: [`/packages/react/src`](/packages/react/src)
- Vue: [`/packages/vue/src`](/packages/vue/src)
2. If there are lint errors, run `pnpm lint.fix` to automatically fix any errors. Repeat step 1 to ensure the errors have been fixed, and manually fix them if not.
#### Modifying Tests
1. Locate the e2e test to modify inside the relevant test app directory:
- Angular: [`/packages/angular/test/base/e2e/src`](/packages/angular/test/base/e2e/src)
- React: [`/packages/react/test/base/tests/e2e/specs`](/packages/react/test/base/tests/e2e/specs)
- Vue: [`/packages/vue/test/base/tests/e2e/specs`](/packages/vue/test/base/tests/e2e/specs)
- Angular: [`/packages/angular/test/base/e2e/src`](/packages/angular/test/base/e2e/src)
- React: [`/packages/react/test/base/tests/e2e/specs`](/packages/react/test/base/tests/e2e/specs)
- Vue: [`/packages/vue/test/base/tests/e2e/specs`](/packages/vue/test/base/tests/e2e/specs)
2. If a test exists, modify the test by adding an example to reproduce the problem fixed or feature added.
3. If a new test is needed, copy an existing test, rename it, and edit the content in the test file.
4. Run `npm run test` to run your tests.
4. Run `pnpm test` to run your tests.
#### Building Changes
1. Once all changes have been made, run `npm run build` inside of the package's root directory. This will add your changes to any auto-generated files, if necessary.
1. Once all changes have been made, run `pnpm build` inside of the package's root directory. This will add your changes to any auto-generated files, if necessary.
2. Review the changes and, if everything looks correct, [commit](#commit-message-format) the changes.
3. Make sure the build has finished before committing. If you made changes to the documentation, properties, methods, or anything else that requires an update to a generate file, this needs to be committed.
4. After the changes have been pushed, publish the branch and [create a pull request](#creating-a-pull-request).
@@ -356,14 +345,13 @@ The team has an internal design process for new Ionic features, which must be co
To expedite the process, please ensure that all feature PRs have an associated issue created, with a clear use case for why the feature should be added to Ionic.
## Commit Message Guidelines
We have very precise rules over how our git commit messages should be formatted. This leads to readable messages that are easy to follow when looking through the project history. We also use the git commit messages to generate our [changelog](https://github.com/ionic-team/ionic-framework/blob/main/CHANGELOG.md). Our format closely resembles Angular's [commit message guidelines](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit).
### Commit Message Format
We follow the [Conventional Commits specification](https://www.conventionalcommits.org/). A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
We follow the [Conventional Commits specification](https://www.conventionalcommits.org/). A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
```
<type>(<scope>): <subject>
@@ -385,14 +373,14 @@ If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. Howev
Must be one of the following:
* **feat**: A new feature
* **fix**: A bug fix
* **docs**: Documentation only changes
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
* **refactor**: A code change that neither fixes a bug nor adds a feature
* **perf**: A code change that improves performance
* **test**: Adding missing tests
* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
- **feat**: A new feature
- **fix**: A bug fix
- **docs**: Documentation only changes
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- **refactor**: A code change that neither fixes a bug nor adds a feature
- **perf**: A code change that improves performance
- **test**: Adding missing tests
- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
### Scope
@@ -402,12 +390,12 @@ The scope can be anything specifying place of the commit change. Usually it will
The subject contains succinct description of the change:
* use the imperative, present tense: "change" not "changed" nor "changes"
* do not capitalize first letter
* do not place a period `.` at the end
* entire length of the commit message must not go over 50 characters
* describe what the commit does, not what issue it relates to or fixes
* **be brief, yet descriptive** - we should have a good understanding of what the commit does by reading the subject
- use the imperative, present tense: "change" not "changed" nor "changes"
- do not capitalize first letter
- do not place a period `.` at the end
- entire length of the commit message must not go over 50 characters
- describe what the commit does, not what issue it relates to or fixes
- **be brief, yet descriptive** - we should have a good understanding of what the commit does by reading the subject
### Body
@@ -469,7 +457,6 @@ revert: feat(skeleton-text): add animated property
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
```
## License
By contributing your code to the ionic-team/ionic GitHub Repository, you agree to license your contribution under the MIT license.

View File

@@ -6,13 +6,20 @@ runs:
- uses: actions/setup-node@v4
with:
node-version: 18.x
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: ./.github/workflows/actions/download-archive
with:
name: ionic-core
path: ./core
filename: CoreBuild.zip
- name: Install Angular Server Dependencies
run: npm ci
run: pnpm install
shell: bash
working-directory: ./packages/angular-server
- name: Build
run: npm run build.prod
run: pnpm run build.prod
shell: bash
working-directory: ./packages/angular-server
- uses: ./.github/workflows/actions/upload-archive

View File

@@ -6,25 +6,24 @@ runs:
- uses: actions/setup-node@v4
with:
node-version: 18.x
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: ./.github/workflows/actions/download-archive
with:
name: ionic-core
path: ./core
filename: CoreBuild.zip
- name: Install Angular Dependencies
run: npm ci
shell: bash
working-directory: ./packages/angular
- name: Sync
run: npm run sync
run: pnpm install
shell: bash
working-directory: ./packages/angular
- name: Lint
run: npm run lint
run: pnpm run lint
shell: bash
working-directory: ./packages/angular
- name: Build
run: npm run build
run: pnpm run build
shell: bash
working-directory: ./packages/angular
- name: Check Diff

View File

@@ -12,17 +12,19 @@ runs:
- uses: actions/setup-node@v4
with:
node-version: 18.x
- uses: pnpm/action-setup@v2
with:
version: 8
- name: Install Dependencies
run: npm ci
run: pnpm install
working-directory: ./core
shell: bash
- name: Install Stencil ${{ inputs.stencil-version }}
working-directory: ./core
run: npm i @stencil/core@${{ inputs.stencil-version }}
run: pnpm i @stencil/core@${{ inputs.stencil-version }}
shell: bash
- name: Build Core
run: npm run build -- --ci --debug --verbose
run: pnpm npm run build -- --ci --debug --verbose
working-directory: ./core
shell: bash
- uses: ./.github/workflows/actions/upload-archive

View File

@@ -12,19 +12,22 @@ runs:
- uses: actions/setup-node@v4
with:
node-version: 18.x
- uses: pnpm/action-setup@v2
with:
version: 8
- name: Install Dependencies
run: npm install
run: pnpm install
working-directory: ./core
shell: bash
# If an Ionicons version was specified install that.
# Otherwise just use the version defined in the package.json.
- name: Install Ionicons Version
if: inputs.ionicons-version != ''
run: npm install ionicons@${{ inputs.ionicons-version }}
run: pnpm install ionicons@${{ inputs.ionicons-version }}
working-directory: ./core
shell: bash
- name: Build Core
run: npm run build -- --ci
run: pnpm run build --ci
working-directory: ./core
shell: bash
- uses: ./.github/workflows/actions/upload-archive

View File

@@ -6,6 +6,9 @@ runs:
- uses: actions/setup-node@v4
with:
node-version: 18.x
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: ./.github/workflows/actions/download-archive
with:
name: ionic-core
@@ -17,19 +20,15 @@ runs:
path: ./packages/react
filename: ReactBuild.zip
- name: Install Dependencies
run: npm ci
shell: bash
working-directory: ./packages/react-router
- name: Sync
run: npm run sync
run: pnpm install
shell: bash
working-directory: ./packages/react-router
- name: Lint
run: npm run lint
run: pnpm run lint
shell: bash
working-directory: ./packages/react-router
- name: Build
run: npm run build
run: pnpm run build
shell: bash
working-directory: ./packages/react-router
- uses: ./.github/workflows/actions/upload-archive

View File

@@ -6,29 +6,28 @@ runs:
- uses: actions/setup-node@v4
with:
node-version: 18.x
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: ./.github/workflows/actions/download-archive
with:
name: ionic-core
path: ./core
filename: CoreBuild.zip
- name: Install React Dependencies
run: npm ci
shell: bash
working-directory: ./packages/react
- name: Sync
run: npm run sync
run: pnpm install
shell: bash
working-directory: ./packages/react
- name: Lint
run: npm run lint
run: pnpm run lint
shell: bash
working-directory: ./packages/react
- name: Build
run: npm run build
run: pnpm run build
shell: bash
working-directory: ./packages/react
- name: Test Spec
run: npm run test.spec
run: pnpm run test.spec
shell: bash
working-directory: ./packages/react
- name: Check Diff

View File

@@ -6,6 +6,9 @@ runs:
- uses: actions/setup-node@v4
with:
node-version: 18.x
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: ./.github/workflows/actions/download-archive
with:
name: ionic-core
@@ -17,23 +20,19 @@ runs:
path: ./packages/vue
filename: VueBuild.zip
- name: Install Vue Router Dependencies
run: npm ci
shell: bash
working-directory: ./packages/vue-router
- name: Sync
run: npm run sync
run: pnpm install
shell: bash
working-directory: ./packages/vue-router
- name: Lint
run: npm run lint
run: pnpm run lint
shell: bash
working-directory: ./packages/vue-router
- name: Build
run: npm run build
run: pnpm run build
shell: bash
working-directory: ./packages/vue-router
- name: Test Spec
run: npm run test.spec
run: pnpm run test.spec
shell: bash
working-directory: ./packages/vue-router
- uses: ./.github/workflows/actions/upload-archive

View File

@@ -6,25 +6,24 @@ runs:
- uses: actions/setup-node@v4
with:
node-version: 18.x
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: ./.github/workflows/actions/download-archive
with:
name: ionic-core
path: ./core
filename: CoreBuild.zip
- name: Install Vue Dependencies
run: npm ci
shell: bash
working-directory: ./packages/vue
- name: Sync
run: npm run sync
run: pnpm install
shell: bash
working-directory: ./packages/vue
- name: Lint
run: npm run lint
run: pnpm run lint
shell: bash
working-directory: ./packages/vue
- name: Build
run: npm run build
run: pnpm run build
shell: bash
working-directory: ./packages/vue
- name: Check Diff

View File

@@ -22,6 +22,9 @@ runs:
- uses: actions/setup-node@v4
with:
node-version: 18.x
- uses: pnpm/action-setup@v2
with:
version: 8
# Provenance requires npm 9.5.0+
- name: Install latest npm
run: npm install -g npm@latest
@@ -29,27 +32,26 @@ runs:
# This ensures the local version of Lerna is installed
# and that we do not use the global Lerna version
- name: Install root dependencies
run: npm ci
run: pnpm install
shell: bash
- name: Install Dependencies
run: npx lerna bootstrap --include-dependencies --scope ${{ inputs.scope }} --ignore-scripts -- --legacy-peer-deps
- name: Install project dependencies
run: pnpm install
shell: bash
working-directory: ${{ inputs.working-directory }}
- name: Update Version
run: npx lerna version ${{ inputs.version }} --yes --exact --no-changelog --no-push --no-git-tag-version --preid=${{ inputs.preid }}
run: pnpm exec lerna version ${{ inputs.version }} --yes --exact --no-changelog --no-push --no-git-tag-version --preid=${{ inputs.preid }}
shell: bash
working-directory: ${{ inputs.working-directory }}
- name: Run Build
run: npm run build
run: pnpm run build
shell: bash
working-directory: ${{ inputs.working-directory }}
- name: Prepare NPM Token
run: echo //registry.npmjs.org/:_authToken=${NPM_TOKEN} > .npmrc
working-directory: ${{ inputs.working-directory }}
run: pnpm config set //registry.npmjs.org/:_authToken ${NPM_TOKEN}
shell: bash
env:
NPM_TOKEN: ${{ inputs.token }}
- name: Publish to NPM
run: npm publish ${{ inputs.folder }} --tag ${{ inputs.tag }} --provenance
run: pnpm publish ${{ inputs.folder }} --tag ${{ inputs.tag }} --provenance --no-git-checks
shell: bash
working-directory: ${{ inputs.working-directory }}

View File

@@ -9,6 +9,9 @@ runs:
- uses: actions/setup-node@v4
with:
node-version: 18
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: ./.github/workflows/actions/download-archive
with:
name: ionic-core
@@ -29,14 +32,10 @@ runs:
shell: bash
working-directory: ./packages/angular/test
- name: Install Dependencies
run: npm install
shell: bash
working-directory: ./packages/angular/test/build/${{ inputs.app }}
- name: Sync Built Changes
run: npm run sync
run: pnpm install
shell: bash
working-directory: ./packages/angular/test/build/${{ inputs.app }}
- name: Run Tests
run: npm run test
run: pnpm run test
shell: bash
working-directory: ./packages/angular/test/build/${{ inputs.app }}

View File

@@ -6,12 +6,15 @@ runs:
- uses: actions/setup-node@v4
with:
node-version: 18.x
- uses: pnpm/action-setup@v2
with:
version: 8
- name: Install Dependencies
run: npm ci
run: pnpm install
working-directory: ./core
shell: bash
- name: Lint
run: npm run lint
run: pnpm run lint
shell: bash
working-directory: ./core
# Lint changes should be pushed

View File

@@ -16,18 +16,21 @@ runs:
- uses: actions/setup-node@v4
with:
node-version: 18.x
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: ./.github/workflows/actions/download-archive
with:
name: ionic-core
path: ./core
filename: CoreBuild.zip
- name: Install Dependencies
run: npm install
run: pnpm install
shell: bash
working-directory: ./core
- name: Test
if: inputs.update != 'true'
run: npm run test.e2e.docker.ci ${{ inputs.component }} -- --shard=${{ inputs.shard }}/${{ inputs.totalShards }}
run: pnpm run test.e2e.docker.ci ${{ inputs.component }} -- --shard=${{ inputs.shard }}/${{ inputs.totalShards }}
shell: bash
working-directory: ./core
- name: Test and Update
@@ -49,7 +52,7 @@ runs:
# which is why we not using the upload-archive
# composite step here.
run: |
npm run test.e2e.docker.ci ${{ inputs.component }} -- --shard=${{ inputs.shard }}/${{ inputs.totalShards }} --update-snapshots
pnpm run test.e2e.docker.ci ${{ inputs.component }} -- --shard=${{ inputs.shard }}/${{ inputs.totalShards }} --update-snapshots
git add src/\*.png --force
mkdir updated-screenshots
cd ../ && rsync -R --progress $(git diff --name-only --cached) core/updated-screenshots

View File

@@ -9,12 +9,15 @@ runs:
- uses: actions/setup-node@v4
with:
node-version: 18.x
- uses: pnpm/action-setup@v2
with:
version: 8
- name: Install Dependencies
run: npm ci
run: pnpm install
working-directory: ./core
shell: bash
- name: Install Stencil ${{ inputs.stencil-version }}
run: npm install @stencil/core@${{ inputs.stencil-version }}
run: pnpm install @stencil/core@${{ inputs.stencil-version }}
shell: bash
working-directory: ./core
if: ${{ inputs.stencil-version != '' }}
@@ -24,6 +27,6 @@ runs:
path: ./core
filename: CoreBuild.zip
- name: Test
run: npm run test.spec -- --ci
run: pnpm run test.spec --ci
shell: bash
working-directory: ./core

View File

@@ -9,6 +9,9 @@ runs:
- uses: actions/setup-node@v4
with:
node-version: 18.x
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: ./.github/workflows/actions/download-archive
with:
name: ionic-core
@@ -29,19 +32,15 @@ runs:
shell: bash
working-directory: ./packages/react/test
- name: Install Dependencies
run: npm install
shell: bash
working-directory: ./packages/react/test/build/${{ inputs.app }}
- name: Sync Built Changes
run: npm run sync
run: pnpm install
shell: bash
working-directory: ./packages/react/test/build/${{ inputs.app }}
- name: Build
run: npm run build
run: pnpm run build
shell: bash
working-directory: ./packages/react/test/build/${{ inputs.app }}
- name: Run Tests
run: npm run e2e
run: pnpm run e2e
shell: bash
working-directory: ./packages/react/test/build/${{ inputs.app }}

View File

@@ -9,6 +9,9 @@ runs:
- uses: actions/setup-node@v4
with:
node-version: 18.x
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: ./.github/workflows/actions/download-archive
with:
name: ionic-core
@@ -29,18 +32,14 @@ runs:
shell: bash
working-directory: ./packages/react-router/test
- name: Install Dependencies
run: npm install
shell: bash
working-directory: ./packages/react-router/test/build/${{ inputs.app }}
- name: Sync Built Changes
run: npm run sync
run: pnpm install
shell: bash
working-directory: ./packages/react-router/test/build/${{ inputs.app }}
- name: Build
run: npm run build
run: pnpm run build
shell: bash
working-directory: ./packages/react-router/test/build/${{ inputs.app }}
- name: Run Tests
run: npm run e2e
run: pnpm run e2e
shell: bash
working-directory: ./packages/react-router/test/build/${{ inputs.app }}

View File

@@ -9,6 +9,9 @@ runs:
- uses: actions/setup-node@v4
with:
node-version: 18.x
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: ./.github/workflows/actions/download-archive
with:
name: ionic-core
@@ -29,18 +32,14 @@ runs:
shell: bash
working-directory: ./packages/vue/test
- name: Install Dependencies
run: npm install
shell: bash
working-directory: ./packages/vue/test/build/${{ inputs.app }}
- name: Sync
run: npm run sync
run: pnpm install
shell: bash
working-directory: ./packages/vue/test/build/${{ inputs.app }}
- name: Run Spec Tests
run: npm run test:unit
run: pnpm run test:unit
shell: bash
working-directory: ./packages/vue/test/build/${{ inputs.app }}
- name: Run E2E Tests
run: npm run test:e2e
run: pnpm run test:e2e
shell: bash
working-directory: ./packages/vue/test/build/${{ inputs.app }}

View File

@@ -10,11 +10,14 @@ jobs:
dev-hash: ${{ steps.create-dev-hash.outputs.DEV_HASH }}
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
with:
version: 8
# A 1 is required before the timestamp
# as lerna will fail when there is a leading 0
# See https://github.com/lerna/lerna/issues/2840
- name: Install Dependencies
run: npm ci
run: pnpm install
shell: bash
- id: create-dev-hash
name: Create Dev Hash

View File

@@ -13,11 +13,14 @@ jobs:
nightly-hash: ${{ steps.create-nightly-hash.outputs.NIGHTLY_HASH }}
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
with:
version: 8
# A 1 is required before the timestamp
# as lerna will fail when there is a leading 0
# See https://github.com/lerna/lerna/issues/2840
- name: Install Dependencies
run: npm ci
run: pnpm install
shell: bash
- id: create-nightly-hash
name: Create Nightly Hash

View File

@@ -161,7 +161,6 @@ jobs:
version: ${{ inputs.version }}
preid: ${{ inputs.preid }}
working-directory: 'packages/angular-server'
folder: './dist'
token: ${{ secrets.NPM_TOKEN }}
release-react-router:

View File

@@ -54,6 +54,9 @@ jobs:
with:
token: ${{ secrets.IONITRON_TOKEN }}
fetch-depth: 0
- uses: pnpm/action-setup@v2
with:
version: 8
- name: Configure Identity
# Commits from github-actions do not
# trigger other GitHub Actions. As a result,
@@ -101,7 +104,7 @@ jobs:
# so we do that here.
- name: Bump Package Lock
run: |
lerna exec "npm install --package-lock-only"
pnpm install --lockfile-only
git add .
git commit -m "chore(): update package lock files"
git push

View File

@@ -549,7 +549,7 @@ ion-infinite-scroll-content,prop,loadingText,IonicSafeString | string | undefine
ion-input,scoped
ion-input,prop,accept,string | undefined,undefined,false,false
ion-input,prop,autocapitalize,string,'off',false,false
ion-input,prop,autocomplete,"name" | "on" | "off" | "honorific-prefix" | "given-name" | "additional-name" | "family-name" | "honorific-suffix" | "nickname" | "email" | "username" | "new-password" | "current-password" | "one-time-code" | "organization-title" | "organization" | "street-address" | "address-line1" | "address-line2" | "address-line3" | "address-level4" | "address-level3" | "address-level2" | "address-level1" | "country" | "country-name" | "postal-code" | "cc-name" | "cc-given-name" | "cc-additional-name" | "cc-family-name" | "cc-number" | "cc-exp" | "cc-exp-month" | "cc-exp-year" | "cc-csc" | "cc-type" | "transaction-currency" | "transaction-amount" | "language" | "bday" | "bday-day" | "bday-month" | "bday-year" | "sex" | "tel" | "tel-country-code" | "tel-national" | "tel-area-code" | "tel-local" | "tel-extension" | "impp" | "url" | "photo",'off',false,false
ion-input,prop,autocomplete,"name" | "email" | "tel" | "url" | "on" | "off" | "honorific-prefix" | "given-name" | "additional-name" | "family-name" | "honorific-suffix" | "nickname" | "username" | "new-password" | "current-password" | "one-time-code" | "organization-title" | "organization" | "street-address" | "address-line1" | "address-line2" | "address-line3" | "address-level4" | "address-level3" | "address-level2" | "address-level1" | "country" | "country-name" | "postal-code" | "cc-name" | "cc-given-name" | "cc-additional-name" | "cc-family-name" | "cc-number" | "cc-exp" | "cc-exp-month" | "cc-exp-year" | "cc-csc" | "cc-type" | "transaction-currency" | "transaction-amount" | "language" | "bday" | "bday-day" | "bday-month" | "bday-year" | "sex" | "tel-country-code" | "tel-national" | "tel-area-code" | "tel-local" | "tel-extension" | "impp" | "photo",'off',false,false
ion-input,prop,autocorrect,"off" | "on",'off',false,false
ion-input,prop,autofocus,boolean,false,false,false
ion-input,prop,clearInput,boolean,false,false,false
@@ -1159,7 +1159,7 @@ ion-row,shadow
ion-searchbar,scoped
ion-searchbar,prop,animated,boolean,false,false,false
ion-searchbar,prop,autocapitalize,string,'default',false,false
ion-searchbar,prop,autocomplete,"name" | "on" | "off" | "honorific-prefix" | "given-name" | "additional-name" | "family-name" | "honorific-suffix" | "nickname" | "email" | "username" | "new-password" | "current-password" | "one-time-code" | "organization-title" | "organization" | "street-address" | "address-line1" | "address-line2" | "address-line3" | "address-level4" | "address-level3" | "address-level2" | "address-level1" | "country" | "country-name" | "postal-code" | "cc-name" | "cc-given-name" | "cc-additional-name" | "cc-family-name" | "cc-number" | "cc-exp" | "cc-exp-month" | "cc-exp-year" | "cc-csc" | "cc-type" | "transaction-currency" | "transaction-amount" | "language" | "bday" | "bday-day" | "bday-month" | "bday-year" | "sex" | "tel" | "tel-country-code" | "tel-national" | "tel-area-code" | "tel-local" | "tel-extension" | "impp" | "url" | "photo",'off',false,false
ion-searchbar,prop,autocomplete,"name" | "email" | "tel" | "url" | "on" | "off" | "honorific-prefix" | "given-name" | "additional-name" | "family-name" | "honorific-suffix" | "nickname" | "username" | "new-password" | "current-password" | "one-time-code" | "organization-title" | "organization" | "street-address" | "address-line1" | "address-line2" | "address-line3" | "address-level4" | "address-level3" | "address-level2" | "address-level1" | "country" | "country-name" | "postal-code" | "cc-name" | "cc-given-name" | "cc-additional-name" | "cc-family-name" | "cc-number" | "cc-exp" | "cc-exp-month" | "cc-exp-year" | "cc-csc" | "cc-type" | "transaction-currency" | "transaction-amount" | "language" | "bday" | "bday-day" | "bday-month" | "bday-year" | "sex" | "tel-country-code" | "tel-national" | "tel-area-code" | "tel-local" | "tel-extension" | "impp" | "photo",'off',false,false
ion-searchbar,prop,autocorrect,"off" | "on",'off',false,false
ion-searchbar,prop,cancelButtonIcon,string,config.get('backButtonIcon', arrowBackSharp) as string,false,false
ion-searchbar,prop,cancelButtonText,string,'Cancel',false,false

17248
core/package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

View File

@@ -43,6 +43,7 @@
"@capacitor/status-bar": "^5.0.7",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "^2.0.0",
"@jest/core": "^27.5.1",
"@playwright/test": "^1.39.0",
"@rollup/plugin-node-resolve": "^8.4.0",
"@rollup/plugin-virtual": "^2.0.3",
@@ -50,7 +51,7 @@
"@stencil/react-output-target": "^0.5.3",
"@stencil/sass": "^3.0.9",
"@stencil/vue-output-target": "^0.8.7",
"@types/jest": "^29.5.6",
"@types/jest": "^27.5.2",
"@types/node": "^14.6.0",
"@typescript-eslint/eslint-plugin": "^6.7.2",
"@typescript-eslint/parser": "^6.7.2",
@@ -60,9 +61,10 @@
"eslint-config-prettier": "^8.5.0",
"eslint-plugin-custom-rules": "file:custom-rules",
"execa": "^5.0.0",
"fast-deep-equal": "^3.1.3",
"fs-extra": "^9.0.1",
"jest": "^29.7.0",
"jest-cli": "^29.7.0",
"jest": "^27.5.1",
"jest-cli": "^27.5.1",
"prettier": "^2.6.1",
"rollup": "^2.26.4",
"sass": "^1.33.0",
@@ -71,35 +73,35 @@
"stylelint-order": "^4.1.0"
},
"scripts": {
"build": "npm run clean && npm run build.css && stencil build --es5 --docs-json dist/docs.json",
"build.css": "npm run css.sass && npm run css.minify",
"build.debug": "npm run clean && stencil build --debug",
"build": "pnpm run clean && pnpm run build.css && stencil build --es5 --docs-json dist/docs.json",
"build.css": "pnpm run css.sass && pnpm run css.minify",
"build.debug": "pnpm run clean && stencil build --debug",
"build.docs.json": "stencil build --docs-json dist/docs.json",
"clean": "node scripts/clean.js",
"css.minify": "cleancss -O2 -o ./css/ionic.bundle.css ./css/ionic.bundle.css",
"css.sass": "sass --embed-sources src/css:./css",
"eslint": "eslint src",
"lint": "npm run lint.ts && npm run lint.sass && npm run prettier -- --write --cache",
"lint.fix": "npm run lint.ts.fix && npm run lint.sass.fix && npm run prettier -- --write --cache",
"lint": "pnpm run lint.ts && pnpm run lint.sass && pnpm run prettier --write --cache",
"lint.fix": "pnpm run lint.ts.fix && pnpm run lint.sass.fix && pnpm run prettier --write --cache",
"lint.sass": "stylelint \"src/**/*.scss\"",
"lint.sass.fix": "npm run lint.sass -- --fix",
"lint.ts": "npm run eslint",
"lint.ts.fix": "npm run eslint -- --fix",
"lint.sass.fix": "pnpm run lint.sass --fix",
"lint.ts": "pnpm run eslint",
"lint.ts.fix": "pnpm run eslint --fix",
"prerender.e2e": "node scripts/testing/prerender.js",
"prettier": "prettier \"./src/**/*.{html,ts,tsx,js,jsx}\"",
"start": "npm run build.css && stencil build --dev --watch --serve",
"test": "npm run test.spec && npm run test.e2e",
"start": "pnpm run build.css && stencil build --dev --watch --serve",
"test": "pnpm run test.spec && pnpm run test.e2e",
"test.spec": "stencil test --spec --max-workers=2",
"test.e2e": "npx playwright test",
"test.e2e.update-snapshots": "npm run test.e2e -- --update-snapshots",
"test.e2e": "pnpm exec playwright test",
"test.e2e.update-snapshots": "pnpm run test.e2e --update-snapshots",
"test.watch": "jest --watch --no-cache",
"test.treeshake": "node scripts/treeshaking.js dist/index.js",
"validate": "npm run lint && npm run test && npm run build && npm run test.treeshake",
"validate": "pnpm run lint && pnpm run test && pnpm run build && pnpm run test.treeshake",
"docker.build": "docker build -t ionic-playwright .",
"test.e2e.docker": "npm run docker.build && docker run -it --rm -e DISPLAY=$(cat docker-display.txt) -v $(cat docker-display-volume.txt) --ipc=host --mount=type=bind,source=./,target=/ionic ionic-playwright npm run test.e2e --",
"test.e2e.docker.update-snapshots": "npm run test.e2e.docker -- --update-snapshots",
"test.e2e.docker.ci": "npm run docker.build && docker run -e CI='true' --rm --ipc=host --mount=type=bind,source=./,target=/ionic ionic-playwright npm run test.e2e --",
"test.report": "npx playwright show-report"
"test.e2e.docker": "pnpm run docker.build && docker run -it --rm -e DISPLAY=$(cat docker-display.txt) -v $(cat docker-display-volume.txt) --ipc=host --mount=type=bind,source=./,target=/ionic ionic-playwright pnpm run test.e2e --",
"test.e2e.docker.update-snapshots": "pnpm run test.e2e.docker -- --update-snapshots",
"test.e2e.docker.ci": "pnpm run docker.build && docker run -e CI='true' --rm --ipc=host --mount=type=bind,source=./,target=/ionic ionic-playwright pnpm run test.e2e --",
"test.report": "pnpm exec playwright show-report"
},
"author": "Ionic Team",
"license": "MIT",

13850
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

View File

@@ -7,5 +7,9 @@
},
"engines": {
"node": ">= 16"
},
"scripts": {
"preinstall": "npx only-allow pnpm",
"build": "echo noop"
}
}

View File

File diff suppressed because it is too large Load Diff

View File

@@ -26,11 +26,11 @@
"scripts": {
"test": "echo 'angular no tests yet'",
"build": "ng-packagr -p ng-package.json -c tsconfig.json",
"build.prod": "npm run clean && npm run build",
"build.watch": "npm run build -- --watch",
"build.prod": "pnpm run clean && pnpm run build",
"build.watch": "pnpm run build --watch",
"clean": "rm -rf ./dist",
"lint": "eslint . --ext .ts && npm run prettier",
"lint.fix": "eslint . --ext .ts --fix && npm run prettier.fix",
"lint": "eslint . --ext .ts && pnpm run prettier",
"lint.fix": "eslint . --ext .ts --fix && pnpm run prettier.fix",
"prettier": "prettier \"**/*.ts\" --check",
"prettier.fix": "prettier \"**/*.ts\" --write"
},

View File

@@ -1,6 +1,6 @@
{
"root": true,
"ignorePatterns": ["test/**/*"],
"ignorePatterns": ["test/**/*", "src/schematics/**/*"],
"overrides": [
{
"files": ["*.ts"],

View File

@@ -21,7 +21,7 @@ Ionic Angular specific building blocks on top of [@ionic/core](https://www.npmjs
## Testing ng-add in ionic
1. Pull the latest from `main`
2. Build ionic/angular: `npm run build`
2. Build ionic/angular: `pnpm build`
3. Run `npm link` from `ionic/angular/dist` directory
4. Create a blank angular project
@@ -72,3 +72,35 @@ Ionic developers can access this by importing from `@ionic/angular/standalone`.
This is where the lazy loaded component implementations live.
Ionic developers can access this by importing from `@ionic/angular`.
## Building
1. Install dependencies in `@ionic/core`:
```shell
cd core && pnpm install
```
2. Build `@ionic/core`. This will generate Angular component bindings in the `packages/angular` directory:
```shell
pnpm build
```
> [!WARNING]
> If you are receiving errors about missing packages, you may need to run `pnpm install --force` to force the installation of the missing packages.
3. Install dependencies in `@ionic/angular`:
```shell
cd packages/angular && pnpm install
```
4. Build `@ionic/angular`:
```shell
pnpm build
```
> [!WARNING]
> If you are receiving errors about missing packages, you may need to run `pnpm install --force` to force the installation of the missing packages.

View File

File diff suppressed because it is too large Load Diff

View File

@@ -24,22 +24,21 @@
},
"homepage": "https://ionicframework.com/",
"scripts": {
"build": "npm run clean && npm run build.ng && npm run build.core && npm run clean-generated",
"build": "pnpm run clean && pnpm run build.ng && pnpm run build.core && pnpm run clean-generated",
"build.core": "node scripts/build-core.js",
"build.ng": "ng-packagr -p ng-package.json -c tsconfig.json",
"build.watch": "npm run build.ng -- --watch",
"build.watch": "pnpm build.core && pnpm build.ng --watch",
"clean": "node scripts/clean.js",
"clean-generated": "node ./scripts/clean-generated.js",
"lint": "npm run eslint && npm run prettier -- --write --cache",
"lint.fix": "npm run eslint -- --fix",
"fmt": "npm run eslint -- --fix && npm run prettier -- --write --cache",
"lint": "pnpm run eslint && pnpm run prettier --write --cache",
"lint.fix": "pnpm run eslint --fix",
"fmt": "pnpm run eslint --fix && pnpm run prettier --write --cache",
"prettier": "prettier \"**/*.ts\"",
"eslint": "eslint . --ext .ts",
"prerelease": "npm run validate && np prerelease --yolo --any-branch --tag next",
"sync": "./scripts/sync.sh",
"prerelease": "pnpm run validate && np prerelease --yolo --any-branch --tag next",
"test": "echo 'angular no tests yet'",
"tsc": "tsc -p .",
"validate": "npm i && npm run lint && npm run test && npm run build"
"validate": "pnpm i && pnpm run lint && pnpm run test && pnpm run build"
},
"exports": {
"./css/*": {
@@ -65,15 +64,15 @@
"@angular-eslint/eslint-plugin": "^14.0.0",
"@angular-eslint/eslint-plugin-template": "^14.0.0",
"@angular-eslint/template-parser": "^14.0.0",
"@angular/cli": "^14.0.0",
"@angular/common": "^14.0.0",
"@angular/compiler": "^14.0.0",
"@angular/compiler-cli": "^14.0.0",
"@angular/core": "^14.0.0",
"@angular/forms": "^14.0.0",
"@angular/platform-browser": "^14.0.0",
"@angular/platform-browser-dynamic": "^14.0.0",
"@angular/router": "^14.0.0",
"@angular/cli": "^17.0.7",
"@angular/common": "^14.3.0",
"@angular/compiler": "^14.3.0",
"@angular/compiler-cli": "^14.3.0",
"@angular/core": "^14.3.0",
"@angular/forms": "^14.3.0",
"@angular/platform-browser": "^14.3.0",
"@angular/platform-browser-dynamic": "^14.3.0",
"@angular/router": "^14.3.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "^2.0.0",
"@schematics/angular": "^17.0.0",
@@ -83,6 +82,7 @@
"eslint": "^8.0.0",
"eslint-plugin-import": "^2.25.2",
"fs-extra": "^7.0.0",
"glob": "^10.3.10",
"ng-packagr": "^14.0.0",
"prettier": "^2.4.1",
"rxjs": "~7.5.0",

View File

@@ -4,6 +4,12 @@ const spawn = require('child_process').spawn;
const typescriptPath = path.join(__dirname, '..', 'node_modules', '.bin');
/**
* Copy the CSS from the core package to the angular package.
*
* This allows developers to import the global stylesheets
* from the @ionic/angular package instead of @ionic/core.
*/
function copyCSS() {
const src = path.join(__dirname, '..', '..', '..', 'core', 'css');
const dst = path.join(__dirname, '..','dist', 'css');

View File

@@ -10,7 +10,7 @@ const distGeneratedNodeModules = path.join(distDir, 'node_modules');
function doGlob(globString) {
return new Promise((resolve, reject) => {
glob(globString, (err, matches) => {
glob.glob(globString, (err, matches) => {
if (err) {
return reject(err);
}

View File

@@ -1,12 +0,0 @@
#!/bin/bash
set -e
# Delete old packages
rm -f *.tgz
# Pack @ionic/core
npm pack ../../core
# Install Dependencies
npm install *.tgz --no-save

View File

@@ -1,21 +0,0 @@
// Re-exports from ionic/core
// UTILS
export { IonicSafeString, getPlatforms, isPlatform, createAnimation } from '@ionic/core';
// CORE TYPES
export {
Animation,
AnimationBuilder,
AnimationCallbackOptions,
AnimationDirection,
AnimationFill,
AnimationKeyFrames,
AnimationLifecycle,
Gesture,
GestureConfig,
GestureDetail,
mdTransitionAnimation,
iosTransitionAnimation,
NavComponentWithProps,
} from '@ionic/core';

View File

@@ -6,19 +6,16 @@ Ionic Framework supports multiple versions of Angular. As a result, we need to v
The Angular test app supports syncing your locally built changes for validation.
1. Build the `core` and `packages/angular` directories using `npm run build`.
2. [Build the Angular test app](#test-app-build-structure).
3. Navigate to the built test app directory (e.g. `packages/angular/test/build/ng14`).
4. Install dependencies using `npm install`.
5. Sync your local changes using `npm run sync`.
1. [Build](../README.md#building) the `core` and `packages/angular` projects using `pnpm build`.
2. Watch for changes made in `packages/angular` by using `pnpm build.watch`.
3. [Build the Angular test app](#test-app-build-structure).
4. Navigate to the built test app directory (e.g. `packages/angular/test/build/ng17`).
5. Install dependencies using `pnpm install`.
From here you can either build the application or start a local dev server. When re-syncing changes, you will need to [wipe or disable the application cache](#application-cache).
From here you can either build the application or start a local dev server.
## Application Cache
Angular CLI creates a cache of several files on disk by default in the `.angular` directory. This decreases the time taken to build the test application. However, the cache makes it difficult to quickly sync and check local changes of Ionic. As a result, the `.angular` cache is disabled by default in the test app projects.
See https://angular.io/cli/cache for more information.
> [!NOTE]
> Making changes to the `test` app will require you to rebuild the app and restart the dev server.
### Disable Cache
@@ -56,8 +53,8 @@ Unlike other test applications, these test apps are broken up into multiple dire
Usage:
```shell
# Build a test app using apps/ng14 as a reference
./build.sh ng14
# Build a test app using apps/ng17 as a reference
./build.sh ng17
```
## How to modify test apps

View File

File diff suppressed because it is too large Load Diff

View File

@@ -6,7 +6,6 @@
"ng": "ng",
"start": "ng serve",
"sync:build": "sh scripts/build-ionic.sh",
"sync": "sh scripts/sync.sh",
"build": "ng build --configuration production --no-progress",
"lint": "ng lint",
"postinstall": "ngcc",
@@ -16,8 +15,8 @@
"prerender": "ng run test-app:prerender",
"cy.open": "cypress open",
"cy.run": "cypress run",
"test": "concurrently \"npm run start -- --configuration production\" \"wait-on http-get://localhost:4200 && npm run cy.run\" --kill-others --success first",
"test.watch": "concurrently \"npm run start\" \"wait-on http-get://localhost:4200 && npm run cy.open\" --kill-others --success first"
"test": "concurrently \"pnpm run start --configuration production\" \"wait-on http-get://localhost:4200 && pnpm run cy.run\" --kill-others --success first",
"test.watch": "concurrently \"pnpm run start\" \"wait-on http-get://localhost:4200 && pnpm run cy.open\" --kill-others --success first"
},
"dependencies": {
"@angular/animations": "^14.1.0",
@@ -29,8 +28,8 @@
"@angular/platform-browser-dynamic": "^14.1.0",
"@angular/platform-server": "^14.1.0",
"@angular/router": "^14.1.0",
"@ionic/angular": "^6.1.15",
"@ionic/angular-server": "^6.1.15",
"@ionic/angular": "file:../../../dist",
"@ionic/angular-server": "file:../../../../angular-server/dist",
"core-js": "^2.6.11",
"express": "^4.15.2",
"ionicons": "^7.2.0",

View File

File diff suppressed because it is too large Load Diff

View File

View File

File diff suppressed because it is too large Load Diff

View File

@@ -6,7 +6,6 @@
"ng": "ng",
"start": "ng serve",
"sync:build": "sh scripts/build-ionic.sh",
"sync": "sh scripts/sync.sh",
"build": "ng build --configuration production --no-progress",
"lint": "ng lint",
"postinstall": "ngcc",
@@ -16,8 +15,8 @@
"prerender": "ng run test-app:prerender",
"cy.open": "cypress open",
"cy.run": "cypress run",
"test": "concurrently \"npm run start -- --configuration production\" \"wait-on http-get://localhost:4200 && npm run cy.run\" --kill-others --success first",
"test.watch": "concurrently \"npm run start\" \"wait-on http-get://localhost:4200 && npm run cy.open\" --kill-others --success first"
"test": "concurrently \"pnpm run start --configuration production\" \"wait-on http-get://localhost:4200 && pnpm run cy.run\" --kill-others --success first",
"test.watch": "concurrently \"pnpm run start\" \"wait-on http-get://localhost:4200 && pnpm run cy.open\" --kill-others --success first"
},
"dependencies": {
"@angular/animations": "^15.0.0",
@@ -29,8 +28,8 @@
"@angular/platform-browser-dynamic": "^15.0.0",
"@angular/platform-server": "^15.0.0",
"@angular/router": "^15.0.0",
"@ionic/angular": "^6.1.15",
"@ionic/angular-server": "^6.1.15",
"@ionic/angular": "file:../../../dist",
"@ionic/angular-server": "file:../../../../angular-server/dist",
"@nguniversal/express-engine": "^15.0.0",
"core-js": "^2.6.11",
"express": "^4.15.2",

View File

File diff suppressed because it is too large Load Diff

View File

View File

File diff suppressed because it is too large Load Diff

View File

@@ -6,7 +6,6 @@
"ng": "ng",
"start": "ng serve",
"sync:build": "sh scripts/build-ionic.sh",
"sync": "sh scripts/sync.sh",
"build": "ng build --configuration production --no-progress",
"lint": "ng lint",
"serve:ssr": "node dist/test-app/server/main.js",
@@ -15,8 +14,8 @@
"prerender": "ng run test-app:prerender",
"cy.open": "cypress open",
"cy.run": "cypress run",
"test": "concurrently \"npm run start -- --configuration production\" \"wait-on http-get://localhost:4200 && npm run cy.run\" --kill-others --success first",
"test.watch": "concurrently \"npm run start\" \"wait-on http-get://localhost:4200 && npm run cy.open\" --kill-others --success first"
"test": "concurrently \"pnpm run start --configuration production\" \"wait-on http-get://localhost:4200 && pnpm run cy.run\" --kill-others --success first",
"test.watch": "concurrently \"pnpm run start\" \"wait-on http-get://localhost:4200 && pnpm run cy.open\" --kill-others --success first"
},
"dependencies": {
"@angular/animations": "^16.0.0",
@@ -28,8 +27,8 @@
"@angular/platform-browser-dynamic": "^16.0.0",
"@angular/platform-server": "^16.0.0",
"@angular/router": "^16.0.0",
"@ionic/angular": "^7.0.0",
"@ionic/angular-server": "^7.0.0",
"@ionic/angular": "file:../../../dist",
"@ionic/angular-server": "file:../../../../angular-server/dist",
"@nguniversal/express-engine": "^16.0.0",
"core-js": "^2.6.11",
"express": "^4.15.2",

View File

File diff suppressed because it is too large Load Diff

View File

View File

File diff suppressed because it is too large Load Diff

View File

@@ -6,7 +6,6 @@
"ng": "ng",
"start": "ng serve",
"sync:build": "sh scripts/build-ionic.sh",
"sync": "sh scripts/sync.sh",
"build": "ng build --configuration production --no-progress",
"lint": "ng lint",
"serve:ssr": "node dist/test-app/server/main.js",
@@ -15,8 +14,8 @@
"prerender": "ng run test-app:prerender",
"cy.open": "cypress open",
"cy.run": "cypress run",
"test": "concurrently \"npm run start -- --configuration production\" \"wait-on http-get://localhost:4200 && npm run cy.run\" --kill-others --success first",
"test.watch": "concurrently \"npm run start\" \"wait-on http-get://localhost:4200 && npm run cy.open\" --kill-others --success first"
"test": "concurrently \"pnpm run start --configuration production\" \"wait-on http-get://localhost:4200 && pnpm run cy.run\" --kill-others --success first",
"test.watch": "concurrently \"pnpm run start\" \"wait-on http-get://localhost:4200 && pnpm run cy.open\" --kill-others --success first"
},
"dependencies": {
"@angular/animations": "^17.0.2",
@@ -29,8 +28,8 @@
"@angular/platform-server": "^17.0.2",
"@angular/router": "^17.0.2",
"@angular/ssr": "^17.0.0",
"@ionic/angular": "^7.0.0",
"@ionic/angular-server": "^7.0.0",
"@ionic/angular": "file:../../../dist",
"@ionic/angular-server": "file:../../../../angular-server/dist",
"core-js": "^3.33.2",
"express": "^4.15.2",
"ionicons": "^7.2.0",

View File

File diff suppressed because it is too large Load Diff

View File

View File

@@ -38,4 +38,12 @@ cp -R $FULL_BASE_DIR $BUILD_APP_DIR
# will override any files in the base application.
cp -R $FULL_APP_DIR $BUILD_APP_DIR
echo "Copied test app files for ${APP_DIR}"
GREEN='\033[0;32m'
NC='\033[0m' # No Color
# Print a message with instructions for developers.
echo -e "\n${GREEN}Successfully generated test app at: $BUILD_APP_DIR \n${NC}"
echo -e "Please follow these steps:"
echo -e " 1. cd $BUILD_APP_DIR"
echo -e " 2. Install dependencies with: pnpm install"
echo -e " 3. Run the dev server with: pnpm start\n"

View File

@@ -1,2 +1,50 @@
## @ionic/react-router (beta)
## @ionic/react-router
Routing integration for `@ionic/react` applications.
## Building
1. Install dependencies in `@ionic/core`:
```shell
cd core && pnpm install
```
2. Build `@ionic/core`. This will generate React component bindings in the `packages/react` directory:
```shell
pnpm build
```
> [!WARNING]
> If you are receiving errors about missing packages, you may need to run `pnpm install --force` to force the installation of the missing packages.
3. Install dependencies in `@ionic/react`:
```shell
cd packages/react && pnpm install
```
4. Build `@ionic/react`:
```shell
pnpm build
```
> [!WARNING]
> If you are receiving errors about missing packages, you may need to run `pnpm install --force` to force the installation of the missing packages.
5. Install dependencies in `@ionic/react-router`:
```shell
cd packages/react-router && pnpm install
```
6. Build `@ionic/react-router`:
```shell
pnpm build
```
> [!WARNING]
> If you are receiving errors about missing packages, you may need to run `pnpm install --force` to force the installation of the missing packages.

View File

File diff suppressed because it is too large Load Diff

View File

@@ -20,15 +20,14 @@
"url": "git+https://github.com/ionic-team/ionic-framework.git"
},
"scripts": {
"build": "npm run clean && npm run compile",
"build.watch": "npm run compile -- --watch",
"build": "pnpm run clean && pnpm run compile",
"build.watch": "pnpm run compile --watch",
"clean": "rimraf dist",
"compile": "rollup -c",
"eslint": "eslint src",
"prettier": "prettier \"./src/**/*.{html,ts,tsx,js,jsx}\"",
"lint": "npm run eslint && npm run prettier -- --write --cache",
"lint.fix": "npm run eslint -- --fix && npm run prettier -- --write --cache",
"sync": "sh ./scripts/sync.sh"
"lint": "pnpm run eslint && pnpm run prettier --write --cache",
"lint.fix": "pnpm run eslint --fix && pnpm run prettier --write --cache"
},
"main": "dist/index.js",
"types": "dist/types/index.d.ts",
@@ -37,6 +36,7 @@
],
"dependencies": {
"@ionic/react": "^7.8.2",
"history": "^4.9.0",
"tslib": "*"
},
"peerDependencies": {
@@ -49,6 +49,7 @@
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "^2.0.0",
"@rollup/plugin-typescript": "^11.1.5",
"@types/history": "4",
"@types/node": "^14.0.14",
"@types/react": "^17.0.79",
"@types/react-dom": "^17.0.25",

View File

@@ -1,15 +0,0 @@
#!/bin/bash
set -e
# Copy ionic react dist
rm -rf node_modules/@ionic/react/dist node_modules/@ionic/react/css
cp -a ../react/dist node_modules/@ionic/react/dist
cp -a ../react/css node_modules/@ionic/react/css
cp -a ../react/package.json node_modules/@ionic/react/package.json
# Copy core dist
rm -rf node_modules/@ionic/core/dist node_modules/@ionic/core/components
cp -a ../../core/dist node_modules/@ionic/core/dist
cp -a ../../core/components node_modules/@ionic/core/components
cp -a ../../core/package.json node_modules/@ionic/core/package.json

View File

@@ -6,13 +6,17 @@ Ionic Framework supports multiple versions of React Router. As a result, we need
The React test app supports syncing your locally built changes for validation.
1. Build the `@ionic/core`, `@ionic/react`, and `@ionic/react-router` projects using `npm run build`.
2. [Build the React test app](#test-app-build-structure).
3. Navigate to the built test app.
4. Install dependencies using `npm install`.
5. Sync your local changes using `npm run sync`.
1. [Build](../../README.md#building) the `core`, `packages/react`, and `packages/react-router` projects using `pnpm build`.
2. Watch for changes made in `packages/react-router` by using `pnpm build.watch`.
3. [Build the React test app](#test-app-build-structure).
4. Navigate to the built test app.
5. Install dependencies using `pnpm install`.
From here you can either build the application or start a local dev server.
> [!NOTE]
> Making changes to the `test` app will require you to rebuild the app and restart the dev server.
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.
## Test App Build Structure

View File

File diff suppressed because it is too large Load Diff

View File

@@ -3,15 +3,18 @@
"version": "0.0.1",
"private": true,
"dependencies": {
"@ionic/react": "^6.6.1",
"@ionic/react-router": "^6.6.1",
"@ionic/react": "workspace:*",
"@ionic/react-router": "workspace:*",
"@testing-library/jest-dom": "^5.16.5",
"@testing-library/react": "^14.0.0",
"@testing-library/user-event": "^14.4.3",
"@types/react": "^18.0.28",
"@types/react-dom": "^18.0.11",
"@types/history": "4",
"@types/jest": "^27.5.2",
"@types/react": "^18.2.0",
"@types/react-dom": "^18.2.0",
"@types/react-router": "^5.1.20",
"@types/react-router-dom": "^5.3.3",
"history": "^4.9.0",
"ionicons": "^6.0.4",
"react": "^18.2.0",
"react-dom": "^18.2.0",
@@ -28,8 +31,7 @@
"test": "cypress open",
"cypress": "node_modules/.bin/cypress run --headless --browser chrome",
"cypress.open": "cypress open",
"e2e": "concurrently \"serve -s build -l 3000\" \"wait-on http-get://localhost:3000 && npm run cypress\" --kill-others --success first",
"sync": "sh ./scripts/sync.sh"
"e2e": "concurrently \"serve -s build -l 3000\" \"wait-on http-get://localhost:3000 && pnpm run cypress\" --kill-others --success first"
},
"eslintConfig": {
"extends": [
@@ -59,5 +61,9 @@
"description": "An Ionic project",
"engines": {
"node": ">= 16"
},
"resolutions": {
"@types/react": "^18.0.27",
"react": "^18.2.0"
}
}

View File

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,3 @@
packages:
- ../../../../react
- ../../../

View File

@@ -1,18 +0,0 @@
#!/bin/bash
set -e
# Delete old packages
rm -f *.tgz
# Pack @ionic/core
npm pack ../../../../../core
# Pack @ionic/react
npm pack ../../../../react
# Pack @ionic/react-router
npm pack ../../../
# Install Dependencies
npm install *.tgz --no-save

View File

@@ -4,6 +4,53 @@ These are React specific building blocks on top of [@ionic/core](https://www.npm
To get started, install the Ionic CLI by running `npm i -g @ionic/cli`. Then, start a new Ionic React Project by running `ionic start myapp --type=react`.
## Building
1. Install dependencies in `@ionic/core`:
```shell
cd core && pnpm install
```
2. Build `@ionic/core`. This will generate React component bindings in the `packages/react` directory:
```shell
pnpm build
```
> [!WARNING]
> If you are receiving errors about missing packages, you may need to run `pnpm install --force` to force the installation of the missing packages.
3. Install dependencies in `@ionic/react`:
```shell
cd packages/react && pnpm install
```
4. Build `@ionic/react`:
```shell
pnpm build
```
> [!WARNING]
> If you are receiving errors about missing packages, you may need to run `pnpm install --force` to force the installation of the missing packages.
5. Install dependencies in `@ionic/react-router`:
```shell
cd packages/react-router && pnpm install
```
6. Build `@ionic/react-router`:
```shell
pnpm build
```
> [!WARNING]
> If you are receiving errors about missing packages, you may need to run `pnpm install --force` to force the installation of the missing packages.
## Publishing a Native Application
You can now make use of all of the ionic components in your React application.

View File

File diff suppressed because it is too large Load Diff

View File

@@ -20,17 +20,16 @@
"url": "git+https://github.com/ionic-team/ionic-framework.git"
},
"scripts": {
"build": "npm run clean && npm run copy && npm run compile",
"build.watch": "npm run compile -- --watch",
"build": "pnpm run clean && pnpm run copy && pnpm run compile",
"build.watch": "pnpm copy && pnpm compile --watch",
"clean": "rimraf dist && rimraf routing",
"compile": "rollup -c",
"eslint": "eslint src",
"prettier": "prettier \"./src/**/*.{html,ts,tsx,js,jsx}\"",
"lint": "npm run eslint && npm run prettier -- --write --cache",
"lint.fix": "npm run eslint -- --fix && npm run prettier -- --write --cache",
"lint": "pnpm run eslint && pnpm run prettier --write --cache",
"lint.fix": "pnpm run eslint --fix && pnpm run prettier --write --cache",
"copy": "node scripts/copy.js",
"test.spec": "jest --ci",
"sync": "sh ./scripts/sync.sh"
"test.spec": "jest --ci"
},
"main": "dist/index.js",
"types": "dist/types/index.d.ts",
@@ -51,7 +50,7 @@
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "^2.0.0",
"@rollup/plugin-typescript": "^11.1.5",
"@testing-library/jest-dom": "^5.11.6",
"@testing-library/jest-dom": "^6.1.5",
"@testing-library/react": "^12.1.5",
"@testing-library/react-hooks": "^7.0.1",
"@types/jest": "^26.0.15",
@@ -63,6 +62,7 @@
"eslint": "^7.32.0",
"fs-extra": "^9.0.1",
"jest": "^26.6.3",
"jest-environment-jsdom": "^26.6.0",
"np": "^6.4.0",
"prettier": "^2.8.3",
"react": "^17.0.2",

View File

@@ -1,6 +1,11 @@
const fs = require('fs-extra');
const path = require('path');
/**
* Copy the CSS from the core package to the react package.
*
* This allows developers to import the global stylesheets
* from the @ionic/react package instead of @ionic/core.
*/
function copyCSS() {
const src = path.join(__dirname, '..', '..', '..', 'core', 'css');
const dst = path.join(__dirname, '..', 'css');

View File

@@ -1,12 +0,0 @@
#!/bin/bash
set -e
# Delete old packages
rm -f *.tgz
# Pack @ionic/core
npm pack ../../core
# Install Dependencies
npm install *.tgz --no-save

View File

@@ -1,5 +1,5 @@
import * as utils from '../react-component-lib/utils';
import '@testing-library/jest-dom/extend-expect';
import '@testing-library/jest-dom';
describe('isCoveredByReact', () => {
it('should identify standard events as covered by React', () => {

View File

@@ -6,13 +6,16 @@ Ionic Framework supports multiple versions of React. As a result, we need to ver
The React test app supports syncing your locally built changes for validation.
1. Build the `core`, `packages/react`, and `packages/react-router` directories using `npm run build`.
2. [Build the React test app](#test-app-build-structure).
3. Navigate to the built test app.
4. Install dependencies using `npm install`.
5. Sync your local changes using `npm run sync`.
1. [Build](../README.md#building) the `core`, `packages/react`, and `packages/react-router` projects using `pnpm build`.
2. Watch for changes made in `packages/react` by using `pnpm build.watch`.
3. [Build the React test app](#test-app-build-structure).
4. Navigate to the built test app.
5. Install dependencies using `pnpm install`.
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.
From here you can either build the application or start a local dev server.
> [!NOTE]
> Making changes to the `test` app will require you to rebuild the app and restart the dev server.
## Test App Build Structure

View File

File diff suppressed because it is too large Load Diff

View File

@@ -3,8 +3,8 @@
"version": "0.0.1",
"private": true,
"dependencies": {
"@ionic/react": "^6.6.1",
"@ionic/react-router": "^6.6.1",
"@ionic/react": "workspace:*",
"@ionic/react-router": "workspace:*",
"@types/react": "^17.0.53",
"@types/react-dom": "^17.0.19",
"@types/react-router": "^5.1.20",
@@ -22,10 +22,9 @@
"build": "react-scripts build",
"test": "react-scripts test --env=jsdom --transformIgnorePatterns 'node_modules/(?!(@ionic/react|@ionic/react-router|@ionic/core|@stencil/core|ionicons)/)'",
"eject": "react-scripts eject",
"sync": "sh ./scripts/sync.sh",
"cypress": "cypress run --headless --browser chrome",
"cypress.open": "cypress open",
"e2e": "concurrently \"serve -s build -l 3000\" \"wait-on http-get://localhost:3000 && npm run cypress\" --kill-others --success first"
"e2e": "concurrently \"serve -s build -l 3000\" \"wait-on http-get://localhost:3000 && pnpm run cypress\" --kill-others --success first"
},
"eslintConfig": {
"extends": [
@@ -60,5 +59,9 @@
"description": "An Ionic project",
"engines": {
"node": ">= 16"
},
"resolutions": {
"@types/react": "^17.0.53",
"react": "^17.0.2"
}
}

View File

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,3 @@
packages:
- ../../../
- ../../../../react-router

View File

File diff suppressed because it is too large Load Diff

View File

@@ -3,8 +3,9 @@
"version": "0.0.1",
"private": true,
"dependencies": {
"@ionic/react": "^7.0.0",
"@ionic/react-router": "^7.0.0",
"@ionic/react": "workspace:*",
"@ionic/react-router": "workspace:*",
"@types/jest": "27.5.2",
"ionicons": "^7.0.0",
"react": "^18.2.0",
"react-dom": "^18.2.0",
@@ -16,10 +17,9 @@
"start": "vite",
"build": "tsc && vite build",
"test": "vitest",
"sync": "sh ./scripts/sync.sh",
"cypress": "cypress run --headless --browser chrome",
"cypress.open": "cypress open",
"e2e": "concurrently \"serve -s dist -l 3000\" \"wait-on http-get://localhost:3000 && npm run cypress\" --kill-others --success first"
"e2e": "concurrently \"serve -s dist -l 3000\" \"wait-on http-get://localhost:3000 && pnpm run cypress\" --kill-others --success first"
},
"devDependencies": {
"@testing-library/jest-dom": "^5.16.5",
@@ -29,21 +29,25 @@
"@types/react-dom": "^18.0.10",
"@types/react-router": "^5.1.20",
"@types/react-router-dom": "^5.3.3",
"@vitejs/plugin-legacy": "^4.0.2",
"@vitejs/plugin-legacy": "^5.0.0",
"@vitejs/plugin-react": "^4.0.1",
"concurrently": "^6.3.0",
"cypress": "^13.2.0",
"serve": "^14.0.1",
"wait-on": "^6.0.0",
"eslint": "^8.35.0",
"eslint-plugin-react": "^7.32.2",
"jsdom": "^22.1.0",
"serve": "^14.0.1",
"typescript": "^5.1.6",
"vite": "^4.3.9",
"vitest": "^0.32.2"
"vite": "^5.0.0",
"vitest": "^0.32.2",
"wait-on": "^6.0.0"
},
"description": "An Ionic project",
"engines": {
"node": ">= 16"
},
"resolutions": {
"@types/react": "^18.0.27",
"react": "^18.2.0"
}
}

View File

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,3 @@
packages:
- ../../../
- ../../../../react-router

View File

@@ -15,5 +15,13 @@ export default defineConfig({
},
server: {
port: 3000
},
optimizeDeps: {
exclude: ['@ionic/react', '@ionic/react-router'],
/**
* ESM dependencies that have a CJS dependency need to
* include that dependency for optimization.
*/
include: ['@ionic/react > react-dom']
}
})

View File

@@ -37,3 +37,13 @@ cp -R $FULL_BASE_DIR $BUILD_APP_DIR
# Then we can copy the specific app which
# will override any files in the base application.
cp -R $FULL_APP_DIR $BUILD_APP_DIR
GREEN='\033[0;32m'
NC='\033[0m' # No Color
# Print a message with instructions for developers.
echo -e "\n${GREEN}Successfully generated test app at: $BUILD_APP_DIR \n${NC}"
echo -e "Please follow these steps:"
echo -e " 1. cd $BUILD_APP_DIR"
echo -e " 2. Install dependencies with: pnpm install"
echo -e " 3. Run the dev server with: pnpm dev\n"

View File

@@ -4,22 +4,55 @@ Routing integration for `@ionic/vue` applications.
## Building
1. Install dependencies:
1. Install dependencies in `@ionic/core`:
```shell
npm install
cd core && pnpm install
```
2. Run build script:
2. Build `@ionic/core`. This will generate Vue component bindings in the `packages/vue` directory:
```shell
npm run build
pnpm build
````
> [!WARNING]
> If you are receiving errors about missing packages, you may need to run `pnpm install --force` to force the installation of the missing packages.
3. Install dependencies in `@ionic/vue`:
```shell
cd packages/vue && pnpm install
```
4. Build `@ionic/vue`:
```shell
pnpm build
````
> [!WARNING]
> If you are receiving errors about missing packages, you may need to run `pnpm install --force` to force the installation of the missing packages.
5. Install dependencies in `@ionic/vue-router`:
```shell
cd packages/vue-router && pnpm install
```
6. Build `@ionic/vue-router`:
```shell
pnpm build
````
> [!WARNING]
> If you are receiving errors about missing packages, you may need to run `pnpm install --force` to force the installation of the missing packages.
## Tests
* Tests are found in the `__tests__` directory and use Jest.
* Tests can be run using `npm run test.spec`
* Tests can be run using `pnpm test.spec`
* Bug fix and feature PRs should have new tests verifying the PR functionality.
## Contributing

View File

File diff suppressed because it is too large Load Diff

View File

@@ -6,13 +6,12 @@
"test.spec": "jest",
"eslint": "eslint src",
"prettier": "prettier \"./src/**/*.{html,ts,tsx,js,jsx}\"",
"lint": "npm run eslint && npm run prettier -- --write --cache",
"lint.fix": "npm run eslint -- --fix && npm run prettier -- --write --cache",
"lint": "pnpm run eslint && pnpm run prettier --write --cache",
"lint.fix": "pnpm run eslint --fix && pnpm run prettier --write --cache",
"bundle": "rollup --config rollup.config.mjs",
"build": "npm run clean && npm run bundle",
"build.watch": "npm run bundle -- --watch",
"clean": "rimraf dist",
"sync": "sh ./scripts/sync.sh"
"build": "pnpm run clean && pnpm run bundle",
"build.watch": "pnpm run bundle --watch",
"clean": "rimraf dist"
},
"main": "./dist/index.js",
"types": "./dist/types/index.d.ts",

View File

@@ -1,15 +0,0 @@
#!/bin/bash
set -e
# Delete old packages
rm -f *.tgz
# Pack @ionic/core
npm pack ../../core
# Pack @ionic/vue
npm pack ../vue
# Install Dependencies
npm install *.tgz --no-save

View File

@@ -7,43 +7,52 @@ Ionic Framework integration for Vue 3 apps.
1. Install dependencies in `@ionic/core`:
```shell
cd core && npm install
cd core && pnpm install
```
2. Build `@ionic/core`. This will generate Vue component bindings in the `packages/vue` directory:
```shell
npm run build
pnpm build
````
> [!WARNING]
> If you are receiving errors about missing packages, you may need to run `pnpm install --force` to force the installation of the missing packages.
3. Install dependencies in `@ionic/vue`:
```shell
cd packages/vue && npm install
cd packages/vue && pnpm install
```
4. Build `@ionic/vue`:
```shell
npm run build
pnpm build
````
> [!WARNING]
> If you are receiving errors about missing packages, you may need to run `pnpm install --force` to force the installation of the missing packages.
5. Install dependencies in `@ionic/vue-router`:
```shell
cd packages/vue-router && npm install
cd packages/vue-router && pnpm install
```
6. Build `@ionic/vue-router`:
```shell
npm run build
pnpm build
````
> [!WARNING]
> If you are receiving errors about missing packages, you may need to run `pnpm install --force` to force the installation of the missing packages.
## 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](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.
* When making changes to `@ionic/vue` or `@ionic/vue-router` you can run `pnpm build.watch` in their root directories to ensure that the test application is using your latest 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.

View File

File diff suppressed because it is too large Load Diff

View File

@@ -5,18 +5,17 @@
"scripts": {
"eslint": "eslint src",
"prettier": "prettier \"./src/**/*.{html,ts,tsx,js,jsx}\"",
"lint": "npm run eslint && npm run prettier -- --write --cache",
"lint.fix": "npm run eslint -- --fix && npm run prettier -- --write --cache",
"lint": "pnpm run eslint && pnpm run prettier --write --cache",
"lint.fix": "pnpm run eslint --fix && pnpm run prettier --write --cache",
"test": "jest",
"build": "npm run clean && npm run copy && npm run copy.overlays && npm run bundle && npm run build.vetur && npm run build.web-types",
"build.watch": "npm run bundle -- --watch",
"build": "pnpm run clean && pnpm run copy && pnpm run copy.overlays && pnpm run bundle && pnpm run build.vetur && pnpm run build.web-types",
"build.watch": "pnpm copy && pnpm bundle --watch",
"bundle": "rollup --config rollup.config.mjs",
"clean": "rimraf dist",
"build.web-types": "node ./scripts/build-web-types.js",
"build.vetur": "node ./scripts/build-vetur.js",
"copy": "node ./scripts/copy-css.js",
"copy.overlays": "node ./scripts/copy-overlays.js",
"sync": "sh ./scripts/sync.sh"
"copy.overlays": "node ./scripts/copy-overlays.js"
},
"main": "./dist/index.js",
"types": "./dist/types/index.d.ts",

View File

@@ -1,6 +1,12 @@
const fs = require('fs-extra');
const path = require('path');
/**
* Copy the CSS from the core package to the vue package.
*
* This allows developers to import the global stylesheets
* from the @ionic/vue package instead of @ionic/core.
*/
function copyCSS() {
const src = path.join(__dirname, '..', '..', '..', 'core', 'css');
const dst = path.join(__dirname, '..', 'css');

View File

@@ -1,15 +0,0 @@
#!/bin/bash
set -e
# Delete old packages
rm -f *.tgz
# Pack @ionic/core
npm pack ../../core
# Pack @ionic/vue-router
npm pack ../vue-router
# Install Dependencies
npm install *.tgz --no-save

View File

@@ -5,7 +5,8 @@ import type {
LIFECYCLE_WILL_LEAVE,
} from "@ionic/core/components";
declare module "@vue/runtime-core" {
// https://vuejs.org/guide/typescript/options-api.html#augmenting-custom-options
declare module "vue" {
export interface ComponentCustomOptions {
[LIFECYCLE_DID_ENTER]?: () => void;
[LIFECYCLE_DID_LEAVE]?: () => void;

View File

@@ -6,13 +6,16 @@ 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](../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 directory (e.g. `packages/vue/test/build/vue3`).
4. Install dependencies using `npm install`.
5. Sync your local changes using `npm run sync`.
1. [Build](../README.md#building) the `core`, `packages/vue`, and `packages/vue-router` projects using `pnpm build`.
2. Watch for changes made in `packages/vue` by using `pnpm build.watch`.
3. [Build the Vue test app](#test-app-build-structure).
4. Navigate to the built test app directory (e.g. `packages/vue/test/build/vue3`).
5. Install dependencies using `pnpm install`.
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.
From here you can either build the application or start a local dev server.
> [!NOTE]
> Making changes to the `test` app will require you to rebuild the app and restart the dev server.
## Test App Build Structure

View File

File diff suppressed because it is too large Load Diff

View File

@@ -8,16 +8,15 @@
"build": "vite build",
"serve": "vite preview",
"test:unit": "vitest",
"test:e2e": "concurrently \"npm run build && npm run serve\" \"wait-on http-get://localhost:8080 && npm run cypress\" --kill-others --success first",
"test:e2e": "concurrently \"pnpm run build && pnpm run serve\" \"wait-on http-get://localhost:8080 && pnpm run cypress\" --kill-others --success first",
"lint": "eslint --ext .js,.vue,.ts --ignore-path .gitignore --fix src",
"cypress": "node_modules/.bin/cypress run --headless --browser chrome",
"cypress.open": "cypress open",
"start": "npm run dev",
"sync": "sh ./scripts/sync.sh"
"start": "pnpm run dev"
},
"dependencies": {
"@ionic/vue": "^6.0.12",
"@ionic/vue-router": "^6.0.12",
"@ionic/vue": "file:../../../",
"@ionic/vue-router": "file:../../../../vue-router",
"ionicons": "^6.0.4",
"vue": "^3.4.14",
"vue-router": "^4.2.5"

3904
packages/vue/test/apps/vue3/pnpm-lock.yaml generated Normal file
View File

File diff suppressed because it is too large Load Diff

View File

View File

@@ -20,5 +20,8 @@ export default defineConfig({
// Preview applies to "vite preview" command
preview: {
port: 8080
},
optimizeDeps: {
exclude: ['@ionic/vue', '@ionic/vue-router']
}
})

View File

@@ -37,3 +37,13 @@ cp -R $FULL_BASE_DIR $BUILD_APP_DIR
# Then we can copy the specific app which
# will override any files in the base application.
cp -R $FULL_APP_DIR $BUILD_APP_DIR
GREEN='\033[0;32m'
NC='\033[0m' # No Color
# Print a message with instructions for developers.
echo -e "\n${GREEN}Successfully generated test app at: $BUILD_APP_DIR \n${NC}"
echo -e "Please follow these steps:"
echo -e " 1. cd $BUILD_APP_DIR"
echo -e " 2. Install dependencies with: pnpm install"
echo -e " 3. Run the dev server with: pnpm dev\n"

17453
pnpm-lock.yaml generated Normal file
View File

File diff suppressed because it is too large Load Diff

9
pnpm-workspace.yaml Normal file
View File

@@ -0,0 +1,9 @@
packages:
- 'core'
- 'docs'
- 'packages/angular'
- 'packages/angular-server'
- 'packages/vue'
- 'packages/vue-router'
- 'packages/react'
- 'packages/react-router'