github-mirror/framework
2
0
Fork 0
mirror of https://github.com/flarum/framework.git synced 2024-11-22 11:08:19 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add support for Flarum typings in tsconfig

Browse Source
This commit is contained in:
David Wheatley 2021-05-27 22:37:32 +01:00 committed by GitHub
parent df4b5969e3
commit f1635cde13
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -23,7 +23,12 @@ A baseline `tsconfig.json` is provided below that you can modify as needed. This
"include": ["src/**/*"],
"compilerOptions": {
// This will output typings to `dist-typings`
"declarationDir": "./dist-typings"
"declarationDir": "./dist-typings",
"paths": {
"flarum/*": ["../vendor/flarum/core/js/dist-typings/*"]
}
}
}
```
You'll also need to ensure that you run `composer update` in your extension's root directory to ensure that a copy of core is downloaded to your `vendor` folder. Remember that `vendor` should **not** be committed to git repositories.