Skip to content

Add prettier and pygrep hooks to pre-commit hooks - #9644

Merged
dcherian merged 10 commits into
pydata:mainfrom
Armavica:repo-review
Nov 18, 2024
Merged

Add prettier and pygrep hooks to pre-commit hooks#9644
dcherian merged 10 commits into
pydata:mainfrom
Armavica:repo-review

Conversation

@Armavica

@ArmavicaArmavica commented Oct 18, 2024•
edited
Loading

Copy link
Copy Markdown
Contributor

Towards #8239. This mainly addresses problems in rst and markdown files.

max-sixty
max-sixty reviewed Oct 18, 2024
View reviewed changes
Comment thread.github/PULL_REQUEST_TEMPLATE.md Outdated
max-sixty
max-sixty reviewed Oct 18, 2024
View reviewed changes
Comment threaddesign_notes/grouper_objects.md Outdated
max-sixty
max-sixty reviewed Oct 18, 2024
View reviewed changes
Comment threaddesign_notes/grouper_objects.md Outdated
max-sixty
max-sixty reviewed Oct 18, 2024
View reviewed changes
Comment threaddoc/whats-new.rst
@max-sixty

max-sixty commented Oct 18, 2024

Copy link
Copy Markdown
Collaborator

Overall looks great!

We should check some of those, I added a couple of comments, though not a complete review.

To the extent that some might interfere with mypy or ruff, etc, that's not good — we don't want to be in a situation where code can't get through both checkers. Are we OK there?

The markdown & rst checkers look overall great!

@TomNicholasTomNicholas added the CI Continuous Integration tools label Oct 19, 2024
keewis
keewis reviewed Oct 19, 2024
View reviewed changes
Comment thread.pre-commit-config.yaml Outdated
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.18
hooks:
- id: mdformat

@keewiskeewisOct 19, 2024

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

apparently, we can fix (some of) the surprising bracket escapes with

Suggested change
- id: mdformat
- id: mdformat
additional_dependencies: [mdformat-gfm]

@keewiskeewisOct 19, 2024•
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

though I wonder if instead of using mdformat we should rely on prettier to format markdown, as that can also format json and yaml?

@max-sixtymax-sixtyOct 19, 2024

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW in prql we quite successfully use prettier to format all non-core code, including yaml / json / md; would recommend: https://github.com/PRQL/prql/blob/86becc591eb1a6421695ccccdf67dd8ab5c775ec/.pre-commit-config.yaml#L18-L22

...and it has a nice VS Code extension (and I guess emacs for the pros among us...)

@headtr1ck

headtr1ck commented Oct 21, 2024

Copy link
Copy Markdown
Collaborator

Why don't we instead try to rely on ruff and enable these rules there?
Many seems supported already, rules start with PGH*.

@max-sixty

max-sixty commented Oct 21, 2024

Copy link
Copy Markdown
Collaborator

Why don't we instead try to rely on ruff and enable these rules there? Many seems supported already, rules start with PGH*.

Definitely preferable for the python ones. (though formatting non-python files would still be part of this sort of effort...)

Illviljan
Illviljan reviewed Oct 30, 2024
View reviewed changes
Comment threadCORE_TEAM_GUIDE.md Outdated
Comment threadHOW_TO_RELEASE.md Outdated
Comment threadasv_bench/benchmarks/README_CI.md Outdated
@Armavica
Armavicaforce-pushed the repo-review branch 2 times, most recently from 90ea56e to 522e28dCompareNovember 16, 2024 21:40
@Armavica

Armavica commented Nov 16, 2024

Copy link
Copy Markdown
ContributorAuthor

Thank you for all your comments, I switched to prettier which seems to do a less surprising job in many cases.
I also deselected the pygrep-hooks that are already checked by ruff.

