Solution for #72 + Add type definitions for Text(D)Encoder

[HeavenVolkoff]

Hello,

This PR presents a solution for #72. It adds a notice to the README informing users that it is recommended to edit their tsconfig.json file for GJS projects. Besides, logic was built to check, during runtime, if the project has the DOM lib in its tsconfig.json and if that is the case ask the user if he wants to skip generating any conflicting type.

Also, included in this PR are the definitions for the Text(D)Encoder interfaces added in GJS 1.69.2:
https://gitlab.gnome.org/GNOME/gjs/-/blob/572f8e8c/NEWS#L384-393
https://gitlab.gnome.org/GNOME/gjs/-/blob/master/doc/Encoding.md
https://gitlab.gnome.org/GNOME/gjs/-/blob/master/modules/esm/_encoding/encoding.js

[HeavenVolkoff]

Will check why the tests are failing

[HeavenVolkoff]

So, typescript has its own parser for tsconfig.json, and it seems to accept more than the pure JSON spec, because of this using JSON.parse is not possible as it can fail with valid tsconfig.json. My solution was to simply import the typescript compiler's own parser and use it directly. The consequence is that this requires typescript to be a runtime dependency, IMHO I don't think this will have much of an impact for end users, as this tools will probably be a devDependency on project using it and most of them will probably also use typescript. However, if you don't agree with this, I can look for alternative parser that may offer a better compatibility with tsconfig.json, json5 seems to be a good alternative.

[JumpLink]

However, if you don't agree with this, I can look for alternative parser that may offer a better compatibility with tsconfig.json, json5 seems to be a good alternative.

@HeavenVolkoff Another alternative is jsonc-parser which is from Microsoft, so maybe this package is also used internally in TypeScript?

I have used pkg-types in another project which can read the package.json and the tsconfig.json, is using jsonc-parser for parsing and has good TypeScript Type Definitions. What do you think about it?

P.S. Today is my birthday and I just saw your pull requests today, which is a great birthday present, thank you! :)

Edit
I just realized that the tsconfig.json can also inherit from other config files using extend, to parse this should work better with your current solution so I will merge that now :)

[HeavenVolkoff]

@HeavenVolkoff Another alternative is jsonc-parser which is from Microsoft, so maybe this package is also used internally in TypeScript?

Although jsonc-parser seems to be a good option, it isn't what Typescript uses internally, they actually implemented their own parser, because they seem to try parsing some broken JSON without failing. Here you can see their parser implementation:
https://github.com/microsoft/TypeScript/blob/main/src/compiler/parser.ts

Edit I just realized that the tsconfig.json can also inherit from other config files using extend, to parse this should work
better with your current solution so I will merge that now :)

Oh, that is a good point, I didn't consider it when I implemented this XD. Just went with the simplest solution. But, I would say it is the main advantage of using TS own parsing logic, even if they change format or break compatibility, it would have very little effect on this project.

P.S. Today is my birthday and I just saw your pull requests today, which is a great birthday present, thank you! :)

Hey man, Happy Birthday 🎂. Hope you enjoy your day.