chore: auto-format .proto files with buf (#227)

This change should have no user impact. `buf format` can auto-format .proto files, similar to Prettier. This change: - Auto-formats our .proto files with `buf format`. - Adds `npm run format:buf` to auto-format .proto files. - Adds `npm run lint:buf-format` to check formatting of .proto files. - Updates `npm run format` to call both `npm run format:buf` and Prettier. - Updates `npm run lint` to call both `npm run lint:buf-format` and Prettier.
digidem · Aug 29, 2024 · 486c627 · 486c627
1 parent 788229e
commit 486c627
Show file tree

Hide file tree

Showing 12 changed files with 24 additions and 24 deletions.
diff --git a/package.json b/package.json
@@ -13,8 +13,12 @@
     "build:tsc": "tsc",
     "build:copy": "cpy 'intermediate/generated/**' 'intermediate/src/**' dist/",
     "build:doc": "typedoc src/index.ts --tsconfig tsconfig.typedoc.json --plugin typedoc-plugin-markdown",
-    "format": "prettier --write .",
-    "lint": "prettier --check .",
+    "format:buf": "buf format --write ./proto",
+    "format:prettier": "prettier --write .",
+    "format": "npm-run-all --parallel format:*",
+    "lint:buf-format": "buf format --diff --exit-code ./proto",
+    "lint:prettier": "prettier --check .",
+    "lint": "npm-run-all --parallel lint:*",
     "prepack": "npm run build",
     "pretest": "npm run lint",
     "test": "node --test test"

diff --git a/proto/coreOwnership/v1.proto b/proto/coreOwnership/v1.proto
@@ -1,9 +1,9 @@
 syntax = "proto3";
 package mapeo;
 
+import "common/v1.proto";
 import "google/protobuf/struct.proto";
 import "google/protobuf/timestamp.proto";
-import "common/v1.proto";
 import "options.proto";
 
 message CoreOwnership_1 {

diff --git a/proto/deviceInfo/v1.proto b/proto/deviceInfo/v1.proto
@@ -1,9 +1,9 @@
 syntax = "proto3";
 package mapeo;
 
+import "common/v1.proto";
 import "google/protobuf/struct.proto";
 import "google/protobuf/timestamp.proto";
-import "common/v1.proto";
 import "options.proto";
 
 message DeviceInfo_1 {

diff --git a/proto/field/v1.proto b/proto/field/v1.proto
@@ -1,11 +1,11 @@
 syntax = "proto3";
 package mapeo;
 
+import "common/v1.proto";
 import "google/protobuf/any.proto";
 import "google/protobuf/timestamp.proto";
-import "tags/v1.proto";
-import "common/v1.proto";
 import "options.proto";
+import "tags/v1.proto";
 
 message Field_1 {
   // **DO NOT CHANGE dataTypeId** generated with `openssl rand -hex 6`

diff --git a/proto/icon/v1.proto b/proto/icon/v1.proto
@@ -25,7 +25,6 @@ message Icon_1 {
     PixelDensity pixelDensity = 1 [(required) = true];
   }
 
-
   message IconVariant {
     oneof variant {
       IconVariantSvg svgIcon = 1;
@@ -48,5 +47,4 @@ message Icon_1 {
     BlobVersionId blobVersionId = 4 [(required) = true];
   }
   repeated IconVariant variants = 3;
-
 }
diff --git a/proto/observation/v1.proto b/proto/observation/v1.proto
@@ -1,11 +1,11 @@
 syntax = "proto3";
 package mapeo;
 
-import "google/protobuf/timestamp.proto";
-import "google/protobuf/struct.proto";
-import "tags/v1.proto";
 import "common/v1.proto";
+import "google/protobuf/struct.proto";
+import "google/protobuf/timestamp.proto";
 import "options.proto";
+import "tags/v1.proto";
 import "versionId/v1.proto";
 
 message Observation_1 {
@@ -74,5 +74,4 @@ message Observation_1 {
     bytes docId = 1;
     VersionId_1 versionId = 2;
   }
-
 }
diff --git a/proto/options.proto b/proto/options.proto
@@ -1,7 +1,8 @@
 syntax = "proto3";
-import "google/protobuf/descriptor.proto";
 package mapeo;
 
+import "google/protobuf/descriptor.proto";
+
 extend google.protobuf.MessageOptions {
   // This should be a hex-encoded 48-bit random number, and should never change
   // for a given message type. Generated with `openssl rand -hex 6`

diff --git a/proto/preset/v1.proto b/proto/preset/v1.proto
@@ -1,12 +1,12 @@
 syntax = "proto3";
 package mapeo;
 
+import "common/v1.proto";
 import "google/protobuf/struct.proto";
 import "google/protobuf/timestamp.proto";
+import "options.proto";
 import "tags/v1.proto";
-import "common/v1.proto";
 import "versionId/v1.proto";
-import "options.proto";
 
 message Preset_1 {
   // **DO NOT CHANGE dataTypeId** generated with `openssl rand -hex 6`
@@ -34,7 +34,6 @@ message Preset_1 {
     relation = 5;
   }
 
-
   message FieldRef {
     bytes docId = 1;
     VersionId_1 versionId = 2;

diff --git a/proto/projectSettings/v1.proto b/proto/projectSettings/v1.proto
@@ -1,8 +1,8 @@
 syntax = "proto3";
 package mapeo;
 
-import "google/protobuf/timestamp.proto";
 import "common/v1.proto";
+import "google/protobuf/timestamp.proto";
 import "options.proto";
 
 message ProjectSettings_1 {
@@ -18,7 +18,7 @@ message ProjectSettings_1 {
     repeated bytes vertex = 3;
     repeated bytes line = 4;
     repeated bytes relation = 5;
-  };
+  }
 
   message ConfigMetadata {
     string name = 1;

diff --git a/proto/role/v1.proto b/proto/role/v1.proto
@@ -1,9 +1,9 @@
 syntax = "proto3";
 package mapeo;
 
+import "common/v1.proto";
 import "google/protobuf/struct.proto";
 import "google/protobuf/timestamp.proto";
-import "common/v1.proto";
 import "options.proto";
 
 message Role_1 {

diff --git a/proto/track/v1.proto b/proto/track/v1.proto
@@ -1,11 +1,11 @@
 syntax = "proto3";
 package mapeo;
 
-import "google/protobuf/timestamp.proto";
-import "google/protobuf/struct.proto";
-import "tags/v1.proto";
 import "common/v1.proto";
+import "google/protobuf/struct.proto";
+import "google/protobuf/timestamp.proto";
 import "options.proto";
+import "tags/v1.proto";
 import "versionId/v1.proto";
 
 message Track_1 {

diff --git a/proto/translation/v1.proto b/proto/translation/v1.proto
@@ -2,8 +2,8 @@ syntax = "proto3";
 package mapeo;
 
 import "common/v1.proto";
-import "versionId/v1.proto";
 import "options.proto";
+import "versionId/v1.proto";
 
 message Translation_1 {
   // **DO NOT CHANGE dataTypeId** generated with `openssl rand -hex 6`
@@ -33,5 +33,4 @@ message Translation_1 {
     track = 7;
   }
   DocRefType docRefType = 7;
-
 }