Modify project:fix to format:fix

ArBridgeman · ArBridgeman · commit ad53fdea2fd0 · 2025-11-27T09:10:24.000+01:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -8,7 +8,7 @@ repos:
         types: [ python ]
         pass_filenames: false
         language: system
-        entry: poetry run -- nox -s project:fix
+        entry: poetry run -- nox -s format:fix
         stages: [ pre-commit ]
 
   - repo: local
@@ -39,4 +39,4 @@ repos:
       - id: end-of-file-fixer
         stages: [ pre-commit ]
       - id: trailing-whitespace
-        stages: [ pre-commit ]
+        stages: [ pre-commit ]
diff --git a/doc/changes/unreleased.md b/doc/changes/unreleased.md
@@ -1 +1,5 @@
 # Unreleased
+
+## Refactoring
+
+* #606: Renamed nox session `project:fix` more aptly to `format:fix`
diff --git a/doc/user_guide/features/formatting_code/index.rst b/doc/user_guide/features/formatting_code/index.rst
@@ -38,7 +38,7 @@ deterministic manner.
 +--------------------+------------------+------------------------------------+
 | Nox session        | CI Usage         | Action                             |
 +====================+==================+====================================+
-| ``project:fix``    | No               | Applies code formatting changes    |
+| ``format:fix``     | No               | Applies code formatting changes    |
 +--------------------+------------------+------------------------------------+
 | ``project:format`` | ``checks.yml``   | Checks that current code does not  |
 |                    |                  | need to be re-formatted            |
diff --git a/doc/user_guide/features/formatting_code/troubleshooting.rst b/doc/user_guide/features/formatting_code/troubleshooting.rst
@@ -3,12 +3,12 @@
 Troubleshooting
 ===============
 
-Formatting still fails after running ``project:fix``
+Formatting still fails after running ``format:fix``
 ----------------------------------------------------
 
 If when you execute:
 
-#. Run ``project:fix``
+#. Run ``format:fix``
 #. Run ``project:format``
 
 you receive an error from ``project:format`` (i.e. ``isort`` or ``black``), it it
diff --git a/doc/user_guide/migrating.rst b/doc/user_guide/migrating.rst
@@ -63,9 +63,9 @@ For example, if test execution isn't performed in the standard way (e.g., :code:
     from exasol.toolbox.nox.tasks import *  # pylint: disable=wildcard-import disable=unused-wildcard-import
 
     # default actions to be run if nothing is explicitly specified with the -s option
-    nox.options.sessions = ["project:fix"]
+    nox.options.sessions = ["format:fix"]
 
-    @nox.session(name="project:fix", python=False)
+    @nox.session(name="format:fix", python=False)
     def my_project_fix_overwrite(session) -> None:
         """Runs all automated fixes on the code base"""
 
@@ -75,7 +75,7 @@ For example, if test execution isn't performed in the standard way (e.g., :code:
         from exasol.toolbox.nox._shared import python_files
 
         py_files = [f"{file}" for file in python_files(PROJECT_CONFIG.root)]
