This repository has been archived by the owner on Nov 8, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: one-shot TS upgrade for existing codebases (#48)
* feat: enhance upgrade algorithm with latest core integrations * docs(README): add some info and deprecation notice * feat(code-update): apply store and route helpers (#1) * feat(code-update): apply store and route helpers * refactor: solve TODOs * chore(linting): revert quasar eslint package usage
- Loading branch information
Showing
13 changed files
with
605 additions
and
369 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,44 @@ | ||
# quasar-app-extension-typescript [wip] | ||
# quasar-app-extension-typescript | ||
|
||
> ### WARNING | ||
> | ||
> This app extension is out of date with the Current version of Quasar app-v1.6.0 and will may not work as expected. This extension will be updated shortly. | ||
> An updated starter that support Typescript natively is currently being tested and should be integrated with the `Quasar create` command soon. If you would like to try it out now run the following command `quasar create <project name> --kit IlCallo/quasar-starter-kit --branch dev` | ||
> This extension will bring you in sync with Quasar + TS setup as of `[email protected]` and `@quasar/[email protected]` | ||
> | ||
> This extension is DEPRECATED and is only meant to ease the transition of pre-existing codebases. For new projects use starter-kit `TypeScript` option | ||
> | ||
> ESLint configuration will be overwritten, only Prettier flavour is supported out-of-the-box. | ||
> `airbnb` and `default` configuration should be manually merged using your previous `.eslintrc.js` or one generated when creating a new Quasar project. | ||
> | ||
> You need to remove this extension and `typescript` dependency after a successful installation: the extension will only do the migration and there's no point into keeping it after that, while `typescript` dependency is already provided by `@quasar/app` | ||
> | ||
> **This extension is one-shot and does not provide uninstall script, make sure you've some form of version control in place to perform rollbacks** | ||
Add TypeScript to your Quasar project (won't work for 0.x Quasar versions). | ||
|
||
For simpler cases, just running this extension will do the job. | ||
|
||
Add typescript to your Quasar 1.0 project | ||
For the majority of cases, many tweaks on your side will be needed to fix type or linting issues, take some time when trying the migration. | ||
|
||
visit https://hackmd.io/Ypx6VMWUQp6R1iPyCvRHWQ?edit to join the conversation | ||
If you don't trust a software to automatically update your code, you can manually update your project following the [official documentation](https://quasar.dev/quasar-cli/cli-documentation/supporting-ts#Installation-of-TypeScript-Support). | ||
|
||
## Installation | ||
|
||
Add the app extension to your project: | ||
|
||
```shell | ||
$ quasar ext add @quasar/typescript | ||
``` | ||
|
||
To test the various build types, cd into test-extension and: | ||
|
||
``` | ||
$ yarn | ||
$ quasar ext invoke @quasar/typescript | ||
``` | ||
|
||
## Fallback | ||
|
||
If you experience problems you cannot understand or resolve, copy your `src` folder (and any project specific configuration) into a freshly created project with `TypeScript` option enabled. | ||
Then proceed to manually update your files to use TypeScript. | ||
|
||
To create a new project, run `quasar create <your project name>` using the global Quasar CLI and enable the `TypeScript` option. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.