@aryam/fixmap 0.8.0 → 0.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -9,7 +9,7 @@ FixMap turns an issue, prompt, or git diff into ranked context files, test route
9
9
  Paste a public GitHub issue URL; FixMap fetches its task context and infers the repository:
10
10
 
11
11
  ```bash
12
- npx -y @aryam/fixmap plan --issue https://github.com/aryamthecodebreaker/FixMap/issues/59
12
+ npx -y @aryam/fixmap@latest plan --issue https://github.com/chalk/chalk/issues/624
13
13
  ```
14
14
 
15
15
  Or supply your own task and public repository:
@@ -38,9 +38,9 @@ Machine-readable output:
38
38
  npx @aryam/fixmap plan --base main --head HEAD --format json --output fixmap-report.json
39
39
  ```
40
40
 
41
- Public GitHub issue and repository URL modes are available in the CLI and MCP server for issue-only analysis. FixMap fetches issue context anonymously, shallow-clones the default branch into an isolated temporary directory, disables credentials and repository execution surfaces, and removes the checkout before returning. Clone locally to use `--diff`, `--base`, or `--head`.
41
+ Public GitHub issue, pull request, and repository URL modes are available in the CLI and MCP server for issue-only analysis. FixMap fetches task context anonymously, shallow-clones the default branch into an isolated temporary directory, disables credentials and repository execution surfaces, and removes the checkout before returning. Clone locally to use `--diff`, `--base`, `--head`, or working-tree inputs.
42
42
 
43
- For long task text, use `--issue-file task.md`, `--issue @task.md`, or pipe text to `--issue -`. If a stale global installation shadows a pinned npx package on Windows, run `npm uninstall -g @aryam/fixmap` or use `npm exec --yes --package=@aryam/fixmap@0.7.4 -- fixmap ...`.
43
+ For long task text, use `--issue-file task.md`, `--issue @task.md`, or pipe text to `--issue -`. If a stale global installation shadows a pinned npx package on Windows, run `fixmap doctor`, remove the stale install with `npm uninstall -g @aryam/fixmap`, or use `npm exec --yes --package=@aryam/fixmap@0.8.2 -- fixmap ...`.
44
44
 
45
45
  ## MCP server
46
46
 
@@ -70,14 +70,21 @@ Cursor, Windsurf, or any MCP client:
70
70
  ```text
71
71
  fixmap plan Generate a FixMap report for a task or diff
72
72
  fixmap verify Compare a saved plan with the diff that followed
73
+ fixmap doctor Report the resolved version and any shadowing install
73
74
  fixmap mcp Run FixMap as an MCP server over stdio
74
75
 
75
- --issue <text|url> Issue text, task description, or public GitHub issue URL
76
- --issue-file <file> Read task text from a UTF-8 file, or - for stdin
76
+ --issue <text|url> Issue text, task description, or public GitHub issue or pull request URL
77
+ --issue-file <file> Read task text from a UTF-8 or UTF-16 file, or - for stdin
77
78
  --diff <spec> Git diff spec, such as main...HEAD
78
79
  --base <ref> Base ref for diffing when --diff is not given
79
80
  --head <ref> Head ref for diffing (defaults to HEAD)
80
- --repo <source> Local path or public GitHub HTTPS URL
81
+ --working-tree Map staged and unstaged tracked changes against HEAD
82
+ --include-untracked With --working-tree, count untracked files as changed
83
+ --explain <path> Explain why one path ranked where it did, or did not appear
84
+ --compare <file> Diff this plan against a saved JSON plan
85
+ --limit <n> Cap reported context files, 1 to 20 (default 8)
86
+ --exclude <pattern> Leave paths out of ranking; repeatable, gitignore-flavored
87
+ --repo <source> Local path, file:// URL, or public GitHub HTTPS/SSH URL
81
88
  --format <fmt> Output format: markdown (default) or json
82
89
  --output <file> Write the report to a file instead of stdout
