Add linters and formatters to CI when pre-commit isn't used (#249)

* Add linters and formatters to CI when pre-commit isn't used

* Fix tool add order

Author: nathanjmcdougall

src/usethis/_ci.py

@@ -4,9 +4,9 @@
 from usethis._integrations.bitbucket.anchor import ScriptItemAnchor
 from usethis._integrations.bitbucket.schema import Script, Step
 from usethis._integrations.bitbucket.steps import (
-    add_step_in_default,
+    add_bitbucket_step_in_default,
     get_steps_in_default,
-    remove_step_from_default,
+    remove_bitbucket_step_from_default,
 )
 from usethis._integrations.uv.python import get_supported_major_python_versions
 
@@ -15,22 +15,54 @@ def is_bitbucket_used() -> bool:
     return (Path.cwd() / "bitbucket-pipelines.yml").exists()
 
 
-def add_bitbucket_pre_commit_step() -> None:
-    add_step_in_default(_get_bitbucket_pre_commit_step())
+def get_bitbucket_pre_commit_step() -> Step:
+    return Step(
+        name="Run pre-commit",
+        caches=["uv", "pre-commit"],
+        script=Script(
+            [
+                ScriptItemAnchor(name="install-uv"),
+                "uv run pre-commit run --all-files",
+            ]
+        ),
+    )
 
 
-def remove_bitbucket_pre_commit_step() -> None:
-    remove_step_from_default(_get_bitbucket_pre_commit_step())
+def get_bitbucket_ruff_step() -> Step:
+    return Step(
+        name="Run Ruff",
+        caches=["uv"],
+        script=Script(
+            [
+                ScriptItemAnchor(name="install-uv"),
+                "uv run ruff check --fix",
+                "uv run ruff format",
+            ]
+        ),
+    )
 
 
-def _get_bitbucket_pre_commit_step() -> Step:
+def get_bitbucket_deptry_step() -> Step:
     return Step(
-        name="Run pre-commit",
-        caches=["uv", "pre-commit"],
+        name="Run Deptry",
+        caches=["uv"],
         script=Script(
             [
                 ScriptItemAnchor(name="install-uv"),
-                "uv run pre-commit run --all-files",
+                "uv run deptry src",
+            ]
+        ),
+    )
+
+
+def get_bitbucket_pyproject_fmt_step() -> Step:
+    return Step(
+        name="Run pyproject-fmt",
+        caches=["uv"],
+        script=Script(
+            [
+                ScriptItemAnchor(name="install-uv"),
+                "uv run pyproject-fmt pyproject.toml",
             ]
         ),
     )
@@ -39,7 +71,7 @@ def _get_bitbucket_pre_commit_step() -> Step:
 def update_bitbucket_pytest_steps() -> None:
     matrix = get_supported_major_python_versions()
     for version in matrix:
