dittory 0.0.3 → 0.0.5

package/README.md

@@ -3,9 +3,7 @@
 [![npm version](https://img.shields.io/npm/v/dittory.svg)](https://www.npmjs.com/package/dittory)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-A static analysis CLI that detects **parameters always receiving the same value** in React components and functions.
-
-> **dittory** = "ditto" (same) + "-ory" — finds repetitive patterns in your code
+A static analysis CLI that detects **parameters that always receive the same value** in React components and functions.
 
 ## Why?
 
@@ -47,8 +45,8 @@ dittory --target=functions   # Functions and class methods only
 dittory --target=all         # Both (default)
 
 # Output mode
-dittory --output=simple      # Show only constants (default)
-dittory --output=verbose     # Show all exported functions and details
+dittory --output=simple      # Show only constant parameters (default)
+dittory --output=verbose     # Also show all analyzed functions
 ```
 
 ## Example Output
@@ -84,7 +82,7 @@ Found 2 function(s) with constant arguments out of 24 function(s).
 | Target | Description |
 |--------|-------------|
 | **React Components** | Props passed to JSX elements (`<Button variant="primary" />`) |
-| **Functions** | Arguments passed to exported function calls |
+| **Functions** | Arguments passed to exported functions |
 | **Class Methods** | Arguments passed to methods of exported classes |
 
 ## Supported Detection Patterns
@@ -101,9 +99,11 @@ Found 2 function(s) with constant arguments out of 24 function(s).
 | Variable references | `const x = 3; fn(x)` | ✅ |
 | Variable chains | `const a = 1; const b = a; fn(b)` → resolves to `1` | ✅ |
 | Object literals | `{ nested: { value: 1 } }` | ✅ |
-| Function references | `onClick={handleClick}` | ✅ (by location) |
+| Function references | `onClick={handleClick}` | ⚠️ (tracked per call site) |
 | `undefined` | `fn(undefined)` | ✅ |
 
+> **Note on Function references:** Function values are identified by their usage location (file + line), not by identity. Even if the same function is passed from multiple locations, each usage is treated as a different value. This is by design, as the analysis takes a conservative approach regarding runtime behavior.
+
 ### Parameter Propagation (Call Graph Analysis)
 
 dittory can track values through component/function chains:
@@ -152,7 +152,7 @@ const Parent = ({ num, ...others }) => <Child {...others} />;
 
 ### Conditional Branches
 
-When different code paths pass different values, dittory correctly identifies them as different values (not constant):
+When different code paths pass different values, dittory correctly identifies them as different values (not constants):
 
 ```tsx
 // Different values in branches → correctly NOT reported as constant
@@ -189,14 +189,27 @@ const Enhanced = withAuth(Component);
 <Enhanced role="admin" />
 ```
 
+### Function Overloads
+
+```ts
+// ❌ Overloaded functions may not correctly map arguments
+function process(a: string): void;
+function process(a: string, b: number): void;
+function process(a: string, b?: number): void { ... }
+
+// Only parameters from the first overload signature are recognized
+process("hello", 42);  // "b" argument is not tracked
+```
+
 ## CLI Options
 
 | Option | Description | Default |
 |--------|-------------|---------|
-| `--min=<n>` | Minimum number of usages to consider | `2` |
+| `--min=<n>` | Minimum number of usages required to report | `2` |
 | `--target=<mode>` | What to analyze: `all`, `components`, `functions` | `all` |
 | `--output=<mode>` | Output verbosity: `simple`, `verbose` | `simple` |
 | `--tsconfig=<path>` | Path to tsconfig.json | `./tsconfig.json` |
+| `--value-types=<types>` | Value types to detect (comma-separated): `boolean`, `number`, `string`, `enum`, `undefined`, `all` | `all` |
 | `--help` | Show help message | — |
 
 ## Configuration File
@@ -215,6 +228,7 @@ export default {
   output: "verbose",
   tsconfig: "./tsconfig.app.json",
   targetDir: "./src",
+  valueTypes: ["boolean", "string"], // or "all"
 };
 ```
 
@@ -247,7 +261,7 @@ Works alongside other directives like `eslint-disable-line` or `@ts-ignore`.
 <Button onClick={handleClick}>Submit</Button>
 ```
 
-### Remove Unused Flexibility
+### Remove Unnecessary Flexibility
 
 ```ts
 // Before: cache is always false in all 15 call sites