Gitiles
Code Review Sign In
review.gerrithub.io / cue-lang / cue / a58ac536005e7347332a26c911d2c3fa43453fc9
commita58ac536005e7347332a26c911d2c3fa43453fc9[log] [tgz]
authorDaniel Martí <mvdan@mvdan.cc>Wed May 04 17:58:38 2022 +0100
committerDaniel Martí <mvdan@mvdan.cc>Thu May 05 12:03:07 2022 +0000
treeb8513be8d62b785c30fe33c75664a487cacd8622
parent13918ddeb0b0bb58ebbe92f91fd87e5d364a5844 [diff]
all: make vet happy

	$ go vet ./...
	# cuelang.org/go/cue/errors
	cue/errors/errors.go:326:15: method Is(err error, target error) bool should have signature Is(error) bool
	cue/errors/errors.go:335:15: method As(err error, target interface{}) bool should have signature As(any) bool
	# cuelang.org/go/cue/ast/astutil
	cue/ast/astutil/resolve.go:207:6: unreachable code

The unreachable code warning is an easy one: just like in other bits of
disabled code, comment it out.

The Is/As signature warning is slightly more worrying.
Presumably due to a mistake, cue/errors.list never actually satisfied
the interfaces used by Go's errors.As and errors.Is.
The added parameter was never used, reinforcing that theory.

Adjust the two methods. We don't strictly need a regression test, given
that `go vet` will now spot that mistake in CI.

And, as per the above, add `go vet` to CI.

Signed-off-by: Daniel Martí <mvdan@mvdan.cc>
Change-Id: Ie6f65a89fb41f232beede0ab732b14f0a0b831a1
Reviewed-on: https://review.gerrithub.io/c/cue-lang/cue/+/537656
Unity-Result: CUEcueckoo <cueckoo@cuelang.org>
TryBot-Result: CUEcueckoo <cueckoo@cuelang.org>
Reviewed-by: Roger Peppe <rogpeppe@gmail.com>
6 files changed
tree: b8513be8d62b785c30fe33c75664a487cacd8622
  1. .github/
  2. cmd/
  3. cue/
  4. cue.mod/
  5. cuego/
  6. doc/
  7. encoding/
  8. internal/
  9. pkg/
  10. tools/
  11. .dockerignore
  12. .gitattributes
  13. .gitignore
  14. .goreleaser.yml
  15. AUTHORS
  16. codereview.cfg
  17. CONTRIBUTING.md
  18. Dockerfile
  19. go.mod
  20. go.sum
  21. LICENSE
  22. navbar.md
  23. README.md
README.md

Go Reference Github GolangCI Go 1.16+ platforms

The CUE Data Constraint Language

Configure, Unify, Execute

CUE is an open source data constraint language which aims to simplify tasks involving defining and using data.

It is a superset of JSON, allowing users familiar with JSON to get started quickly.

What is it for?

You can use CUE to

  • define a detailed validation schema for your data (manually or automatically from data)
  • reduce boilerplate in your data (manually or automatically from schema)
  • extract a schema from code
  • generate type definitions and validation code
  • merge JSON in a principled way
  • define and run declarative scripts

How?

CUE merges the notion of schema and data. The same CUE definition can simultaneously be used for validating data and act as a template to reduce boilerplate. Schema definition is enriched with fine-grained value definitions and default values. At the same time, data can be simplified by removing values implied by such detailed definitions. The merging of these two concepts enables many tasks to be handled in a principled way.

Constraints provide a simple and well-defined, yet powerful, alternative to inheritance, a common source of complexity with configuration languages.

CUE Scripting

The CUE scripting layer defines declarative scripting, expressed in CUE, on top of data. This solves three problems: working around the closedness of CUE definitions (we say CUE is hermetic), providing an easy way to share common scripts and workflows for using data, and giving CUE the knowledge of how data is used to optimize validation.

There are many tools that interpret data or use a specialized language for a specific domain (Kustomize, Ksonnet). This solves dealing with data on one level, but the problem it solves may repeat itself at a higher level when integrating other systems in a workflow. CUE scripting is generic and allows users to define any workflow.

Tooling

CUE is designed for automation. Some aspects of this are:

  • convert existing YAML and JSON
  • automatically simplify configurations
  • rich APIs designed for automated tooling
  • formatter
  • arbitrary-precision arithmetic
  • generate CUE templates from source code
  • generate source code from CUE definitions (TODO)

Download and Install

Release builds

Download the latest release from GitHub.

Install using Homebrew

Using Homebrew, you can install using the CUE Homebrew tap:

brew install cue-lang/tap/cue

Install from Source

If you already have Go 1.16 or later installed, the short version is:

go install cuelang.org/go/cmd/cue@latest

This will install the cue command line tool.

For more details see Installing CUE.

Learning CUE

The fastest way to learn the basics is to follow the tutorial on basic language constructs.

A more elaborate tutorial demonstrating of how to convert and restructure an existing set of Kubernetes configurations is available in written form.

References

Contributing

Our canonical Git repository is located at https://review.gerrithub.io/q/project:cue-lang%252Fcue.

To contribute, please read the Contribution Guide.

To report issues or make a feature request, use the issue tracker.

Changes can be contributed using Gerrit or Github pull requests.

Code of Conduct

Guidelines for participating in CUE community spaces and a reporting process for handling issues can be found in the Code of Conduct.

Contact

You can get in touch with the cuelang community in the following ways:

Unless otherwise noted, the CUE source files are distributed under the Apache 2.0 license found in the LICENSE file.

This is not an officially supported Google product.