Typescript definitions file about i18njs

[roddeh]

I am unlikely to be able to get to this any time soon. I would be happy to review a PR.

I can provide ones, but looks like you have no Typescript files yet to make definitions for.

[gregBerthelot]

Yes looks like you should PR the TS files as well

[vishnuvardhana]

@kaliinmtrx PR for typescript files are also needed , let me know if I can assist .. not fully aware of the process of creating definitions, happy to learn.

[roddeh]

Does setting up a definition file require the project to be converted to TS?

Or is it possible to leave the library code as is and simply provide a definition file that describes the interfaces of what exists in JS?

I am not opposed to converting the project to TS, just wanting to reduce the scope of the initial PR to get it working nicely with TS.

[vishnuvardhana]

We are ok with having definitions separately need not convert entire library, type definitions @types/roddeh-i18n will be great .

[vishnuvardhana]

I am sure we can set up types without converting the project.

[gregBerthelot]

This should help https://github.com/DefinitelyTyped/DefinitelyTyped#create-a-new-package

[roddeh]

Ok, cool. Thanks for clarifying. @vishnuvardhana @kaliinmtrx are either of you able to setup the definitions as a PR?

[gregBerthelot]

@kaliinmtrx do you need help?

[Gesh4o]

Hey guys, do you still need help on this one?

[gregBerthelot]

@Gesh4o seems that nobody has move forward yet. I need it but I am not in position to help on this. @vishnuvardhana I am sure can help if needed

[Gesh4o]

I will look at your docs and file a PR, would that be ok?

[gregBerthelot]

That would be great 👍

[vishnuvardhana]

@Gesh4o thank you once you start I will be able to help you.

[Gesh4o]

I was about to open a PR today but I guess it doesn't matter now :/

[roddeh]

@evilarceus thanks for submitting the PR. It looks good to me. But @vishnuvardhana @Gesh4o, perhaps you could also take a look given you have more experience with TS definitions.

[Gesh4o]

I think @evilarceus has done a good job. However I cannot give my recommendations about the typescript definitions themselves but here are several improvements that could be made:

1. Create tslint.config and index.spec.ts (generally ts definitions come as 4 files - look at: https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/express)

2. Include two new commands: lint:definitions and test:definitions (could be named differently ofc) and include them in your CI flow. You will have to maintain that piece of code so make sure to avoid regressions as much as possible.

3. Keep an eye for private methods - they should not be included in definitions.

[entriphy]

I added the changes for testing and linting to the pull request. Currently, it uses dtslint, unfortunately meaning that it can't do linting only: lint:typings does both linting and testing, and test:typings only does testing. The scripts might need to be renamed or combined to make it more accurate. If we wanted, we could use tslint for linting only and then use dtslint for testing (or use a different testing system, though we are still only testing types, which is why I personally prefer to use dtslint).

Private methods were not included in the definitions, assuming all functions below translator.translateHash() (excluding create(), that's included in the definitions) are private.

As for CI flow: I don't believe this project has CI integration.

[roddeh]

Thanks for the contributions @evilarceus. Merged ;)