style: use pre-commit to enforce line endings/etc (#2005)

svix-jbrown · web-flow · commit 6647f5493ad9 · 2025-08-18T12:33:51.000-07:00
This sets up [`pre-commit`](https://pre-commit.com/) to enforce line endings, trailing whitespace, bad symlinks, and other surface-level details. It also fixes all existing violations.
diff --git a/.github/linters/phpcs.xml b/.github/linters/phpcs.xml
@@ -5,4 +5,4 @@
     <rule ref="PSR12">
         <exclude name="PSR12.Properties.ConstantVisibility" />
     </rule>
-</ruleset>
+</ruleset>
diff --git a/.github/linters/sun_checks.xml b/.github/linters/sun_checks.xml
@@ -154,7 +154,7 @@
 
     <!-- Checks for class design                         -->
     <!-- See https://checkstyle.org/config_design.html -->
-    <!-- TODO re-enable once we Javadoc <module name="DesignForExtension"/> --> 
+    <!-- TODO re-enable once we Javadoc <module name="DesignForExtension"/> -->
     <module name="FinalClass"/>
     <module name="HideUtilityClassConstructor"/>
     <module name="InterfaceIsType"/>
@@ -175,4 +175,4 @@
 
   </module>
 
-</module>
+</module>
diff --git a/.github/workflows/mega-releaser.yml b/.github/workflows/mega-releaser.yml
@@ -8,4 +8,4 @@ jobs:
     name: Kick-off Releases
     runs-on: ubuntu-latest
     steps:
-      - run: /bin/true
+      - run: /bin/true
diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
@@ -0,0 +1,16 @@
+name: pre-commit
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  typos:
+    name: Validate pre-commit
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+      - uses: pre-commit/action@v3.0.1
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,16 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: 582b9c66e0791980685c8b80bb11e6a3df1a06ef
+    hooks:
+    - id: end-of-file-fixer
+      exclude: "(^.yarn/)|(.svg$)|(-openapi.json)|(java/lib/src/test/resources/__files/)|(kotlin/lib/src/test/resources/__files/)|(server/svix-server/migrations/202[234])"
+    - id: trailing-whitespace
+      exclude: "(^.yarn/)|(.svg$)|(-openapi.json)|(java/lib/src/test/resources/__files/)|(kotlin/lib/src/test/resources/__files/)|(svix-cli/wix/main.wxs)|(server/svix-server/migrations/202[234])"
+    - id: check-case-conflict
+    - id: check-illegal-windows-names
+    - id: check-merge-conflict
+    - id: check-symlinks
+    - id: check-toml
+    - id: check-yaml
+    - id: check-json
+      exclude: "(kotlin/lib/src/test/resources/__files/ExpectedMsgCreateBodyWithHeaders.json)|(tsconfig.json)"
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -270,7 +270,7 @@ This version contains a big overhaul of the client libraries, with improved typi
 * Libs: Upgrade `openapi-generator` to 7.9.0, with dependency upgrades and internal changes in the SDKs.
 * Server: Add Redis sentinel support
 * Server: Add OTEL metrics for Redis queues
-* Server: Add Redis DLQ support 
+* Server: Add Redis DLQ support
 * Server: Several dependency upgrades and CI improvements
 
 ## Version 1.38.0
@@ -343,7 +343,7 @@ This version contains a big overhaul of the client libraries, with improved typi
 * Libs/Rust: Add `Svix::with_token` to allow changing API token
 * Libs/PHP: Replace ctype_digit for PHP 8.1 deprecation of non-string arguments
 
-## Version 1.24.0 
+## Version 1.24.0
 * Server: Update redis health check
 * Server: Clean up tracing spans for HTTP requests
 * Libs: Update OpenAPI
@@ -377,17 +377,17 @@ This version contains a big overhaul of the client libraries, with improved typi
 * Libs/Rust: Make request timeout configurable
 
 ## Version 1.18.0
-* Server: upgrade dependencies 
+* Server: upgrade dependencies
 * Server: adopt omniqueue as a queue backend
 * Libs/C#: **[Breaking]** Return iterator information in list endpoints. Changes the return type of list endpoints.
 * Libs/Java: don't serialize nulls in PATCH endpoint methods
-* Libs/Rust: upgrade and clean up dependencies 
+* Libs/Rust: upgrade and clean up dependencies
 * Libs/Rust: switch from reqwest to hyper 1.0
 
 ## Version 1.17.0
 * Server: Upgrade hyper to 0.14.28
 * Libs/Rust: **[Important]** Fix a bug in the webhook signature verification method where certain signatures could bypass the verification.
-* Libs/Java: **[Breaking]** Use Java time instead of threetenbp. This removes the need to import threetenbp to use the library. Depending on how the lib is used, it might require migrating uses of threetenbp to Java 8 Date-Time APIs. 
+* Libs/Java: **[Breaking]** Use Java time instead of threetenbp. This removes the need to import threetenbp to use the library. Depending on how the lib is used, it might require migrating uses of threetenbp to Java 8 Date-Time APIs.
 
 ## Version 1.16.0
 * Server: Add `tag` parameter to list-message for Go, JavaScript, and Python.
diff --git a/README.md b/README.md
@@ -420,7 +420,7 @@ Contributions are what makes the open source world go round! All contributions a
 Please refer to the [contribution guide](./CONTRIBUTING.md) for information on how to contribute.
 
 A quick how to for contribution:
-    
+
 1. Fork the project
 2. Create your feature branch (`git checkout -b feature/some-feature`)
 3. Make your changes
diff --git a/codegen/generated_files.json b/codegen/generated_files.json
@@ -1507,4 +1507,4 @@
         "svix-cli/src/cmds/api/operational_webhook.rs",
         "svix-cli/src/cmds/api/operational_webhook_endpoint.rs"
     ]
-]
+]
diff --git a/codegen/templates/go/types/struct_enum.go.jinja b/codegen/templates/go/types/struct_enum.go.jinja
@@ -25,17 +25,17 @@ import (
 //   - {% for v in vars %}"{{ v.name }}"{% if not loop.last %},{% endif %}{% endfor %}: {{ use_type }}
 {%- endfor -%}
 type {{ ty_name }} struct {
-    {% include "types/struct_fields.go.jinja" -%}	
+	{% include "types/struct_fields.go.jinja" -%}
 	{{ discriminator_field }} {{ ty_name }}{{ discriminator_field }} `json:"{{ type.discriminator_field }}"`
 	{{ content_field }} {{ ty_name }}{{ content_field }} `json:"{{ type.content_field }}"`
 }
 
 type {{ ty_name }}{{ discriminator_field }} string
 
 const (
-    {% for v in type.variants -%}
+	{% for v in type.variants -%}
 	{{ ty_name }}{{ discriminator_field }}{{ v.name | to_upper_camel_case }} {{ ty_name }}{{ discriminator_field }} = "{{ v.name }}"
-    {% endfor -%}
+	{% endfor -%}
 )
 
 
@@ -83,7 +83,7 @@ func (i *{{ ty_name }}) UnmarshalJSON(data []byte) error {
 var {{ ty_name }}{{ discriminator_field }}WithNo{{ content_field }} = map[string]bool{
 	{% for v in type.variants -%}
 		{% if v.schema_ref is not defined -%}
-    "{{ v.name }}": true,
+	"{{ v.name }}": true,
 		{% endif -%}
 	{% endfor -%}
 }
@@ -93,7 +93,7 @@ func (i {{ ty_name }}) MarshalJSON() ([]byte, error) {
 	type Alias {{ ty_name }}
 	{% if has_variant_with_no_schema_ref -%}
 	if _, found := {{ ty_name }}{{ discriminator_field }}WithNo{{ content_field }}[string(i.{{ discriminator_field }})]; found {
- 	   i.{{ content_field }} = emptyMap{}
+ 		i.{{ content_field }} = emptyMap{}
 	}
 	{% endif -%}
 	return json.Marshal(&struct {Alias}{Alias: (Alias)(i)})
diff --git a/codegen/templates/kotlin/types/struct_enum.kt.jinja b/codegen/templates/kotlin/types/struct_enum.kt.jinja
@@ -29,7 +29,7 @@ sealed  class {{ enum_type_name }} {
     val variantName: String get() = this::class.annotations.filterIsInstance<VariantName>().first().name
     abstract fun toJsonElement(): JsonElement
 
-{% for variant in type.variants %} 
+{% for variant in type.variants %}
     {% set val_name %}{{ variant.name | to_lower_camel_case }}{% endset -%}
     @VariantName("{{ variant.name }}")
     {% if variant.schema_ref is defined -%}
diff --git a/codegen/templates/python/api_extra/authentication.py b/codegen/templates/python/api_extra/authentication.py
@@ -9,4 +9,3 @@ def _header_params(self) -> t.Dict[str, str]:
                 "idempotency-key": self.idempotency_key,
             }
         )
-
diff --git a/codegen/templates/python/types/struct_enum.py.jinja b/codegen/templates/python/types/struct_enum.py.jinja
@@ -18,7 +18,7 @@ class {{ type_name }}(BaseModel):
     ]
     {{ type.content_field }}: t.Union[
         {% set content_field_types = [] %}
-        {{ type.variants| map(attribute="schema_ref", default="t.Dict[str,t.Any]") | unique | join(",") }}        
+        {{ type.variants| map(attribute="schema_ref", default="t.Dict[str,t.Any]") | unique | join(",") }}
     ]
 
     @model_validator(mode="wrap")
@@ -29,7 +29,7 @@ class {{ type_name }}(BaseModel):
         output = handler(data)
         {% for v in type.variants -%}
 
-        
+
         {% if loop.first -%}if{% else %}elif{% endif %} output.type == "{{ v.name }}":
             {%- if v.schema_ref is defined %}
             output.{{ type.content_field | to_snake_case }} = {{ v.schema_ref | to_upper_camel_case }}.model_validate(data.get("{{ type.content_field }}", {}))
@@ -40,4 +40,3 @@ class {{ type_name }}(BaseModel):
         else:
             raise ValueError(f"Unexpected type `{output.type}`")
         return output
-
diff --git a/java/README.md b/java/README.md
@@ -91,4 +91,3 @@ Simply run:
 ```sh
 ./gradlew publishToSonatype closeAndReleaseSonatypeStagingRepository
 ```
-
diff --git a/java/deploy.gradle b/java/deploy.gradle
@@ -40,7 +40,7 @@ nexusPublishing {
         sonatype {
             nexusUrl.set(uri(getReleaseRepositoryUrl()))
             snapshotRepositoryUrl.set(uri(getSnapshotRepositoryUrl()))
-            
+
             username = getRepositoryUsername()
             password = getRepositoryPassword()
         }
diff --git a/kotlin/settings.gradle b/kotlin/settings.gradle
@@ -1,2 +1,2 @@
 
-rootProject.name = 'svix-kotlin'
+rootProject.name = 'svix-kotlin'
diff --git a/php/.gitignore b/php/.gitignore
@@ -1,2 +1,2 @@
 /vendor/
-composer.lock
+composer.lock
diff --git a/python/.flake8 b/python/.flake8
@@ -1,4 +1,4 @@
 [flake8]
 max-line-length = 120
 extend-ignore = E203, W503, E501, E711, E712, N803
-exclude = .git,__pycache__,__init__.py,.mypy_cache,.pytest_cache,svix/internal
+exclude = .git,__pycache__,__init__.py,.mypy_cache,.pytest_cache,svix/internal
diff --git a/python/.gitignore b/python/.gitignore
@@ -65,4 +65,4 @@ target/
 # Ipython Notebook
 .ipynb_checkpoints
 
-/svix/internal
+/svix/internal
diff --git a/python/tests/test_httpretty.py b/python/tests/test_httpretty.py
@@ -75,7 +75,7 @@ def test_client_provided_idempotency_key_is_not_overridden():
         "http://test.example/api/v1/app",
         body='{"uid":"unique-identifier","name":"My first application","rateLimit":0,"id":"app_1srOrx2ZWZBpBUvZwXKQmoEYga2","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","metadata":{"property1":"string","property2":"string"}}'
     )
-    
+
     client_provided_key = "test-key-123"
     svx.application.create(
         ApplicationIn(name="test app"),
@@ -96,6 +96,6 @@ def test_unknown_keys_are_ignored():
         "http://test.example/api/v1/app",
         body='{"data":[],"done":true,"iterator":null,"prevIterator":null,"extra-key":"ignored"}'
     )
-    
-    
+
+
     svx.application.list()
diff --git a/regen_openapi.py b/regen_openapi.py
@@ -357,6 +357,7 @@ def log_generated_files(generated_paths: list[list[str]]):
     generated_paths.sort()
     with open(Path("codegen").joinpath("generated_files.json"), "w") as f:
         json.dump(generated_paths, f, indent=4)
+        f.write("\n")
 
 
 def main():
diff --git a/ruby/.gitignore b/ruby/.gitignore
@@ -6,4 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
-*.gem
+*.gem
diff --git a/server/svix-server/config.default.toml b/server/svix-server/config.default.toml
@@ -122,4 +122,4 @@ worker_max_tasks = 500
 # dangerous_disable_tls_verification = false
 
 # Maximum seconds of queue long-poll
-queue_max_poll_secs = 20
+queue_max_poll_secs = 20
diff --git a/svix-cli/README.md b/svix-cli/README.md
@@ -154,4 +154,3 @@ For detailed instructions on configuring completions for your shell run `svix co
 ## Documentation
 
 For a more information, checkout our [API reference](https://docs.svix.com).
-
diff --git a/tools/update_postman.js b/tools/update_postman.js
@@ -55,4 +55,4 @@ const update_collection = async (collection) => {
       error(e);
     }
   }
-})();
+})();

Original file line number	Diff line number	Diff line change
`@@ -1507,4 +1507,4 @@`
`1507`	`1507`	`"svix-cli/src/cmds/api/operational_webhook.rs",`
`1508`	`1508`	`"svix-cli/src/cmds/api/operational_webhook_endpoint.rs"`
`1509`	`1509`	`]`
`1510`		`-]`
	`1510`	`+]`