Run yarn lint and prettier in CI #1674

We’ve had some trouble with different people’s editors disagreeing about formatting, so I’d like to make our formatting checks in CI to have it consistent. I expect this to fail initially, but hopefully it won’t take much work to get it passing.

I was getting a warning that our version of typescript is too new for our version of this package: updating removes the warning.

TSLint is deprecated, and the suggested replacement is typescript-eslint. This commit also updates eslint, prettier, and eslint-plugin-prettier, and adds eslint-config-prettier.

Prettier’s docs [recommend it be run directly rather than via eslint](https://prettier.io/docs/en/integrating-with-linters.html), so this commit removes eslint-plugin-prettier and runs it directly within the lint scripts in package.json.

I’m guessing the path to fronts-client was updated, and the symlink wasn’t.

To produce this diff, I ran `yarn lint-fix`.

The @guardian/prettier config uses tabs for indentation, so this commit changes the .editorconfig files to match. (Since the .prettierrc is linked at the root, I think I need to update both .editorconfig files.)

My editor has some auto-formatting that makes these tables much nicer to read in the markdown source: unless anyone objects I figure it’s an improvement?

- remove mentions of TSLint - recommend setting up editor integration for Prettier

Now that I’ve removed TSLint, this import is failing the build. To fix the build, this commit copies the definition of isError from my local node_modules. I took a look at #1277, which introduced this, and I didn’t see any explanation for this bit of code: it seems strange to import something from tslint (which is a dev dependency) for this, which makes me wonder if it was deliberate? Either way, I believe the check is necessary: I initially tried removing it, but that broke some tests.

Now that we’re not using TSLint, these comments aren’t doing anything. I’ll reintroduce the equivalents for eslint if they’re required.

In a recent commit I ran prettier to format the code, which produced a very big diff. This diff can get in the way of blaming with git, so Iʼve recorded the commit ref in .git-blame-ignore-revs, which facilitates telling git (using the config option blame.ignoreRevsFile) to ignore the commit when blaming. (Iʼll add this config to the setup script shortly.)

This change configures git to ignore the commits listed in .git-blame-ignore-revs when blaming, which prevents formatting commits from obscuring more meaningful blame info.

While I see it, this was being flagged by eslint as a non-breaking warning: might as well follow the suggestion to silence the warning.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Run yarn lint and prettier in CI #1674

Run yarn lint and prettier in CI #1674

Commits on Oct 14, 2024