Pass of lint for .proto files

.github/workflows/test.yaml

@@ -22,7 +22,7 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@v2
         with:
-          go-version: "1.14"
+          go-version: "1.16"
 
       - name: Install Go deps
         # Since 10/23/2019 pwsh is the default shell
@@ -50,16 +50,27 @@ jobs:
       - name: Install Poetry
         run: pip install poetry
 
+      - name: Install buf (protoc linter)
+        if: runner.os == 'Linux'
+        run: |
+          go install github.com/bufbuild/buf/cmd/buf@latest
+          go install github.com/bufbuild/buf/cmd/protoc-gen-buf-breaking@latest
+          go install github.com/bufbuild/buf/cmd/protoc-gen-buf-lint@latest
+        shell: bash
+
       - name: Check the code is good
+        if: runner.os == 'Linux'
         run: task check
 
       - name: Install protoc compiler
+        if: runner.os == 'Linux'
         uses: arduino/setup-protoc@v1
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Check protocol buffers compile correctly
-        run: task protoc
+        if: runner.os == 'Linux'
+        run: task protoc:compile
 
       - name: Build the CLI
         run: task build

Taskfile.yml

@@ -19,10 +19,10 @@ tasks:
   docs:gen:protobuf:
     desc: Generate markdown contents for protobuffers
     cmds:
-      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,commands.md --proto_path=rpc ./rpc/commands/*.proto'
-      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,monitor.md --proto_path=rpc ./rpc/monitor/*.proto'
-      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,settings.md --proto_path=rpc ./rpc/settings/*.proto'
-      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,debug.md --proto_path=rpc ./rpc/debug/*.proto'
+      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,commands.md --proto_path=rpc ./rpc/cc/arduino/cli/commands/v1/*.proto'
+      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,monitor.md --proto_path=rpc ./rpc/cc/arduino/cli/monitor/v1/*.proto'
+      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,settings.md --proto_path=rpc ./rpc/cc/arduino/cli/settings/v1/*.proto'
+      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,debug.md --proto_path=rpc ./rpc/cc/arduino/cli/debug/v1/*.proto'
       - task: docs:format
 
   docs:gen:
@@ -77,20 +77,37 @@ tasks:
       - npx {{ .PRETTIER }} --write "**/*.md"
 
   protoc:
+    desc: Lint, format and compile protobuf definitions
+    deps:
+      - protoc:check
+      - protoc:format
+      - protoc:compile
+
+  protoc:compile:
     desc: Compile protobuf definitions
     cmds:
-      - '{{ default "protoc" .PROTOC_BINARY }} --proto_path=rpc --go_out=plugins=grpc,paths=source_relative:rpc ./rpc/commands/*.proto'
-      - '{{ default "protoc" .PROTOC_BINARY }} --proto_path=rpc --go_out=plugins=grpc,paths=source_relative:rpc ./rpc/monitor/*.proto'
-      - '{{ default "protoc" .PROTOC_BINARY }} --proto_path=rpc --go_out=plugins=grpc,paths=source_relative:rpc ./rpc/settings/*.proto'
-      - '{{ default "protoc" .PROTOC_BINARY }} --proto_path=rpc --go_out=plugins=grpc,paths=source_relative:rpc ./rpc/debug/*.proto'
+      - '{{ default "protoc" .PROTOC_BINARY }} --proto_path=rpc --go_out=plugins=grpc,paths=source_relative:rpc ./rpc/cc/arduino/cli/commands/v1/*.proto'
+      - '{{ default "protoc" .PROTOC_BINARY }} --proto_path=rpc --go_out=plugins=grpc,paths=source_relative:rpc ./rpc/cc/arduino/cli/monitor/v1/*.proto'
+      - '{{ default "protoc" .PROTOC_BINARY }} --proto_path=rpc --go_out=plugins=grpc,paths=source_relative:rpc ./rpc/cc/arduino/cli/settings/v1/*.proto'
+      - '{{ default "protoc" .PROTOC_BINARY }} --proto_path=rpc --go_out=plugins=grpc,paths=source_relative:rpc ./rpc/cc/arduino/cli/debug/v1/*.proto'
 
   protoc:docs:
     desc: Generate docs for protobuf definitions
     cmds:
