Don't dump full stack trace when there are file validation errors (#768)

nathanjmcdougall · web-flow · commit 6c7a78bd0e1c · 2025-06-20T15:25:00.000+12:00
diff --git a/src/usethis/_integrations/ci/bitbucket/io_.py b/src/usethis/_integrations/ci/bitbucket/io_.py
@@ -10,6 +10,7 @@
 from usethis._console import tick_print
 from usethis._integrations.ci.bitbucket.schema import PipelinesConfiguration
 from usethis._integrations.file.yaml.io_ import edit_yaml
+from usethis.errors import FileConfigError
 
 if TYPE_CHECKING:
     from collections.abc import Generator
@@ -20,9 +21,14 @@
     from usethis._integrations.file.yaml.io_ import YAMLLiteral
 
 
-class BitbucketPipelinesYAMLConfigError(Exception):
+class BitbucketPipelinesYAMLConfigError(FileConfigError):
     """Raised when there the 'bitbucket-pipelines.yml' file fails validation."""
 
+    @property
+    def name(self) -> str:
+        """The name of the file that has a configuration error."""
+        return "bitbucket-pipelines.yml"
+
 
 @dataclass
 class BitbucketPipelinesYAMLDocument:
diff --git a/src/usethis/_integrations/file/pyproject_toml/errors.py b/src/usethis/_integrations/file/pyproject_toml/errors.py
@@ -9,6 +9,7 @@
     UnexpectedTOMLIOError,
     UnexpectedTOMLOpenError,
 )
+from usethis.errors import FileConfigError
 
 
 class PyprojectTOMLError(TOMLError):
@@ -40,9 +41,14 @@ class UnexpectedPyprojectTOMLIOError(PyprojectTOMLError, UnexpectedTOMLIOError):
     """Raised when an unexpected attempt is made to read or write the pyproject.toml file."""
 
 
-class PyprojectTOMLProjectSectionError(PyprojectTOMLError):
+class PyprojectTOMLProjectSectionError(FileConfigError, PyprojectTOMLError):
     """Raised when the 'project' section is missing or invalid in 'pyproject.toml'."""
 
+    @property
+    def name(self) -> str:
+        """The name of the file that has a configuration error."""
+        return "pyproject.toml"
+
 
 class PyprojectTOMLProjectNameError(PyprojectTOMLProjectSectionError):
     """Raised when the 'project.name' key is missing or invalid in 'pyproject.toml'."""
diff --git a/src/usethis/_integrations/pre_commit/io_.py b/src/usethis/_integrations/pre_commit/io_.py
@@ -10,6 +10,7 @@
 from usethis._console import tick_print
 from usethis._integrations.file.yaml.io_ import edit_yaml
 from usethis._integrations.pre_commit.schema import JsonSchemaForPreCommitConfigYaml
+from usethis.errors import FileConfigError
 
 if TYPE_CHECKING:
     from collections.abc import Generator
@@ -19,9 +20,14 @@
     from usethis._integrations.file.yaml.io_ import YAMLLiteral
 
 
-class PreCommitConfigYAMLConfigError(Exception):
+class PreCommitConfigYAMLConfigError(FileConfigError):
     """Raised when there the 'bitbucket-pipelines.yml' file fails validation."""
 
+    @property
+    def name(self) -> str:
+        """The name of the file that has a configuration error."""
+        return ".pre-commit-config.yaml"
+
 
 @dataclass
 class PreCommitConfigYAMLDocument:
diff --git a/src/usethis/errors.py b/src/usethis/errors.py
@@ -7,7 +7,20 @@ class UsethisError(Exception):
     """Base class for all errors."""
 
 
-class FileDecodeError(UsethisError):
+class FileConfigError(UsethisError):
+    """Raised when there is an error in a file configuration."""
+
+    @property
+    def name(self) -> str:
+        """The name of the file that has a configuration error.
+
+        This is not necessarily defined for all subclasses, and will raise
+        NotImplementedError if not overridden.
+        """
+        raise NotImplementedError
+
+
+class FileDecodeError(FileConfigError):
     """Raised when a file is unexpectedly not decodable."""
 
     @property
