[Breaking Change] Add `usethis hook` command and `--hook/--no-hook` to `usethis init` by Copilot · Pull Request #1454 · usethis-python/usethis-python

Copilot · 2026-03-22T09:04:02Z

Higher-level interface for managing git hooks, analogous to usethis lint, usethis typecheck, etc. Uses pre-commit as the underlying framework for now.

Changes

New usethis hook command — top-level command under "Manage Tooling" with standard --remove, --how, --offline, --frozen, --backend options
- _toolset/hook.py: wraps use_pre_commit()
- _ui/interface/hook.py: CLI interface
- Registered in app.py
usethis init flag rename — --pre-commit/--no-pre-commit → --hook/--no-hook (default: False)
- Internal wiring updated to use use_hook_framework() from the toolset layer instead of importing use_pre_commit directly from _core
Architecture — hook added to .importlinter ui_interface contract
Docs — usethis hook added to docs/cli/overview.md, docs/cli/reference.md, and README.md
- docs/cli/reference.md: new ## usethis hook section added and --pre-commit renamed to --hook under usethis init

Usage

$ usethis hook           # Add pre-commit framework
$ usethis hook --remove  # Remove it
$ usethis init --hook    # Include hook framework in project init

Original prompt

This section details on the original issue you should resolve

<issue_title>usethis hook or similar</issue_title>
<issue_description>Higher level interface for choosing an opinionated framework for managing git hooks. Will use pre-commit as the tool for now.

Could use #1003

Also add --hook/--no-hook to usethis init, defaulting to false.</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes usethis hook or similar #1004

📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

- Create _toolset/hook.py wrapping use_pre_commit() - Create _ui/interface/hook.py CLI interface - Register `usethis hook` command in app.py - Replace --pre-commit/--no-pre-commit with --hook/--no-hook in init - Update .importlinter, docs/cli/overview.md, and README.md - Add test_hook.py tests and update test_init.py Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com> Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/5e55d87a-8269-437d-8ff1-abea260f5a4a

nathanjmcdougall · 2026-03-22T09:36:50Z

This is a breaking change because it renames the --pre-commit argument to --hook in usethis init.

codspeed-hq · 2026-03-22T09:41:46Z

Merging this PR will not alter performance

✅ 2 untouched benchmarks

_{Comparing copilot/add-pre-commit-hook-option (ebd433b) with main (93eebf1)}

codecov · 2026-03-22T09:58:30Z

Codecov Report

❌ Patch coverage is 88.46154% with 3 lines in your changes missing coverage. Please review.
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
src/usethis/_ui/interface/hook.py	81.25%	3 Missing ⚠️

📢 Thoughts on this report? Let us know!

Copilot

Pull request overview

Adds a new high-level usethis hook CLI command (wrapping pre-commit) and renames the usethis init flag from --pre-commit/--no-pre-commit to --hook/--no-hook, aligning git hook management with other “Manage Tooling” commands.

Changes:

Introduces usethis hook UI + toolset entrypoint and registers it in the Typer app.
Renames usethis init’s pre-commit option to --hook/--no-hook and rewires init to call the toolset hook function.
Updates overview/README docs and import-linter layer contract; adds CLI interface tests for hook.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
tests/usethis/_ui/interface/test_init.py	Updates init CLI tests for the renamed `--hook` option and new output message.
tests/usethis/_ui/interface/test_hook.py	Adds new CLI tests for `usethis hook` add/how/remove/backend behaviors.
src/usethis/_ui/interface/init.py	Renames init option and routes hook setup via `use_hook_framework()`.
src/usethis/_ui/interface/hook.py	New CLI entrypoint implementing `usethis hook` with standard tool flags.
src/usethis/_ui/app.py	Registers the new top-level `hook` command in the Typer app.
src/usethis/_toolset/hook.py	Adds toolset wrapper `use_hook_framework()` (currently delegates to `use_pre_commit()`).
docs/cli/overview.md	Adds `usethis hook` to the CLI overview list.
README.md	Adds `usethis hook` to the README CLI command list.
.importlinter	Adds `hook` to the `ui_interface` layers contract.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-22T16:20:55Z

