@esotech/contextuate 2.1.0 → 2.1.1

package/dist/templates/templates/standards/javascript.standards.md

@@ -1,292 +0,0 @@
-# JavaScript/TypeScript Coding Standards
-
-> **Language:** JavaScript / TypeScript
-> **Generated:** {DATE}
-
----
-
-## Formatting
-
-### Indentation
-- **Style:** {tabs|spaces}
-- **Size:** {2|4} {spaces|tabs}
-
-### Semicolons
-- **Required:** {yes|no}
-
-### Quotes
-- **Strings:** {single|double|backticks for templates}
-
-### Trailing Commas
-- **Style:** {none|es5|all}
-
----
-
-## Naming Conventions
-
-### Classes/Components
-- **Style:** PascalCase
-- **Example:** `UserService`, `PaymentForm`
-
-### Functions/Methods
-- **Style:** camelCase
-- **Example:** `getUserById()`, `handleSubmit()`
-
-### Variables
-- **Style:** camelCase
-- **Example:** `userName`, `isActive`
-
-### Constants
-- **Style:** {UPPER_SNAKE_CASE|camelCase}
-- **Example:** `MAX_RETRIES` or `maxRetries`
-
-### Private Members
-- **Style:** {underscore prefix|# prefix|none}
-- **Example:** `_privateMethod()` or `#privateField`
-
-### File Names
-- **Style:** {kebab-case|camelCase|PascalCase}
-- **Example:** `user-service.js` or `UserService.js`
-
----
-
-## Structure
-
-### Module Organization
-```javascript
-// 1. Imports - external
-import React from 'react';
-import axios from 'axios';
-
-// 2. Imports - internal
-import { UserService } from './services';
-import { formatDate } from './utils';
-
-// 3. Types/Interfaces (TypeScript)
-interface User {
-    id: number;
-    name: string;
-}
-
-// 4. Constants
-const API_URL = '/api/v1';
-
-// 5. Main export
-export class MyClass {
-    // ...
-}
-
-// 6. Helper functions (if not exported separately)
-function helperFunction() {
-    // ...
-}
-```
-
-### Function Length
-- **Guideline:** {max lines per function}
-
----
-
-## Variable Declarations
-
-### Preferred Keywords
-- **Immutable:** `const` (default)
-- **Mutable:** `let`
-- **Avoid:** `var`
-
-```javascript
-// GOOD
-const user = getUser();
-let count = 0;
-
-// BAD
-var user = getUser();
-```
-
----
-
-## Functions
-
-### Declaration Style
-```javascript
-// Preferred: {function declaration|arrow function|mixed}
-
-// Function declaration
-function processData( data ) {
-    // ...
-}
-
-// Arrow function
-const processData = ( data ) => {
-    // ...
-};
-```
-
-### Parameters
-```javascript
-// Destructuring: {preferred|optional}
-function createUser( { name, email, role = 'user' } ) {
-    // ...
-}
-
-// Default values
-function greet( name = 'Guest' ) {
-    // ...
-}
-```
-
----
-
-## Async/Await
-
-### Preferred Style
-```javascript
-// {async/await|promises|callbacks for specific cases}
-
-// GOOD
-async function fetchUser( id ) {
-    try {
-        const response = await api.get( `/users/${id}` );
-        return response.data;
-    } catch( error ) {
-        handleError( error );
-    }
-}
-
-// AVOID (unless necessary)
-function fetchUser( id ) {
-    return api.get( `/users/${id}` )
-        .then( response => response.data )
-        .catch( handleError );
-}
-```
-
----
-
-## TypeScript Specific
-
-### Type Annotations
-```typescript
-// {Required|Inferred where possible}
-
-// Explicit
-function getUser( id: number ): Promise<User> {
-    // ...
-}
-
-// Inferred (if allowed)
-const count = 0; // inferred as number
-```
-
-### Interfaces vs Types
-```typescript
-// Preferred for objects: {interface|type}
-interface User {
-    id: number;
-    name: string;
-}
-
-// Use type for: unions, primitives, tuples
-type Status = 'active' | 'inactive';
-```
-
-### Strict Mode
-- **Enabled:** {yes|no}
-- **Null checks:** {strict|relaxed}
-
----
-
-## Error Handling
-
-### Try/Catch
-```javascript
-try {
-    await riskyOperation();
-} catch( error ) {
-    if( error instanceof SpecificError ){
-        // handle specific
-    } else {
-        // handle general
-    }
-}
-```
-
-### Error Types
-```typescript
-// Custom errors: {yes|no}
-class ValidationError extends Error {
-    constructor( message: string, public field: string ){
-        super( message );
-        this.name = 'ValidationError';
-    }
-}
-```
-
----
-
-## Imports/Exports
-
-### Module Style
-```javascript
-// Named exports (preferred for utilities)
-export function helper() {}
-export const CONSTANT = 'value';
-
-// Default export (for main class/component)
-export default class MainService {}
-```
-
-### Import Organization
-```javascript
-// 1. External packages
-// 2. Internal absolute paths
-// 3. Internal relative paths
-// 4. Styles/assets
-```
-
----
-
-## Common Patterns
-
-### Null/Undefined Handling
-```javascript
-// Optional chaining
-const city = user?.address?.city;
-
-// Nullish coalescing
-const name = user.name ?? 'Anonymous';
-
-// Default parameters
-function greet( name = 'Guest' ) {}
-```
-
-### Object Manipulation
-```javascript
-// Spread for copies
-const updated = { ...user, name: 'New Name' };
-
-// Destructuring
-const { id, name } = user;
-```
-
----
-
-## Anti-Patterns
-
-```javascript
-// BAD: {description}
-{bad example}
-
-// GOOD: {description}
-{good example}
-```
-
----
-
-## Framework-Specific
-
-{Add any React/Vue/Node/etc. specific conventions here}
-
----
-
-*This file should be customized for your project. Replace placeholders with actual values.*

package/dist/templates/templates/standards/php.standards.md

@@ -1,181 +0,0 @@
-# PHP Coding Standards
-
-> **Language:** PHP
-> **Generated:** {DATE}
-
----
-
-## Formatting
-
-### Indentation
-- **Style:** {tabs|spaces}
-- **Size:** {2|4} {spaces|tabs}
-
-### Braces
-- **Classes/Functions:** {same-line|next-line}
-- **Control structures:** {same-line|next-line}
-
-### Spacing
-- **Inside parentheses:** {yes|no} - `function( $param )` vs `function($param)`
-- **After keywords:** {yes|no} - `if ( $x )` vs `if($x)`
-- **Array brackets:** {no-spaces} - `$arr['key']`
-
----
-
-## Naming Conventions
-
-### Classes
-- **Style:** PascalCase
-- **Example:** `UserService`, `PaymentController`
-
-### Methods
-- **Style:** camelCase
-- **Example:** `getUserById()`, `processPayment()`
-
-### Variables
-- **Style:** {camelCase|snake_case}
-- **Example:** `$userName` or `$user_name`
-
-### Constants
-- **Style:** UPPER_SNAKE_CASE
-- **Example:** `MAX_RETRY_COUNT`, `API_VERSION`
-
-### Properties
-- **Style:** {camelCase|snake_case}
-- **Visibility prefix:** {none|underscore for private}
-
----
-
-## Structure
-
-### File Organization
-```php
-<?php
-// 1. Strict types declaration (if used)
-declare( strict_types=1 );
-
-// 2. Namespace
-namespace App\Services;
-
-// 3. Use statements (alphabetized)
-use App\Models\User;
-use Exception;
-
-// 4. Class definition
-class UserService {
-    // 5. Constants
-    // 6. Properties
-    // 7. Constructor
-    // 8. Public methods
-    // 9. Protected methods
-    // 10. Private methods
-}
-```
-
-### Method Length
-- **Guideline:** {max lines per method}
-- **Complexity:** {max cyclomatic complexity}
-
----
-
-## Type Hints
-
-### Parameters
-```php
-// {Required|Optional}
-public function process( string $name, int $count ): void
-```
-
-### Return Types
-```php
-// {Required|Optional}
-public function getData(): array
-```
-
-### Property Types (PHP 7.4+)
-```php
-// {Required|Optional}
-private string $name;
-private User|null $user = null;
-```
-
----
-
-## Documentation
-
-### Class DocBlocks
-```php
-/**
- * {Required|Optional}
- * Brief description of the class.
- */
-class MyClass
-```
-
-### Method DocBlocks
-```php
-/**
- * {Required|Optional|Only for complex methods}
- *
- * @param string $name Description
- * @return array Description
- * @throws Exception When condition
- */
-```
-
----
-
-## Error Handling
-
-### Exceptions
-- **Custom exceptions:** {yes|no}
-- **Base exception class:** {name if applicable}
-
-### Try/Catch
-```php
-try {
-    // code
-} catch( SpecificException $e ){
-    // handle
-} catch( Exception $e ){
-    // fallback
-}
-```
-
----
-
-## Common Patterns
-
-### Dependency Injection
-```php
-// {Constructor injection|Setter injection|Container}
-public function __construct( private UserRepository $repo )
-```
-
-### Null Handling
-```php
-// Preferred: {null coalescing|ternary|early return}
-$value = $data['key'] ?? 'default';
-```
-
----
-
-## Anti-Patterns
-
-```php
-// BAD: {description}
-{bad example}
-
-// GOOD: {description}
-{good example}
-```
-
----
-
-## Framework-Specific
-
-{Add any framework-specific conventions here}
-
----
-
-*This file should be customized for your project. Replace placeholders with actual values.*

package/dist/templates/templates/standards/python.standards.md

@@ -1,175 +0,0 @@
-# Python Coding Standards
-
-> **Language:** Python
-> **Generated:** {DATE}
-
----
-
-## Formatting
-
-### Indentation
-- **Style:** {spaces}
-- **Size:** {4} {spaces}
-
-### Line Length
-- **Max Length:** {88|100|120} chars
-- **Docstrings:** {72} chars
-
-### Imports
-- **Sort Order:** {Standard Library} > {Third Party} > {Local Application}
-- **Style:** {Absolute imports preferred}
-
----
-
-## Naming Conventions
-
-### Classes
-- **Style:** PascalCase
-- **Example:** `UserContext`, `PaymentProcessor`
-
-### Functions/Methods
-- **Style:** snake_case
-- **Example:** `get_user_by_id()`, `process_payment()`
-
-### Variables
-- **Style:** snake_case
-- **Example:** `user_name`, `is_active`
-
-### Constants
-- **Style:** UPPER_SNAKE_CASE
-- **Example:** `MAX_RETRY_COUNT`, `API_VERSION`
-
-### Private Members
-- **Style:** {underscore prefix}
-- **Example:** `_private_method()`, `_internal_var`
-
----
-
-## Structure
-
-### File Organization
-```python
-# 1. Shebang (if executable)
-#!/usr/bin/env python3
-
-# 2. Module Docstring
-"""
-Module description.
-"""
-
-# 3. Imports
-import os
-from typing import List, Optional
-
-# 4. Constants
-MAX_RETRIES = 3
-
-# 5. Classes
-class MyClass:
-    """Class docstring."""
-
-    def __init__(self):
-        pass
-
-# 6. Main execution
-if __name__ == "__main__":
-    pass
-```
-
----
-
-## Type Hints (PEP 484)
-
-### Parameters & Returns
-```python
-# {Required|Preferred}
-def process(name: str, count: int = 0) -> None:
-    pass
-```
-
-### Variables (PEP 526)
-```python
-# {Optional|Preferred}
-user_id: int = 123
-```
-
----
-
-## Documentation (Docstrings)
-
-### Style
-- **Format:** {Google|NumPy|Sphinx/reST}
-
-#### Google Style Example
-```python
-def fetch_data(url: str) -> dict:
-    """Fetches data from the API.
-
-    Args:
-        url: The endpoint URL.
-
-    Returns:
-        A dictionary containing the response data.
-
-    Raises:
-        ConnectionError: If the request fails.
-    """
-```
-
----
-
-## Error Handling
-
-### Exceptions
-```python
-try:
-    process_data()
-except ValueError as e:
-    logger.error(f"Validation error: {e}")
-except Exception:
-    # Catch-all only if necessary
-    raise
-```
-
----
-
-## Common Patterns
-
-### List Comprehensions
-```python
-# Preferred for simple transformations
-names = [u.name for u in users if u.is_active]
-```
-
-### Context Managers
-```python
-# Preferred for resource management
-with open("file.txt") as f:
-    content = f.read()
-```
-
----
-
-## Anti-Patterns
-
-```python
-# BAD: Mutable default arguments
-def add_item(item, list=[]):
-    list.append(item)
-
-# GOOD:
-def add_item(item, list=None):
-    if list is None:
-        list = []
-    list.append(item)
-```
-
----
-
-## Framework-Specific
-
-{Add Django/Flask/FastAPI specific conventions here}
-
----
-
-*This file should be customized for your project. Replace placeholders with actual values.*