@mytechtoday/augment-extensions 1.7.0 → 2.2.0

package/augment-extensions/coding-standards/typescript/README.md

@@ -1,45 +1,274 @@
 # TypeScript Coding Standards
 
-Comprehensive TypeScript coding standards and best practices for Augment Code AI.
+> **Version 2.0.0** | Comprehensive TypeScript coding standards and best practices for Augment Code AI
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Module Contents](#module-contents)
+  - [Core Rules](#core-rules)
+  - [Advanced Topics](#advanced-topics)
+  - [Examples](#examples)
+- [Usage Guide](#usage-guide)
+- [Version History](#version-history)
+- [Contributing](#contributing)
 
 ## Overview
 
-This module provides detailed TypeScript coding standards that exceed the `.augment/` character limit, including:
+This module provides comprehensive TypeScript coding standards that exceed the `.augment/` character limit (~25,000 characters). It covers everything from basic naming conventions to advanced architecture patterns, modern tooling, and security best practices.
+
+### What's Included
 
-- Naming conventions
-- Type safety guidelines
-- Error handling patterns
-- Async/await best practices
-- Advanced TypeScript features
+- ✅ **9 comprehensive rule files** covering all aspects of TypeScript development
+- ✅ **Modern TypeScript 5.x features** including decorators and const type parameters
+- ✅ **Tooling guides** for ESLint, Biome, tsup, and Vitest
+- ✅ **Architecture patterns** for scalable applications
+- ✅ **Security & performance** best practices
+- ✅ **Monorepo support** with Turborepo and pnpm
+- ✅ **Real-world examples** with working configurations
 
-## Usage
+## Installation
+
+### Using augx CLI (Recommended)
 
 ```bash
 # Link this module to your project
 augx link coding-standards/typescript
 
-# AI agents can then query:
+# Verify installation
+augx list --linked
+```
+
+### Manual Installation
+
+Copy the contents of this directory to your project's `.augment/extensions/` folder.
+
+## Quick Start
+
+### For AI Agents
+
+```bash
+# Query the module
 augx show typescript-standards
+
+# Search for specific topics
+augx search "error handling"
+augx search "monorepo"
 ```
 
-## Contents
+### For Developers
+
+1. Link the module to your project
+2. Configure your IDE to use the provided ESLint/Biome configs
+3. Reference the rules when writing TypeScript code
+4. Use the examples as templates for your own configurations
+
+## Module Contents
+
+### Core Rules
+
+#### 1. [Naming Conventions](rules/naming-conventions.md)
+Comprehensive naming guidelines for variables, functions, classes, types, and more.
+
+**Topics covered:**
+- Variable and function naming
+- Class and interface naming
+- Type and enum naming
+- File and directory naming
+- Constant naming patterns
+
+**Cross-references:** See [Type Patterns](rules/type-patterns.md) for branded types naming
+
+---
+
+#### 2. [Type Patterns](rules/type-patterns.md)
+Advanced TypeScript type patterns and type-level programming.
+
+**Topics covered:**
+- Branded types for type safety
+- Discriminated unions
+- Conditional types
+- Mapped types
+- Template literal types
+- Type-level programming
+
+**Cross-references:** See [Modern Features](rules/modern-features.md) for TypeScript 5.x features
+
+---
+
+#### 3. [Error Handling](rules/error-handling.md)
+Modern error handling patterns including Result types and Effect-TS.
+
+**Topics covered:**
+- Traditional try/catch patterns
+- Result types with Neverthrow
+- Effect-TS introduction
+- Error boundary patterns
+- Custom error classes
+
+**Cross-references:** See [Testing](rules/testing.md) for error testing strategies
+
+---
+
+### Advanced Topics
+
+#### 4. [Modern Features](rules/modern-features.md)
+TypeScript 5.x features and modern language capabilities.
+
+**Topics covered:**
+- Decorators (Stage 3)
+- Const type parameters
+- `satisfies` operator
+- `using` declarations
+- Import attributes
+
+**Cross-references:** See [Type Patterns](rules/type-patterns.md) for advanced type usage
+
+---
+
+#### 5. [Tooling](rules/tooling.md)
+Modern tooling setup and configuration.
+
+**Topics covered:**
+- ESLint flat config (ESLint 9+)
+- Biome setup and migration
+- tsup for library bundling
+- Vitest + MSW for testing
+
+**Cross-references:** See [Testing](rules/testing.md) for test configuration details
 
-### Rules
+---
 
-1. **naming-conventions.md** - Comprehensive naming guidelines
-2. **type-safety.md** - Type safety and inference best practices
-3. **error-handling.md** - Error handling patterns
-4. **async-patterns.md** - Async/await and Promise patterns
+#### 6. [Security & Performance](rules/security-performance.md)
+Security best practices and performance optimization.
+
+**Topics covered:**
+- Secure headers in Next.js
+- Type-safe runtime validation with Zod
+- Memoization patterns
+- Bundle analysis and optimization
+- Tree-shaking strategies
+
+**Cross-references:** See [Tooling](rules/tooling.md) for build optimization tools
+
+---
+
+#### 7. [Testing](rules/testing.md)
+Comprehensive testing strategies and patterns.
+
+**Topics covered:**
+- Unit/integration/e2e testing patterns
+- Snapshot vs assertion testing
+- Property-based testing introduction
+- Test organization patterns
+- MSW for API mocking
+
+**Cross-references:** See [Tooling](rules/tooling.md) for Vitest setup
+
+---
+
+#### 8. [Architecture](rules/architecture.md)
+Architectural patterns for scalable TypeScript applications.
+
+**Topics covered:**
+- Folder-by-convention vs folder-by-feature
+- Dependency inversion principles
+- Domain-driven design basics
+- Layered/clean/hexagonal architecture
+- Module boundaries
+
+**Cross-references:** See [Monorepo](rules/monorepo.md) for multi-package architecture
+
+---
+
+#### 9. [Monorepo](rules/monorepo.md)
+Complete guide to TypeScript monorepo setup and management.
+
+**Topics covered:**
+- Turborepo configuration
+- pnpm workspaces
+- Shared TypeScript configs
+- Dependency management
+- Versioning with changesets
+
+**Cross-references:** See [Tooling](rules/tooling.md) for build tools
+
+---
 
 ### Examples
 
-- **best-practices.ts** - Real-world code examples
+#### Configuration Files
+
+- **[eslint-flat-config.js](examples/eslint-flat-config.js)** - ESLint 9+ flat config with TypeScript
+- **[biome.json](examples/biome.json)** - Biome configuration for linting and formatting
+- **[vitest-setup.ts](examples/vitest-setup.ts)** - Vitest configuration with MSW
+
+#### Monorepo Examples
 
-## Character Count
+- **[monorepo-config/](examples/monorepo-config/)** - Complete monorepo setup examples
 
-Total: ~15,420 characters (would exceed `.augment/` limit if included directly)
+## Usage Guide
+
+### For AI Code Generation
+
+When generating TypeScript code, AI agents should:
+
+1. **Check naming conventions** in [naming-conventions.md](rules/naming-conventions.md)
+2. **Use appropriate type patterns** from [type-patterns.md](rules/type-patterns.md)
+3. **Follow error handling** guidelines from [error-handling.md](rules/error-handling.md)
+4. **Apply modern features** when appropriate from [modern-features.md](rules/modern-features.md)
+5. **Consider architecture** patterns from [architecture.md](rules/architecture.md)
+
+### For Code Review
+
+Use this module as a reference when reviewing TypeScript code:
+
+- Check naming consistency
+- Verify type safety practices
+- Ensure proper error handling
+- Validate security practices
+- Review test coverage
 
 ## Version History
 
-- **1.0.0** - Initial release with core standards
+See [CHANGELOG.md](CHANGELOG.md) for detailed version history.
+
+### Current Version: 2.0.0 (2026-02-25)
+
+**Major additions:**
+- Modern TypeScript 5.x features guide
+- Comprehensive tooling setup (ESLint, Biome, tsup, Vitest)
+- Security and performance best practices
+- Testing strategies guide
+- Architecture patterns
+- Monorepo support
+
+### Previous Versions
+
+- **1.0.0** (2024-01-01) - Initial release with core standards
+
+## Contributing
+
+To contribute to this module:
+
+1. Follow the existing structure and formatting
+2. Add cross-references to related sections
+3. Include practical examples
+4. Update the table of contents
+5. Update CHANGELOG.md with your changes
+6. Increment version in VERSION file
+
+## Metadata
+
+- **Character Count:** ~25,000 characters
+- **Files:** 9 rule files + 3 example files
+- **Compatibility:** Augment Code AI 1.0.0+, Node.js 18+, TypeScript 5.0+
+- **License:** MIT
+- **Author:** Augment Extensions
+
+---
+
+**Need help?** Use `augx show typescript-standards` to view this module's content or `augx search <topic>` to find specific information.
 

package/augment-extensions/coding-standards/typescript/VERSION

@@ -0,0 +1,2 @@
+2.0.0
+

package/augment-extensions/coding-standards/typescript/examples/biome.json

@@ -0,0 +1,199 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
+  "organizeImports": {
+    "enabled": true
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "suspicious": {
+        "noExplicitAny": "warn",
+        "noArrayIndexKey": "warn",
+        "noAssignInExpressions": "error",
+        "noAsyncPromiseExecutor": "error",
+        "noCatchAssign": "error",
+        "noClassAssign": "error",
+        "noCommentText": "error",
+        "noCompareNegZero": "error",
+        "noConfusingVoidType": "warn",
+        "noConsoleLog": "warn",
+        "noConstEnum": "warn",
+        "noControlCharactersInRegex": "error",
+        "noDebugger": "warn",
+        "noDoubleEquals": "error",
+        "noDuplicateCase": "error",
+        "noDuplicateClassMembers": "error",
+        "noDuplicateObjectKeys": "error",
+        "noDuplicateParameters": "error",
+        "noEmptyBlockStatements": "warn",
+        "noFallthroughSwitchClause": "error",
+        "noGlobalObjectCalls": "error",
+        "noImplicitAnyLet": "error",
+        "noMisleadingInstantiator": "error",
+        "noPrototypeBuiltins": "error",
+        "noRedeclare": "error",
+        "noShadowRestrictedNames": "error",
+        "noUnsafeDeclarationMerging": "error",
+        "noUnsafeNegation": "error",
+        "useGetterReturn": "error",
+        "useValidTypeof": "error"
+      },
+      "style": {
+        "noArguments": "error",
+        "noComma": "error",
+        "noImplicitBoolean": "off",
+        "noInferrableTypes": "warn",
+        "noNamespace": "error",
+        "noNegationElse": "warn",
+        "noNonNullAssertion": "warn",
+        "noParameterAssign": "warn",
+        "noRestrictedGlobals": "error",
+        "noShoutyConstants": "off",
+        "noUnusedTemplateLiteral": "warn",
+        "noVar": "error",
+        "useAsConstAssertion": "error",
+        "useBlockStatements": "off",
+        "useCollapsedElseIf": "warn",
+        "useConst": "error",
+        "useDefaultParameterLast": "error",
+        "useEnumInitializers": "warn",
+        "useExponentiationOperator": "error",
+        "useFragmentSyntax": "error",
+        "useLiteralEnumMembers": "error",
+        "useNamingConvention": "off",
+        "useNumericLiterals": "error",
+        "useSelfClosingElements": "error",
+        "useShorthandArrayType": "error",
+        "useShorthandAssign": "error",
+        "useSingleVarDeclarator": "error",
+        "useTemplate": "warn",
+        "useWhile": "error"
+      },
+      "correctness": {
+        "noChildrenProp": "error",
+        "noConstAssign": "error",
+        "noConstantCondition": "warn",
+        "noConstructorReturn": "error",
+        "noEmptyCharacterClassInRegex": "error",
+        "noEmptyPattern": "error",
+        "noGlobalObjectCalls": "error",
+        "noInnerDeclarations": "error",
+        "noInvalidConstructorSuper": "error",
+        "noInvalidNewBuiltin": "error",
+        "noNonoctalDecimalEscape": "error",
+        "noPrecisionLoss": "error",
+        "noSelfAssign": "error",
+        "noSetterReturn": "error",
+        "noSwitchDeclarations": "error",
+        "noUndeclaredVariables": "error",
+        "noUnreachable": "error",
+        "noUnreachableSuper": "error",
+        "noUnsafeFinally": "error",
+        "noUnsafeOptionalChaining": "error",
+        "noUnusedLabels": "error",
+        "noUnusedVariables": "error",
+        "useArrayLiterals": "error",
+        "useExhaustiveDependencies": "warn",
+        "useHookAtTopLevel": "error",
+        "useIsNan": "error",
+        "useValidForDirection": "error",
+        "useYield": "error"
+      },
+      "complexity": {
+        "noBannedTypes": "warn",
+        "noExtraBooleanCast": "error",
+        "noMultipleSpacesInRegularExpressionLiterals": "error",
+        "noUselessCatch": "error",
+        "noUselessConstructor": "error",
+        "noUselessEmptyExport": "error",
+        "noUselessFragments": "error",
+        "noUselessLabel": "error",
+        "noUselessRename": "error",
+        "noUselessSwitchCase": "error",
+        "noUselessThisAlias": "error",
+        "noUselessTypeConstraint": "error",
+        "noVoid": "error",
+        "noWith": "error",
+        "useFlatMap": "warn",
+        "useLiteralKeys": "warn",
+        "useOptionalChain": "warn",
+        "useSimplifiedLogicExpression": "warn"
+      },
+      "performance": {
+        "noDelete": "warn"
+      },
+      "security": {
+        "noDangerouslySetInnerHtml": "warn",
+        "noDangerouslySetInnerHtmlWithChildren": "error"
+      }
+    }
+  },
+  "formatter": {
+    "enabled": true,
+    "formatWithErrors": false,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 100,
+    "lineEnding": "lf",
+    "ignore": []
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "jsxQuoteStyle": "double",
+      "quoteProperties": "asNeeded",
+      "trailingCommas": "es5",
+      "semicolons": "always",
+      "arrowParentheses": "always",
+      "bracketSpacing": true,
+      "bracketSameLine": false
+    }
+  },
+  "json": {
+    "formatter": {
+      "enabled": true,
+      "indentWidth": 2,
+      "lineWidth": 100
+    }
+  },
+  "files": {
+    "ignore": [
+      "node_modules",
+      "dist",
+      "build",
+      ".next",
+      "out",
+      "coverage",
+      ".turbo",
+      "*.config.js",
+      "*.config.ts"
+    ],
+    "include": [
+      "src/**/*.ts",
+      "src/**/*.tsx",
+      "src/**/*.js",
+      "src/**/*.jsx",
+      "app/**/*.ts",
+      "app/**/*.tsx",
+      "pages/**/*.ts",
+      "pages/**/*.tsx"
+    ]
+  },
+  "overrides": [
+    {
+      "include": ["**/*.test.ts", "**/*.test.tsx", "**/*.spec.ts", "**/*.spec.tsx"],
+      "linter": {
+        "rules": {
+          "suspicious": {
+            "noExplicitAny": "off"
+          },
+          "style": {
+            "noNonNullAssertion": "off"
+          }
+        }
+      }
+    }
+  ]
+}
+

package/augment-extensions/coding-standards/typescript/examples/eslint-flat-config.js

@@ -0,0 +1,166 @@
+// eslint.config.js - Modern ESLint Flat Config Example
+// ESLint 9+ flat configuration format
+
+import js from '@eslint/js';
+import typescript from '@typescript-eslint/eslint-plugin';
+import typescriptParser from '@typescript-eslint/parser';
+import importPlugin from 'eslint-plugin-import';
+import react from 'eslint-plugin-react';
+import reactHooks from 'eslint-plugin-react-hooks';
+import jsxA11y from 'eslint-plugin-jsx-a11y';
+
+export default [
+  // Global ignores
+  {
+    ignores: [
+      '**/dist/**',
+      '**/build/**',
+      '**/.next/**',
+      '**/node_modules/**',
+      '**/coverage/**',
+      '**/.turbo/**',
+      '**/out/**'
+    ]
+  },
+
+  // Base JavaScript configuration
+  js.configs.recommended,
+
+  // TypeScript files configuration
+  {
+    files: ['**/*.ts', '**/*.tsx'],
+    languageOptions: {
+      parser: typescriptParser,
+      parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+        project: './tsconfig.json',
+        ecmaFeatures: {
+          jsx: true
+        }
+      },
+      globals: {
+        React: 'readonly',
+        JSX: 'readonly'
+      }
+    },
+    plugins: {
+      '@typescript-eslint': typescript,
+      'import': importPlugin,
+      'react': react,
+      'react-hooks': reactHooks,
+      'jsx-a11y': jsxA11y
+    },
+    rules: {
+      // TypeScript-specific rules
+      '@typescript-eslint/no-unused-vars': ['error', {
+        argsIgnorePattern: '^_',
+        varsIgnorePattern: '^_',
+        caughtErrorsIgnorePattern: '^_'
+      }],
+      '@typescript-eslint/no-explicit-any': 'warn',
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+      '@typescript-eslint/no-non-null-assertion': 'warn',
+      '@typescript-eslint/consistent-type-imports': ['error', {
+        prefer: 'type-imports',
+        fixStyle: 'inline-type-imports'
+      }],
+      '@typescript-eslint/no-floating-promises': 'error',
+      '@typescript-eslint/await-thenable': 'error',
+      '@typescript-eslint/no-misused-promises': 'error',
+
+      // Import rules
+      'import/order': ['error', {
+        'groups': [
+          'builtin',
+          'external',
+          'internal',
+          'parent',
+          'sibling',
+          'index',
+          'object',
+          'type'
+        ],
+        'pathGroups': [
+          {
+            'pattern': 'react',
+            'group': 'external',
+            'position': 'before'
+          },
+          {
+            'pattern': '@/**',
+            'group': 'internal'
+          }
+        ],
+        'pathGroupsExcludedImportTypes': ['react'],
+        'newlines-between': 'always',
+        'alphabetize': {
+          'order': 'asc',
+          'caseInsensitive': true
+        }
+      }],
+      'import/no-duplicates': 'error',
+      'import/no-unresolved': 'off', // TypeScript handles this
+
+      // React rules
+      'react/react-in-jsx-scope': 'off', // Not needed in React 17+
+      'react/prop-types': 'off', // Using TypeScript
+      'react/jsx-uses-react': 'off',
+      'react/jsx-uses-vars': 'error',
+      'react/jsx-key': ['error', {
+        checkFragmentShorthand: true
+      }],
+      'react/jsx-no-target-blank': 'error',
+      'react/jsx-curly-brace-presence': ['error', {
+        props: 'never',
+        children: 'never'
+      }],
+
+      // React Hooks rules
+      'react-hooks/rules-of-hooks': 'error',
+      'react-hooks/exhaustive-deps': 'warn',
+
+      // Accessibility rules
+      'jsx-a11y/alt-text': 'error',
+      'jsx-a11y/anchor-is-valid': 'error',
+      'jsx-a11y/aria-props': 'error',
+      'jsx-a11y/aria-role': 'error',
+      'jsx-a11y/role-has-required-aria-props': 'error',
+
+      // General best practices
+      'no-console': ['warn', { allow: ['warn', 'error'] }],
+      'no-debugger': 'warn',
+      'prefer-const': 'error',
+      'no-var': 'error'
+    },
+    settings: {
+      react: {
+        version: 'detect'
+      },
+      'import/resolver': {
+        typescript: true,
+        node: true
+      }
+    }
+  },
+
+  // Test files configuration
+  {
+    files: ['**/*.test.ts', '**/*.test.tsx', '**/*.spec.ts', '**/*.spec.tsx'],
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-non-null-assertion': 'off',
+      'no-console': 'off'
+    }
+  },
+
+  // Configuration files
+  {
+    files: ['**/*.config.js', '**/*.config.ts'],
+    rules: {
+      'import/no-default-export': 'off'
+    }
+  }
+];
+