azure-sdk-typescript-sample-review

name	azure-sdk-typescript-sample-review
description	Reviews Azure SDK TypeScript code samples for best practices, credential handling, error patterns, and documentation compliance. Trigger: "review TypeScript Azure SDK sample", "check TypeScript sample", "Azure SDK TypeScript review".
status	active
tags	["review","azure","sdk","typescript","sample","check","best","practices","code","reviewing"]
category	review

USE FOR

• "review Azure SDK TypeScript sample"
• "check TypeScript sample for best practices"
• "Azure SDK TypeScript code review"
• Reviewing credential handling in Azure SDK TypeScript samples
• Error pattern analysis for TypeScript Azure SDK samples
• Documentation compliance check for TypeScript Azure SDK samples

DO NOT USE FOR

• General TypeScript code review unrelated to Azure SDK samples (use typescript-review)
• Production application code review
• Azure service configuration

Context

Base template: Inherits from azure-sdk-sample-review for shared review patterns (credentials, error handling, documentation, infrastructure). This skill adds TypeScript-specific rules below.

Reviews TypeScript code samples for Azure SDKsintended for publication as Microsoft Azure samples. Focuses on:

• Azure SDK client patterns (Track 2 @azure/* packages, client construction, pipeline options)
• Authentication (DefaultAzureCredential, managed identities, token management)
• Service-specific best practices (Cosmos DB, SQL, Storage, Service Bus, Key Vault, AI services)
• Sample hygiene (credentials, build artifacts, dependency audit, .gitignore)
• Documentation accuracy (README output, troubleshooting, setup instructions)
• Infrastructure-as-code (Bicep/Terraform with AVM modules, API versions, parameter validation)
• azd integration (azure.yaml structure, hooks, service definitions)

Total rules: 63 (10 CRITICAL, 21 HIGH, 26 MEDIUM, 6 LOW)

---

Severity Legend

• CRITICAL: Security vulnerability or sample will not run. Must fix before publication.
• HIGH: Major quality issue causing user confusion or production failures. Fix before merge.
• MEDIUM: Best practice violation. Fix before publication for maintainability.
• LOW: Polish item, nice-to-have improvement.

---

Quick Pre-Review Checklist (5-Minute Scan)

• Uses Track 2 Azure SDK packages (@azure/*, not azure-*)
• Uses DefaultAzureCredential (not connection strings or hardcoded keys)
• .gitignore includes .env, node_modules/, dist/
• No hardcoded credentials, API keys, or tokens in code
• README.md exists with prerequisites, setup steps, and expected output
• LICENSE (MIT) present at some level of repo hierarchy
• npm audit passes with no critical/high vulnerabilities
• strict: true in tsconfig.json
• catch blocks with type-safe error narrowing
• Resource cleanup (finally blocks or Symbol.asyncDispose)
• package-lock.json committed, no mixed package managers
• Build succeeds (npm run build) and sample runs (npm start)

---

Blocker Issues (Auto-Reject)

1. Hardcoded secrets — Any credentials, API keys, connection strings, or tokens in code
2. Missing authentication — No auth or uses insecure methods
3. No error handling — Uncaught promises, no try/catch, silent failures
4. Broken imports — Missing dependencies, incorrect import paths
5. Security vulnerabilities — npm audit shows critical or high CVEs
6. Missing LICENSE — No LICENSE file at ANY level of repo hierarchy (MIT required). ⚠️ Check repo root before flagging.
7. .env file committed — Live credentials in version control. ⚠️ Verify with git ls-files .env.
8. Track 1 packages — Uses legacy azure-* instead of @azure/*

---

Detailed Rules

Language-Specific References (TypeScript code examples)

#	Section	Reference File
1	Project Setup — TypeScript	references/project-setup.md
2	SDK Client Patterns — TypeScript	references/sdk-client-patterns.md
3	AI Services — TypeScript	references/ai-services.md
4	Data Services — TypeScript	references/data-services.md
5	Messaging — TypeScript	references/messaging.md
6	Key Vault — TypeScript	references/keyvault.md
7	Vector Search — TypeScript	references/vector-search.md
8	Error Handling — TypeScript	references/error-handling.md
9	Data Management — TypeScript	references/data-management.md
10	Sample Hygiene — TypeScript	references/sample-hygiene.md

---

Companion Skills

• acrolinx-score-improvement — Article quality, readability, style, terminology
• typescript-review — General TypeScript patterns (not Azure SDK specific)

---

Summary

63 rules (10 CRITICAL, 21 HIGH, 26 MEDIUM, 6 LOW) covering Azure SDK TypeScript sample review across authentication, data services, AI, messaging, infrastructure, documentation, and hygiene. Apply to ensure samples are secure, accurate, maintainable, and ready for publication.

References

References location: All reference files for this skill live inside the skill directory at .github/skills/data-plus-ai-sdk-typescript-sample-review/. Paths like references/file.md resolve to .github/skills/data-plus-ai-sdk-typescript-sample-review/references/file.md. Paths are relative to the skill folder, not the repo root.