diff --git a/packages/turbo-vsc/README.md b/packages/turbo-vsc/README.md index 53ebe1af09740..82d45ac877511 100644 --- a/packages/turbo-vsc/README.md +++ b/packages/turbo-vsc/README.md @@ -1,48 +1,37 @@ -# Turborepo VSC Extension +![](resources/readme-hero.png) -This extension provides a handy interface into your turbo-enhanced monorepo. +Enhance the experience in your Turborepo with faster feedback, repository discovery tooling, one-click task running, and more. ## Features -### Global turbo installer +#### Understand and use your tasks faster -We recommend you use turbo globally to simplify running commands. The extension will prompt you to install it if you don't already have it available. - -### Automatic start / stop for the turbo daemon - -Turborepo uses a background task to make your builds lightning fast. Rather than start it when you invoke turbo, we can instead start it when you launch your editor, keeping things snappy. - -### Simple daemon status controls - -In the bottom left toolbar, you will find the current status of the daemon. Clicking on the button will toggle it on and off. - -### Repository discovery tools +Find references for `turbo` tasks to quickly discover which `package.json` scripts will run. Then, run your pipeline with one click. -#### Find references for turbo tasks - -![references](resources/references.png) +![A screenshot of a VSCode editor showing the references for a `build` pipeline.](resources/references.png) Every task in your pipeline can be followed to find its references. -#### One-click task execution +#### Configuration help -Every entry in your pipeline can be executed with a single click for quick debugging. +Get instant feedback if you write incorrect globs, refer to non-existent packages or tasks, and more. -#### Glob validation +![A screnshot of a VSCode editor notifying of an invalid glob syntax.](resources/globs.png) -![globs](resources/globs.png) +#### Contextual codemods -Detect bad globs live while you write, and even get github copilot involved in resolving them. +Get warned of deprecated syntax and run codemods to fix them with a click. -#### Detect missing tasks and packages +![A screenshot of a VSCode editor showing the ability to Quick Fix a codemod for deprecated syntax.](resources/contextual-codemod.png) -Pipeline entries that do not refer to a valid package or task will be highlighted for you. +### Global `turbo` installer -#### Contextual codemods +We recommend you use turbo globally to simplify running commands. The extension will prompt you to install it if you don't already have it available. + +### Daemon controls -Got deprecated syntax? Know about immediately and automatically fix them with codemods. +Turborepo uses a background task to make your builds lightning fast. Rather than start it when you invoke turbo, we can instead start it when you launch your editor, keeping things snappy. ## Settings -There is a single setting so far, which can be used to override the auto-detected path to your turbo binary, -if it fails or if you use a different one. You can access it in the vscode settings. +- Override the auto-detection for your `turbo` binary if it fails or to use a different one. diff --git a/packages/turbo-vsc/package.json b/packages/turbo-vsc/package.json index dcc9128e9f7d9..87de4f1e0e5f5 100644 --- a/packages/turbo-vsc/package.json +++ b/packages/turbo-vsc/package.json @@ -1,8 +1,8 @@ { "name": "turbo-vsc", - "displayName": "Turborepo", + "displayName": "Turborepo LSP", "version": "1.0.0", - "description": "Turborepo extension for VSCode", + "description": "Tools and instant feedback for your build system", "main": "out/main.js", "publisher": "Vercel", "scripts": { @@ -67,7 +67,7 @@ } ], "configuration": { - "title": "Turborepo", + "title": "Turborepo LSP", "properties": { "turbo.path": { "type": "string", diff --git a/packages/turbo-vsc/resources/contextual-codemod.png b/packages/turbo-vsc/resources/contextual-codemod.png new file mode 100644 index 0000000000000..c3580f4bdfe3a Binary files /dev/null and b/packages/turbo-vsc/resources/contextual-codemod.png differ diff --git a/packages/turbo-vsc/resources/globs.png b/packages/turbo-vsc/resources/globs.png index f805bc5b22cf3..9569d78f1160a 100644 Binary files a/packages/turbo-vsc/resources/globs.png and b/packages/turbo-vsc/resources/globs.png differ diff --git a/packages/turbo-vsc/resources/icon.png b/packages/turbo-vsc/resources/icon.png index 445bc6d2b6c43..2e844ffbb9eb4 100644 Binary files a/packages/turbo-vsc/resources/icon.png and b/packages/turbo-vsc/resources/icon.png differ diff --git a/packages/turbo-vsc/resources/readme-hero.png b/packages/turbo-vsc/resources/readme-hero.png new file mode 100644 index 0000000000000..03f2ae7a35e65 Binary files /dev/null and b/packages/turbo-vsc/resources/readme-hero.png differ diff --git a/packages/turbo-vsc/resources/references.png b/packages/turbo-vsc/resources/references.png index 7632cfe03c4f6..2c060e75f6753 100644 Binary files a/packages/turbo-vsc/resources/references.png and b/packages/turbo-vsc/resources/references.png differ