@mytechtoday/augment-extensions 0.7.0 → 1.2.0

package/augment-extensions/coding-standards/typescript/rules/naming-conventions.md

@@ -1,225 +1,225 @@
-# TypeScript Naming Conventions
-
-## Core Principles
-
-1. **Clarity over brevity** - Names should be self-documenting
-2. **Consistency** - Follow established patterns throughout codebase
-3. **Avoid abbreviations** - Unless universally understood (e.g., `id`, `url`)
-
-## Variables and Constants
-
-### Variables (camelCase)
-
-```typescript
-// ✅ Good
-const userProfile = getUserProfile();
-const isAuthenticated = checkAuth();
-const totalCount = items.length;
-
-// ❌ Bad
-const up = getUserProfile();
-const auth = checkAuth();
-const cnt = items.length;
-```
-
-### Constants (UPPER_SNAKE_CASE for true constants)
-
-```typescript
-// ✅ Good - True constants
-const MAX_RETRY_ATTEMPTS = 3;
-const API_BASE_URL = 'https://api.example.com';
-const DEFAULT_TIMEOUT_MS = 5000;
-
-// ✅ Good - Configuration objects (camelCase)
-const apiConfig = {
-  baseUrl: 'https://api.example.com',
-  timeout: 5000,
-  retries: 3
-};
-
-// ❌ Bad - Mixing conventions
-const Max_Retry_Attempts = 3;
-const api_base_url = 'https://api.example.com';
-```
-
-## Functions and Methods
-
-### Functions (camelCase, verb-based)
-
-```typescript
-// ✅ Good - Clear action verbs
-function fetchUserData(userId: string): Promise<User> { }
-function validateEmail(email: string): boolean { }
-function transformResponse(data: ApiResponse): User[] { }
-
-// ❌ Bad - Unclear or noun-based
-function user(id: string): Promise<User> { }
-function email(e: string): boolean { }
-function response(d: ApiResponse): User[] { }
-```
-
-### Boolean Functions (is/has/can/should prefix)
-
-```typescript
-// ✅ Good
-function isValidEmail(email: string): boolean { }
-function hasPermission(user: User, permission: string): boolean { }
-function canEditPost(user: User, post: Post): boolean { }
-function shouldRetry(attempt: number): boolean { }
-
-// ❌ Bad
-function validEmail(email: string): boolean { }
-function permission(user: User, perm: string): boolean { }
-function editPost(user: User, post: Post): boolean { }
-```
-
-## Classes and Interfaces
-
-### Classes (PascalCase, noun-based)
-
-```typescript
-// ✅ Good
-class UserRepository { }
-class EmailValidator { }
-class PaymentProcessor { }
-class HttpClient { }
-
-// ❌ Bad
-class userRepository { }
-class validateEmail { }
-class processPayment { }
-class httpClient { }
-```
-
-### Interfaces (PascalCase, descriptive)
-
-```typescript
-// ✅ Good - No 'I' prefix (modern TypeScript convention)
-interface User {
-  id: string;
-  email: string;
-}
-
-interface UserRepository {
-  findById(id: string): Promise<User | null>;
-  save(user: User): Promise<void>;
-}
-
-// ❌ Bad - Hungarian notation
-interface IUser { }
-interface IUserRepository { }
-```
-
-### Type Aliases (PascalCase)
-
-```typescript
-// ✅ Good
-type UserId = string;
-type UserRole = 'admin' | 'user' | 'guest';
-type ApiResponse<T> = {
-  data: T;
-  error?: string;
-};
-
-// ❌ Bad
-type userId = string;
-type user_role = 'admin' | 'user' | 'guest';
-```
-
-## Enums
-
-### Enums (PascalCase for enum, UPPER_SNAKE_CASE for values)
-
-```typescript
-// ✅ Good
-enum UserRole {
-  ADMIN = 'ADMIN',
-  USER = 'USER',
-  GUEST = 'GUEST'
-}
-
-enum HttpStatus {
-  OK = 200,
-  NOT_FOUND = 404,
-  INTERNAL_ERROR = 500
-}
-
-// ❌ Bad
-enum userRole {
-  admin = 'admin',
-  user = 'user'
-}
-```
-
-## Generics
-
-### Generic Type Parameters
-
-```typescript
-// ✅ Good - Descriptive single letter or full word
-function map<T, U>(items: T[], fn: (item: T) => U): U[] { }
-function createRepository<TEntity>(config: Config): Repository<TEntity> { }
-
-// ✅ Good - Multiple related generics
-interface Map<TKey, TValue> {
-  get(key: TKey): TValue | undefined;
-  set(key: TKey, value: TValue): void;
-}
-
-// ❌ Bad - Unclear or inconsistent
-function map<A, B>(items: A[], fn: (item: A) => B): B[] { }
-```
-
-## Files and Directories
-
-### File Names (kebab-case)
-
-```
-// ✅ Good
-user-repository.ts
-email-validator.ts
-payment-processor.ts
-api-client.ts
-
-// ❌ Bad
-UserRepository.ts
-emailValidator.ts
-payment_processor.ts
-```
-
-### Directory Names (kebab-case)
-
-```
-src/
-├── user-management/
-├── payment-processing/
-├── api-clients/
-└── shared-utilities/
-```
-
-## Private Members
-
-### Private Fields (prefix with underscore)
-
-```typescript
-class UserService {
-  // ✅ Good
-  private _cache: Map<string, User>;
-  private _apiClient: HttpClient;
-  
-  // ❌ Bad (no clear indication of privacy)
-  private cache: Map<string, User>;
-  private apiClient: HttpClient;
-}
-```
-
-## Summary
-
-- **Variables/Functions**: camelCase
-- **Classes/Interfaces/Types**: PascalCase
-- **Constants**: UPPER_SNAKE_CASE (true constants) or camelCase (config objects)
-- **Files/Directories**: kebab-case
-- **Booleans**: is/has/can/should prefix
-- **Generics**: T, U, V or descriptive (TEntity, TKey, TValue)
-- **Private**: Prefix with underscore
-
+# TypeScript Naming Conventions
+
+## Core Principles
+
+1. **Clarity over brevity** - Names should be self-documenting
+2. **Consistency** - Follow established patterns throughout codebase
+3. **Avoid abbreviations** - Unless universally understood (e.g., `id`, `url`)
+
+## Variables and Constants
+
+### Variables (camelCase)
+
+```typescript
+// ✅ Good
+const userProfile = getUserProfile();
+const isAuthenticated = checkAuth();
+const totalCount = items.length;
+
+// ❌ Bad
+const up = getUserProfile();
+const auth = checkAuth();
+const cnt = items.length;
+```
+
+### Constants (UPPER_SNAKE_CASE for true constants)
+
+```typescript
+// ✅ Good - True constants
+const MAX_RETRY_ATTEMPTS = 3;
+const API_BASE_URL = 'https://api.example.com';
+const DEFAULT_TIMEOUT_MS = 5000;
+
+// ✅ Good - Configuration objects (camelCase)
+const apiConfig = {
+  baseUrl: 'https://api.example.com',
+  timeout: 5000,
+  retries: 3
+};
+
+// ❌ Bad - Mixing conventions
+const Max_Retry_Attempts = 3;
+const api_base_url = 'https://api.example.com';
+```
+
+## Functions and Methods
+
+### Functions (camelCase, verb-based)
+
+```typescript
+// ✅ Good - Clear action verbs
+function fetchUserData(userId: string): Promise<User> { }
+function validateEmail(email: string): boolean { }
+function transformResponse(data: ApiResponse): User[] { }
+
+// ❌ Bad - Unclear or noun-based
+function user(id: string): Promise<User> { }
+function email(e: string): boolean { }
+function response(d: ApiResponse): User[] { }
+```
+
+### Boolean Functions (is/has/can/should prefix)
+
+```typescript
+// ✅ Good
+function isValidEmail(email: string): boolean { }
+function hasPermission(user: User, permission: string): boolean { }
+function canEditPost(user: User, post: Post): boolean { }
+function shouldRetry(attempt: number): boolean { }
+
+// ❌ Bad
+function validEmail(email: string): boolean { }
+function permission(user: User, perm: string): boolean { }
+function editPost(user: User, post: Post): boolean { }
+```
+
+## Classes and Interfaces
+
+### Classes (PascalCase, noun-based)
+
+```typescript
+// ✅ Good
+class UserRepository { }
+class EmailValidator { }
+class PaymentProcessor { }
+class HttpClient { }
+
+// ❌ Bad
+class userRepository { }
+class validateEmail { }
+class processPayment { }
+class httpClient { }
+```
+
+### Interfaces (PascalCase, descriptive)
+
+```typescript
+// ✅ Good - No 'I' prefix (modern TypeScript convention)
+interface User {
+  id: string;
+  email: string;
+}
+
+interface UserRepository {
+  findById(id: string): Promise<User | null>;
+  save(user: User): Promise<void>;
+}
+
+// ❌ Bad - Hungarian notation
+interface IUser { }
+interface IUserRepository { }
+```
+
+### Type Aliases (PascalCase)
+
+```typescript
+// ✅ Good
+type UserId = string;
+type UserRole = 'admin' | 'user' | 'guest';
+type ApiResponse<T> = {
+  data: T;
+  error?: string;
+};
+
+// ❌ Bad
+type userId = string;
+type user_role = 'admin' | 'user' | 'guest';
+```
+
+## Enums
+
+### Enums (PascalCase for enum, UPPER_SNAKE_CASE for values)
+
+```typescript
+// ✅ Good
+enum UserRole {
+  ADMIN = 'ADMIN',
+  USER = 'USER',
+  GUEST = 'GUEST'
+}
+
+enum HttpStatus {
+  OK = 200,
+  NOT_FOUND = 404,
+  INTERNAL_ERROR = 500
+}
+
+// ❌ Bad
+enum userRole {
+  admin = 'admin',
+  user = 'user'
+}
+```
+
+## Generics
+
+### Generic Type Parameters
+
+```typescript
+// ✅ Good - Descriptive single letter or full word
+function map<T, U>(items: T[], fn: (item: T) => U): U[] { }
+function createRepository<TEntity>(config: Config): Repository<TEntity> { }
+
+// ✅ Good - Multiple related generics
+interface Map<TKey, TValue> {
+  get(key: TKey): TValue | undefined;
+  set(key: TKey, value: TValue): void;
+}
+
+// ❌ Bad - Unclear or inconsistent
+function map<A, B>(items: A[], fn: (item: A) => B): B[] { }
+```
+
+## Files and Directories
+
+### File Names (kebab-case)
+
+```
+// ✅ Good
+user-repository.ts
+email-validator.ts
+payment-processor.ts
+api-client.ts
+
+// ❌ Bad
+UserRepository.ts
+emailValidator.ts
+payment_processor.ts
+```
+
+### Directory Names (kebab-case)
+
+```
+src/
+├── user-management/
+├── payment-processing/
+├── api-clients/
+└── shared-utilities/
+```
+
+## Private Members
+
+### Private Fields (prefix with underscore)
+
+```typescript
+class UserService {
+  // ✅ Good
+  private _cache: Map<string, User>;
+  private _apiClient: HttpClient;
+  
+  // ❌ Bad (no clear indication of privacy)
+  private cache: Map<string, User>;
+  private apiClient: HttpClient;
+}
+```
+
+## Summary
+
+- **Variables/Functions**: camelCase
+- **Classes/Interfaces/Types**: PascalCase
+- **Constants**: UPPER_SNAKE_CASE (true constants) or camelCase (config objects)
+- **Files/Directories**: kebab-case
+- **Booleans**: is/has/can/should prefix
+- **Generics**: T, U, V or descriptive (TEntity, TKey, TValue)
+- **Private**: Prefix with underscore
+