-      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,commands.md --proto_path=rpc ./rpc/commands/*.proto'
-      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,monitor.md --proto_path=rpc ./rpc/monitor/*.proto'
-      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,settings.md --proto_path=rpc ./rpc/settings/*.proto'
-      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,debug.md --proto_path=rpc ./rpc/debug/*.proto'
+      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,commands.md --proto_path=rpc ./rpc/cc/arduino/cli/commands/v1/*.proto'
+      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,monitor.md --proto_path=rpc ./rpc/cc/arduino/cli/monitor/v1/*.proto'
+      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,settings.md --proto_path=rpc ./rpc/cc/arduino/cli/settings/v1/*.proto'
+      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,debug.md --proto_path=rpc ./rpc/cc/arduino/cli/debug/v1/*.proto'
+
+  protoc:check:
+    desc: Perform linting of the protobuf definitions
+    cmds:
+      - buf lint rpc
+
+  protoc:format:
+    desc: Perform formatting of the protobuf definitions
+    cmds:
+      - clang-format -i rpc/cc/arduino/cli/*/*/*.proto
 
   build:
     desc: Build the project
@@ -134,6 +151,7 @@ tasks:
       - task: python:check
       - task: docs:check
       - task: config:check
+      - task: protoc:check
 
   config:check:
     desc: Check linting of configuration and supporting files

arduino/libraries/libraries.go

@@ -19,7 +19,7 @@ import (
 	"fmt"
 
 	"github.com/arduino/arduino-cli/arduino/cores"
-	rpc "github.com/arduino/arduino-cli/rpc/commands"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	paths "github.com/arduino/go-paths-helper"
 	properties "github.com/arduino/go-properties-orderedmap"
 	semver "go.bug.st/relaxed-semver"

arduino/libraries/libraries_layout.go

@@ -19,7 +19,7 @@ import (
 	"encoding/json"
 	"fmt"
 
-	rpc "github.com/arduino/arduino-cli/rpc/commands"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 )
 
 // LibraryLayout represents how the library source code is laid out in the library
@@ -72,9 +72,9 @@ func (d *LibraryLayout) UnmarshalJSON(b []byte) error {
 func (d *LibraryLayout) ToRPCLibraryLayout() rpc.LibraryLayout {
 	switch *d {
 	case FlatLayout:
-		return rpc.LibraryLayout_flat_layout
+		return rpc.LibraryLayout_LIBRARY_LAYOUT_FLAT
 	case RecursiveLayout:
-		return rpc.LibraryLayout_recursive_layout
+		return rpc.LibraryLayout_LIBRARY_LAYOUT_RECURSIVE
 	}
 	panic(fmt.Sprintf("invalid LibraryLayout value %d", *d))
 }

arduino/libraries/libraries_location.go

@@ -19,7 +19,7 @@ import (
 	"encoding/json"
 	"fmt"
 
-	rpc "github.com/arduino/arduino-cli/rpc/commands"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 )
 
 // LibraryLocation represents where the library is installed
@@ -89,27 +89,27 @@ func (d *LibraryLocation) UnmarshalJSON(b []byte) error {
 func (d *LibraryLocation) ToRPCLibraryLocation() rpc.LibraryLocation {
 	switch *d {
 	case IDEBuiltIn:
-		return rpc.LibraryLocation_ide_builtin
+		return rpc.LibraryLocation_LIBRARY_LOCATION_IDE_BUILTIN
 	case PlatformBuiltIn:
-		return rpc.LibraryLocation_platform_builtin
+		return rpc.LibraryLocation_LIBRARY_LOCATION_PLATFORM_BUILTIN
 	case ReferencedPlatformBuiltIn:
-		return rpc.LibraryLocation_referenced_platform_builtin
+		return rpc.LibraryLocation_LIBRARY_LOCATION_REFERENCED_PLATFORM_BUILTIN
 	case User:
-		return rpc.LibraryLocation_user
+		return rpc.LibraryLocation_LIBRARY_LOCATION_USER
 	}
 	panic(fmt.Sprintf("invalid LibraryLocation value %d", *d))
 }
 
 // FromRPCLibraryLocation converts a rpc.LibraryLocation to a LibraryLocation
 func FromRPCLibraryLocation(l rpc.LibraryLocation) LibraryLocation {
 	switch l {
-	case rpc.LibraryLocation_ide_builtin:
+	case rpc.LibraryLocation_LIBRARY_LOCATION_IDE_BUILTIN:
 		return IDEBuiltIn
-	case rpc.LibraryLocation_platform_builtin:
+	case rpc.LibraryLocation_LIBRARY_LOCATION_PLATFORM_BUILTIN:
 		return PlatformBuiltIn
-	case rpc.LibraryLocation_referenced_platform_builtin:
+	case rpc.LibraryLocation_LIBRARY_LOCATION_REFERENCED_PLATFORM_BUILTIN:
 		return ReferencedPlatformBuiltIn
-	case rpc.LibraryLocation_user:
+	case rpc.LibraryLocation_LIBRARY_LOCATION_USER:
 		return User
 	}
 	panic(fmt.Sprintf("invalid rpc.LibraryLocation value %d", l))

arduino/libraries/librariesindex/index.go

@@ -20,7 +20,7 @@ import (
 
 	"github.com/arduino/arduino-cli/arduino/libraries"
 	"github.com/arduino/arduino-cli/arduino/resources"
-	rpc "github.com/arduino/arduino-cli/rpc/commands"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	semver "go.bug.st/relaxed-semver"
 )
 

cli/board/attach.go

@@ -24,7 +24,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/cli/output"
 	"github.com/arduino/arduino-cli/commands/board"
-	rpc "github.com/arduino/arduino-cli/rpc/commands"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -64,7 +64,7 @@ func runAttachCommand(cmd *cobra.Command, args []string) {
 		path = initSketchPath(path)
 	}
 
-	if _, err = board.Attach(context.Background(), &rpc.BoardAttachReq{
+	if _, err = board.Attach(context.Background(), &rpc.BoardAttachRequest{
 		Instance:      instance,
 		BoardUri:      args[0],
 		SketchPath:    path.String(),

cli/board/details.go

@@ -25,7 +25,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/commands/board"
 	"github.com/arduino/arduino-cli/i18n"
-	rpc "github.com/arduino/arduino-cli/rpc/commands"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/arduino-cli/table"
 	"github.com/fatih/color"
 	"github.com/spf13/cobra"
@@ -66,7 +66,7 @@ func runDetailsCommand(cmd *cobra.Command, args []string) {
 		fqbn = args[0]
 	}
 
-	res, err := board.Details(context.Background(), &rpc.BoardDetailsReq{
+	res, err := board.Details(context.Background(), &rpc.BoardDetailsRequest{
 		Instance: inst,
 		Fqbn:     fqbn,
 	})
@@ -82,7 +82,7 @@ func runDetailsCommand(cmd *cobra.Command, args []string) {
 // output from this command requires special formatting, let's create a dedicated
 // feedback.Result implementation
 type detailsResult struct {
-	details *rpc.BoardDetailsResp
+	details *rpc.BoardDetailsResponse
 }
 
 func (dr detailsResult) Data() interface{} {
@@ -134,28 +134,28 @@ func (dr detailsResult) String() string {
 			table.NewCell("✔", color.New(color.FgGreen)))
 	}
 
-	for i, idp := range details.IdentificationPref {
+	for i, idp := range details.IdentificationPrefs {
 		if i == 0 {
 			t.AddRow() // get some space from above
-			t.AddRow(tr("Identification properties:"), "VID:"+idp.UsbID.VID+" PID:"+idp.UsbID.PID)
+			t.AddRow(tr("Identification properties:"), "VID:"+idp.UsbId.Vid+" PID:"+idp.UsbId.Pid)
 			continue
 		}
-		t.AddRow("", "VID:"+idp.UsbID.VID+" PID:"+idp.UsbID.PID)
+		t.AddRow("", "VID:"+idp.UsbId.Vid+" PID:"+idp.UsbId.Pid)
 	}
 
 	t.AddRow() // get some space from above
 	addIfNotEmpty(tr("Package name:"), details.Package.Name)
 	addIfNotEmpty(tr("Package maintainer:"), details.Package.Maintainer)
 	addIfNotEmpty(tr("Package URL:"), details.Package.Url)
-	addIfNotEmpty(tr("Package website:"), details.Package.WebsiteURL)
+	addIfNotEmpty(tr("Package website:"), details.Package.WebsiteUrl)
 	addIfNotEmpty(tr("Package online help:"), details.Package.Help.Online)
 
 	t.AddRow() // get some space from above
 	addIfNotEmpty(tr("Platform name:"), details.Platform.Name)
 	addIfNotEmpty(tr("Platform category:"), details.Platform.Category)
 	addIfNotEmpty(tr("Platform architecture:"), details.Platform.Architecture)
 	addIfNotEmpty(tr("Platform URL:"), details.Platform.Url)
-	addIfNotEmpty(tr("Platform file name:"), details.Platform.ArchiveFileName)
+	addIfNotEmpty(tr("Platform file name:"), details.Platform.ArchiveFilename)
 	if details.Platform.Size != 0 {
 		addIfNotEmpty(tr("Platform size (bytes):"), fmt.Sprint(details.Platform.Size))
 	}
@@ -167,7 +167,7 @@ func (dr detailsResult) String() string {
 		if showFullDetails {
 			for _, sys := range tool.Systems {
 				t.AddRow("", tr("OS:"), "", sys.Host)
-				t.AddRow("", tr("File:"), "", sys.ArchiveFileName)
+				t.AddRow("", tr("File:"), "", sys.ArchiveFilename)
 				t.AddRow("", tr("Size (bytes):"), "", fmt.Sprint(sys.Size))
 				t.AddRow("", tr("Checksum:"), "", sys.Checksum)
 				t.AddRow("", "URL:", "", sys.Url)

cli/board/list.go

@@ -26,7 +26,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/commands/board"
-	rpc "github.com/arduino/arduino-cli/rpc/commands"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/arduino-cli/table"
 	"github.com/spf13/cobra"
 )
@@ -147,15 +147,15 @@ func (dr result) String() string {
 		if boards := port.GetBoards(); len(boards) > 0 {
 			sort.Slice(boards, func(i, j int) bool {
 				x, y := boards[i], boards[j]
-				return x.GetName() < y.GetName() || (x.GetName() == y.GetName() && x.GetFQBN() < y.GetFQBN())
+				return x.GetName() < y.GetName() || (x.GetName() == y.GetName() && x.GetFqbn() < y.GetFqbn())
 			})
 			for _, b := range boards {
 				board := b.GetName()
 
 				// to improve the user experience, show on a dedicated column
 				// the name of the core supporting the board detected
 				var coreName = ""
-				fqbn, err := cores.ParseFQBN(b.GetFQBN())
+				fqbn, err := cores.ParseFQBN(b.GetFqbn())
 				if err == nil {
 					coreName = fmt.Sprintf("%s:%s", fqbn.Package, fqbn.PlatformArch)
 				}
@@ -206,15 +206,15 @@ func (dr watchEvent) String() string {
 	if boards := dr.Boards; len(boards) > 0 {
 		sort.Slice(boards, func(i, j int) bool {
 			x, y := boards[i], boards[j]
-			return x.GetName() < y.GetName() || (x.GetName() == y.GetName() && x.GetFQBN() < y.GetFQBN())
+			return x.GetName() < y.GetName() || (x.GetName() == y.GetName() && x.GetFqbn() < y.GetFqbn())
 		})
 		for _, b := range boards {
 			board := b.GetName()
 
 			// to improve the user experience, show on a dedicated column
 			// the name of the core supporting the board detected
 			var coreName = ""
-			fqbn, err := cores.ParseFQBN(b.GetFQBN())
+			fqbn, err := cores.ParseFQBN(b.GetFqbn())
 			if err == nil {
 				coreName = fmt.Sprintf("%s:%s", fqbn.Package, fqbn.PlatformArch)
 			}

cli/board/listall.go

@@ -24,7 +24,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/commands/board"
-	rpc "github.com/arduino/arduino-cli/rpc/commands"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/arduino-cli/table"
 	"github.com/spf13/cobra"
 )
@@ -56,7 +56,7 @@ func runListAllCommand(cmd *cobra.Command, args []string) {
 		os.Exit(errorcodes.ErrGeneric)
 	}
 
-	list, err := board.ListAll(context.Background(), &rpc.BoardListAllReq{
+	list, err := board.ListAll(context.Background(), &rpc.BoardListAllRequest{
 		Instance:            inst,
 		SearchArgs:          args,
 		IncludeHiddenBoards: showHiddenBoard,
@@ -72,7 +72,7 @@ func runListAllCommand(cmd *cobra.Command, args []string) {
 // output from this command requires special formatting, let's create a dedicated
 // feedback.Result implementation
 type resultAll struct {
-	list *rpc.BoardListAllResp
+	list *rpc.BoardListAllResponse
 }
 
 func (dr resultAll) Data() interface{} {
@@ -91,7 +91,7 @@ func (dr resultAll) String() string {
 		if item.IsHidden {
 			hidden = "(hidden)"
 		}
-		t.AddRow(item.GetName(), item.GetFQBN(), hidden)
+		t.AddRow(item.GetName(), item.GetFqbn(), hidden)
 	}
 	return t.Render()
 }

cli/board/search.go

@@ -25,7 +25,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/commands/board"
-	rpc "github.com/arduino/arduino-cli/rpc/commands"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/arduino-cli/table"
 	"github.com/spf13/cobra"
 )
@@ -58,7 +58,7 @@ func runSearchCommand(cmd *cobra.Command, args []string) {
 		os.Exit(errorcodes.ErrGeneric)
 	}
 
-	res, err := board.Search(context.Background(), &rpc.BoardSearchReq{
+	res, err := board.Search(context.Background(), &rpc.BoardSearchRequest{
 		Instance:            inst,
 		SearchArgs:          strings.Join(args, " "),
 		IncludeHiddenBoards: searchFlags.showHiddenBoard,
@@ -93,7 +93,7 @@ func (r searchResults) String() string {
 		if item.IsHidden {
 			hidden = "(hidden)"
 		}
-		t.AddRow(item.GetName(), item.GetFQBN(), item.Platform.ID, hidden)
+		t.AddRow(item.GetName(), item.GetFqbn(), item.Platform.Id, hidden)
 	}
 	return t.Render()
 }