dcherian
dcherian reviewed Nov 17, 2024
View reviewed changes
Comment threaddoc/whats-new.rst Outdated
dcherian
dcherian reviewed Nov 17, 2024
View reviewed changes
Comment threaddoc/user-guide/dask.rst Outdated
dcherian
dcherian reviewed Nov 17, 2024
View reviewed changes
Comment threaddoc/internals/internal-design.rst Outdated
dcherian
dcherian reviewed Nov 17, 2024
View reviewed changes
Comment threaddoc/internals/how-to-add-new-backend.rst Outdated
dcherian
dcherian reviewed Nov 17, 2024
View reviewed changes
Comment threaddoc/internals/how-to-add-new-backend.rst Outdated
dcherian
dcherian reviewed Nov 17, 2024
View reviewed changes
Comment threaddoc/user-guide/data-structures.rst Outdated
dcherian
dcherian reviewed Nov 17, 2024
View reviewed changes
Comment threaddoc/user-guide/indexing.rst Outdated
dcherian
dcherian reviewed Nov 17, 2024
View reviewed changes
Comment threaddoc/user-guide/data-structures.rst Outdated
keewis
keewis reviewed Nov 18, 2024
View reviewed changes
Comment thread.pre-commit-config.yaml
@dcheriandcherian changed the title Add pygrep-hooks and mdformat to pre-commit hooksAdd prettier to pre-commit hooksNov 18, 2024
dcherian
dcherian reviewed Nov 18, 2024
View reviewed changes
Comment threaddoc/user-guide/weather-climate.rst Outdated
dcherian
dcherian reviewed Nov 18, 2024
View reviewed changes
Comment threaddoc/user-guide/io.rst Outdated
dcherian
dcherian reviewed Nov 18, 2024
View reviewed changes
Comment threaddoc/user-guide/io.rst Outdated
dcherianand others added 3 commits November 18, 2024 09:08
@dcheriandcherian changed the title Add prettier to pre-commit hooksAdd prettier and pygrep hooks to pre-commit hooksNov 18, 2024
@dcherian
dcherian merged commit fa62c2d into pydata:mainNov 18, 2024
dcherian added a commit that referenced this pull request Nov 19, 2024
@dcherian
Merge branch 'main' into backend-indexing
ab20531
* main: (24 commits)
Bump minimum versions (#9796)
Namespace-aware `xarray.ufuncs` (#9776)
Add prettier and pygrep hooks to pre-commit hooks (#9644)
`rolling.construct`: Add `sliding_window_kwargs` to pipe arguments down to `sliding_window_view` (#9720)
Bump codecov/codecov-action from 4.6.0 to 5.0.2 in the actions group (#9793)
Buffer types (#9787)
Add download stats badges (#9786)
Fix open_mfdataset for list of fsspec files (#9785)
add 'User-Agent'-header to pooch.retrieve (#9782)
Optimize `ffill`, `bfill` with dask when `limit` is specified (#9771)
fix cf decoding of grid_mapping (#9765)
Allow wrapping `np.ndarray` subclasses (#9760)
Optimize polyfit (#9766)
Use `map_overlap` for rolling reductions with Dask (#9770)
fix html repr indexes section (#9768)
Bump pypa/gh-action-pypi-publish from 1.11.0 to 1.12.2 in the actions group (#9763)
unpin array-api-strict, as issues are resolved upstream (#9762)
rewrite the `min_deps_check` script (#9754)
CI runs ruff instead of pep8speaks (#9759)
Specify copyright holders in main license file (#9756)
...
@Armavica
Armavica deleted the repo-review branch November 19, 2024 12:39
dcherian added a commit to dcherian/xarray that referenced this pull request Nov 19, 2024
@dcherian
Merge branch 'main' into groupby-shuffle
d533638
* main:
Bump minimum versions (pydata#9796)
Namespace-aware `xarray.ufuncs` (pydata#9776)
Add prettier and pygrep hooks to pre-commit hooks (pydata#9644)
`rolling.construct`: Add `sliding_window_kwargs` to pipe arguments down to `sliding_window_view` (pydata#9720)
Bump codecov/codecov-action from 4.6.0 to 5.0.2 in the actions group (pydata#9793)
Buffer types (pydata#9787)
Add download stats badges (pydata#9786)
Fix open_mfdataset for list of fsspec files (pydata#9785)
add 'User-Agent'-header to pooch.retrieve (pydata#9782)
Optimize `ffill`, `bfill` with dask when `limit` is specified (pydata#9771)
fix cf decoding of grid_mapping (pydata#9765)
Allow wrapping `np.ndarray` subclasses (pydata#9760)
Optimize polyfit (pydata#9766)
Use `map_overlap` for rolling reductions with Dask (pydata#9770)
wavebyrd pushed a commit to wavebyrd/xarray that referenced this pull request Mar 13, 2026
@dcherian
Merge branch 'main' into backend-indexing
9e96ede
* main: (24 commits)
Bump minimum versions (pydata#9796)
Namespace-aware `xarray.ufuncs` (pydata#9776)
Add prettier and pygrep hooks to pre-commit hooks (pydata#9644)
`rolling.construct`: Add `sliding_window_kwargs` to pipe arguments down to `sliding_window_view` (pydata#9720)
Bump codecov/codecov-action from 4.6.0 to 5.0.2 in the actions group (pydata#9793)
Buffer types (pydata#9787)
Add download stats badges (pydata#9786)
Fix open_mfdataset for list of fsspec files (pydata#9785)
add 'User-Agent'-header to pooch.retrieve (pydata#9782)
Optimize `ffill`, `bfill` with dask when `limit` is specified (pydata#9771)
fix cf decoding of grid_mapping (pydata#9765)
Allow wrapping `np.ndarray` subclasses (pydata#9760)
Optimize polyfit (pydata#9766)
Use `map_overlap` for rolling reductions with Dask (pydata#9770)
fix html repr indexes section (pydata#9768)
Bump pypa/gh-action-pypi-publish from 1.11.0 to 1.12.2 in the actions group (pydata#9763)
unpin array-api-strict, as issues are resolved upstream (pydata#9762)
rewrite the `min_deps_check` script (pydata#9754)
CI runs ruff instead of pep8speaks (pydata#9759)
Specify copyright holders in main license file (pydata#9756)
...
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dcheriandcheriandcherian left review comments
@max-sixtymax-sixtymax-sixty left review comments
@IllviljanIllviljanIllviljan left review comments
@keewiskeewiskeewis left review comments
@TomNicholasTomNicholasTomNicholas left review comments

Assignees

No one assigned

Labels

CIContinuous Integration tools

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@Armavica@max-sixty@headtr1ck@dcherian@Illviljan@keewis@TomNicholas