Add "typings" field to package.json

[letmaik]

The package.json file should contain a "typings" field as described here. Then IDEs like Visual Studio Code will automatically find the typing information.

So, that should be:

"typings": "lib/chevrotain.d.ts"

[bd82]

Thanks @letmaik I was not aware of this.

I've looked at the docs you listed and related issues on the TypeScript github page.
What I'm trying to figure out is if I now need to have two separate d.ts files published with chevrotain. one for external modules and one for global usage...

Because If I understand correctly the

declare module "chevrotain" {}

needs to be removed as well.

Hopefully it is enough to just change Chevrotain's d.ts to use one the modern module template
As I am currently using an older style of d.ts template that I saw used on definitely typed.

Did the existing chevrotain.d.ts work on VSCode after you have manually added the "typings" property ?

[bd82]

I've tried doing as you have suggested.
The current chevrotain.d.ts format is not compatible with this.
You can see the logs in the failing build.

https://travis-ci.org/SAP/chevrotain/jobs/150854082

src/examples/json/api.ts(8,8): error TS2656: Exported external package typings file '/home/travis/build/SAP/chevrotain/examples/language_services/node_modules/chevrotain/lib/chevrotain.d.ts' is not a module. Please contact the package author to update the package definition.

it does work with the new UMD module template syntax.
But this syntax only works with Typescript 2 which is still in beta.

I do not think it is worth the bother right now to create another hacked d.ts file (or more than one).
Because Typescript 2 is supposed to be released "soon" so then a "standard" solution can be used.

I will try to create a push request that solves this (using typescript 2 beta) but will only merge once
the typescript 2 is officially released.

[letmaik]

Thanks for investigating this! I don't have much experience with definition files myself yet. Your plan sounds good, version 2 is just a few weeks away. As a work-around, it seems to be enough to just copy the chevrotain.d.ts file somewhere in the project so that the compiler finds it.

[bd82]

@letmaik No Problem.

And thanks for the feedback. now I know about the "typings" package.json property
and how to make usage of Chevrotain easier in the near future. 😄

[bd82]

fixed in
#280

will be available in next version.