Developer Documentation

November 14, 2025 ยท View on GitHub

This directory contains documentation for developers contributing to the SSL VS Code extension.

๐Ÿ“š Documentation Files

Architecture & Development

ARCHITECTURE.md

  • Complete extension architecture and design
  • Feature implementation details
  • Build and development guide
  • Configuration reference

CI/CD & Testing

CI_SETUP.md

  • GitHub Actions workflow documentation
  • CI/CD pipeline setup
  • Testing infrastructure
  • Publishing workflow

Language Reference

grammar/ssl-ebnf.md

  • Complete EBNF grammar for SSL v11
  • Language syntax reference
  • Parser implementation guide

๐Ÿš€ Quick Start

For Contributors

  1. Read ARCHITECTURE.md to understand the codebase
  2. Check CI_SETUP.md for testing and CI information
  3. See grammar/ssl-ebnf.md for language details

Running Tests

npm run compile
npm run lint
npm run test:unit

Building the Extension

npm run package

Creates a .vsix file you can install locally.

๐Ÿ“– Additional Resources

๐Ÿค Contributing

See ARCHITECTURE.md for:

  • Project structure
  • Coding conventions
  • Testing guidelines
  • Pull request process