Updated Parser and README

This commit is contained in:
Richard Davey 2019-05-10 16:05:20 +01:00
parent 9ed98e97a8
commit 9a4ea21ca9
3 changed files with 9 additions and 2 deletions

7
scripts/tsgen/README.md Normal file
View file

@ -0,0 +1,7 @@
## TypeScript Defs Generation Tool
The TypeScript defs generation tool is called `tsgen` and is written in TypeScript. Build it by running `npm run build-tsgen`. This will compile the parser locally.
You can then run `npm run tsgen` to build the actual defs. They will replace the file located in the root `types` folder. Once the parser is built you only need use this command. Use it to re-generate the defs if you have modified the Phaser source code and wish to test your change worked.
There is also a test script available: `npm run test-ts` which will compile a test TypeScript project and output any compilation errors to `output.txt`.

View file

@ -77,7 +77,7 @@ class Parser {
case 'Phaser.Scale.ScaleModes':
case 'Phaser.Scale.Zoom':
case 'Phaser.Textures.FilterMode':
console.log('Forcing enum for ' + doclet.longname);
// console.log('Forcing enum for ' + doclet.longname);
doclet.kind = 'member';
doclet.isEnum = true;
break;

File diff suppressed because one or more lines are too long