cmd

package

v1.0.1 Latest Latest Go to latest Published: Jun 5, 2026 License: Apache-2.0 Imports: 21 Imported by: 0

Details

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

Repository

github.com/snarlysodboxer/predictable-yaml

Links

Open Source Insights

Documentation ¶

Overview ¶

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constants ¶

This section is empty.

Variables ¶

View Source

var Version = "dev"

Version is set at build time via ldflags.

Functions ¶

func Execute ¶

func Execute()

Execute adds all child commands to the root command and sets flags appropriately.

Types ¶

type ProjectConfig ¶ added in v1.0.0

type ProjectConfig struct {
	ConfigDir string              `yaml:"config-dir"`
	Remote    ProjectRemoteConfig `yaml:"remote"`
	Fixer     ProjectFixerConfig  `yaml:"fixer"`
}

ProjectConfig represents the contents of a .predictable-yaml.yaml config file.

type ProjectFixerConfig ¶ added in v1.0.0

type ProjectFixerConfig struct {
	IndentationLevel        *int  `yaml:"indentation-level"`
	CompactLists            *bool `yaml:"compact-lists"`
	AddPreferred            *bool `yaml:"add-preferred"`
	DisablePostProcessing   *bool `yaml:"disable-post-processing"`
	Prompt                  *bool `yaml:"prompt"`
	PromptIfLineCountChange *bool `yaml:"prompt-if-line-count-change"`
	UnmatchedToBeginning    *bool `yaml:"unmatched-to-beginning"`
	Validate                *bool `yaml:"validate"`
}

ProjectFixerConfig holds fixer default settings.

type ProjectRemoteConfig ¶ added in v1.0.0

type ProjectRemoteConfig struct {
	URL     string `yaml:"url"`
	Version string `yaml:"version"`
}

ProjectRemoteConfig holds the remote config source settings.

Source Files ¶

View all Source files

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