String ID Standards Extension

A VS Code extension for displaying internal string ID standards with a React-based interface.

Features

This extension provides a comprehensive reference for string ID naming standards across different categories:

• Component IDs: Hierarchical component identifier patterns
• API Endpoints: Structured API endpoint naming conventions
• Event Names: Event identifier patterns with domain and action
• Configuration Keys: Modular configuration key structures
• Error Codes: Standardized error identification patterns

Usage

1. Open the command palette (Cmd+Shift+P or Ctrl+Shift+P)
2. Type "String ID Standards" and select "Open String ID Standards"
3. Browse the standards with search and category filtering

Development

Prerequisites

• Node.js (v18 or higher)
• VS Code

Setup

npm install
npm run compile

Running the Extension

1. Press F5 to open a new Extension Development Host window
2. In the new window, open the command palette and run "String ID Standards: Open String ID Standards"

Building for Production

npm run package

Project Structure

• src/extension.ts - Main extension code with webview panel management
• src/webview/ - React components for the webview content
• media/ - CSS files and bundled webview assets

Standards Categories

Component IDs

Pattern: component.elementType.specificPurpose Example: button.primary.submit

API Endpoints

Pattern: api.version.resource.action Example: api.v1.users.create

Event Names

Pattern: event.domain.action.target Example: event.user.login.success

Configuration Keys

Pattern: config.module.setting.property Example: config.database.connection.timeout

Error Codes

Pattern: error.domain.type.code Example: error.auth.validation.invalidCredentials

Contributing

Follow the established string ID standards when making changes to this extension.