83
90
  ```
@@ -98,7 +105,7 @@ fixmap mcp Run FixMap as an MCP server over stdio
98
105
  ## Links
99
106
 
100
107
  - [GitHub repository](https://github.com/aryamthecodebreaker/FixMap)
101
- - [Live demo](https://fixmap-flax.vercel.app)
108
+ - [Live demo](https://usefixmap.vercel.app)
102
109
  - [Changelog](https://github.com/aryamthecodebreaker/FixMap/blob/main/CHANGELOG.md)
103
110
 
104
111
  MIT © FixMap contributors.
@@ -29,9 +29,10 @@ export type CliDependencies = {
29
29
  stderr?: (text: string) => void;
30
30
  stdout?: (text: string) => void;
31
31
  writeReport?: (path: string, contents: string) => Promise<void>;
32
- readIssueFile?: (path: string | number) => string;
32
+ readIssueFile?: (path: string | number) => string | Buffer;
33
33
  };
34
- export declare const USAGE = "FixMap maps an issue, prompt, or diff to context files, test routes, and review risks.\n\nUsage:\n fixmap plan --issue \"Users cannot reset passwords\"\n fixmap plan --issue https://github.com/owner/repository/issues/123\n fixmap plan --issue-file task.md\n fixmap plan --issue -\n fixmap plan --issue \"Fix login\" --repo https://github.com/owner/repository\n fixmap plan --diff main...HEAD\n fixmap plan --base main --head HEAD --format json\n fixmap verify --report fixmap-report.json --diff main...HEAD\n fixmap mcp\n\nCommands:\n plan Generate a FixMap report for a task or diff\n verify Compare a saved report against the diff that followed it\n doctor Check the FixMap install for stale global or npx shadows\n mcp Run FixMap as an MCP server over stdio for AI coding agents\n\nOptions:\n --issue <text|url> Issue text, task description, or public GitHub issue URL\n --issue-file <file> Read task text from a UTF-8 file (use - for stdin)\n --diff <spec> Git diff spec, such as main...HEAD\n --base <ref> Base ref for diffing when --diff is not given\n --head <ref> Head ref for diffing (defaults to HEAD)\n --working-tree Map staged and unstaged changes against HEAD\n --include-untracked With --working-tree, also include untracked files\n --repo <source> Local path or public GitHub HTTPS URL (defaults to current directory)\n --limit <n> Maximum context files to report (default 8, max 20)\n --exclude <glob> Path pattern to leave out of ranking (repeatable)\n --format <fmt> Output format: markdown (default) or json\n --output <file> Write the report or verification to a file instead of stdout\n --explain <path> Explain why one file was ranked where it was, or left out\n --compare <file> Compare this plan against an earlier JSON report\n --report <file> Verify command only: the JSON report the change was planned from\n --help, -h Show this help\n --version, -v Show the FixMap version\n\nA repository may also list exclusion patterns in .fixmapignore, one per line.\nSet FIXMAP_PROGRESS=1 to print scan and clone phases to stderr.\n";
34
+ export declare const USAGE = "FixMap maps an issue, prompt, or diff to context files, test routes, and review risks.\n\nUsage:\n fixmap owner/repository#123\n fixmap https://github.com/owner/repository/issues/123\n fixmap plan --issue \"Users cannot reset passwords\"\n fixmap plan --issue https://github.com/owner/repository/issues/123\n fixmap plan --issue https://github.com/owner/repository/pull/123\n fixmap plan --issue-file task.md\n fixmap plan --issue -\n fixmap plan --issue \"Fix login\" --repo https://github.com/owner/repository\n fixmap plan --diff main...HEAD\n fixmap plan --working-tree --include-untracked --limit 12 --exclude \"docs/**\"\n fixmap plan --issue \"Fix login\" --format json --output current.json --compare previous.json\n fixmap plan --base main --head HEAD --format json\n fixmap verify --report fixmap-report.json --diff main...HEAD\n fixmap verify --report fixmap-report.json --working-tree\n fixmap doctor --format json\n fixmap mcp\n\nCommands:\n plan Generate a FixMap report for a task or diff\n verify Compare a saved report against the diff that followed it\n doctor Check the FixMap install for stale global or npx shadows\n mcp Run FixMap as an MCP server over stdio for AI coding agents\n\nOptions:\n --issue <text|url> Task text, or a public GitHub issue or pull request URL\n --issue-file <file> Read task text from a UTF-8 or UTF-16 file (use - for stdin)\n --diff <spec> Git diff spec, such as main...HEAD (the repository scan can still rank untracked candidates)\n --base <ref> Base ref for diffing when --diff is not given\n --head <ref> Head ref for diffing (defaults to HEAD)\n --working-tree Map staged and unstaged changes against HEAD\n --include-untracked With --working-tree, also include untracked files\n --repo <source> Local path or public GitHub HTTPS URL (defaults to current directory)\n --limit <n> Maximum context files to report (default 8, max 20)\n --exclude <glob> Path pattern to leave out of ranking (repeatable)\n --format <fmt> Output format: markdown (default) or json\n --output <file> Write the report or verification to a file instead of stdout\n --explain <path> Explain why one file was ranked where it was, or left out\n --compare <file> Compare this plan against an earlier JSON report\n --report <file> Verify command only: the JSON report the change was planned from\n --help, -h Show this help\n --version, -v Show the FixMap version\n\nA repository may also list exclusion patterns in .fixmapignore, one per line. Supported\nsyntax is *, **, ?, root-leading /, directory-trailing /, comments, and ! negation.\nSet FIXMAP_PROGRESS=1 to print scan and clone phases to stderr.\n";
35
35
  export declare function runCli(args: string[], dependencies?: CliDependencies): Promise<number>;
36
+ export declare function expandIssueShorthand(args: string[]): string[];
36
37
  export declare const MAX_CONTEXT_FILE_LIMIT = 20;
37
38
  export declare function parseArgs(args: string[]): CliOptions;