-        add_step_in_default(
+        add_bitbucket_step_in_default(
             Step(
                 name=f"Test on 3.{version}",
                 caches=["uv"],
@@ -58,11 +90,11 @@ def update_bitbucket_pytest_steps() -> None:
             if match:
                 version = int(match.group(1))
                 if version not in matrix:
-                    remove_step_from_default(step)
+                    remove_bitbucket_step_from_default(step)
 
 
 def remove_bitbucket_pytest_steps() -> None:
     # Remove any with pattern "^Test on 3.\d+$"
     for step in get_steps_in_default():
         if step.name is not None and re.match(r"^Test on 3.\d+$", step.name):
-            remove_step_from_default(step)
+            remove_bitbucket_step_from_default(step)

src/usethis/_core/ci.py

@@ -1,14 +1,24 @@
 from usethis._ci import (
-    add_bitbucket_pre_commit_step,
+    get_bitbucket_deptry_step,
+    get_bitbucket_pre_commit_step,
+    get_bitbucket_pyproject_fmt_step,
+    get_bitbucket_ruff_step,
     update_bitbucket_pytest_steps,
 )
 from usethis._console import box_print, info_print
 from usethis._integrations.bitbucket.config import (
     add_bitbucket_pipeline_config,
     remove_bitbucket_pipeline_config,
 )
+from usethis._integrations.bitbucket.steps import add_bitbucket_step_in_default
 from usethis._integrations.uv.init import ensure_pyproject_toml
-from usethis._tool import PreCommitTool, PytestTool
+from usethis._tool import (
+    DeptryTool,
+    PreCommitTool,
+    PyprojectFmtTool,
+    PytestTool,
+    RuffTool,
+)
 
 
 def use_ci_bitbucket(*, remove: bool = False) -> None:
@@ -17,12 +27,26 @@ def use_ci_bitbucket(*, remove: bool = False) -> None:
     if not remove:
         use_pre_commit = PreCommitTool().is_used()
         use_pytest = PytestTool().is_used()
-        use_any_tool = use_pre_commit or use_pytest
+        use_ruff = RuffTool().is_used()
+        use_deptry = DeptryTool().is_used()
+        use_pyproject_fmt = PyprojectFmtTool().is_used()
+        use_any_tool = (
+            use_pre_commit or use_pytest or use_ruff or use_deptry or use_pyproject_fmt
+        )
 
         add_bitbucket_pipeline_config(report_placeholder=not use_any_tool)
 
         if use_pre_commit:
-            add_bitbucket_pre_commit_step()
+            add_bitbucket_step_in_default(get_bitbucket_pre_commit_step())
+        else:
+            # This order should match the canonical order in the function which add
+            # steps
+            if use_pyproject_fmt:
+                add_bitbucket_step_in_default(get_bitbucket_pyproject_fmt_step())
+            if use_ruff:
+                add_bitbucket_step_in_default(get_bitbucket_ruff_step())
+            if use_deptry:
+                add_bitbucket_step_in_default(get_bitbucket_deptry_step())
 
         if use_pytest:
             update_bitbucket_pytest_steps()

src/usethis/_core/tool.py

@@ -1,13 +1,19 @@
 from pathlib import Path
 
 from usethis._ci import (
-    add_bitbucket_pre_commit_step,
+    get_bitbucket_deptry_step,
+    get_bitbucket_pre_commit_step,
+    get_bitbucket_pyproject_fmt_step,
+    get_bitbucket_ruff_step,
     is_bitbucket_used,
-    remove_bitbucket_pre_commit_step,
     remove_bitbucket_pytest_steps,
     update_bitbucket_pytest_steps,
 )
 from usethis._console import box_print, tick_print
+from usethis._integrations.bitbucket.steps import (
+    add_bitbucket_step_in_default,
+    remove_bitbucket_step_from_default,
+)
 from usethis._integrations.pre_commit.core import (
     install_pre_commit_hooks,
     remove_pre_commit_config,
@@ -78,11 +84,14 @@ def use_deptry(*, remove: bool = False) -> None:
         add_deps_to_group(tool.dev_deps, "dev")
         if PreCommitTool().is_used():
             tool.add_pre_commit_repo_configs()
+        elif is_bitbucket_used():
+            add_bitbucket_step_in_default(get_bitbucket_deptry_step())
 
         box_print("Run 'deptry src' to run deptry.")
     else:
-        if PreCommitTool().is_used():
-            tool.remove_pre_commit_repo_configs()
+        tool.remove_pre_commit_repo_configs()
+        remove_bitbucket_step_from_default(get_bitbucket_deptry_step())
+
         remove_deps_from_group(tool.dev_deps, "dev")
 
 
@@ -113,12 +122,14 @@ def use_pre_commit(*, remove: bool = False) -> None:
         install_pre_commit_hooks()
 
         if is_bitbucket_used():
-            add_bitbucket_pre_commit_step()
+            add_bitbucket_step_in_default(get_bitbucket_pre_commit_step())
+            _remove_bitbucket_linter_steps_from_default()
 
         box_print("Run 'pre-commit run --all-files' to run the hooks manually.")
     else:
         if is_bitbucket_used():
-            remove_bitbucket_pre_commit_step()
+            remove_bitbucket_step_from_default(get_bitbucket_pre_commit_step())
+            _add_bitbucket_linter_steps_to_default()
 
         # Need pre-commit to be installed so we can uninstall hooks
         add_deps_to_group(tool.dev_deps, "dev")
@@ -139,6 +150,26 @@ def use_pre_commit(*, remove: bool = False) -> None:
             _requirements_txt_instructions_basic()
 
 
+def _add_bitbucket_linter_steps_to_default() -> None:
+    # This order of adding tools should be synced with the order hard-coded
+    # in the function which adds steps.
+    if is_bitbucket_used():
+        if PyprojectFmtTool().is_used():
+            add_bitbucket_step_in_default(get_bitbucket_pyproject_fmt_step())
+        if DeptryTool().is_used():
+            add_bitbucket_step_in_default(get_bitbucket_deptry_step())
+        if RuffTool().is_used():
+            add_bitbucket_step_in_default(get_bitbucket_ruff_step())
+
+
+def _remove_bitbucket_linter_steps_from_default() -> None:
+    # This order of removing tools should be synced with the order hard-coded
+    # in the function which adds steps.
+    remove_bitbucket_step_from_default(get_bitbucket_pyproject_fmt_step())
+    remove_bitbucket_step_from_default(get_bitbucket_deptry_step())
+    remove_bitbucket_step_from_default(get_bitbucket_ruff_step())
+
+
 def use_pyproject_fmt(*, remove: bool = False) -> None:
     tool = PyprojectFmtTool()
 
@@ -149,6 +180,8 @@ def use_pyproject_fmt(*, remove: bool = False) -> None:
 
         if not is_pre_commit:
             add_deps_to_group(tool.dev_deps, "dev")
+            if is_bitbucket_used():
+                add_bitbucket_step_in_default(get_bitbucket_pyproject_fmt_step())
         else:
             tool.add_pre_commit_repo_configs()
 
@@ -159,9 +192,9 @@ def use_pyproject_fmt(*, remove: bool = False) -> None:
         else:
             _pyproject_fmt_instructions_pre_commit()
     else:
+        remove_bitbucket_step_from_default(get_bitbucket_pyproject_fmt_step())
         tool.remove_pyproject_configs()
-        if PreCommitTool().is_used():
-            tool.remove_pre_commit_repo_configs()
+        tool.remove_pre_commit_repo_configs()
         remove_deps_from_group(tool.dev_deps, "dev")
 
 
@@ -252,8 +285,7 @@ def use_requirements_txt(*, remove: bool = False) -> None:
         else:
             _requirements_txt_instructions_pre_commit()
     else:
-        if PreCommitTool().is_used():
-            tool.remove_pre_commit_repo_configs()
+        tool.remove_pre_commit_repo_configs()
 
         if path.exists() and path.is_file():
             tick_print("Removing 'requirements.txt'.")
@@ -306,11 +338,13 @@ def use_ruff(*, remove: bool = False) -> None:
         ignore_ruff_rules(ignored_rules)
         if PreCommitTool().is_used():
             tool.add_pre_commit_repo_configs()
+        elif is_bitbucket_used():
+            add_bitbucket_step_in_default(get_bitbucket_ruff_step())
 
         box_print("Run 'ruff check --fix' to run the Ruff linter with autofixes.")
         box_print("Run 'ruff format' to run the Ruff formatter.")
     else:
-        if PreCommitTool().is_used():
-            tool.remove_pre_commit_repo_configs()
+        tool.remove_pre_commit_repo_configs()
+        remove_bitbucket_step_from_default(get_bitbucket_ruff_step())
         tool.remove_pyproject_configs()  # N.B. this will remove the selected Ruff rules
         remove_deps_from_group(tool.dev_deps, "dev")

src/usethis/_integrations/bitbucket/steps.py

@@ -59,7 +59,7 @@
     script_item.yaml_set_anchor(value=name, always_dump=True)
 
 
-def add_step_in_default(step: Step) -> None:
+def add_bitbucket_step_in_default(step: Step) -> None:
     try:
         existing_steps = get_steps_in_default()
     except UnexpectedImportPipelineError:
@@ -88,7 +88,7 @@ def add_step_in_default(step: Step) -> None:
     placeholder = _get_placeholder_step()
     if not _steps_are_equivalent(placeholder, step):
         # Only remove the placeholder if it hasn't already been added.
-        remove_step_from_default(placeholder)
+        remove_bitbucket_step_from_default(placeholder)
 
 
 def _add_step_in_default_via_doc(
@@ -154,9 +154,12 @@ def _add_step_in_default_via_doc(
     # See https://github.com/nathanjmcdougall/usethis-python/issues/149
     step_order = [
         "Run pre-commit",
+        # For these tools, sync them with the pre-commit removal logic
+        "Run pyproject-fmt",
+        "Run Ruff",
+        "Run Deptry",
         *[f"Test on 3.{maj}" for maj in get_supported_major_python_versions()],
     ]
-
     for step_name in step_order:
         if step_name == step.name:
             break
@@ -173,7 +176,7 @@ def _add_step_in_default_via_doc(
         )
 
 
-def remove_step_from_default(step: Step) -> None:
+def remove_bitbucket_step_from_default(step: Step) -> None:
     """Remove a step from the default pipeline in the Bitbucket Pipelines configuration.
 
     If the default pipeline does not exist, or the step is not found, nothing happens.
@@ -402,7 +405,7 @@ def _(item: StageItem) -> list[Step]:
 
 
 def add_placeholder_step_in_default(report_placeholder: bool = True) -> None:
-    add_step_in_default(_get_placeholder_step())
+    add_bitbucket_step_in_default(_get_placeholder_step())
 
     if report_placeholder:
         tick_print(