-
-
Notifications
You must be signed in to change notification settings - Fork 164
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add VS Code docs and blog post. (#375)
* Start on doc page. * Add report api. * Add blog post. * Fix script. * Update config. * Move file...
- Loading branch information
Showing
13 changed files
with
159 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
slug: vscode-extension | ||
title: New VS Code extension! | ||
authors: [milesj] | ||
tags: [editors, vscode] | ||
--- | ||
|
||
import Image from '@site/src/components/Image'; | ||
|
||
We're very excited to announce the initial release of our Visual Studio Code extension! | ||
|
||
<!--truncate--> | ||
|
||
If you're a huge VS Code fan like us, you most likely use extensions in your everyday workflow. We | ||
want to enhance this experience by providing a fully integrated and interactive moon console! Here's | ||
a preview of what it looks like: | ||
|
||
<Image src={require('../docs/editors/vscode/projects-view.png')} width="40%" /> | ||
|
||
Excited?? Want to learn more? Check out the official | ||
[moonrepo.moon-console](https://marketplace.visualstudio.com/items?itemName=moonrepo.moon-console) | ||
marketplace page, or read the [official documentation](../docs/editors/vscode). This is only the | ||
first iteration of the extension. Expect more advanced features in the future, like... | ||
|
||
- Schema validation for configuration files | ||
- Autocompletion for configuration files | ||
- Automatic running/building of projects in the background | ||
- File type association | ||
- Integrated language server | ||
- And much more! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
--- | ||
title: VS Code extension | ||
sidebar_label: VS Code | ||
--- | ||
|
||
import Image from '@site/src/components/Image'; | ||
import TwoColumn from '@site/src/components/TwoColumn'; | ||
|
||
Enhance your VS Code experience with our integrated moon console! Whether you're a fan of the | ||
command line, or prefer interactive interfaces, our console will be a welcome experience. | ||
|
||
> This extension is in its early stages. Expect more advanced features in the future, like | ||
> autocompletion, config validation, and more! | ||
## Views | ||
|
||
<div className="flex"> | ||
<div className="mr-2"> | ||
<Image | ||
src={require('./vscode/activity-icon.png')} | ||
alt="VS Code - Sidebar icon" | ||
width="50px" | ||
align="left" | ||
padding="0" | ||
/> | ||
</div> | ||
<div> | ||
|
||
All views are available within the moon sidebar. Simply click the moon icon in the left activity | ||
bar! | ||
|
||
</div> | ||
</div> | ||
|
||
<br /> | ||
|
||
<TwoColumn aside={<Image src={require('./vscode/projects-view.png')} alt="VS Code view - Projects" />}> | ||
|
||
### Projects | ||
|
||
The backbone of moon is the projects view. In this view, all moon configured projects will be | ||
listed, categorized by their [`type`](../config/project#type), and designated with their | ||
[`language`](../config/project#language). | ||
|
||
Each project can then be expanded to view all available tasks. Tasks can be ran by clicking the `▶` | ||
icon, or using the command palette. | ||
|
||
> This view is available in both the "Explorer" and "moon" sidebars. | ||
</TwoColumn> | ||
|
||
<TwoColumn | ||
aside={<Image src={require('./vscode/last-run-view.png')} alt="VS Code view - Last run" />} | ||
> | ||
|
||
### Last run | ||
|
||
Information about the last ran target will be displayed in a beautiful table with detailed stats. | ||
Only tasks ran from the [projects view](#projects), or with `--report` on the command line will be | ||
displayed here. | ||
|
||
This table displays all actions that were ran alongside the running primary target(s). They are | ||
ordered topologically via the dependency graph. | ||
|
||
</TwoColumn> | ||
|
||
## Troubleshooting | ||
|
||
View the | ||
[official VS Code marketplace](https://marketplace.visualstudio.com/items?itemName=moonrepo.moon-console) | ||
for more information on the extension, its commands, available settings, and more! | ||
|
||
If you encounter a bug, or have a feature request, please submit them to the | ||
[moonrepo/dev](https://github.com/moonrepo/dev/tree/master/packages/vscode-extension) repository! |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
import React from 'react'; | ||
import clsx from 'clsx'; | ||
|
||
export interface TwoColumnProps { | ||
aside: React.ReactNode; | ||
children: React.ReactNode; | ||
reversed?: boolean; | ||
} | ||
|
||
export default function TwoColumn({ children, aside, reversed }: TwoColumnProps) { | ||
return ( | ||
<section className="sm:grid gap-2 grid-cols-5 mb-4"> | ||
<div className={clsx('col-span-3', reversed && 'order-2')}>{children}</div> | ||
<aside className={clsx('col-span-2', reversed && 'order-1')}>{aside}</aside> | ||
</section> | ||
); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters