maint: Add prettier pre-commit hook #3663
Conversation
| hooks: | ||
| - id: rst-backticks | ||
| - id: rst-directive-colons | ||
| - id: rst-inline-touching-normal | ||
| - id: rst-backticks |
There was a problem hiding this comment.
This an example when existing hooks allow different styles (even in the same file)
| @@ -5,28 +5,25 @@ repos: | |||
| hooks: | |||
| - id: trailing-whitespace | |||
| - id: end-of-file-fixer | |||
| - id: fix-encoding-pragma | |||
There was a problem hiding this comment.
This is deprecated
| - id: check-yaml | ||
| exclude: ^.+(/tests/|/recipe/).+$ | ||
| - id: check-toml | ||
| - id: check-json | ||
| - id: check-merge-conflict | ||
| - id: pretty-format-json | ||
| args: [--autofix] |
There was a problem hiding this comment.
These checks (except check-merge-conflict) no longer seem to be needed
| - id: debug-statements | ||
| language_version: python3 | ||
| # Autoformat: YAML, JSON, Markdown, etc. | ||
| - repo: https://github.com/rbubley/mirrors-prettier |
There was a problem hiding this comment.
Using a fork, since official prettier pre-commit hook has been archived:
http://github.com/prettier/prettier/issues/15742
There was a problem hiding this comment.
Hum, I'm kind of reluctant here. As I'm in favor of general improvements, using something that just has been archived (even if a mirror is available) doesn't seem a good idea to me.
https://github.com/rbubley/mirrors-prettier seems to rather be a workaround to let people keep using the hook and there are no guarantees that it will be maintained in the long term.
I would highly suggest to wait until a stable solution is available (could be something used by a significant number of people, regularly maintained, or officially superseding the archived one in pre-commit).
There was a problem hiding this comment.
There is an important gotcha: the https://github.com/rbubley/mirrors-prettier is not a mirror/fork of prettier ore pre-commit.
It's a small repo to make vanilla prettier work as pre-commit hook.
If you take a look at the source code, you'll see that the part which matters is less than 100 lines.
So, there is not much to maintain and the code to automatically update the version of the prettier is already there.
Even in the worst case scenario, this fork will stop updating, we will have some prettier version in this repo.
It's already working great for lots of files like json/yaml/toml/markdown.
I don't think these files have that much new syntax features added to them (unlike python/c++ code, where you really want tools to work with newer code as well).
So, it's unlikely we'll encounter issues due to not using the latest version.
And the sooner we add prettier, the less diff this PR will generate.
| @@ -39,8 +39,7 @@ def template_substitute(contents): | |||
| today = datetime.date.today() | |||
| fmt_today = today.strftime("%B %d, %Y") | |||
|
|
|||
| header_line = f"{name} {version} ({fmt_today})" | |||
| res += f"{header_line}\n{'=' * len(header_line)}\n\n" | |||
| res += f"# {name} {version} ({fmt_today})\n\n" | |||
There was a problem hiding this comment.
releaser.py and changelog.py are changed manually by me, to make sure new changelogs are written correctly
| @@ -40,15 +39,14 @@ Bug fixes: | |||
| - [libmamba, micromamba] Create empty base prefix with `env update` by @Hind-M in https://github.com/mamba-org/mamba/pull/3519 | |||
| - [libmamba, micromamba] fix: Use POSIX-compliant scripts by @jjerphan in https://github.com/mamba-org/mamba/pull/3522 | |||
| - [libmamba, micromamba] maint: Clarify `env` subcommand documentation in help menu (cont'd) by @jjerphan in https://github.com/mamba-org/mamba/pull/3539 | |||
| - [libmamba] fix: Handle space in `mamba` and `micromamba` executable absolute paths by @NewUserHa in https://github.com/mamba-org/mamba/pull/3525 | |||
| - [libmamba] fix: Handle space in `mamba` and `micromamba` executable absolute paths by @NewUserHa in https://github.com/mamba-org/mamba/pull/3525 | |||
There was a problem hiding this comment.
Sometimes prettier fixes double space and some other minor things in markdown text, don't think this is gonna cause trouble
|
Please, let me know if you don't like PRs with improvements to tooling around the code quality. |
mathbunnyru
changed the title
jjerphan
changed the title
There was a problem hiding this comment.
Thank you for this proposal, @mathbunnyru.
I am not against it, but I think we should ignore the formatting done by this PR then.
I am waiting for someone else from the team to comment.
prettieris a much better tool than using hooks fromhttps://github.com/pre-commit/pre-commit-hooks- the style is much better, always consistent and it actually works