GoodScript VS Code Extension

Language support for GoodScript - TypeScript without the bad parts.

Features

• Full TypeScript Integration: -gs.ts and -gs.tsx files work as TypeScript files with all IDE features
• JSX/TSX Support: Use -gs.tsx for React components with Phase 1 enforcement
• Zero Configuration: Automatic setup - just open a -gs.ts or -gs.tsx file and start coding
• Real-time Validation: Instant feedback on Phase 1 violations (var, ==, function keyword, etc.)
• Quick Fixes: Intelligent code actions for common errors (e.g., add ownership qualifiers)
• Error Squiggles: All GoodScript diagnostics shown as VS Code problems
• Incremental Adoption: Mix -gs.ts, -gs.tsx, and .ts files in the same project

What is Phase 1?

GoodScript Phase 1 enforces "The Good Parts" - a strict TypeScript subset that eliminates JavaScript's problematic features:

• ❌ No var keyword (use let or const)
• ❌ No == or != (use === or !==)
• ❌ No function keyword (use arrow functions)
• ❌ No any type (use explicit types or generics)
• ❌ No implicit truthy/falsy (use explicit comparisons)
• ❌ No delete operator (use optional properties or destructuring)
• ❌ No comma operator (use separate statements)
• ❌ No void operator (use undefined directly)
• ❌ No with statement
• ❌ No eval or Function() constructor
• ❌ No arguments object (use rest parameters)
• ❌ No for-in loops (use for-of)
• ❌ No implicit type coercion (explicit conversions required)

See the GoodScript documentation for complete details.

Requirements

Install the GoodScript compiler:

npm install -g goodscript

This installs both gsc (compiler) and gs (modern CLI tool).

Alternatively, configure a custom compiler path in VS Code settings.

Quick Start

1. Install the extension
2. Create a file with -gs.ts (or -gs.tsx for React) extension
3. Start coding - the extension will:
   • Auto-generate tsconfig.json if needed
   • Provide full TypeScript IntelliSense
   • Show GoodScript Phase 1 errors in real-time

File Extensions

Use -gs.ts for GoodScript files, -gs.tsx for React/JSX.

This provides:

• ✅ Full TypeScript language server support
• ✅ Go to definition, rename, refactoring
• ✅ Import/export works seamlessly
• ✅ JSX syntax highlighting and auto-completion (-gs.tsx only)
• ✅ All IDE features work out of the box

Note: -gs.tsx files compile to TypeScript/JavaScript only (not C++). They're for web development workflows.

Automatic Configuration

When you open a folder with -gs.ts or -gs.tsx files, the extension automatically creates:

tsconfig.json - TypeScript configuration (if not present):

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "lib": ["ES2020"],
    "strict": true,
    "jsx": "preserve"
  },
  "include": ["**/*-gs.ts", "**/*-gs.tsx"]
}

You can customize this configuration as needed - the extension respects existing TypeScript settings.

Extension Settings

This extension contributes the following settings:

• goodscript.compilerPath: Path to the GoodScript compiler (default: gsc)
• goodscript.enableValidation: Enable/disable real-time validation (default: true)
• goodscript.validateOnSave: Validate files on save (default: true)
• goodscript.validateOnType: Validate as you type (default: false, may impact performance)

Installation

1. Install the Extension

Search for "GoodScript" in VS Code Extensions marketplace, or:

code --install-extension goodscript.goodscript

2. Install the Compiler

npm install -g goodscript

This provides the gsc compiler and gs CLI tool needed for validation.

Usage

1. Open or create a -gs.ts file
2. Extension automatically activates and configures your workspace
3. Write GoodScript code with full TypeScript IntelliSense
4. Errors and warnings appear as squiggles
5. View all diagnostics in Problems panel (Cmd/Ctrl+Shift+M)

Supported Diagnostics

The extension shows all GoodScript compiler diagnostics:

• GS001: Ownership cycle detected
• GS101-GS107: Language restrictions (var, eval, ==, !=, etc.)
• GS201: Type coercion not allowed
• GS301: Missing null check on usage reference
• GS303: Missing ownership annotation (naked class reference)

And more!

Quick Fixes

The extension provides intelligent quick fixes for common errors:

GS303 (Missing Ownership Annotation)

When you use a class type without an ownership qualifier:

class Node {
  next: Node | null = null;  // ❌ GS303: naked class reference
}

Click the lightbulb 💡 to see quick fix options:

• 🔒 Wrap with own - Exclusive ownership (unique_ptr)
• 🔗 Wrap with share - Shared ownership (shared_ptr) [Preferred]
• 👁️ Wrap with use - Non-owning reference (weak_ptr)

Selecting an option automatically transforms your code:

class Node {
  next: share<Node> | null = null;  // ✅ Fixed!
}

Commands

• GoodScript: Validate Current File - Manually trigger validation

Known Issues

• Validation on type may impact performance on large files (disabled by default)
• Requires GoodScript compiler to be installed separately

Release Notes

0.9.0

Code Actions and Quick Fixes:

• ✨ Added intelligent quick fixes for GS303 (naked class references)
• 💡 Lightbulb suggestions with ownership qualifier options
• 🎯 Context-aware code actions with helpful descriptions
• 🚀 One-click fixes for missing ownership annotations

0.4.1

Documentation update:

• Added npm installation instructions
• Updated release notes

0.4.0

Updated to match GoodScript 0.4.0 release:

• Support for no-args compilation with tsconfig.json
• Directory structure preservation in output
• Enhanced tsc compatibility

0.1.0

Initial release:

• Zero-configuration setup for -gs.ts files
• Automatic type definition generation
• Full TypeScript language feature integration
• Real-time GoodScript validation
• Support for ownership analysis, null-check enforcement, and language restrictions

Contributing

See the GoodScript repository for contribution guidelines.

License

MIT