-        print("The original 'project:fix' task has been taken hostage by this overwrite")
+        print("The original 'format:fix' task has been taken hostage by this overwrite")
         print("Files:\n{files}".format(files="\n".join(py_files))
 
 
diff --git a/exasol/toolbox/nox/_format.py b/exasol/toolbox/nox/_format.py
@@ -42,7 +42,7 @@ def command(*args: str) -> Iterable[str]:
     session.run(*command("ruff", "check"), *files)
 
 
-@nox.session(name="project:fix", python=False)
+@nox.session(name="format:fix", python=False)
 def fix(session: Session) -> None:
     """Runs all automated fixes on the code base"""
     py_files = python_files(PROJECT_CONFIG.root)
diff --git a/exasol/toolbox/nox/_package_version.py b/exasol/toolbox/nox/_package_version.py
@@ -23,7 +23,7 @@
     """
     ATTENTION:
         This file is generated by exasol/toolbox/nox/_package_version.py when using:
-            * either "poetry run -- nox -s project:fix"
+            * either "poetry run -- nox -s format:fix"
             * or "poetry run -- nox -s version:check -- --fix"
     Do not edit this file manually!
     If you need to change the version, do so in the pyproject.toml, e.g. by using
diff --git a/exasol/toolbox/templates/noxfile.py b/exasol/toolbox/templates/noxfile.py
@@ -4,4 +4,4 @@
 from exasol.toolbox.nox.tasks import *
 
 # default actions to be run if nothing is explicitly specified with the -s option
-nox.options.sessions = ["project:fix"]
+nox.options.sessions = ["format:fix"]
diff --git a/exasol/toolbox/templates/pre-commit-config.yaml b/exasol/toolbox/templates/pre-commit-config.yaml
@@ -8,7 +8,7 @@ repos:
         types: [ python ]
         pass_filenames: false
         language: system
-        entry: poetry run -- nox -s project:fix
+        entry: poetry run -- nox -s format:fix
 
   - repo: local
     hooks:
diff --git a/exasol/toolbox/version.py b/exasol/toolbox/version.py
diff --git a/noxfile.py b/noxfile.py
@@ -6,7 +6,7 @@
 from exasol.toolbox.nox.tasks import *  # pylint: disable=wildcard-import disable=unused-wildcard-import
 
 # default actions to be run if nothing is explicitly specified with the -s option
-nox.options.sessions = ["project:fix"]
+nox.options.sessions = ["format:fix"]
 
 
 # entry point for debugging
diff --git a/project-template/{{cookiecutter.repo_name}}/.pre-commit-config.yaml b/project-template/{{cookiecutter.repo_name}}/.pre-commit-config.yaml
@@ -8,7 +8,7 @@ repos:
         types: [ python ]
         pass_filenames: false
         language: system
-        entry: poetry run -- nox -s project:fix
+        entry: poetry run -- nox -s format:fix
         stages: [ pre-commit ]
 
   - repo: local
@@ -39,4 +39,4 @@ repos:
       - id: end-of-file-fixer
         stages: [ pre-commit ]
       - id: trailing-whitespace
-        stages: [ pre-commit ]
+        stages: [ pre-commit ]
diff --git a/project-template/{{cookiecutter.repo_name}}/exasol/{{cookiecutter.package_name}}/version.py b/project-template/{{cookiecutter.repo_name}}/exasol/{{cookiecutter.package_name}}/version.py
@@ -1,6 +1,6 @@
 """ATTENTION:
 This file is generated by exasol/toolbox/nox/_package_version.py when using:
-   * either "poetry run -- nox -s project:fix"
+   * either "poetry run -- nox -s format:fix"
    * or "poetry run -- nox -s version:check -- --fix"
 Do not edit this file manually!
 If you need to change the version, do so in the pyproject.toml, e.g. by using
diff --git a/project-template/{{cookiecutter.repo_name}}/noxfile.py b/project-template/{{cookiecutter.repo_name}}/noxfile.py
@@ -4,4 +4,4 @@
 from exasol.toolbox.nox.tasks import *
 
 # default actions to be run if nothing is explicitly specified with the -s option
-nox.options.sessions = ["project:fix"]
+nox.options.sessions = ["format:fix"]
diff --git a/test/unit/nox/_format_test.py b/test/unit/nox/_format_test.py
@@ -120,7 +120,7 @@ def test_mode_check(nox_session, file_with_unneeded_import, caplog):
 def file_with_multiple_problems(tmp_path):
     """
     In this file with multiple problems, it is expected that the nox session
-    `project:fix` would alter the following:
+    `format:fix` would alter the following:
 
     * x: Union[int, str]=2
        * This should be altered to `x: int | str = 2` via pyupgrade.
