@futdevpro/dynamo-eslint 1.15.22 → 1.15.28

package/src/scripts/eslintrc-audit.ts

@@ -1,116 +1,116 @@
-#!/usr/bin/env node
-/**
- * @fileoverview ESLint Configuration Audit Script
- * 
- * This script analyzes ESLint configuration files (.eslintrc.json) across the project
- * to provide statistics on rule usage. It helps identify commonly used rules and
- * potential configuration inconsistencies.
- * 
- * @usage
- * ```bash
- * dynamo-eslintrc-audit
- * ```
- * 
- * @example
- * ```bash
- * # Audit all ESLint configurations in the project
- * npx dynamo-eslintrc-audit
- * 
- * # Or run via npm script
- * npm run audit:eslintrc
- * ```
- * 
- * @author Future Development Program Ltd.
- * @version 1.14.3
- */
-
-import fg from 'fast-glob';
-import { readFileSync } from 'fs';
-/** Type alias for any JSON value */
-type AnyJson = any;
-
-/**
- * Safely parses a JSON file and returns the parsed object or null if parsing fails
- * 
- * @param jsonPath - Path to the JSON file to parse
- * @returns Parsed JSON object or null if parsing fails
- * 
- * @example
- * ```typescript
- * const config = safeParse('./.eslintrc.json');
- * if (config) {
- *   console.log('Rules:', Object.keys(config.rules || {}));
- * }
- * ```
- */
-function safeParse(jsonPath: string): AnyJson | null {
-  try {
-    const content = readFileSync(jsonPath, 'utf8');
-
-    return JSON.parse(content);
-  } catch {
-    // Return null for any parsing errors (malformed JSON, file not found, etc.)
-    return null;
-  }
-}
-
-/**
- * Main function that analyzes ESLint configuration files and generates rule usage statistics
- * 
- * Scans for all .eslintrc.json files in the project, extracts rule configurations,
- * and provides a sorted table of the most commonly used rules.
- * 
- * @returns Promise that resolves when analysis is complete
- * 
- * @example
- * ```typescript
- * // The function will output a table like:
- * // ┌─────────┬─────────────────────────┬───────┐
- * // │ (index) │          rule           │ count │
- * // ├─────────┼─────────────────────────┼───────┤
- * // │    0    │    'no-unused-vars'     │   5   │
- * // │    1    │    'semi'               │   4   │
- * // └─────────┴─────────────────────────┴───────┘
- * ```
- */
-async function main(): Promise<void> {
-  // Find all ESLint configuration files, excluding node_modules
-  const files: string[] = await fg([ '**/.eslintrc.json' ], { ignore: [ '**/node_modules/**' ] });
-  const ruleCounts: Record<string, number> = {};
-  const total: number = files.length;
-
-  // Process each configuration file
-  for (const p of files) {
-    const cfg = safeParse(p);
-
-    // Skip files without rules configuration
-    if (!cfg?.rules) continue;
-
-    // Count each rule occurrence
-    for (const key of Object.keys(cfg.rules)) {
-      ruleCounts[key] = (ruleCounts[key] ?? 0) + 1;
-    }
-  }
-
-  // Sort rules by usage count (most used first)
-  const entries = Object.entries(ruleCounts).sort(
-    (a: [ string, number ], b: [ string, number ]): number => b[1] - a[1]
-  );
-
-  // Display results
-  console.log(`[dynamo-eslintrc-audit] analyzed ${total} files`);
-  console.table(entries.slice(0, 50).map(([ rule, count ]) => ({ rule, count })));
-}
-
-// Execute the main function and handle any errors
-main().catch((err: Error): void => {
-  console.error(err);
-  process.exit(1);
-});
-
-
-
-
-
-
-
+#!/usr/bin/env node
+/**
+ * @fileoverview ESLint Configuration Audit Script
+ * 
+ * This script analyzes ESLint configuration files (.eslintrc.json) across the project
+ * to provide statistics on rule usage. It helps identify commonly used rules and
+ * potential configuration inconsistencies.
+ * 
+ * @usage
+ * ```bash
+ * dynamo-eslintrc-audit
+ * ```
+ * 
+ * @example
+ * ```bash
+ * # Audit all ESLint configurations in the project
+ * npx dynamo-eslintrc-audit
+ * 
+ * # Or run via npm script
+ * npm run audit:eslintrc
+ * ```
+ * 
+ * @author Future Development Program Ltd.
+ * @version 1.14.3
+ */
+
+import fg from 'fast-glob';
+import { readFileSync } from 'fs';
+/** Type alias for any JSON value */
+type AnyJson = any;
+
+/**
+ * Safely parses a JSON file and returns the parsed object or null if parsing fails
+ * 
+ * @param jsonPath - Path to the JSON file to parse
+ * @returns Parsed JSON object or null if parsing fails
+ * 
+ * @example
+ * ```typescript
+ * const config = safeParse('./.eslintrc.json');
+ * if (config) {
+ *   console.log('Rules:', Object.keys(config.rules || {}));
+ * }
+ * ```
+ */
+function safeParse(jsonPath: string): AnyJson | null {
+  try {
+    const content = readFileSync(jsonPath, 'utf8');
+
+    return JSON.parse(content);
+  } catch {
+    // Return null for any parsing errors (malformed JSON, file not found, etc.)
+    return null;
+  }
+}
+
+/**
+ * Main function that analyzes ESLint configuration files and generates rule usage statistics
+ * 
+ * Scans for all .eslintrc.json files in the project, extracts rule configurations,
+ * and provides a sorted table of the most commonly used rules.
+ * 
+ * @returns Promise that resolves when analysis is complete
+ * 
+ * @example
+ * ```typescript
+ * // The function will output a table like:
+ * // ┌─────────┬─────────────────────────┬───────┐
+ * // │ (index) │          rule           │ count │
+ * // ├─────────┼─────────────────────────┼───────┤
+ * // │    0    │    'no-unused-vars'     │   5   │
+ * // │    1    │    'semi'               │   4   │
+ * // └─────────┴─────────────────────────┴───────┘
+ * ```
+ */
+async function main(): Promise<void> {
+  // Find all ESLint configuration files, excluding node_modules
+  const files: string[] = await fg([ '**/.eslintrc.json' ], { ignore: [ '**/node_modules/**' ] });
+  const ruleCounts: Record<string, number> = {};
+  const total: number = files.length;
+
+  // Process each configuration file
+  for (const p of files) {
+    const cfg = safeParse(p);
+
+    // Skip files without rules configuration
+    if (!cfg?.rules) continue;
+
+    // Count each rule occurrence
+    for (const key of Object.keys(cfg.rules)) {
+      ruleCounts[key] = (ruleCounts[key] ?? 0) + 1;
+    }
+  }
+
+  // Sort rules by usage count (most used first)
+  const entries = Object.entries(ruleCounts).sort(
+    (a: [ string, number ], b: [ string, number ]): number => b[1] - a[1]
+  );
+
+  // Display results
+  console.log(`[dynamo-eslintrc-audit] analyzed ${total} files`);
+  console.table(entries.slice(0, 50).map(([ rule, count ]) => ({ rule, count })));
+}
+
+// Execute the main function and handle any errors
+main().catch((err: Error): void => {
+  console.error(err);
+  process.exit(1);
+});
+
+
+
+
+
+
+

