ts-backend-check 1.2.0__py3-none-any.whl → 1.2.2__py3-none-any.whl

ts_backend_check/checker.py

@@ -29,7 +29,7 @@ class TypeChecker:
         self.model_fields = extract_model_fields(models_file)
         self.ts_parser = TypeScriptParser(types_file)
         self.ts_interfaces = self.ts_parser.parse_interfaces()
-        self.backend_only = self.ts_parser.get_backend_only_fields()
+        self.backend_only = self.ts_parser.get_ignored_fields()
 
     def check(self) -> List[str]:
         """
@@ -177,9 +177,12 @@ class TypeChecker:
             The message displayed to the user when missing fields are found.
         """
         camel_field = snake_to_camel(input_str=field)
+        interface_of_interfaces = (
+            "interface" if len(interfaces.keys()) == 1 else "interfaces"
+        )
+
         return (
-            f"\nField '{field}' (camelCase: '{camel_field}') from model '{model_name}' is missing in TypeScript types."
-            f"\nExpected to find in interface(s): {', '.join(interfaces.keys())}"
-            f"\nTo ignore this field, add a comment that references it like: '// Note: {camel_field} is backend only'"
-            "\n"
+            f"\nField '{field}' (camelCase: '{camel_field}') from model '{model_name}' is missing in the TypeScript interfaces."
+            f"\nExpected to find this field in the frontend {interface_of_interfaces}: {', '.join(interfaces.keys())}"
+            f"\nTo ignore this field, add the following comment to the TypeScript file: '// ts-backend-check: ignore field {camel_field}'"
         )

ts_backend_check/cli/main.py

@@ -124,7 +124,7 @@ def main() -> None:
 
         if missing := checker.check():
             rprint(
-                "\n[red]❌ ts-backend-check error: Missing typescript fields found:[/red]\n"
+                "\n[red]❌ ts-backend-check error: There are inconsistencies between the provided backend models and TypeScript interfaces. Please see the output below for details.[/red]"
             )
 
             # Print each error message in red.
@@ -133,12 +133,12 @@ def main() -> None:
 
             field_or_fields = "fields" if len(missing) > 1 else "field"
             rprint(
-                f"\n[red]Please fix the {len(missing)} {field_or_fields} above to have the backend models synced with the typescript interfaces.[/red]"
+                f"[red]\nPlease fix the {len(missing)} {field_or_fields} above to have the backend models of {args.backend_model_file} synced with the typescript interfaces of {(args.typescript_file)}.[/red]"
             )
             sys.exit(1)
 
         rprint(
-            "[green]✅ Success: All models are synced with their corresponding TypeScript interfaces.[/green]"
+            "[green]✅ Success: All backend models are synced with their corresponding TypeScript interfaces for the provided files.[/green]"
         )
 
 

ts_backend_check/parsers/typescript_parser.py

@@ -60,24 +60,17 @@ class TypeScriptParser:
 
         return interfaces
 
-    def get_backend_only_fields(self) -> Set[str]:
+    def get_ignored_fields(self) -> Set[str]:
         """
-        Extract fields marked as backend-only in comments.
+        Extract fields marked as ignored in comments.
 
         Returns
         -------
         Set[str]
-            The field names that are marked with a backend-only identifier to ignore them.
+            The field names that are marked with a ts-backend-check-ignore identifier to ignore them.
         """
-        patterns = [
-            r"//.*?Note:\s*(\w+)\s+is\s+backend\s+only",
-            r"//.*?(\w+)\s+is\s+backend\s+only",
-            r"//\s*@backend-only\s+(\w+)",
-            r"//.*?backend-only:\s*(\w+)",
-        ]
-        return {
-            match for pattern in patterns for match in re.findall(pattern, self.content)
-        }
+        ignore_pattern = r"//.*?ts-backend-check: ignore field\s+(\w+)"
+        return set(re.findall(ignore_pattern, self.content))
 
     @staticmethod
     def _extract_fields(interface_body: str) -> Set[str]:

