ribrdb / desynced-tools

Tools for working with behaviors and blueprints from Desynced.
MIT License
4 stars 3 forks source link

Prettier, eslint, gitignore #49

Open swazrgb opened 4 months ago

swazrgb commented 4 months ago

Would you accept a PR that adds prettier to reformat the code, eslint for linting and adds the files generated by geninstr.ts to the gitignore?

I would propose to exclude dsconvert.js from formatting & linting errors since it's vendored from DesyncedJavaScriptUtils.

Running prettier on compile.ts & assemble.ts would be a pretty big diff, prone to merge conflicts. Such merge conflicts are relatively easy to resolve by also running prettier on the branch that is being merged, but it would be good to coordinate this.

Thanks!

ribrdb commented 4 months ago

Prettier sounds good. I'm a little unsure about eslint, I'd want to see what/how much it screams about. Maybe do that one separately?

I'm also not sure about gitignore for the generated files. It's kind of tricky to generate them, although it's at least documented how to do it now.

swazrgb commented 4 months ago

I'm also not sure about gitignore for the generated files

I would propose keeping the .json file(s) extracted from the game, but ignoring the other source files, they only require running a single node command which could be implemented as npm run generate.

ribrdb commented 4 months ago

I didn't include that one in particular because I thought the game devs might not like it. Although the other files contain most of the same info, so maybe it's not any different?

swazrgb commented 4 months ago

I asked beatwho (Co-Founder of Stage Games Inc.) for permission to redistribute the data.json produced by my Data Dump mod, which includes this data and more:

image

So we could distribute only the json file, and have everything else be generated (at runtime, where feasable).

ribrdb commented 4 months ago

Ok awesome!