typespec-vscode 0.65.0-dev.8 → 0.65.0

package/README.md

@@ -1,25 +1,75 @@
-# TypeSpec Language Support for VS Code
+# TypeSpec Extension in Visual Studio Code
 
 [Repository](https://github.com/microsoft/typespec) | [Documentation](https://typespec.io/docs) | [Issues](https://github.com/microsoft/typespec/issues) | [Samples](https://github.com/microsoft/typespec/tree/main/packages/samples/specs)
 
-This provides provides [TypeSpec](https://github.com/microsoft/typespec) language support for VS Code.
+The TypeSpec extension for Visual Studio Code enhances the development of TypeSpec by leveraging VS Code's powerful features. It provides:
 
-![](https://raw.githubusercontent.com/microsoft/typespec/main/docs/images/vscode.gif)
+- IntelliSense and syntax highlighting
+- Code autocompletion and formatting
+- Live diagnostics and quick fixes
+- Refactoring tools (rename, go-to definition, etc.)
+- Seamless project setup and emitter configuration
+- Generate code from TypeSpec
+
+## Prerequisites
+
+Before using the TypeSpec extension, install [Node.js](https://nodejs.org/en/download/) and verify npm is available:
+
+```sh
+npm --version
+```
+
+Other necessary installations will be prompted within the extension as needed.
 
 ## Features
 
-- Live diagnostic reporting
-- Syntax highlighting
-- Code completion
-- Code folding
-- Formatting
-- Hover info
-- Rename refactoring
-- Go to definition
+### Writing TypeSpec
+
+- **IntelliSense & Auto-completion**: Code faster with smart suggestions.
+- **Code Formatting & Folding**: Keep your code clean and organized with built-in formatting and folding support.
+- **Syntax Highlighting**: Clear and readable TypeSpec syntax.
+- **Live Diagnostics**: Get real-time feedback on code issues.
+- **Quick Fixes & Refactoring**: Rename, go-to definition, and format with ease.
+- **Hover Info**: Get detailed information about TypeSpec elements by hovering over them.
+
+![vscode.gif](https://raw.githubusercontent.com/microsoft/typespec/main/website/src/content/docs/docs/images/vscode.gif)
+
+### Project Initialization
+
+- **Create TypeSpec Project**: Easily initialize a new TypeSpec project based on a template, ensuring a structured and ready-to-use setup.
+  ![vscode_project_scaffolding.gif](https://raw.githubusercontent.com/microsoft/typespec/main/website/src/content/docs/docs/images/vscode_project_scaffolding.gif)
+
+### Generating Code from TypeSpec
+
+The extension allows generating various outputs from TypeSpec:
+
+- **OpenAPI Specification**
+- **Server SDKs**: Generate server stubs for different back-end frameworks.
+- **Client SDKs**: Generate client code for multiple languages, including:
+  - .NET (C#)
+  - Python
+  - Java
+  - JavaScript/TypeScript
+
+Invoke `TypeSpec: Generate From TypeSpec` to generate code:
+
+![vscode_tsp_to_openapi3_generation.gif](https://raw.githubusercontent.com/microsoft/typespec/main/website/src/content/docs/docs/images/vscode_tsp_to_openapi3_generation.gif)
+
+## Commands
+
+The extension provides the following commands:
+
+| **Command**                                        | **Description**                                                     |
+| -------------------------------------------------- | ------------------------------------------------------------------- |
+| `TypeSpec: Create TypeSpec Project`                | Scaffold a new TypeSpec project.                                    |
+| `TypeSpec: Install TypeSpec Compiler/CLI globally` | Install the TypeSpec Compiler/CLI globally.                         |
+| `TypeSpec: Generate From TypeSpec`                 | Compile and generate from TypeSpec files into the specified output. |
+| `TypeSpec: Restart TypeSpec Server`                | Restart the TypeSpec language server.                               |
+| `TypeSpec: Show Output Channel`                    | Open the TypeSpec output channel to view logs.                      |
 
-## Configure
+## Configuration
 
-TypeSpec wil interpolate a few variables using this pattern `${<name>}`. For example `${workspaceFolder}`.
+TypeSpec will interpolate a few variables using this pattern `${<name>}`. For example `${workspaceFolder}`.
 
 Available variables:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typespec-vscode",
-  "version": "0.65.0-dev.8",
+  "version": "0.65.0",
   "author": "Microsoft Corporation",
   "description": "TypeSpec language support for VS Code",
   "homepage": "https://typespec.io",
@@ -227,8 +227,6 @@
     "@types/node": "~22.10.10",
     "@types/vscode": "~1.96.0",
     "@types/semver": "^7.5.8",
-    "@typespec/compiler": "~0.64.0 || >=0.65.0-dev <0.65.0",
-    "@typespec/internal-build-utils": "~0.64.0 || >=0.65.0-dev <0.65.0",
     "@vitest/coverage-v8": "^3.0.4",
     "@vitest/ui": "^3.0.3",
     "@vscode/test-web": "^0.0.65",
@@ -239,12 +237,12 @@
     "rollup": "~4.31.0",
     "semver": "^7.6.3",
     "typescript": "~5.7.3",
-    "vitest": "^3.0.4",
+    "vitest": "^3.0.5",
     "vscode-languageclient": "~9.0.1",
-    "yaml": "~2.7.0"
+    "yaml": "~2.7.0",
+    "@typespec/compiler": "~0.65.0",
+    "@typespec/internal-build-utils": "~0.65.0"
   },
-  "dependencies": {},
-  "peerDependencies": {},
   "scripts": {
     "clean": "rimraf ./dist ./temp",
     "build": "npm run compile && npm run copy-tmlanguage && npm run generate-language-configuration && npm run generate-third-party-notices && npm run package-vsix",