Best Practices Extension

A VS Code extension providing quick access to internal best practices scripts and workflows for CBS Consulting.

Features

This extension adds convenient command buttons to your editor toolbar for frequently used tasks:

Git Ticket Management

• Git: Open Ticket - Execute git open-ticket <prefix> <ticket> command
  • Prompts for prefix (feature, fix, bug, chore, docs, or custom text)
  • Prompts for ticket number
• Git: Close Ticket - Execute git close-ticket [--auto-complete] [-m <message>] command
  • Prompts for auto-complete preference (default: Yes)
  • Prompts for optional commit message (required if multiple commits exist)

These buttons are always visible in the status bar (bottom of VS Code) when enabled, even when no file is open.

HDI Container Deployment

• HDI Deployments - Tree view in the Explorer sidebar showing deployment profiles from .cdsrc-private.json
  • Displays all profiles that contain HANA service configurations
  • Shows services with detailed binding information (org/space/instance)
  • Click the rocket icon (🚀) next to any profile to deploy HDI container using that profile
  • Refresh button to reload profiles after configuration changes

The deployment process executes the following steps:

1. Build CDS project with selected profile (cds build --profile <profile> --for hana)
2. Generate temporary credentials from Cloud Foundry bindings
3. Deploy to HDI container in gen/db
4. Cleanup temporary credentials

Note: Only profiles with hdiDeployable: true AND at least one hana or hana-cloud service will appear in the tree view. Both conditions are required for HDI deployment.

Code Documentation

• Add Documentation button calls GitHub Copilot's documentation generation command directly

This button appears only when:

• Text is selected in the editor
• The file is TypeScript (.ts) or JavaScript (.js)

Note: This uses GitHub Copilot's default keybindings. You can also access documentation generation through GitHub Copilot's own interface.

Commands

All commands are available through the Command Palette (Ctrl+Shift+P / Cmd+Shift+P):

• Git: Open Ticket - Opens a terminal and executes git open-ticket <prefix> <ticket> with prompted parameters
• Git: Close Ticket - Opens a terminal and executes git close-ticket with prompted options (auto-complete and optional message)
• HDI Containers: Deploy - Deploys HDI container using the selected profile from the tree view
• HDI Containers: Refresh - Reloads profiles from .cdsrc-private.json

Configuration

Control button visibility through VS Code settings:

• bestPractices.showGitButtons - Show/hide Git ticket buttons in status bar (default: true)
• bestPractices.showDocButton - Show/hide documentation button when applicable (default: true)

Access settings: File > Preferences > Settings and search for "Best Practices"

Requirements

• VS Code 1.85.0 or higher
• Git installed and configured with open-ticket and close-ticket aliases
• GitHub Copilot extension (for documentation generation feature)
• For HDI deployment:
  • Cloud Foundry CLI (cf) installed and authenticated
  • SAP Cloud Application Programming Model CLI (@sap/cds-dk) installed
  • .cdsrc-private.json file in workspace root with Cloud Foundry service bindings
  • @cbs-consulting/generate-default-env package installed in workspace (npm install -D @cbs-consulting/generate-default-env)