Solves #22 and greatly improves the project documentation

[Sharcoux]

Add types for use with intellisense, typescript, etc, and improve project documentation

Solve #22

[derhuerst]

Can you keep the formatting (no trailing semicolons, indentation, etc.) as before? The current changeset makes reviewing (and blaming in the future) very hard.

[Sharcoux]

You should probably define those in a linter config, this way the formatting will always follow the same rules.

[derhuerst]

You should probably define those in a linter config, this way the formatting will always follow the same rules.

I see your point! But this creates more maintenance work, and I would like to rather make it less. See also public-transport/hafas-client#305 (comment) .

[Sharcoux]

This is the opposite. The linter will automatically ensure that the code style is the same throughout the project. I don't like prettier either, but you can perfectly lint code with eslint, which is already installed in the project. If you check my last change, it implements some of your requirements.

[derhuerst]

Adding a linter creates long-term friction for me, this is why I don't want to have such a setup. (I can see that using it is worth it in projects with multiple active maintainers and/or many contributors.)

Thanks for adjusting your PR accordingly.

[Sharcoux]

Adding a linter creates long-term friction for me, this is why I don't want to have such a setup. (I can see that using it is worth it in projects with multiple active maintainers and/or many contributors.)

Thanks for adjusting your PR accordingly.

You already have a linter. eslint is a linter - there is a hint in the name 😉