Retracted: Retracted because the 1.0.0 release was published prematurely.

sidekick

package

v1.0.0 Latest Latest Go to latest Published: Nov 6, 2025 License: Apache-2.0 Imports: 28 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/googleapis/librarian

Links

Open Source Insights

Documentation ¶

Overview ¶

Package sidekick provides functionality for automating code generation.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Run ¶

func Run(args []string) error

Run is the entry point for the sidekick logic. It expects args to be the command line arguments, minus the program name.

Types ¶

type CargoConfig ¶

type CargoConfig struct {
	Package CargoPackage // `toml:"package"`
}

CargoConfig is the configuration for a cargo package.

type CargoPackage ¶

type CargoPackage struct {
	Name string // `toml:"name"`
}

CargoPackage is a cargo package.

type CommandLine ¶

type CommandLine struct {
	Command             []string
	ProjectRoot         string
	SpecificationFormat string
	SpecificationSource string
	ServiceConfig       string
	Source              map[string]string
	Output              string
	Language            string
	Codec               map[string]string
	UpdatedRoot         string
	DryRun              bool
}

CommandLine Represents the arguments received from the command line.

Source Files ¶

View all Source files

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
internal
api Package api defines the data model representing a parsed API surface.	Package api defines the data model representing a parsed API surface.
api/apitest Package apitest provides helper functions for testing the api package.	Package apitest provides helper functions for testing the api package.
codec_sample Package codec_sample provides an example implementation of a code generator.	Package codec_sample provides an example implementation of a code generator.
config Package config provides functionality for working with the sidekick.toml configuration file.	Package config provides functionality for working with the sidekick.toml configuration file.
config/gcloudyaml Package gcloudyaml provides Go type definitions for parsing and representing Google Cloud CLI (gcloud) configuration files.	Package gcloudyaml provides Go type definitions for parsing and representing Google Cloud CLI (gcloud) configuration files.
dart Package dart implements a native Dart code generator.	Package dart implements a native Dart code generator.
external Package external provides helper functions to work with external commands.	Package external provides helper functions to work with external commands.
gcloud Package gcloud provides utilities for generating gcloud command configurations and related types.	Package gcloud provides utilities for generating gcloud command configurations and related types.
language Package language provides common utilities for language-specific code generation	Package language provides common utilities for language-specific code generation
license Package license provides functions for generating license header text.	Package license provides functions for generating license header text.
parser Package parser reads specifications and converts them into the `genclient.API` model.	Package parser reads specifications and converts them into the `genclient.API` model.
parser/discovery Package discovery parses Google Discovery Documents into the sidekick abstract API model (`api.API`).	Package discovery parses Google Discovery Documents into the sidekick abstract API model (`api.API`).
parser/httprule Package httprule provides a parser for the path templates found in [google.api.http] annotations.	Package httprule provides a parser for the path templates found in [google.api.http] annotations.
parser/svcconfig Package svcconfig contains helper functions to parse service config files.	Package svcconfig contains helper functions to parse service config files.
protobuf Package protobuf provides utilities for handling protobuf files.	Package protobuf provides utilities for handling protobuf files.
rust Package rust implements a native Rust code generator.	Package rust implements a native Rust code generator.
rust_prost Package rust_prost implements a Rust code generator using the prost toolchain.	Package rust_prost implements a Rust code generator using the prost toolchain.
rust_release Package rustrelease implements the release automation logic for Rust crates.	Package rustrelease implements the release automation logic for Rust crates.
sample Package sample provides sample data for testing.	Package sample provides sample data for testing.