-
Notifications
You must be signed in to change notification settings - Fork 5
Implement usethis tool zensical
#1756
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Copilot
wants to merge
14
commits into
main
Choose a base branch
from
copilot/implement-usethis-tool-zensical
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
bbb00dd
Initial plan
Copilot b4cc347
Implement usethis tool zensical
Copilot df9345d
Fix test assertions per code review feedback
Copilot 4c53862
Improve use_zensical to subprocess zensical new . for scaffolding
Copilot f6298bd
Remove zensical new . subprocess, use manual setup like mkdocs
Copilot e48ca5f
Merge branch 'main' into copilot/implement-usethis-tool-zensical
nathanjmcdougall 83d4997
Merge branch 'main' into copilot/implement-usethis-tool-zensical
nathanjmcdougall b737df6
Register ZensicalTool in use_tool dispatch in src/_test.py
Copilot 6771444
Register ZensicalTool in use_tool and remove dead OTHER_TOOLS list
Copilot e280165
Fix broken references to the moved `_test` module
nathanjmcdougall 2d8bca6
Fix test failures: add ZensicalToolSpec to ALL_TOOL_SPECS and update …
Copilot 04d93c7
Fix dogfooding: remove MkDocsYMLManager from ZensicalToolSpec config …
Copilot 75aa9f2
Revert MkDocsYMLManager removal and fix empty zensical.toml creation
Copilot 099af08
Fix typo in `CONTRIBUTING.md`
nathanjmcdougall File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| """Zensical tool implementation.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from typing import final | ||
|
|
||
| from typing_extensions import assert_never, override | ||
|
|
||
| from usethis._backend.dispatch import get_backend | ||
| from usethis._backend.poetry.detect import is_poetry_used | ||
| from usethis._backend.uv.detect import is_uv_used | ||
| from usethis._console import how_print | ||
| from usethis._tool.base import Tool | ||
| from usethis._tool.impl.spec.zensical import ZensicalToolSpec | ||
| from usethis._types.backend import BackendEnum | ||
|
|
||
|
|
||
| @final | ||
| class ZensicalTool(ZensicalToolSpec, Tool): | ||
| @override | ||
| def print_how_to_use(self) -> None: | ||
| backend = get_backend() | ||
| if backend is BackendEnum.uv and is_uv_used(): | ||
| how_print("Run 'uv run zensical build' to build the documentation.") | ||
| how_print("Run 'uv run zensical serve' to serve the documentation locally.") | ||
| elif backend is BackendEnum.poetry and is_poetry_used(): | ||
| how_print("Run 'poetry run zensical build' to build the documentation.") | ||
| how_print( | ||
| "Run 'poetry run zensical serve' to serve the documentation locally." | ||
| ) | ||
| elif backend in (BackendEnum.none, BackendEnum.uv, BackendEnum.poetry): | ||
| how_print("Run 'zensical build' to build the documentation.") | ||
| how_print("Run 'zensical serve' to serve the documentation locally.") | ||
| else: | ||
| assert_never(backend) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
use_zensical(remove=True)assumes configs only live in managed files, butZensicalToolSpec.config_spec()can selectmkdocs.ymlas the active config file. In that case, removing Zensical currently leaves behind managed config entries inmkdocs.ymland can cause the tool to still be detected as used. Consider adjusting the removal path (e.g., calltool.remove_configs()with care) and/or changing which config items are considered managed so removal and usage detection behave consistently.