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

Various grammatical changes

Browse Source
This commit is contained in:
David Wheatley 2021-07-09 08:56:10 +01:00 committed by GitHub
parent f4807ada6a
commit 91d4c63090
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,12 +1,12 @@
# Flarum Typescript Config
A standardised `tsconfig.json` for use in Typescript Flarum extensions.
A standardised `tsconfig.json` for use in Flarum extensions.
## Usage
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:
You need to install this package as a dev dependency to your extension JS:
```properties
npm install --save-dev flarum-tsconfig
@ -32,4 +32,4 @@ A baseline `tsconfig.json` is provided below that you can modify as needed. This
}
```
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.
You'll also need to ensure that you run `composer update` in your extension's root directory to ensure that a copy of Flarum core is downloaded to your `vendor` folder. Remember that `vendor` should **not** be committed to Git repositories.