github-mirror/framework
github-mirror/framework
2
0
Fork 0
mirror of https://github.com/flarum/framework.git synced 2025-02-26 21:00:54 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat: update tsconfig docs

Browse Source
This commit is contained in:
Alexander Skvortsov 2022-04-07 16:18:47 -04:00
parent 246bf54155
commit e9d8c0726d
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
js-packages/tsconfig/README.md
View File

@ -4,6 +4,16 @@ A standardised `tsconfig.json` for use in Flarum extensions.
## Usage
### With Flarum CLI
Flarum CLI can add/manage TypeScript configuration for you! Run:
`flarum-cli infra typescript` in your extension's root to configure TypeScript.
You can then re-run the same command, or use `flarum-cli audit infra [--fix]` to keep this config up to date.
## Without Flarum CLI
You'll need to configure a `tsconfig.json` file to ensure your IDE sets up Typescript support correctly.
You need to install this package as a dev dependency to your extension JS:
@ -22,7 +32,7 @@ A baseline `tsconfig.json` is provided below that you can modify as needed. This
// This will match all .ts, .tsx, .d.ts, .js, .jsx files in your `src` folder
// and also tells your Typescript server to read core's global typings for
// access to `dayjs` and `$` in the global namespace.
"include": ["src/**/*", "../vendor/flarum/framework/js/dist-typings/@types/**/*"],
"include": ["src/**/*", "../vendor/*/*/js/dist-typings/@types/**/*"],
"compilerOptions": {
// This will output typings to `dist-typings`
"declarationDir": "./dist-typings",