Categorygithub.com/xiaoyawei/bufprivatebufpkgbufconfig
package
0.0.0-20230306131847-26f457599b8d
Repository: https://github.com/xiaoyawei/buf.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
20
Dependents
18
Files
801 SLOC

# Functions

ExistingConfigFilePath checks if a configuration file exists, and if so, returns the path within the ReadBucket of this configuration file.
GetConfigForBucket gets the Config for the YAML data at ConfigFilePath.
GetConfigForData gets the Config for the given JSON or YAML data.
ReadConfigOS reads the configuration from the OS or an override, if any.
ReadConfigOSWithOverride sets the override.
ValidateVersion checks that a given version string is valid.
WriteConfig writes an initial configuration file into the bucket.
WriteConfigWithBreakingConfig returns a new WriteConfigOption that sets the breaking change config for the module.
WriteConfigWithDependencyModuleReferences returns a new WriteConfigOption that sets the dependencies of the module.
WriteConfigWithDocumentationComments returns a new WriteConfigOption that documents the resulting configuration file.
WriteConfigWithLintConfig returns a new WriteConfigOption that sets the lint config for the module.
WriteConfigWithModuleIdentity returns a new WriteConfigOption that sets the name of the module to the given ModuleIdentity.
WriteConfigWithUncomment returns a new WriteConfigOption that uncomments the resulting configuration file options that are commented out by default.
WriteConfigWithVersion returns a new WriteConfigOption that sets the version of the config being written.

# Constants

ExternalConfigV1Beta1FilePath is the v1beta1 file path.
ExternalConfigV1FilePath is the default configuration file path.
V1Beta1Version is the v1beta1 version.
V1Version is the v1 version.

# Variables

AllConfigFilePaths are all acceptable config file paths without overrides.
All versions are all the versions in order.

# Structs

Config is the user config.
ExternalConfigV1 represents the on-disk representation of the Config at version v1.
ExternalConfigV1Beta1 represents the on-disk representation of the Config at version v1beta1.
ExternalConfigVersion defines the subset of all config file versions that is used to determine the configuration version.

# Type aliases

ReadConfigOSOption is an option for ReadConfig.
WriteConfigOption is an option for WriteConfig.