Re: [Django] #35007: Add a formatter for CSS and JS (was: Add prettier to format CSS and JS)

[Django]

#35007: Add a formatter for CSS and JS
-------------------------------------+-------------------------------------
Reporter: Tom Carrick | Owner: Tom
Type: | Carrick
Cleanup/optimization | Status: assigned
Component: Core (Other) | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Tom Carrick):

* summary: Add prettier to format CSS and JS => Add a formatter for CSS
and JS


Old description:

> From https://forum.djangoproject.com/t/adding-a-formatter-for-css-
> js/25754:
>
> The idea is to add formatting for CSS and JS.
>
> For motivation, I find myself fairly often in the admin CSS (especially
> lately) and it’s reasonably laid out for the most part, but there are
> things that are a little off. Sometimes the indentation is different from
> the rest of the file, for example. The JS is in a bit worse shape I
> think, some of the files have whitespace issues. These could be fixed but
> it would be better to enforce them in a way that’s easier to review, so I
> think a formatter makes sense here. What’s annoying (for me) is that when
> editing files, sometimes my editor “fixes” the issues for me, then I have
> to revert them and save without formatting. If I don’t spot my editor’s
> work, it’s more annoying to fix. Of course I could turn this stuff off
> somewhere, but if it’s annoying for me I’m sure it’ll be annoying for
> others as well.
>
> I’m open to suggestions, but Thibaud suggested prettier, and I also use
> it myself. It doesn’t really require any configuration, though is
> configurable if people do have strong opinions.
>
> But barring differing opinions there, the process would be something
> like:
>
> Make a PR with three commits. The first sets up the machinery, installs
> prettier, adds to pre-commit, etc. The second does the work and the third
> adds the second commit to .git-blame-ignore-revs. As far as I know, the
> same as when black was set up.

New description:

From https://forum.djangoproject.com/t/adding-a-formatter-for-css-
js/25754:

The idea is to add formatting for CSS and JS.

For motivation, I find myself fairly often in the admin CSS (especially
lately) and it’s reasonably laid out for the most part, but there are
things that are a little off. Sometimes the indentation is different from
the rest of the file, for example. The JS is in a bit worse shape I think,
some of the files have whitespace issues. These could be fixed but it
would be better to enforce them in a way that’s easier to review, so I
think a formatter makes sense here. What’s annoying (for me) is that when
editing files, sometimes my editor “fixes” the issues for me, then I have
to revert them and save without formatting. If I don’t spot my editor’s
work, it’s more annoying to fix. Of course I could turn this stuff off
somewhere, but if it’s annoying for me I’m sure it’ll be annoying for
others as well.

But barring differing opinions there, the process would be something like:

Make a PR with three commits. The first sets up the machinery, installs
the formatter, adds to pre-commit, etc. The second does the work and the
third adds the second commit to .git-blame-ignore-revs. As far as I know,
the same as when black was set up.

--
--
Ticket URL: <https://code.djangoproject.com/ticket/35007#comment:6>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.