@esotech/contextuate 2.1.0 → 2.1.2

package/dist/templates/templates/standards/go.standards.md

@@ -1,167 +0,0 @@
-# Go Coding Standards
-
-> **Language:** Go
-> **Generated:** {DATE}
-
----
-
-## Formatting
-
-### Tooling
-- **Required:** `gofmt` (or `goimports`) must be applied to all files.
-
-### Indentation
-- **Style:** Tabs (Standard Go behavior)
-
-### Line Length
-- **Guideline:** No strict limit, but prefer readability (80-120 chars).
-
----
-
-## Naming Conventions
-
-### General Rule
-- Use `MixedCaps` or `mixedCaps` (CamelCase).
-- Keep names short and concise.
-
-### Packages
-- **Style:** lowercase, single word
-- **Avoid:** snake_case, camelCase in package names
-- **Example:** `package user`, not `package user_service`
-
-### Interfaces
-- **Style:** Method name + "er" (if single method)
-- **Example:** `Reader`, `Writer`, `Formatter`
-
-### Structs/Interfaces
-- **Exported:** PascalCase (`User`)
-- **Unexported:** camelCase (`userHelper`)
-
-### Functions/Methods
-- **Exported:** PascalCase (`GetUser`)
-- **Unexported:** camelCase (`parseData`)
-
-### Constants
-- **Style:** PascalCase (for exported) or camelCase
-- **Avoid:** UPPER_SNAKE_CASE (unlike other languages)
-- **Example:** `MaxRetries`, not `MAX_RETRIES`
-
----
-
-## Structure
-
-### File Organization
-```go
-package main
-
-// 1. Imports (grouped: stdlib, third-party, local)
-import (
-    "fmt"
-    "os"
-
-    "github.com/pkg/errors"
-
-    "myproject/internal/user"
-)
-
-// 2. Constants
-const DefaultTimeout = 30
-
-// 3. Types (Structs/Interfaces)
-type Service interface {
-    Do() error
-}
-
-// 4. Factory Functions
-func NewService() Service {
-    return &serviceImpl{}
-}
-
-// 5. Methods
-func (s *serviceImpl) Do() error {
-    return nil
-}
-```
-
----
-
-## Error Handling
-
-### Pattern
-- **Style:** Check errors immediately. Avoid nesting.
-
-```go
-// GOOD
-f, err := os.Open("file.txt")
-if err != nil {
-    return err
-}
-
-// BAD
-if f, err := os.Open("file.txt"); err == nil {
-    // ...
-}
-```
-
-### Wrapping
-- **Guideline:** Wrap errors with context when passing up the stack.
-- **Example:** `fmt.Errorf("failed to open config: %w", err)`
-
----
-
-## Documentation
-
-### Comments
-- **Exported identifiers:** MUST have a doc comment starting with the name.
-- **Format:** Complete sentences.
-
-```go
-// User represents a system user.
-type User struct { ... }
-
-// Fetch retrieves the user by ID.
-func (u *User) Fetch(id int) error { ... }
-```
-
----
-
-## Common Patterns
-
-### Options Pattern
-```go
-// Preferred for complex constructors
-type Option func(*Server)
-
-func WithPort(port int) Option {
-    return func(s *Server) { s.port = port }
-}
-
-func NewServer(opts ...Option) *Server { ... }
-```
-
-### Context
-- **Guideline:** Pass `context.Context` as the first argument to functions performing I/O.
-
-```go
-func (s *Service) GetData(ctx context.Context, id string) error { ... }
-```
-
----
-
-## Anti-Patterns
-
-```go
-// BAD: Panic in libraries
-func Parse() {
-    if err != nil {
-        panic(err) // Return error instead
-    }
-}
-
-// BAD: Global state
-var db *sql.DB // Use dependency injection
-```
-
----
-
-*This file should be customized for your project. Replace placeholders with actual values.*

package/dist/templates/templates/standards/java.standards.md

@@ -1,167 +0,0 @@
-# Java Coding Standards
-
-> **Language:** Java
-> **Generated:** {DATE}
-
----
-
-## Formatting
-
-### Indentation
-- **Style:** {Spaces}
-- **Size:** {4} {spaces}
-
-### Braces
-- **Style:** K&R (same line) for classes and methods.
-
-### Line Length
-- **Max Length:** {100|120} chars
-
----
-
-## Naming Conventions
-
-### Classes/Interfaces
-- **Style:** PascalCase
-- **Example:** `UserManager`, `PaymentProcessor`
-
-### Methods
-- **Style:** camelCase
-- **Example:** `calculateTotal()`, `findUserById()`
-
-### Variables
-- **Style:** camelCase
-- **Example:** `firstName`, `orderCount`
-
-### Constants (static final)
-- **Style:** UPPER_SNAKE_CASE
-- **Example:** `DEFAULT_TIMEOUT`, `MAX_USERS`
-
-### Generics
-- **Style:** Single capital letter
-- **Example:** `E` (element), `T` (type), `K` (key), `V` (value)
-
----
-
-## Structure
-
-### File Organization
-```java
-// 1. Package declaration
-package com.company.project.service;
-
-// 2. Imports (sorted alphabetically, no wildcards)
-import java.util.List;
-import org.springframework.stereotype.Service;
-
-// 3. Class definition
-@Service
-public class UserService {
-
-    // 4. Constants
-    private static final int MAX_AGE = 100;
-
-    // 5. Fields
-    private final UserRepository userRepository;
-
-    // 6. Constructor
-    public UserService(UserRepository userRepository) {
-        this.userRepository = userRepository;
-    }
-
-    // 7. Public methods
-    public User getUser(Long id) {
-        // ...
-    }
-
-    // 8. Private methods
-    private void validate(User user) {
-        // ...
-    }
-}
-```
-
----
-
-## Documentation (Javadoc)
-
-### Required Elements
-- **Classes:** Purpose of the class.
-- **Public Methods:** Description, `@param`, `@return`, `@throws`.
-
-```java
-/**
- * Processes payment transactions.
- */
-public class PaymentService {
-
-    /**
-     * Authorizes a transaction.
-     *
-     * @param amount The amount to authorize
-     * @return true if successful
-     * @throws PaymentException if connection fails
-     */
-    public boolean authorize(BigDecimal amount) throws PaymentException { ... }
-}
-```
-
----
-
-## Error Handling
-
-### Exceptions
-- **Guideline:** Use unchecked exceptions (`RuntimeException`) for recoverable errors.
-- **Guideline:** Avoid swallowing exceptions.
-
-```java
-// GOOD
-try {
-    file.read();
-} catch (IOException e) {
-    throw new UncheckedIOException("Failed to read config", e);
-}
-
-// BAD
-catch (Exception e) {
-    e.printStackTrace(); // Use a logger
-}
-```
-
----
-
-## Common Patterns
-
-### Optional
-- **Guideline:** Use `Optional<T>` for return types that may be null.
-- **Avoid:** Using `Optional` in parameters or fields.
-
-```java
-public Optional<User> findByEmail(String email) { ... }
-```
-
-### Streams API
-- **Guideline:** Prefer Streams for collections processing.
-
-```java
-List<String> names = users.stream()
-    .filter(User::isActive)
-    .map(User::getName)
-    .collect(Collectors.toList());
-```
-
----
-
-## Anti-Patterns
-
-```java
-// BAD: Public fields
-public String name; // Use private + getter
-
-// BAD: Magic numbers
-if (status == 4) // Use constant STATUS_ACTIVE
-```
-
----
-
-*This file should be customized for your project. Replace placeholders with actual values.*

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.*