https://github.com/joaopalmeiro/create-vue-tsconfigs
TSConfig files for projects created with create-vue.
https://github.com/joaopalmeiro/create-vue-tsconfigs
Last synced: about 1 month ago
JSON representation
TSConfig files for projects created with create-vue.
- Host: GitHub
- URL: https://github.com/joaopalmeiro/create-vue-tsconfigs
- Owner: joaopalmeiro
- License: mit
- Created: 2024-02-21T19:57:42.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-21T21:00:34.000Z (about 1 year ago)
- Last Synced: 2025-01-31T07:12:15.931Z (3 months ago)
- Homepage: https://www.npmjs.com/package/create-vue-tsconfigs
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# create-vue-tsconfigs
TSConfig files for projects created with [create-vue](https://github.com/vuejs/create-vue).
- [Source code](https://github.com/joaopalmeiro/create-vue-tsconfigs)
- [npm package](https://www.npmjs.com/package/create-vue-tsconfigs)
- [Licenses](https://licenses.dev/npm/create-vue-tsconfigs/0.1.0)
## Available TSConfig files
### [[email protected]](https://github.com/vuejs/create-vue/tree/v3.9.2) and [[email protected]](https://github.com/vuejs/create-vue-templates/tree/v3.9.2)
| Template | Package TSConfig file | Source TSConfig file |
| ---------------------------------------------------------------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| [typescript](https://github.com/vuejs/create-vue-templates/tree/v3.9.2/typescript) | [tsconfig.app.json](typescript/tsconfig.app.json) | [tsconfig.app.json](https://github.com/vuejs/create-vue-templates/blob/v3.9.2/typescript/tsconfig.app.json) |
| [typescript](https://github.com/vuejs/create-vue-templates/tree/v3.9.2/typescript) | [tsconfig.node.json](typescript/tsconfig.node.json) | [tsconfig.node.json](https://github.com/vuejs/create-vue-templates/blob/v3.9.2/typescript/tsconfig.node.json) |
## Development
Install [fnm](https://github.com/Schniz/fnm) (if necessary).
```bash
fnm install && fnm use && node --version && npm --version
```
```bash
npm install
```
```bash
npm create [email protected] test-create-vue
```
```bash
cd test-create-vue && npm install
```
```bash
npx vue-tsc --project tsconfig.app.json --showConfig
```
```bash
npx vue-tsc --project tsconfig.node.json --showConfig
```
```bash
cd ..
```
Delete the following [top-level options](https://www.typescriptlang.org/tsconfig#extends) (if necessary):
- `"references"`
- `"files"`
- `"include"`
- `"exclude"`
Remove the following [`compilerOptions` options](https://www.typescriptlang.org/tsconfig) (if necessary):
- `"types"`
- `"tsBuildInfoFile"`
- `"baseUrl"`
- `"paths"`
Add the following [`compilerOptions` option](https://www.typescriptlang.org/docs/handbook/project-references.html#composite) (if necessary):
- `"composite": true`
```bash
npm run format
```
## Deployment
```bash
npm pack --dry-run
```
```bash
npm version patch
```
```bash
npm version minor
```
```bash
npm version major
```
- Update the version in the `Licenses` link at the top.
- Commit and push changes.
- Create a tag on [GitHub Desktop](https://github.blog/2020-05-12-create-and-push-tags-in-the-latest-github-desktop-2-5-release/).
- Check [GitHub](https://github.com/joaopalmeiro/create-vue-tsconfigs/tags).
```bash
npm login
```
```bash
npm publish
```
- Check [npm](https://www.npmjs.com/package/create-vue-tsconfigs).