chore(deps): bump go.einride.tech/sage from 0.247.0 to 0.260.0 in /.sage

Bumps [go.einride.tech/sage](https://github.com/einride/sage) from 0.247.0 to 0.260.0. - [Release notes](https://github.com/einride/sage/releases) - [Commits](einride/sage@v0.247.0...v0.260.0) --- updated-dependencies: - dependency-name: go.einride.tech/sage dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>
einride · Jan 2, 2024 · f0289cf · f0289cf
1 parent 2cfaae2
commit f0289cf
Show file tree

Hide file tree

Showing 6 changed files with 155 additions and 112 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,5 @@
 .idea
+
+# Go workspace files
+go.work
+go.work.sum
diff --git a/.sage/go.mod b/.sage/go.mod
@@ -2,4 +2,4 @@ module sage
 
 go 1.19
 
-require go.einride.tech/sage v0.247.0
+require go.einride.tech/sage v0.260.0
diff --git a/.sage/go.sum b/.sage/go.sum
@@ -1,2 +1,2 @@
-go.einride.tech/sage v0.247.0 h1:4K8KVRWP3gutmxhR7gMc+Q5ss8+OA7SFnGpVxmk6wT4=
-go.einride.tech/sage v0.247.0/go.mod h1:EzV5uciFX7/2ho8EKB5K9JghOfXIxlzs694b+Tkl5GQ=
+go.einride.tech/sage v0.260.0 h1:Ny4n2yq0rBvbOizP1z8Aoa/1XHP37issom1xOlHxUG4=
+go.einride.tech/sage v0.260.0/go.mod h1:EzV5uciFX7/2ho8EKB5K9JghOfXIxlzs694b+Tkl5GQ=
diff --git a/.sage/sagefile.go b/.sage/sagefile.go
@@ -10,7 +10,7 @@ import (
 	"go.einride.tech/sage/tools/sggo"
 	"go.einride.tech/sage/tools/sggolangcilint"
 	"go.einride.tech/sage/tools/sggoreview"
-	"go.einride.tech/sage/tools/sgmarkdownfmt"
+	"go.einride.tech/sage/tools/sgmdformat"
 	"go.einride.tech/sage/tools/sgyamlfmt"
 )
 
@@ -47,7 +47,7 @@ func FormatYAML(ctx context.Context) error {
 
 func FormatMarkdown(ctx context.Context) error {
 	sg.Logger(ctx).Println("formatting Markdown files...")
-	return sgmarkdownfmt.Command(ctx, "-w", ".").Run()
+	return sgmdformat.Command(ctx).Run()
 }
 
 func GoLint(ctx context.Context) error {

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,87 +1,128 @@
-Contributor Covenant Code of Conduct
-====================================
+# Contributor Covenant Code of Conduct
 
-Our Pledge
-----------
+## Our Pledge
 
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
 
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
-Our Standards
--------------
+## Our Standards
 
-Examples of behavior that contributes to a positive environment for our community include:
+Examples of behavior that contributes to a positive environment for our
+community include:
 
--	Demonstrating empathy and kindness toward other people
--	Being respectful of differing opinions, viewpoints, and experiences
--	Giving and gracefully accepting constructive feedback
--	Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
--	Focusing on what is best not just for us as individuals, but for the overall community
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
 
 Examples of unacceptable behavior include:
 
--	The use of sexualized language or imagery, and sexual attention or advances of any kind
--	Trolling, insulting or derogatory comments, and personal or political attacks
--	Public or private harassment
--	Publishing others' private information, such as a physical or email address, without their explicit permission
--	Other conduct which could reasonably be considered inappropriate in a professional setting
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
-Enforcement Responsibilities
-----------------------------
+## Enforcement Responsibilities
 
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
 
-Scope
------
+## Scope
 
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
 
-Enforcement
------------
+## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at open-source@einride.tech.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+open-source@einride.tech.
 
 All complaints will be reviewed and investigated promptly and fairly.
 
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
 
-Enforcement Guidelines
-----------------------
+## Enforcement Guidelines
 
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
 
 ### 1. Correction
 
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
 
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
 
 ### 2. Warning
 
-**Community Impact**: A violation through a single incident or series of actions.
+**Community Impact**: A violation through a single incident or series of
+actions.
 
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
 
 ### 3. Temporary Ban
 
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
 
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
 
 ### 4. Permanent Ban
 
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
 
-**Consequence**: A permanent ban from any sort of public interaction within the community.
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
 
-Attribution
------------
+## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+This Code of Conduct is adapted from the
+[Contributor Covenant](https://www.contributor-covenant.org), version 2.0,
+available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
 
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
 
-For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
diff --git a/README.md b/README.md
@@ -1,80 +1,78 @@
 [![Go Reference](https://pkg.go.dev/badge/go.einride.tech/aip.svg)](https://pkg.go.dev/go.einride.tech/aip)
 
-AIP Go
-======
+# AIP Go
 
-Go SDK for implementing [Google API Improvement Proposals](https://aip.dev/) (AIP).
+Go SDK for implementing [Google API Improvement Proposals](https://aip.dev/)
+(AIP).
 
-Documentation
--------------
+## Documentation
 
 See [https://aip.dev](https://aip.dev/) for the full AIP documentation.
 
-Installing
-----------
+## Installing
 
 ```bash
 $ go get -u go.einride.tech/aip
 ```
 
-Examples
---------
+## Examples
 
 ### [AIP-132](https://google.aip.dev/132) (Standard method: List)
 
--	Use [`pagination.PageToken`](./pagination/pagetoken.go) to implement offset-based pagination.
+- Use [`pagination.PageToken`](./pagination/pagetoken.go) to implement
+  offset-based pagination.
 
-	```go
-	package examplelibrary
+  ```go
+  package examplelibrary
 
-	import (
-	    "context"
+  import (
+      "context"
 
-	    "go.einride.tech/aip/pagination"
-	    "google.golang.org/genproto/googleapis/example/library/v1"
-	    "google.golang.org/grpc/codes"
-	    "google.golang.org/grpc/status"
-	)
+      "go.einride.tech/aip/pagination"
+      "google.golang.org/genproto/googleapis/example/library/v1"
+      "google.golang.org/grpc/codes"
+      "google.golang.org/grpc/status"
+  )
 
-	func (s *Server) ListShelves(
-	    ctx context.Context,
-	    request *library.ListShelvesRequest,
-	) (*library.ListShelvesResponse, error) {
-	    // Handle request constraints.
-	    const (
-	§           maxPageSize     = 1000
-	        defaultPageSize = 100
-	    )
-	    switch {
-	    case request.PageSize < 0:
-	        return nil, status.Errorf(codes.InvalidArgument, "page size is negative")
-	    case request.PageSize == 0:
-	        request.PageSize = defaultPageSize
-	    case request.PageSize > maxPageSize:
-	        request.PageSize = maxPageSize
-	    }
-	    // Use pagination.PageToken for offset-based page tokens.
-	    pageToken, err := pagination.ParsePageToken(request)
-	    if err != nil {
-	        return nil, status.Errorf(codes.InvalidArgument, "invalid page token")
-	    }
-	    // Query the storage.
-	    result, err := s.Storage.ListShelves(ctx, &ListShelvesQuery{
-	        Offset:   pageToken.Offset,
-	        PageSize: request.GetPageSize(),
-	    })
-	    if err != nil {
-	        return nil, err
-	    }
-	    // Build the response.
-	    response := &library.ListShelvesResponse{
-	        Shelves: result.Shelves,
-	    }
-	    // Set the next page token.
-	    if result.HasNextPage {
-	        response.NextPageToken = pageToken.Next(request).String()
-	    }
-	    // Respond.
-	    return response, nil
-	}
-	```
+  func (s *Server) ListShelves(
+      ctx context.Context,
+      request *library.ListShelvesRequest,
+  ) (*library.ListShelvesResponse, error) {
+      // Handle request constraints.
+      const (
+  §           maxPageSize     = 1000
+          defaultPageSize = 100
+      )
+      switch {
+      case request.PageSize < 0:
+          return nil, status.Errorf(codes.InvalidArgument, "page size is negative")
+      case request.PageSize == 0:
+          request.PageSize = defaultPageSize
+      case request.PageSize > maxPageSize:
+          request.PageSize = maxPageSize
+      }
+      // Use pagination.PageToken for offset-based page tokens.
+      pageToken, err := pagination.ParsePageToken(request)
+      if err != nil {
+          return nil, status.Errorf(codes.InvalidArgument, "invalid page token")
+      }
+      // Query the storage.
+      result, err := s.Storage.ListShelves(ctx, &ListShelvesQuery{
+          Offset:   pageToken.Offset,
+          PageSize: request.GetPageSize(),
+      })
+      if err != nil {
+          return nil, err
+      }
+      // Build the response.
+      response := &library.ListShelvesResponse{
+          Shelves: result.Shelves,
+      }
+      // Set the next page token.
+      if result.HasNextPage {
+          response.NextPageToken = pageToken.Next(request).String()
+      }
+      // Respond.
+      return response, nil
+  }
+  ```