package/src/scripts/fix-return-types.spec.ts

@@ -1,65 +1,65 @@
-import * as ts from 'typescript';
-
-import { buildTypeNodeFromString } from './fix-return-types';
-
-/**
- * A `buildTypeNodeFromString` helper-t fedi le — ez a B2 regresszio magja: a regi
- * `ts.factory.createTypeReferenceNode(typeString)` csonka `Record`-ot emittalt a
- * generic tipusoknal. A helper most a teljes tipus-stringet valodi TypeNode-da
- * parse-olja, vagy bail-el (undefined), ha nem biztonsagos.
- */
-describe('| fix-return-types buildTypeNodeFromString', () => {
-  const printer: ts.Printer = ts.createPrinter();
-  const dummySource: ts.SourceFile = ts.createSourceFile('__dummy__.ts', '', ts.ScriptTarget.Latest, false);
-
-  /** Egy TypeNode-ot vissza-printel forras-szovegge az assert-hez. */
-  function printType(node: ts.TypeNode): string {
-    return printer.printNode(ts.EmitHint.Unspecified, node, dummySource);
-  }
-
-  it('| should keep the type arguments of a generic Record (no truncation)', () => {
-    const node: ts.TypeNode | undefined = buildTypeNodeFromString('Record<string, unknown>');
-
-    expect(node).toBeDefined();
-
-    const printed: string = printType(node as ts.TypeNode);
-
-    // A regi bug itt csonka "Record"-ot adott — most a teljes generic megmarad.
-    expect(printed).toContain('Record');
-    expect(printed).toContain('<');
-    expect(printed).toContain('string');
-    expect(printed).toContain('unknown');
-    expect(printed).not.toMatch(/^Record;?$/);
-  });
-
-  it('| should preserve a union type', () => {
-    const node: ts.TypeNode | undefined = buildTypeNodeFromString('string | null');
-
-    expect(node).toBeDefined();
-    expect(printType(node as ts.TypeNode)).toContain('|');
-  });
-
-  it('| should preserve a nested generic (Promise of array)', () => {
-    const node: ts.TypeNode | undefined = buildTypeNodeFromString('Promise<number[]>');
-
-    expect(node).toBeDefined();
-
-    const printed: string = printType(node as ts.TypeNode);
-    expect(printed).toContain('Promise');
-    expect(printed).toContain('number');
-    expect(printed).toContain('[]');
-  });
-
-  it('| should bail (undefined) on an inline import() type to avoid leaking a path', () => {
-    const node: ts.TypeNode | undefined = buildTypeNodeFromString('import("/abs/path/to/mod").Foo');
-
-    expect(node).toBeUndefined();
-  });
-
-  it('| should still handle a plain identifier type', () => {
-    const node: ts.TypeNode | undefined = buildTypeNodeFromString('MyType');
-
-    expect(node).toBeDefined();
-    expect(printType(node as ts.TypeNode)).toBe('MyType');
-  });
-});
+import * as ts from 'typescript';
+
+import { buildTypeNodeFromString } from './fix-return-types';
+
+/**
+ * A `buildTypeNodeFromString` helper-t fedi le — ez a B2 regresszio magja: a regi
+ * `ts.factory.createTypeReferenceNode(typeString)` csonka `Record`-ot emittalt a
+ * generic tipusoknal. A helper most a teljes tipus-stringet valodi TypeNode-da
+ * parse-olja, vagy bail-el (undefined), ha nem biztonsagos.
+ */
+describe('| fix-return-types buildTypeNodeFromString', () => {
+  const printer: ts.Printer = ts.createPrinter();
+  const dummySource: ts.SourceFile = ts.createSourceFile('__dummy__.ts', '', ts.ScriptTarget.Latest, false);
+
+  /** Egy TypeNode-ot vissza-printel forras-szovegge az assert-hez. */
+  function printType(node: ts.TypeNode): string {
+    return printer.printNode(ts.EmitHint.Unspecified, node, dummySource);
+  }
+
+  it('| should keep the type arguments of a generic Record (no truncation)', () => {
+    const node: ts.TypeNode | undefined = buildTypeNodeFromString('Record<string, unknown>');
+
+    expect(node).toBeDefined();
+
+    const printed: string = printType(node as ts.TypeNode);
+
+    // A regi bug itt csonka "Record"-ot adott — most a teljes generic megmarad.
+    expect(printed).toContain('Record');
+    expect(printed).toContain('<');
+    expect(printed).toContain('string');
+    expect(printed).toContain('unknown');
+    expect(printed).not.toMatch(/^Record;?$/);
+  });
+
+  it('| should preserve a union type', () => {
+    const node: ts.TypeNode | undefined = buildTypeNodeFromString('string | null');
+
+    expect(node).toBeDefined();
+    expect(printType(node as ts.TypeNode)).toContain('|');
+  });
+
+  it('| should preserve a nested generic (Promise of array)', () => {
+    const node: ts.TypeNode | undefined = buildTypeNodeFromString('Promise<number[]>');
+
+    expect(node).toBeDefined();
+
+    const printed: string = printType(node as ts.TypeNode);
+    expect(printed).toContain('Promise');
+    expect(printed).toContain('number');
+    expect(printed).toContain('[]');
+  });
+
+  it('| should bail (undefined) on an inline import() type to avoid leaking a path', () => {
+    const node: ts.TypeNode | undefined = buildTypeNodeFromString('import("/abs/path/to/mod").Foo');
+
+    expect(node).toBeUndefined();
+  });
+
+  it('| should still handle a plain identifier type', () => {
+    const node: ts.TypeNode | undefined = buildTypeNodeFromString('MyType');
+
+    expect(node).toBeDefined();
+    expect(printType(node as ts.TypeNode)).toBe('MyType');
+  });
+});