You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
provides syntax highlighting and autocompletion for editing the `lint.yaml`
26
+
file, as well as linting for OpenAPI documents and other supported file
27
+
types.
28
+
</span>
26
29
</Callout>
27
30
28
31
In addition to running validation, Speakeasy lints OpenAPI documents to ensure stylistic validity. By default, the linter runs using a [recommended set of rules](/docs/linting/linting#speakeasy-recommended), which can be extended with the [available ruleset](/docs/linting/linting#available-rulesets). Custom rules can also be written using the Spectral format.
@@ -60,7 +63,7 @@ sources:
60
63
61
64
Running `speakeasy run` lints the document as part of the workflow and generates an HTML report accessible from a link in the command output.
62
65
63
-
3. Use the <Image src="/docs/assets/vscode.svg" width="20" height="20" style={{display: "inline-block"}} alt='Visual Studio Code logo' /> [Speakeasy VS Code extension](https://marketplace.visualstudio.com/items?itemName=Speakeasy.speakeasy-vscode-extension) in the IDE.
66
+
3. Use the <Image src="/assets/vscode.svg" width="20" height="20" style={{display: "inline-block"}} alt='Visual Studio Code logo' /> [Speakeasy VS Code extension](https://marketplace.visualstudio.com/items?itemName=Speakeasy.speakeasy-vscode-extension) in the IDE.
64
67
65
68
By default, these options use the `speakeasy-recommended` ruleset to ensure OpenAPI documents meet the Speakeasy quality bar.
For most use cases, the `speakeasy configure` command is the recommended means of interacting with the Speakeasy `gen.yaml` file. The `speakeasy configure` command has subcommands for configuring sources, targets, GitHub workflow setups, and package publications. All new targets created using `speakeasy quickstart` automatically generate workflow files in the `.speakeasy/` folder in the root of the target directory.
11
9
12
-
The <Imagesrc={vsCodeImageUrl}alt="VS Code"width="20"height="20"style={{display: "inline-block"}} /> [Speakeasy VS Code extension](https://marketplace.visualstudio.com/items?itemName=Speakeasy.speakeasy-vscode-extension) provides several useful features for manually editing the `gen.yaml` file, including syntax highlighting, autocompletion, and linting for OpenAPI documents and other supported file types.
10
+
The <Imagesrc="/assets/vscode.svg"alt="VS Code"width="20"height="20"style={{display: "inline-block"}} /> [Speakeasy VS Code extension](https://marketplace.visualstudio.com/items?itemName=Speakeasy.speakeasy-vscode-extension) provides several useful features for manually editing the `gen.yaml` file, including syntax highlighting, autocompletion, and linting for OpenAPI documents and other supported file types.
For most use cases we recommend interacting with the Speakeasy workflow file (`workflow.yaml`) through the `speakeasy configure` command.
16
14
This command has subcommands to configure sources, targets, github setup and package publishing. All new targets created through `speakeasy quickstart` will automatically have a workflow
17
15
file created in the `.speakeasy/` folder in the root of their target directory.
18
16
19
-
For editing the workflow file manually, <Imagesrc={vsCodeImageUrl}alt="VS Code"width="20"height="20"style={{display: "inline-block"}} /> [Speakeasy's VSCode extension](https://marketplace.visualstudio.com/items?itemName=Speakeasy.speakeasy-vscode-extension) provides syntax highlighting and autocompletion for the workflow file,
17
+
For editing the workflow file manually, <Imagesrc="/assets/vscode.svg"alt="VS Code"width="20"height="20"style={{display: "inline-block"}} /> [Speakeasy's VSCode extension](https://marketplace.visualstudio.com/items?itemName=Speakeasy.speakeasy-vscode-extension) provides syntax highlighting and autocompletion for the workflow file,
20
18
in addition to linting for OpenAPI documents, and our other supported file types.
0 commit comments