@webpieces/dev-config 0.2.84 → 0.2.86

package/architecture/executors/validate-code/executor.ts

@@ -7,6 +7,7 @@ import runNoInlineTypesExecutor, { NoInlineTypesMode } from '../validate-no-inli
 import runNoAnyUnknownExecutor, { NoAnyUnknownMode } from '../validate-no-any-unknown/executor';
 import runValidateDtosExecutor, { ValidateDtosMode } from '../validate-dtos/executor';
 import runPrismaConvertersExecutor, { PrismaConverterMode } from '../validate-prisma-converters/executor';
+import runNoDestructureExecutor, { NoDestructureMode } from '../validate-no-destructure/executor';
 
 export type MethodMaxLimitMode = 'OFF' | 'NEW_METHODS' | 'NEW_AND_MODIFIED_METHODS' | 'MODIFIED_FILES';
 export type FileMaxLimitMode = 'OFF' | 'MODIFIED_FILES';
@@ -59,6 +60,12 @@ export interface PrismaConverterConfig {
     ignoreModifiedUntilEpoch?: number;
 }
 
+export interface NoDestructureConfig {
+    mode?: NoDestructureMode;
+    disableAllowed?: boolean;
+    ignoreModifiedUntilEpoch?: number;
+}
+
 export interface ValidateCodeOptions {
     methodMaxLimit?: MethodMaxLimitConfig;
     fileMaxLimit?: FileMaxLimitConfig;
@@ -67,6 +74,7 @@ export interface ValidateCodeOptions {
     noAnyUnknown?: NoAnyUnknownConfig;
     validateDtos?: ValidateDtosConfig;
     prismaConverter?: PrismaConverterConfig;
+    noDestructure?: NoDestructureConfig;
 }
 
 export interface ExecutorResult {
@@ -107,6 +115,9 @@ interface ParsedConfig {
     prismaConverterSchemaPath: string | undefined;
     prismaConverterConvertersPaths: string[];
     prismaConverterIgnoreEpoch: number | undefined;
+    noDestructureMode: NoDestructureMode;
+    noDestructureDisableAllowed: boolean;
+    noDestructureIgnoreEpoch: number | undefined;
 }
 
 interface ResolvedMethodMode {
@@ -119,6 +130,45 @@ interface ResolvedFileMode {
     override: OverrideInfo | undefined;
 }
 
+const VALID_MODES: Record<string, string[]> = {
+    methodMaxLimit:       ['OFF', 'NEW_METHODS', 'NEW_AND_MODIFIED_METHODS', 'MODIFIED_FILES'],
+    fileMaxLimit:         ['OFF', 'MODIFIED_FILES'],
+    requireReturnType:    ['OFF', 'NEW_METHODS', 'NEW_AND_MODIFIED_METHODS', 'MODIFIED_FILES'],
+    noInlineTypeLiterals: ['OFF', 'NEW_METHODS', 'NEW_AND_MODIFIED_METHODS', 'MODIFIED_FILES'],
+    noAnyUnknown:         ['OFF', 'MODIFIED_CODE', 'MODIFIED_FILES'],
+    validateDtos:         ['OFF', 'MODIFIED_CLASS', 'MODIFIED_FILES'],
+    prismaConverter:      ['OFF', 'MODIFIED_METHOD_AND_CODE', 'MODIFIED_FILES'],
+    noDestructure:        ['OFF', 'MODIFIED_CODE', 'MODIFIED_FILES'],
+};
+
+/**
+ * Validate that all configured modes are valid. Produces clear error messages naming the rule.
+ */
+function validateModes(options: ValidateCodeOptions): string[] {
+    const errors: string[] = [];
+
+    const modeEntries: [string, string | undefined][] = [
+        ['methodMaxLimit', options.methodMaxLimit?.mode],
+        ['fileMaxLimit', options.fileMaxLimit?.mode],
+        ['requireReturnType', options.requireReturnType?.mode],
+        ['noInlineTypeLiterals', options.noInlineTypeLiterals?.mode],
+        ['noAnyUnknown', options.noAnyUnknown?.mode],
+        ['validateDtos', options.validateDtos?.mode],
+        ['prismaConverter', options.prismaConverter?.mode],
+        ['noDestructure', options.noDestructure?.mode],
+    ];
+
+    for (const [ruleName, modeValue] of modeEntries) {
+        if (modeValue === undefined) continue;
+        const validModes = VALID_MODES[ruleName];
+        if (!validModes.includes(modeValue)) {
+            errors.push(`${ruleName}.mode = '${modeValue}' is invalid. Valid modes: ${validModes.join(', ')}`);
+        }
+    }
+
+    return errors;
+}
+
 function formatEpochDate(epoch: number): string {
     return new Date(epoch * 1000).toISOString().split('T')[0];
 }
@@ -201,6 +251,9 @@ function parseConfig(options: ValidateCodeOptions): ParsedConfig {
         prismaConverterSchemaPath: options.prismaConverter?.schemaPath,
         prismaConverterConvertersPaths: options.prismaConverter?.convertersPaths ?? [],
         prismaConverterIgnoreEpoch: options.prismaConverter?.ignoreModifiedUntilEpoch,
+        noDestructureMode: options.noDestructure?.mode ?? 'OFF',
+        noDestructureDisableAllowed: options.noDestructure?.disableAllowed ?? true,
+        noDestructureIgnoreEpoch: options.noDestructure?.ignoreModifiedUntilEpoch,
     };
 }
 
@@ -220,6 +273,7 @@ function logConfig(config: ParsedConfig): void {
     console.log(`   No any/unknown: mode=${config.noAnyUnknownMode}, disableAllowed=${config.noAnyUnknownDisableAllowed}`);
     console.log(`   Validate DTOs: mode=${config.validateDtosMode}, disableAllowed=${config.validateDtosDisableAllowed}`);
     console.log(`   Prisma converters: mode=${config.prismaConverterMode}, disableAllowed=${config.prismaConverterDisableAllowed}`);
+    console.log(`   No destructure: mode=${config.noDestructureMode}, disableAllowed=${config.noDestructureDisableAllowed}`);
     console.log('');
 }
 
@@ -227,7 +281,7 @@ function isAllOff(config: ParsedConfig): boolean {
     return config.methodMode === 'OFF' && config.fileMode === 'OFF' &&
         config.returnTypeMode === 'OFF' && config.noInlineTypesMode === 'OFF' &&
         config.noAnyUnknownMode === 'OFF' && config.validateDtosMode === 'OFF' &&
-        config.prismaConverterMode === 'OFF';
+        config.prismaConverterMode === 'OFF' && config.noDestructureMode === 'OFF';
 }
 
 async function runMethodValidators(config: ParsedConfig, context: ExecutorContext): Promise<ExecutorResult[]> {
@@ -253,6 +307,16 @@ export default async function runExecutor(
     options: ValidateCodeOptions,
     context: ExecutorContext
 ): Promise<ExecutorResult> {
+    const modeErrors = validateModes(options);
+    if (modeErrors.length > 0) {
+        console.error('');
+        for (const err of modeErrors) {
+            console.error(`❌ ${err}`);
+        }
+        console.error('');
+        return { success: false };
+    }
+
     const config = parseConfig(options);
 
     if (isAllOff(config)) {
@@ -295,11 +359,17 @@ export default async function runExecutor(
         convertersPaths: config.prismaConverterConvertersPaths,
         ignoreModifiedUntilEpoch: config.prismaConverterIgnoreEpoch,
     }, context);
+    const noDestructureResult = await runNoDestructureExecutor({
+        mode: config.noDestructureMode,
+        disableAllowed: config.noDestructureDisableAllowed,
+        ignoreModifiedUntilEpoch: config.noDestructureIgnoreEpoch,
+    }, context);
 
     const allSuccess = methodResults.every((r) => r.success) &&
         fileResult.success && returnTypesResult.success &&
         noInlineTypesResult.success && noAnyUnknownResult.success &&
-        validateDtosResult.success && prismaConverterResult.success;
+        validateDtosResult.success && prismaConverterResult.success &&
+        noDestructureResult.success;
 
     console.log(allSuccess ? '\n\u2705 All code validations passed\n' : '\n\u274c Some code validations failed\n');
     return { success: allSuccess };

package/architecture/executors/validate-code/schema.json

@@ -15,7 +15,6 @@
                 },
                 "mode": {
                     "type": "string",
-                    "enum": ["OFF", "NEW_METHODS", "NEW_AND_MODIFIED_METHODS", "MODIFIED_FILES"],
                     "description": "OFF: skip validation. NEW_METHODS: only new methods in diff. NEW_AND_MODIFIED_METHODS: new methods + methods with changes. MODIFIED_FILES: all methods in modified files.",
                     "default": "NEW_AND_MODIFIED_METHODS"
                 },
@@ -41,7 +40,6 @@
                 },
                 "mode": {
                     "type": "string",
-                    "enum": ["OFF", "MODIFIED_FILES"],
                     "description": "OFF: skip validation. MODIFIED_FILES: all code in modified files.",
                     "default": "MODIFIED_FILES"
                 },
@@ -62,7 +60,6 @@
             "properties": {
                 "mode": {
                     "type": "string",
-                    "enum": ["OFF", "NEW_METHODS", "NEW_AND_MODIFIED_METHODS", "MODIFIED_FILES"],
                     "description": "OFF: skip return type validation. NEW_METHODS: only new methods in diff. NEW_AND_MODIFIED_METHODS: new methods + methods with changes. MODIFIED_FILES: all methods in modified files.",
                     "default": "OFF"
                 },
@@ -83,7 +80,6 @@
             "properties": {
                 "mode": {
                     "type": "string",
-                    "enum": ["OFF", "NEW_METHODS", "NEW_AND_MODIFIED_METHODS", "MODIFIED_FILES"],
                     "description": "OFF: skip validation. NEW_METHODS: only new methods. NEW_AND_MODIFIED_METHODS: new + modified methods. MODIFIED_FILES: all in modified files. Disallows inline type literals like { x: number } - use named types instead.",
                     "default": "OFF"
                 },
@@ -104,7 +100,6 @@
             "properties": {
                 "mode": {
                     "type": "string",
-                    "enum": ["OFF", "MODIFIED_CODE", "MODIFIED_FILES"],
                     "description": "OFF: skip validation. MODIFIED_CODE: only changed lines in diff. MODIFIED_FILES: all in modified files. Disallows `any` and `unknown` TypeScript keywords.",
                     "default": "OFF"
                 },
@@ -125,7 +120,6 @@
             "properties": {
                 "mode": {
                     "type": "string",
-                    "enum": ["OFF", "MODIFIED_CLASS", "MODIFIED_FILES"],
                     "description": "OFF: skip validation. MODIFIED_CLASS: only validate Dto classes with changed lines. MODIFIED_FILES: validate all Dtos in modified files.",
                     "default": "OFF"
                 },
@@ -155,8 +149,7 @@
             "properties": {
                 "mode": {
                     "type": "string",
-                    "enum": ["OFF", "MODIFIED_FILES"],
-                    "description": "OFF: skip validation. MODIFIED_FILES: validate converter and non-converter files modified in the diff.",
+                    "description": "OFF: skip validation. MODIFIED_METHOD_AND_CODE: validate new/modified methods in converters + changed lines in non-converters. MODIFIED_FILES: validate all methods in modified files.",
                     "default": "OFF"
                 },
                 "disableAllowed": {
@@ -178,6 +171,26 @@
                     "description": "Epoch seconds. Until this time, skip prisma-converter validation entirely. When expired, normal mode resumes. Omit when not needed."
                 }
             }
+        },
+        "noDestructure": {
+            "type": "object",
+            "description": "Validate no destructuring patterns are used. Destructuring hurts code traceability.",
+            "properties": {
+                "mode": {
+                    "type": "string",
+                    "description": "OFF: skip validation. MODIFIED_CODE: only changed lines in diff. MODIFIED_FILES: all in modified files. Disallows destructuring patterns.",
+                    "default": "OFF"
+                },
+                "disableAllowed": {
+                    "type": "boolean",
+                    "description": "Whether disable comments work. When false, no escape hatch.",
+                    "default": true
+                },
+                "ignoreModifiedUntilEpoch": {
+                    "type": "number",
+                    "description": "Epoch seconds. Until this time, skip validation entirely. When expired, normal mode resumes. Omit when not needed."
+                }
+            }
         }
     },
     "required": []

package/architecture/executors/validate-no-destructure/executor.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Validate No Destructure Executor
+ *
+ * Validates that destructuring patterns are not used in TypeScript code.
+ * Uses LINE-BASED detection (not method-based) for git diff filtering.
+ *
+ * ============================================================================
+ * VIOLATIONS (BAD) - These patterns are flagged:
+ * ============================================================================
+ *
+ * - const { x, y } = obj          — object destructuring in variable declarations
+ * - const [a, b] = fn()           — array destructuring (except Promise.all)
+ * - for (const { email } of items) — object destructuring in for-of loops
+ * - for (const [a, b] of items)   — array destructuring in for-of (except Object.entries)
+ * - const { page = 0 } = opts     — destructuring with defaults
+ * - const { done: streamDone } = obj — destructuring with renaming
+ * - function foo({ x, y }: Type)  — function parameter destructuring
+ *
+ * ============================================================================
+ * ALLOWED (skip — NOT violations)
+ * ============================================================================
+ *
+ * - const [a, b] = await Promise.all([...]) — Promise.all array destructuring
+ * - for (const [key, value] of Object.entries(obj)) — Object.entries in for-of
+ * - const { extracted, ...rest } = obj — rest operator separation
+ * - Lines with // webpieces-disable no-destructure -- [reason] (only when disableAllowed: true)
+ *
+ * ============================================================================
+ * MODES (LINE-BASED)
+ * ============================================================================
+ * - OFF:            Skip validation entirely
+ * - MODIFIED_CODE:  Flag destructuring on changed lines (lines in diff hunks)
+ * - MODIFIED_FILES: Flag ALL destructuring in files that were modified
+ *
+ * ============================================================================
+ * ESCAPE HATCH
+ * ============================================================================
+ * Add comment above the violation:
+ *   // webpieces-disable no-destructure -- [your justification]
+ *   const { x, y } = obj;
+ */
+import type { ExecutorContext } from '@nx/devkit';
+export type NoDestructureMode = 'OFF' | 'MODIFIED_CODE' | 'MODIFIED_FILES';
+export interface ValidateNoDestructureOptions {
+    mode?: NoDestructureMode;
+    disableAllowed?: boolean;
+    ignoreModifiedUntilEpoch?: number;
+}
+export interface ExecutorResult {
+    success: boolean;
+}
+export default function runExecutor(options: ValidateNoDestructureOptions, context: ExecutorContext): Promise<ExecutorResult>;