{ts_backend_check-1.2.0.dist-info → ts_backend_check-1.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ts-backend-check
-Version: 1.2.0
+Version: 1.2.2
 Summary: Check TypeScript types against their corresponding backend models to assure that all fields have been accounted for.
 Home-page: https://github.com/activist-org/ts-backend-check
 Author: ts-backend-check developers
@@ -95,9 +95,25 @@ ts-backend-check --help
 
 # Check a TypeScript type against a backend model:
 ts-backend-check -bmf <backend-model-file> -tsf <typescript-file>
+```
+
+Example success and error outputs for the CLI are:
+
+```
+ts-backend-check -bmf backend/models/user.py -tsf frontend/types/user.ts
+✅ Success: All backend models are synced with their corresponding TypeScript interfaces for the provided files.
+```
+
+```
+ts-backend-check -bmf backend/models/user.py -tsf frontend/types/user.ts
+
+❌ ts-backend-check error: There are inconsistencies between the provided backend models and TypeScript interfaces. Please see the output below for details.
+
+Field 'user_name' (camelCase: 'userName') from model 'UserModel' is missing in the TypeScript interfaces.
+Expected to find this field in the frontend interface: User
+To ignore this field, add the following comment to the TypeScript interface: '// ts-backend-check: ignore field userName'
 
-# Example command:
-ts-backend-check -bmf src/models/user.py -tsf src/types/user.ts
+Please fix the 1 field above to have the backend models of backend/models/user.py synced with the typescript interfaces of frontend/types/user.ts.
 ```
 
 <a id="contributing-"></a>

{ts_backend_check-1.2.0.dist-info → ts_backend_check-1.2.2.dist-info}/RECORD

@@ -1,21 +1,21 @@
 ts_backend_check/__init__.py,sha256=HSiEqWvU3Q4a6D7tYsoq3-B-g1HdUOGngEeGV45j8ak,172
-ts_backend_check/checker.py,sha256=ISPl_1H7dXb7DcOl6erdxEhx61xQBJxtHuYkUuEqrck,5792
+ts_backend_check/checker.py,sha256=4QtPdiEnpRVIO4BpcHeCz-sjG2bqTg43M4gfntRnHj4,5956
 ts_backend_check/django_parser.py,sha256=CFg4-zV5BsVhuq-nVQEYD9nS25JSaHbIs2Xr3LE3KWY,3241
 ts_backend_check/typescript_parser.py,sha256=BqBGOjsf-Wlh6ceaK-G2vLm5AMiEiwX-XnJQrr8P-gQ,2885
 ts_backend_check/utils.py,sha256=N9_25_wW2g3dkmGGLWHQj_AHsXI9Rx2XqRnYxT5i2Rk,897
 ts_backend_check/cli/__init__.py,sha256=wJK9tO9MtI10L0xRjrk7WP_qZZRBjbFw1U9jJbIbX7I,108
 ts_backend_check/cli/check_blank.py,sha256=gg6v01UYNmzs8eLasxauCaBCfN9esUtiAwqhqNTzE3w,3377
 ts_backend_check/cli/config.py,sha256=AgzjY3qbgW4ya5JJEdKaBQ9J8h0Ip-39xJNbAjFpA6s,4463
-ts_backend_check/cli/main.py,sha256=6g9Rf_m5H2cWUoPYPU_HEmkoUl6SLLai1Ni2BpgDz6U,4222
+ts_backend_check/cli/main.py,sha256=-MlRG8syI6BMv1CBgXyfenlx6YS0cIKW4vhuQX_C77Q,4405
 ts_backend_check/cli/upgrade.py,sha256=P2LdIDCLdOFs-fOMuKLQoUMijQIyKEIA5PFZVsAUwDg,2952
 ts_backend_check/cli/version.py,sha256=lsocMaxAfF-FHW9O-NGH1sAo6svjuLgdGFxaC-XVoZc,2845
 ts_backend_check/parsers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ts_backend_check/parsers/django_parser.py,sha256=U5OP6IyrSdwI9rDUGU4GbWTDfozwhretWg7lmF6QGB8,3242
-ts_backend_check/parsers/typescript_parser.py,sha256=BqBGOjsf-Wlh6ceaK-G2vLm5AMiEiwX-XnJQrr8P-gQ,2885
-ts_backend_check-1.2.0.data/data/requirements.txt,sha256=ixdwNPm86WRSX0oBBaNegCQL7HQP8evsCRAdEFHLxGk,540
-ts_backend_check-1.2.0.dist-info/licenses/LICENSE.txt,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-ts_backend_check-1.2.0.dist-info/METADATA,sha256=FDqxUd_nslUpUNEtk5sAHxEkATcDVkUAJkBMVYkf0rA,10416
-ts_backend_check-1.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ts_backend_check-1.2.0.dist-info/entry_points.txt,sha256=QeY7RJu20otBnQlhMMZxPL8nB3mP3M3U3h3nOlSFWSU,68
-ts_backend_check-1.2.0.dist-info/top_level.txt,sha256=VzfNWQ3fPNdl-OBdtUKsUWR8Asdd27E3OJNUg2oQU8Y,17
-ts_backend_check-1.2.0.dist-info/RECORD,,
+ts_backend_check/parsers/typescript_parser.py,sha256=UAExnEKxuFREFY6bJgQreG0b7SyVhWRaHw5TjN0CSU4,2680
+ts_backend_check-1.2.2.data/data/requirements.txt,sha256=ixdwNPm86WRSX0oBBaNegCQL7HQP8evsCRAdEFHLxGk,540
+ts_backend_check-1.2.2.dist-info/licenses/LICENSE.txt,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+ts_backend_check-1.2.2.dist-info/METADATA,sha256=oiQpyko2T9eKhHPZlC6GOFFUoYipxqtT6ay-NoltxaM,11258
+ts_backend_check-1.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ts_backend_check-1.2.2.dist-info/entry_points.txt,sha256=QeY7RJu20otBnQlhMMZxPL8nB3mP3M3U3h3nOlSFWSU,68
+ts_backend_check-1.2.2.dist-info/top_level.txt,sha256=VzfNWQ3fPNdl-OBdtUKsUWR8Asdd27E3OJNUg2oQU8Y,17
+ts_backend_check-1.2.2.dist-info/RECORD,,