Code base seems to be non-formatted with Prettier

[kettanaito]

The library is using Prettier to format the changes via lint-staged and npm run prettier command. When doing so, however, it formats the entire file, distorting the commit's diff. This makes contributing to the project extremely tedious.

I believe the reason for that is the lack of the explicit Prettier configuration that'd tell Prettier how to format the code. It must be detecting some of my other Prettier configurations and formatting the code base accordingly.

Solution

Let's add an explicit .prettierrc configuration so that the formatting on the commit hook would produce a consistent result.

[kettanaito]

Once the configuration is added, I highly recommend formatting the entire code base to prevent any unexpected format-related diffs in the future.

[blakeembrey]

I’d rather not add a special config to avoid this, the point of prettier personally was to avoid configuration. That said, I’ll take a look and maybe migrate to https://github.com/borderless/ts-scripts anyway since I’ve standardized this setup for all other repos.

[kettanaito]

I completely agree, yet I'm experiencing an issue when a clean fork without any additional VS Code settings mal-formats the code base of this project. I suspect some implicit Prettier config resolution at the place, but cannot point a finder on it just yet.

An even bigger beauty of prettier is just being opinionated. I always add explicit configs even if they describe prettier's default. The latter can always change, as happened with prettier for javascript, if my memory serves right. In the end, it's about consistent code formatting and contributing experience.

[blakeembrey]

I'll take a look. I think that's actually my fault for merging a prettier update with applying the version I updated to at the same time.

[kettanaito]

Thank you, @blakeembrey. Let me know if you need any help. I can set up a pre-commit hook that'd format any changes, ensuring no unformatted code gets committed. That, and a fixed Prettier configuration will be enough for a great experience.

[frank-dspeed]

i Would love to simply add a normal tsconfig.json here as typescript is the most advanced linter for JS at present it supports JSDOC types so we do not even need to transpil and all this stuff to get typechecking and also type definitions as also can enforce code formarting via tslint or something else.

i am strong against moving the codebase it self to .ts files

[blakeembrey]

Reformatted in the mega commit b45871b. I'm taking a look at your PR finally and will rebase if I can 😄

[kettanaito]

Thank you, @blakeembrey!