Skip to content

Commit

Permalink
remove caveats ffrom readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AidasPa committed Mar 13, 2021
1 parent ce290f9 commit 8d97642
Showing 1 changed file with 0 additions and 8 deletions.
8 changes: 0 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,6 @@ This will watch all `.ts` and `.u.ts` files under `src/` and compile them to `ou
- `@KEYBIND(type: BindAction, action: string, event: IE_RELEASED | IE_PRESSED)`
- `@UFUNCTION` TODO ...

## Caveats :poop:

Sadly, there are a *few* caveats when writing code using this toolkit (nothing that can't be worked on in the future).

1. In order for intellisense to work, you need to set the `.u.ts` file extension be treated as `.ts` You can do this on **vscode** by configuring the file association for `.u.ts` files.
2. Because of #2, **vscode** bugs out and doesn't read the `tsconfig.json` file which enables `experimentalDecorators`. You also can't ignore specific decorator lines because a decorator **must** be above a declaration. One workaraound is simply livin with some squiggly lines or adding a `// @ts-nocheck` ( :neutral_face: ) at the top.
3. ONLY ONE CLASS PER `.u.ts`. Use `commonjs` modules for inheritance.

## Support, Feedback and Contributions :heart:
Having an issue? Feel free to open one here.
Want to contribute? PRs are always welcome no matter how big.

0 comments on commit 8d97642

Please sign in to comment.