README.md

 - [`usethis arch`](https://usethis.readthedocs.io/en/stable/cli/reference#usethis-arch) — Add/Configure recommended architecture analysis tools (namely, [Import Linter](https://import-linter.readthedocs.io/en/stable/)).
 - [`usethis doc`](https://usethis.readthedocs.io/en/stable/cli/reference#usethis-doc) — Add/Configure recommended documentation tools (namely, [MkDocs](https://www.mkdocs.org/)).
 - [`usethis format`](https://usethis.readthedocs.io/en/stable/cli/reference#usethis-format) — Add/Configure recommended formatters (namely, [Ruff](https://docs.astral.sh/ruff/formatter/) and [pyproject-fmt](https://pyproject-fmt.readthedocs.io/en/latest/)).
+- [`usethis hook`](https://usethis.readthedocs.io/en/stable/cli/reference#usethis-hook) — Add/Configure a recommended git hook framework (namely, [pre-commit](https://github.com/pre-commit/pre-commit)).


README links to .../cli/reference#usethis-hook, but the in-repo CLI reference doc (docs/cli/reference.md) currently has no usethis hook section/anchor and still documents --pre-commit/--no-pre-commit for usethis init. Until the reference is updated, this README link is likely to 404/mislead.

Suggested change

- [`usethis hook`](https://usethis.readthedocs.io/en/stable/cli/reference#usethis-hook) — Add/Configure a recommended git hook framework (namely, [pre-commit](https://github.com/pre-commit/pre-commit)).

- [`usethis hook`](https://usethis.readthedocs.io/en/stable/cli/reference) — Add/Configure a recommended git hook framework (namely, [pre-commit](https://github.com/pre-commit/pre-commit)).

@copilot likewise, please update reference.md to ensure this hyperlink is valid

Updated docs/cli/reference.md in ebd433b — added a new ## usethis hook section (with anchor #usethis-hook) and renamed --pre-commit to --hook under usethis init.

Done in ebd433b — reference.md now has the #usethis-hook anchor.

tests/usethis/_ui/interface/test_hook.py

docs/cli/overview.md

nathanjmcdougall · 2026-03-22T17:20:47Z

README.md

 - [`usethis arch`](https://usethis.readthedocs.io/en/stable/cli/reference#usethis-arch) — Add/Configure recommended architecture analysis tools (namely, [Import Linter](https://import-linter.readthedocs.io/en/stable/)).
 - [`usethis doc`](https://usethis.readthedocs.io/en/stable/cli/reference#usethis-doc) — Add/Configure recommended documentation tools (namely, [MkDocs](https://www.mkdocs.org/)).
 - [`usethis format`](https://usethis.readthedocs.io/en/stable/cli/reference#usethis-format) — Add/Configure recommended formatters (namely, [Ruff](https://docs.astral.sh/ruff/formatter/) and [pyproject-fmt](https://pyproject-fmt.readthedocs.io/en/latest/)).
+- [`usethis hook`](https://usethis.readthedocs.io/en/stable/cli/reference#usethis-hook) — Add/Configure a recommended git hook framework (namely, [pre-commit](https://github.com/pre-commit/pre-commit)).


@copilot likewise, please update reference.md to ensure this hyperlink is valid

…-pre-commit to --hook Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com> Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/fdd7c3d5-e514-44f7-a799-5ec619a872f5

Initial plan

3a68cd8

Copilot AI assigned Copilot and nathanjmcdougall Mar 22, 2026

Copilot started work on behalf of nathanjmcdougall March 22, 2026 09:04 View session

Copilot AI changed the title ~~[WIP] Add higher level interface for choosing git hooks framework~~ Add usethis hook command and --hook/--no-hook to usethis init Mar 22, 2026

Copilot AI requested a review from nathanjmcdougall March 22, 2026 09:14

Copilot finished work on behalf of nathanjmcdougall March 22, 2026 09:14

nathanjmcdougall changed the title ~~Add usethis hook command and --hook/--no-hook to usethis init~~ [Breaking Change] Add usethis hook command and --hook/--no-hook to usethis init Mar 22, 2026

Copilot AI temporarily deployed to codecov March 22, 2026 09:36 Inactive

nathanjmcdougall approved these changes Mar 22, 2026

View reviewed changes

nathanjmcdougall marked this pull request as ready for review March 22, 2026 09:42

nathanjmcdougall requested a review from Copilot March 22, 2026 16:15

Copilot started reviewing on behalf of nathanjmcdougall March 22, 2026 16:15 View session

Merge branch 'main' into copilot/add-pre-commit-hook-option

624d5f7

nathanjmcdougall temporarily deployed to codecov March 22, 2026 16:18 — with GitHub Actions Inactive

Copilot AI reviewed Mar 22, 2026

View reviewed changes

nathanjmcdougall requested changes Mar 22, 2026

View reviewed changes

Copilot started work on behalf of nathanjmcdougall March 22, 2026 17:21 View session

Copilot AI requested a review from nathanjmcdougall March 22, 2026 17:24

Copilot finished work on behalf of nathanjmcdougall March 22, 2026 17:24

Copilot AI temporarily deployed to codecov March 22, 2026 18:15 Inactive

nathanjmcdougall approved these changes Mar 22, 2026

View reviewed changes

nathanjmcdougall merged commit b6fcd0d into main Mar 22, 2026
19 checks passed

nathanjmcdougall deleted the copilot/add-pre-commit-hook-option branch March 22, 2026 18:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Breaking Change] Add `usethis hook` command and `--hook/--no-hook` to `usethis init`#1454

[Breaking Change] Add `usethis hook` command and `--hook/--no-hook` to `usethis init`#1454
nathanjmcdougall merged 4 commits intomainfrom
copilot/add-pre-commit-hook-option

Copilot AI commented Mar 22, 2026 •

edited

Loading

Uh oh!

nathanjmcdougall commented Mar 22, 2026

Uh oh!

codspeed-hq bot commented Mar 22, 2026 •

edited

Loading

Uh oh!

codecov bot commented Mar 22, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 22, 2026

Uh oh!

nathanjmcdougall Mar 22, 2026

Uh oh!

Copilot AI Mar 22, 2026

Uh oh!

Copilot AI Mar 22, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nathanjmcdougall Mar 22, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	- [`usethis hook`](https://usethis.readthedocs.io/en/stable/cli/reference#usethis-hook) — Add/Configure a recommended git hook framework (namely, [pre-commit](https://github.com/pre-commit/pre-commit)).
	- [`usethis hook`](https://usethis.readthedocs.io/en/stable/cli/reference) — Add/Configure a recommended git hook framework (namely, [pre-commit](https://github.com/pre-commit/pre-commit)).

Conversation

Copilot AI commented Mar 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Usage

Comments on the Issue (you are @copilot in this section)

Uh oh!

nathanjmcdougall commented Mar 22, 2026

Uh oh!

codspeed-hq bot commented Mar 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will not alter performance

Uh oh!

codecov bot commented Mar 22, 2026

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 22, 2026

Choose a reason for hiding this comment

Uh oh!

nathanjmcdougall Mar 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 22, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nathanjmcdougall Mar 22, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Mar 22, 2026 •

edited

Loading

codspeed-hq bot commented Mar 22, 2026 •

edited

Loading