package/augment-extensions/collections/html-css-js/README.md

@@ -1,82 +1,82 @@
-# HTML/CSS/JS Frontend Collection
-
-Complete frontend development collection bundling HTML, CSS, and JavaScript standards.
-
-## Overview
-
-This collection provides a comprehensive set of coding standards for modern web development by bundling three independent modules:
-
-- **HTML Standards** (`coding-standards/html`)
-- **CSS Standards** (`coding-standards/css`)
-- **JavaScript Standards** (`coding-standards/js`)
-
-## Key Benefits
-
-- **Complete Frontend Coverage**: All three core web technologies in one collection
-- **Modular**: Each module can be used independently if needed
-- **Backward Compatible**: Replaces the monolithic `html-css-js-standards` module
-- **Comprehensive**: Covers semantic HTML, modern CSS, and ES6+ JavaScript
-
-## Installation
-
-### Using the Collection
-
-```bash
-augx link collections/html-css-js
-```
-
-This will automatically link all three modules.
-
-### Using Individual Modules
-
-You can also link modules individually:
-
-```bash
-augx link coding-standards/html
-augx link coding-standards/css
-augx link coding-standards/js
-```
-
-## Included Modules
-
-### HTML Standards (32,477 characters)
-
-- Semantic HTML5 elements
-- Accessibility guidelines (WCAG 2.1)
-- Modern HTML features
-
-### CSS Standards (30,556 characters)
-
-- Modern CSS features (Grid, Flexbox, Custom Properties)
-- Responsive design patterns
-- Preprocessor best practices (Sass, Less)
-
-### JavaScript Standards (101,818 characters)
-
-- ES6+ features and syntax
-- Async patterns (Promises, async/await)
-- DOM manipulation best practices
-- Performance optimization
-- Development tooling
-
-## Total Character Count
-
-~164,851 characters (across all three modules)
-
-## Version
-
-1.0.0
-
-## Backward Compatibility
-
-This collection replaces the monolithic `coding-standards/html-css-js` module. If you were using the old module, you can migrate to this collection seamlessly:
-
-```bash
-augx unlink coding-standards/html-css-js
-augx link collections/html-css-js
-```
-
-## Migration Notes
-
-The collection maintains 100% backward compatibility with the original `html-css-js-standards` module. All rules, examples, and guidelines are preserved in the individual modules.
-
+# HTML/CSS/JS Frontend Collection
+
+Complete frontend development collection bundling HTML, CSS, and JavaScript standards.
+
+## Overview
+
+This collection provides a comprehensive set of coding standards for modern web development by bundling three independent modules:
+
+- **HTML Standards** (`coding-standards/html`)
+- **CSS Standards** (`coding-standards/css`)
+- **JavaScript Standards** (`coding-standards/js`)
+
+## Key Benefits
+
+- **Complete Frontend Coverage**: All three core web technologies in one collection
+- **Modular**: Each module can be used independently if needed
+- **Backward Compatible**: Replaces the monolithic `html-css-js-standards` module
+- **Comprehensive**: Covers semantic HTML, modern CSS, and ES6+ JavaScript
+
+## Installation
+
+### Using the Collection
+
+```bash
+augx link collections/html-css-js
+```
+
+This will automatically link all three modules.
+
+### Using Individual Modules
+
+You can also link modules individually:
+
+```bash
+augx link coding-standards/html
+augx link coding-standards/css
+augx link coding-standards/js
+```
+
+## Included Modules
+
+### HTML Standards (32,477 characters)
+
+- Semantic HTML5 elements
+- Accessibility guidelines (WCAG 2.1)
+- Modern HTML features
+
+### CSS Standards (30,556 characters)
+
+- Modern CSS features (Grid, Flexbox, Custom Properties)
+- Responsive design patterns
+- Preprocessor best practices (Sass, Less)
+
+### JavaScript Standards (101,818 characters)
+
+- ES6+ features and syntax
+- Async patterns (Promises, async/await)
+- DOM manipulation best practices
+- Performance optimization
+- Development tooling
+
+## Total Character Count
+
+~164,851 characters (across all three modules)
+
+## Version
+
+1.0.0
+
+## Backward Compatibility
+
+This collection replaces the monolithic `coding-standards/html-css-js` module. If you were using the old module, you can migrate to this collection seamlessly:
+
+```bash
+augx unlink coding-standards/html-css-js
+augx link collections/html-css-js
+```
+
+## Migration Notes
+
+The collection maintains 100% backward compatibility with the original `html-css-js-standards` module. All rules, examples, and guidelines are preserved in the individual modules.
+