OpenFn / kit

The bits & pieces that make OpenFn work. (diagrammer, cli, compiler, runtime, runtime manager, logger, etc.)
8 stars 12 forks source link

Ensure prettier is automatically set up for new developers #671

Closed josephjclark closed 1 month ago

josephjclark commented 2 months ago

It's really important that prettier runs so that we have a consistent code style.

But new developers coming in to contribute to the repo may not have prettier configured.

My expectation is:

We may need to add documentation to the readme, but ideally this stuff should happen automatically.

I have my VSC setup to format on save, which uses prettier. But this won't work for other editing environments.

We should look at how prettier recommends this to be setup on their officlal pages and be guided by that.

I would prefer not to format pre-commit. The idea of changing code, invisibly, right before commit it to the repo, makes my blood run cold.