https://github.com/upbound/vscode-up

Visual Studio Code extension for @upbound
https://github.com/upbound/vscode-up

Last synced: about 1 year ago
JSON representation

Visual Studio Code extension for @upbound

• Host: GitHub
• URL: https://github.com/upbound/vscode-up
• Owner: upbound
• License: apache-2.0
• Created: 2021-12-03T22:32:13.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-10T23:12:41.000Z (over 1 year ago)
• Last Synced: 2025-05-08T23:46:02.565Z (about 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 29 MB
• Stars: 16
• Watchers: 20
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Crossplane package support for Visual Studio Code

[![Slack](https://img.shields.io/badge/slack-crossplane-green.svg?style=flat)](https://crossplane.slack.com/messages/upbound/)

## Getting Started

Welcome! 👋🏻


Whether you are new to Crossplane package authoring or an experienced Crossplane 

operator, we hope this extension enhances your development experience.

* **Step 1.** If you haven't done so already, install the latest version of [Up]

  and the [VS Code Up extension].

  * If you currently have `up` installed, make sure you are using at least version `v0.8.0`.

    * You can check your version by running `up --version`.

  * [Managing extensions in VS Code].

* **Step 2.** To activate the extension, open any directory or workspace

  containing a Crossplane package (i.e. one that contains a `crossplane.yaml`).

## Features

This extension currently provides diagnostics as you work, through its integation 

with [`xpls`]. You can see overviews of the various features currently available

below:








(crossplane.yaml dependency version validation)










(crossplane.yaml dependency type validation)










(crossplane.yaml dependency missing validation)










(XRC schema validation)










(Composed resource schema validation)










(Composed resource schema validation with patched details)










(XRD openAPIv3Schema validation)



## Ask for help

If you run into a problem please reach out to us

by [filing an issue],

[starting a GitHub discussion],

or by asking a question on [Slack]

## Contributing

See [CONTRIBUTING.md]

## License

[Apache 2.0 license](LICENSE)

[CONTRIBUTING.md]: https://github.com/upbound/vscode-up/blob/main/CONTRIBUTING.md

[filing an issue]: https://github.com/upbound/vscode-up/issues/new/choose

[starting a GitHub discussion]: https://github.com/upbound/vscode-up/discussions

[LICENSE]: LICENSE

[Managing extensions in VS Code]: https://code.visualstudio.com/docs/editor/extension-gallery

[Slack]: https://crossplane.slack.com/messages/upbound/

[Up]: https://github.com/upbound/up

[VS Code Up extension]: https://marketplace.visualstudio.com/items?itemName=Upboundio.upbound

[`xpls`]: https://github.com/upbound/up