@codewalla_india/openspec 1.0.1
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/LICENSE +22 -0
- package/README.md +225 -0
- package/bin/openspec.js +5 -0
- package/dist/cli/index.d.ts +10 -0
- package/dist/cli/index.js +548 -0
- package/dist/commands/change.d.ts +39 -0
- package/dist/commands/change.js +279 -0
- package/dist/commands/completion.d.ts +72 -0
- package/dist/commands/completion.js +264 -0
- package/dist/commands/config.d.ts +36 -0
- package/dist/commands/config.js +552 -0
- package/dist/commands/context.d.ts +3 -0
- package/dist/commands/context.js +155 -0
- package/dist/commands/doctor.d.ts +8 -0
- package/dist/commands/doctor.js +163 -0
- package/dist/commands/feedback.d.ts +9 -0
- package/dist/commands/feedback.js +183 -0
- package/dist/commands/schema.d.ts +6 -0
- package/dist/commands/schema.js +869 -0
- package/dist/commands/shared-gather.d.ts +14 -0
- package/dist/commands/shared-gather.js +31 -0
- package/dist/commands/shared-output.d.ts +18 -0
- package/dist/commands/shared-output.js +61 -0
- package/dist/commands/show.d.ts +19 -0
- package/dist/commands/show.js +177 -0
- package/dist/commands/spec.d.ts +19 -0
- package/dist/commands/spec.js +236 -0
- package/dist/commands/store.d.ts +3 -0
- package/dist/commands/store.js +547 -0
- package/dist/commands/validate.d.ts +26 -0
- package/dist/commands/validate.js +330 -0
- package/dist/commands/workflow/index.d.ts +17 -0
- package/dist/commands/workflow/index.js +12 -0
- package/dist/commands/workflow/instructions.d.ts +45 -0
- package/dist/commands/workflow/instructions.js +500 -0
- package/dist/commands/workflow/new-change.d.ts +20 -0
- package/dist/commands/workflow/new-change.js +106 -0
- package/dist/commands/workflow/schemas.d.ts +10 -0
- package/dist/commands/workflow/schemas.js +34 -0
- package/dist/commands/workflow/shared.d.ts +84 -0
- package/dist/commands/workflow/shared.js +133 -0
- package/dist/commands/workflow/status.d.ts +16 -0
- package/dist/commands/workflow/status.js +92 -0
- package/dist/commands/workflow/templates.d.ts +16 -0
- package/dist/commands/workflow/templates.js +69 -0
- package/dist/commands/workset-input.d.ts +19 -0
- package/dist/commands/workset-input.js +112 -0
- package/dist/commands/workset-prompts.d.ts +12 -0
- package/dist/commands/workset-prompts.js +143 -0
- package/dist/commands/workset.d.ts +25 -0
- package/dist/commands/workset.js +446 -0
- package/dist/core/archive.d.ts +22 -0
- package/dist/core/archive.js +471 -0
- package/dist/core/artifact-graph/graph.d.ts +56 -0
- package/dist/core/artifact-graph/graph.js +141 -0
- package/dist/core/artifact-graph/index.d.ts +9 -0
- package/dist/core/artifact-graph/index.js +14 -0
- package/dist/core/artifact-graph/instruction-loader.d.ts +188 -0
- package/dist/core/artifact-graph/instruction-loader.js +233 -0
- package/dist/core/artifact-graph/outputs.d.ts +14 -0
- package/dist/core/artifact-graph/outputs.js +39 -0
- package/dist/core/artifact-graph/resolver.d.ts +81 -0
- package/dist/core/artifact-graph/resolver.js +257 -0
- package/dist/core/artifact-graph/schema.d.ts +13 -0
- package/dist/core/artifact-graph/schema.js +108 -0
- package/dist/core/artifact-graph/state.d.ts +12 -0
- package/dist/core/artifact-graph/state.js +31 -0
- package/dist/core/artifact-graph/types.d.ts +40 -0
- package/dist/core/artifact-graph/types.js +29 -0
- package/dist/core/available-tools.d.ts +17 -0
- package/dist/core/available-tools.js +43 -0
- package/dist/core/change-metadata/index.d.ts +2 -0
- package/dist/core/change-metadata/index.js +2 -0
- package/dist/core/change-metadata/schema.d.ts +19 -0
- package/dist/core/change-metadata/schema.js +30 -0
- package/dist/core/change-status-policy.d.ts +37 -0
- package/dist/core/change-status-policy.js +35 -0
- package/dist/core/command-generation/adapters/amazon-q.d.ts +13 -0
- package/dist/core/command-generation/adapters/amazon-q.js +26 -0
- package/dist/core/command-generation/adapters/antigravity.d.ts +13 -0
- package/dist/core/command-generation/adapters/antigravity.js +26 -0
- package/dist/core/command-generation/adapters/auggie.d.ts +13 -0
- package/dist/core/command-generation/adapters/auggie.js +27 -0
- package/dist/core/command-generation/adapters/bob.d.ts +14 -0
- package/dist/core/command-generation/adapters/bob.js +32 -0
- package/dist/core/command-generation/adapters/claude.d.ts +13 -0
- package/dist/core/command-generation/adapters/claude.js +37 -0
- package/dist/core/command-generation/adapters/cline.d.ts +14 -0
- package/dist/core/command-generation/adapters/cline.js +27 -0
- package/dist/core/command-generation/adapters/codebuddy.d.ts +13 -0
- package/dist/core/command-generation/adapters/codebuddy.js +28 -0
- package/dist/core/command-generation/adapters/codex.d.ts +16 -0
- package/dist/core/command-generation/adapters/codex.js +39 -0
- package/dist/core/command-generation/adapters/continue.d.ts +13 -0
- package/dist/core/command-generation/adapters/continue.js +28 -0
- package/dist/core/command-generation/adapters/costrict.d.ts +13 -0
- package/dist/core/command-generation/adapters/costrict.js +27 -0
- package/dist/core/command-generation/adapters/crush.d.ts +13 -0
- package/dist/core/command-generation/adapters/crush.js +30 -0
- package/dist/core/command-generation/adapters/cursor.d.ts +14 -0
- package/dist/core/command-generation/adapters/cursor.js +31 -0
- package/dist/core/command-generation/adapters/factory.d.ts +13 -0
- package/dist/core/command-generation/adapters/factory.js +27 -0
- package/dist/core/command-generation/adapters/gemini.d.ts +13 -0
- package/dist/core/command-generation/adapters/gemini.js +26 -0
- package/dist/core/command-generation/adapters/github-copilot.d.ts +13 -0
- package/dist/core/command-generation/adapters/github-copilot.js +26 -0
- package/dist/core/command-generation/adapters/iflow.d.ts +13 -0
- package/dist/core/command-generation/adapters/iflow.js +29 -0
- package/dist/core/command-generation/adapters/index.d.ts +32 -0
- package/dist/core/command-generation/adapters/index.js +32 -0
- package/dist/core/command-generation/adapters/junie.d.ts +13 -0
- package/dist/core/command-generation/adapters/junie.js +26 -0
- package/dist/core/command-generation/adapters/kilocode.d.ts +14 -0
- package/dist/core/command-generation/adapters/kilocode.js +23 -0
- package/dist/core/command-generation/adapters/kiro.d.ts +13 -0
- package/dist/core/command-generation/adapters/kiro.js +26 -0
- package/dist/core/command-generation/adapters/lingma.d.ts +13 -0
- package/dist/core/command-generation/adapters/lingma.js +30 -0
- package/dist/core/command-generation/adapters/opencode.d.ts +13 -0
- package/dist/core/command-generation/adapters/opencode.js +29 -0
- package/dist/core/command-generation/adapters/pi.d.ts +18 -0
- package/dist/core/command-generation/adapters/pi.js +42 -0
- package/dist/core/command-generation/adapters/qoder.d.ts +13 -0
- package/dist/core/command-generation/adapters/qoder.js +30 -0
- package/dist/core/command-generation/adapters/qwen.d.ts +13 -0
- package/dist/core/command-generation/adapters/qwen.js +26 -0
- package/dist/core/command-generation/adapters/roocode.d.ts +14 -0
- package/dist/core/command-generation/adapters/roocode.js +27 -0
- package/dist/core/command-generation/adapters/windsurf.d.ts +14 -0
- package/dist/core/command-generation/adapters/windsurf.js +38 -0
- package/dist/core/command-generation/generator.d.ts +21 -0
- package/dist/core/command-generation/generator.js +27 -0
- package/dist/core/command-generation/index.d.ts +22 -0
- package/dist/core/command-generation/index.js +24 -0
- package/dist/core/command-generation/registry.d.ts +36 -0
- package/dist/core/command-generation/registry.js +98 -0
- package/dist/core/command-generation/types.d.ts +56 -0
- package/dist/core/command-generation/types.js +8 -0
- package/dist/core/command-generation/yaml.d.ts +22 -0
- package/dist/core/command-generation/yaml.js +38 -0
- package/dist/core/completions/command-registry.d.ts +3 -0
- package/dist/core/completions/command-registry.js +778 -0
- package/dist/core/completions/completion-provider.d.ts +71 -0
- package/dist/core/completions/completion-provider.js +129 -0
- package/dist/core/completions/factory.d.ts +64 -0
- package/dist/core/completions/factory.js +75 -0
- package/dist/core/completions/generators/bash-generator.d.ts +35 -0
- package/dist/core/completions/generators/bash-generator.js +230 -0
- package/dist/core/completions/generators/fish-generator.d.ts +32 -0
- package/dist/core/completions/generators/fish-generator.js +160 -0
- package/dist/core/completions/generators/powershell-generator.d.ts +36 -0
- package/dist/core/completions/generators/powershell-generator.js +266 -0
- package/dist/core/completions/generators/zsh-generator.d.ts +47 -0
- package/dist/core/completions/generators/zsh-generator.js +276 -0
- package/dist/core/completions/installers/bash-installer.d.ts +87 -0
- package/dist/core/completions/installers/bash-installer.js +321 -0
- package/dist/core/completions/installers/fish-installer.d.ts +43 -0
- package/dist/core/completions/installers/fish-installer.js +151 -0
- package/dist/core/completions/installers/powershell-installer.d.ts +102 -0
- package/dist/core/completions/installers/powershell-installer.js +415 -0
- package/dist/core/completions/installers/zsh-installer.d.ts +117 -0
- package/dist/core/completions/installers/zsh-installer.js +424 -0
- package/dist/core/completions/shared-flags.d.ts +13 -0
- package/dist/core/completions/shared-flags.js +33 -0
- package/dist/core/completions/templates/bash-templates.d.ts +6 -0
- package/dist/core/completions/templates/bash-templates.js +30 -0
- package/dist/core/completions/templates/fish-templates.d.ts +7 -0
- package/dist/core/completions/templates/fish-templates.js +45 -0
- package/dist/core/completions/templates/powershell-templates.d.ts +6 -0
- package/dist/core/completions/templates/powershell-templates.js +34 -0
- package/dist/core/completions/templates/zsh-templates.d.ts +6 -0
- package/dist/core/completions/templates/zsh-templates.js +45 -0
- package/dist/core/completions/types.d.ts +101 -0
- package/dist/core/completions/types.js +2 -0
- package/dist/core/comprehension/config.d.ts +20 -0
- package/dist/core/comprehension/config.js +23 -0
- package/dist/core/comprehension/fingerprint.d.ts +5 -0
- package/dist/core/comprehension/fingerprint.js +25 -0
- package/dist/core/comprehension/index.d.ts +49 -0
- package/dist/core/comprehension/index.js +78 -0
- package/dist/core/comprehension/pass-record.d.ts +29 -0
- package/dist/core/comprehension/pass-record.js +64 -0
- package/dist/core/comprehension/stats.d.ts +18 -0
- package/dist/core/comprehension/stats.js +41 -0
- package/dist/core/config-prompts.d.ts +9 -0
- package/dist/core/config-prompts.js +34 -0
- package/dist/core/config-schema.d.ts +87 -0
- package/dist/core/config-schema.js +239 -0
- package/dist/core/config.d.ts +18 -0
- package/dist/core/config.js +39 -0
- package/dist/core/converters/json-converter.d.ts +6 -0
- package/dist/core/converters/json-converter.js +51 -0
- package/dist/core/file-state.d.ts +36 -0
- package/dist/core/file-state.js +112 -0
- package/dist/core/global-config.d.ts +51 -0
- package/dist/core/global-config.js +124 -0
- package/dist/core/id.d.ts +17 -0
- package/dist/core/id.js +30 -0
- package/dist/core/index.d.ts +6 -0
- package/dist/core/index.js +7 -0
- package/dist/core/init.d.ts +37 -0
- package/dist/core/init.js +613 -0
- package/dist/core/legacy-cleanup.d.ts +162 -0
- package/dist/core/legacy-cleanup.js +514 -0
- package/dist/core/list.d.ts +11 -0
- package/dist/core/list.js +185 -0
- package/dist/core/migration.d.ts +23 -0
- package/dist/core/migration.js +108 -0
- package/dist/core/openers.d.ts +77 -0
- package/dist/core/openers.js +251 -0
- package/dist/core/openspec-root.d.ts +45 -0
- package/dist/core/openspec-root.js +192 -0
- package/dist/core/parsers/change-parser.d.ts +13 -0
- package/dist/core/parsers/change-parser.js +197 -0
- package/dist/core/parsers/markdown-parser.d.ts +26 -0
- package/dist/core/parsers/markdown-parser.js +227 -0
- package/dist/core/parsers/requirement-blocks.d.ts +37 -0
- package/dist/core/parsers/requirement-blocks.js +201 -0
- package/dist/core/parsers/spec-structure.d.ts +9 -0
- package/dist/core/parsers/spec-structure.js +88 -0
- package/dist/core/planning-home.d.ts +16 -0
- package/dist/core/planning-home.js +67 -0
- package/dist/core/profile-sync-drift.d.ts +38 -0
- package/dist/core/profile-sync-drift.js +200 -0
- package/dist/core/profiles.d.ts +26 -0
- package/dist/core/profiles.js +40 -0
- package/dist/core/project-config.d.ts +120 -0
- package/dist/core/project-config.js +406 -0
- package/dist/core/references.d.ts +63 -0
- package/dist/core/references.js +310 -0
- package/dist/core/relationship-health.d.ts +65 -0
- package/dist/core/relationship-health.js +64 -0
- package/dist/core/root-selection.d.ts +122 -0
- package/dist/core/root-selection.js +337 -0
- package/dist/core/schemas/base.schema.d.ts +13 -0
- package/dist/core/schemas/base.schema.js +13 -0
- package/dist/core/schemas/change.schema.d.ts +73 -0
- package/dist/core/schemas/change.schema.js +31 -0
- package/dist/core/schemas/index.d.ts +4 -0
- package/dist/core/schemas/index.js +4 -0
- package/dist/core/schemas/spec.schema.d.ts +18 -0
- package/dist/core/schemas/spec.schema.js +15 -0
- package/dist/core/shared/index.d.ts +8 -0
- package/dist/core/shared/index.js +8 -0
- package/dist/core/shared/skill-generation.d.ts +49 -0
- package/dist/core/shared/skill-generation.js +96 -0
- package/dist/core/shared/tool-detection.d.ts +71 -0
- package/dist/core/shared/tool-detection.js +158 -0
- package/dist/core/specs-apply.d.ts +78 -0
- package/dist/core/specs-apply.js +394 -0
- package/dist/core/store/errors.d.ts +20 -0
- package/dist/core/store/errors.js +22 -0
- package/dist/core/store/foundation.d.ts +56 -0
- package/dist/core/store/foundation.js +251 -0
- package/dist/core/store/git.d.ts +23 -0
- package/dist/core/store/git.js +137 -0
- package/dist/core/store/index.d.ts +5 -0
- package/dist/core/store/index.js +5 -0
- package/dist/core/store/operations.d.ts +114 -0
- package/dist/core/store/operations.js +783 -0
- package/dist/core/store/registry.d.ts +58 -0
- package/dist/core/store/registry.js +275 -0
- package/dist/core/styles/palette.d.ts +7 -0
- package/dist/core/styles/palette.js +8 -0
- package/dist/core/templates/index.d.ts +8 -0
- package/dist/core/templates/index.js +9 -0
- package/dist/core/templates/skill-templates.d.ts +19 -0
- package/dist/core/templates/skill-templates.js +18 -0
- package/dist/core/templates/types.d.ts +19 -0
- package/dist/core/templates/types.js +5 -0
- package/dist/core/templates/workflows/apply-change.d.ts +10 -0
- package/dist/core/templates/workflows/apply-change.js +337 -0
- package/dist/core/templates/workflows/archive-change.d.ts +10 -0
- package/dist/core/templates/workflows/archive-change.js +278 -0
- package/dist/core/templates/workflows/bulk-archive-change.d.ts +10 -0
- package/dist/core/templates/workflows/bulk-archive-change.js +493 -0
- package/dist/core/templates/workflows/comprehension-guidance.d.ts +9 -0
- package/dist/core/templates/workflows/comprehension-guidance.js +58 -0
- package/dist/core/templates/workflows/continue-change.d.ts +10 -0
- package/dist/core/templates/workflows/continue-change.js +239 -0
- package/dist/core/templates/workflows/explore.d.ts +10 -0
- package/dist/core/templates/workflows/explore.js +464 -0
- package/dist/core/templates/workflows/feedback.d.ts +9 -0
- package/dist/core/templates/workflows/feedback.js +108 -0
- package/dist/core/templates/workflows/ff-change.d.ts +10 -0
- package/dist/core/templates/workflows/ff-change.js +205 -0
- package/dist/core/templates/workflows/mcp-guidance.d.ts +13 -0
- package/dist/core/templates/workflows/mcp-guidance.js +116 -0
- package/dist/core/templates/workflows/new-change.d.ts +10 -0
- package/dist/core/templates/workflows/new-change.js +148 -0
- package/dist/core/templates/workflows/onboard.d.ts +10 -0
- package/dist/core/templates/workflows/onboard.js +566 -0
- package/dist/core/templates/workflows/propose.d.ts +10 -0
- package/dist/core/templates/workflows/propose.js +228 -0
- package/dist/core/templates/workflows/store-selection.d.ts +8 -0
- package/dist/core/templates/workflows/store-selection.js +8 -0
- package/dist/core/templates/workflows/sync-specs.d.ts +10 -0
- package/dist/core/templates/workflows/sync-specs.js +291 -0
- package/dist/core/templates/workflows/verify-change.d.ts +10 -0
- package/dist/core/templates/workflows/verify-change.js +346 -0
- package/dist/core/update.d.ts +82 -0
- package/dist/core/update.js +557 -0
- package/dist/core/validation/constants.d.ts +34 -0
- package/dist/core/validation/constants.js +40 -0
- package/dist/core/validation/types.d.ts +18 -0
- package/dist/core/validation/types.js +2 -0
- package/dist/core/validation/validator.d.ts +44 -0
- package/dist/core/validation/validator.js +435 -0
- package/dist/core/view.d.ts +8 -0
- package/dist/core/view.js +168 -0
- package/dist/core/working-set.d.ts +47 -0
- package/dist/core/working-set.js +43 -0
- package/dist/core/worksets.d.ts +75 -0
- package/dist/core/worksets.js +245 -0
- package/dist/core/zod-issues.d.ts +4 -0
- package/dist/core/zod-issues.js +10 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +3 -0
- package/dist/prompts/searchable-multi-select.d.ts +28 -0
- package/dist/prompts/searchable-multi-select.js +159 -0
- package/dist/telemetry/config.d.ts +38 -0
- package/dist/telemetry/config.js +136 -0
- package/dist/telemetry/index.d.ts +31 -0
- package/dist/telemetry/index.js +164 -0
- package/dist/ui/ascii-patterns.d.ts +16 -0
- package/dist/ui/ascii-patterns.js +133 -0
- package/dist/ui/welcome-screen.d.ts +10 -0
- package/dist/ui/welcome-screen.js +146 -0
- package/dist/utils/change-metadata.d.ts +55 -0
- package/dist/utils/change-metadata.js +141 -0
- package/dist/utils/change-utils.d.ts +71 -0
- package/dist/utils/change-utils.js +138 -0
- package/dist/utils/command-references.d.ts +18 -0
- package/dist/utils/command-references.js +20 -0
- package/dist/utils/file-system.d.ts +41 -0
- package/dist/utils/file-system.js +320 -0
- package/dist/utils/index.d.ts +6 -0
- package/dist/utils/index.js +9 -0
- package/dist/utils/interactive.d.ts +18 -0
- package/dist/utils/interactive.js +21 -0
- package/dist/utils/item-discovery.d.ts +4 -0
- package/dist/utils/item-discovery.js +72 -0
- package/dist/utils/match.d.ts +3 -0
- package/dist/utils/match.js +22 -0
- package/dist/utils/shell-detection.d.ts +20 -0
- package/dist/utils/shell-detection.js +41 -0
- package/dist/utils/task-progress.d.ts +8 -0
- package/dist/utils/task-progress.js +36 -0
- package/package.json +84 -0
- package/schemas/spec-driven/schema.yaml +153 -0
- package/schemas/spec-driven/templates/design.md +19 -0
- package/schemas/spec-driven/templates/proposal.md +23 -0
- package/schemas/spec-driven/templates/spec.md +8 -0
- package/schemas/spec-driven/templates/tasks.md +9 -0
- package/scripts/postinstall.js +83 -0
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { InstallationResult } from '../factory.js';
|
|
2
|
+
/**
|
|
3
|
+
* Installer for Fish completion scripts.
|
|
4
|
+
* Fish automatically loads completions from ~/.config/fish/completions/
|
|
5
|
+
*/
|
|
6
|
+
export declare class FishInstaller {
|
|
7
|
+
private readonly homeDir;
|
|
8
|
+
constructor(homeDir?: string);
|
|
9
|
+
/**
|
|
10
|
+
* Get the installation path for Fish completions
|
|
11
|
+
*
|
|
12
|
+
* @returns Installation path
|
|
13
|
+
*/
|
|
14
|
+
getInstallationPath(): string;
|
|
15
|
+
/**
|
|
16
|
+
* Backup an existing completion file if it exists
|
|
17
|
+
*
|
|
18
|
+
* @param targetPath - Path to the file to backup
|
|
19
|
+
* @returns Path to the backup file, or undefined if no backup was needed
|
|
20
|
+
*/
|
|
21
|
+
backupExistingFile(targetPath: string): Promise<string | undefined>;
|
|
22
|
+
/**
|
|
23
|
+
* Install the completion script
|
|
24
|
+
*
|
|
25
|
+
* @param completionScript - The completion script content to install
|
|
26
|
+
* @returns Installation result with status and instructions
|
|
27
|
+
*/
|
|
28
|
+
install(completionScript: string): Promise<InstallationResult>;
|
|
29
|
+
/**
|
|
30
|
+
* Uninstall the completion script
|
|
31
|
+
*
|
|
32
|
+
* @param options - Optional uninstall options
|
|
33
|
+
* @param options.yes - Skip confirmation prompt (handled by command layer)
|
|
34
|
+
* @returns Uninstallation result
|
|
35
|
+
*/
|
|
36
|
+
uninstall(options?: {
|
|
37
|
+
yes?: boolean;
|
|
38
|
+
}): Promise<{
|
|
39
|
+
success: boolean;
|
|
40
|
+
message: string;
|
|
41
|
+
}>;
|
|
42
|
+
}
|
|
43
|
+
//# sourceMappingURL=fish-installer.d.ts.map
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
import { promises as fs } from 'fs';
|
|
2
|
+
import path from 'path';
|
|
3
|
+
import os from 'os';
|
|
4
|
+
import { FileSystemUtils } from '../../../utils/file-system.js';
|
|
5
|
+
/**
|
|
6
|
+
* Installer for Fish completion scripts.
|
|
7
|
+
* Fish automatically loads completions from ~/.config/fish/completions/
|
|
8
|
+
*/
|
|
9
|
+
export class FishInstaller {
|
|
10
|
+
homeDir;
|
|
11
|
+
constructor(homeDir = os.homedir()) {
|
|
12
|
+
this.homeDir = homeDir;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Get the installation path for Fish completions
|
|
16
|
+
*
|
|
17
|
+
* @returns Installation path
|
|
18
|
+
*/
|
|
19
|
+
getInstallationPath() {
|
|
20
|
+
return path.join(this.homeDir, '.config', 'fish', 'completions', 'openspec.fish');
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Backup an existing completion file if it exists
|
|
24
|
+
*
|
|
25
|
+
* @param targetPath - Path to the file to backup
|
|
26
|
+
* @returns Path to the backup file, or undefined if no backup was needed
|
|
27
|
+
*/
|
|
28
|
+
async backupExistingFile(targetPath) {
|
|
29
|
+
try {
|
|
30
|
+
await fs.access(targetPath);
|
|
31
|
+
// File exists, create a backup
|
|
32
|
+
const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
|
|
33
|
+
const backupPath = `${targetPath}.backup-${timestamp}`;
|
|
34
|
+
await fs.copyFile(targetPath, backupPath);
|
|
35
|
+
return backupPath;
|
|
36
|
+
}
|
|
37
|
+
catch {
|
|
38
|
+
// File doesn't exist, no backup needed
|
|
39
|
+
return undefined;
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Install the completion script
|
|
44
|
+
*
|
|
45
|
+
* @param completionScript - The completion script content to install
|
|
46
|
+
* @returns Installation result with status and instructions
|
|
47
|
+
*/
|
|
48
|
+
async install(completionScript) {
|
|
49
|
+
try {
|
|
50
|
+
const targetPath = this.getInstallationPath();
|
|
51
|
+
// Check if already installed with same content
|
|
52
|
+
let isUpdate = false;
|
|
53
|
+
try {
|
|
54
|
+
const existingContent = await fs.readFile(targetPath, 'utf-8');
|
|
55
|
+
if (existingContent === completionScript) {
|
|
56
|
+
// Already installed and up to date
|
|
57
|
+
return {
|
|
58
|
+
success: true,
|
|
59
|
+
installedPath: targetPath,
|
|
60
|
+
message: 'Completion script is already installed (up to date)',
|
|
61
|
+
instructions: [
|
|
62
|
+
'The completion script is already installed and up to date.',
|
|
63
|
+
'Fish automatically loads completions - they should be available immediately.',
|
|
64
|
+
],
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
// File exists but content is different - this is an update
|
|
68
|
+
isUpdate = true;
|
|
69
|
+
}
|
|
70
|
+
catch (error) {
|
|
71
|
+
// File doesn't exist or can't be read, proceed with installation
|
|
72
|
+
console.debug(`Unable to read existing completion file at ${targetPath}: ${error.message}`);
|
|
73
|
+
}
|
|
74
|
+
if (!(await FileSystemUtils.canWriteFile(targetPath))) {
|
|
75
|
+
throw new Error(`Path is not writable: ${targetPath}`);
|
|
76
|
+
}
|
|
77
|
+
// Ensure the directory exists
|
|
78
|
+
const targetDir = path.dirname(targetPath);
|
|
79
|
+
await fs.mkdir(targetDir, { recursive: true });
|
|
80
|
+
// Backup existing file if updating
|
|
81
|
+
const backupPath = isUpdate ? await this.backupExistingFile(targetPath) : undefined;
|
|
82
|
+
// Write the completion script
|
|
83
|
+
await fs.writeFile(targetPath, completionScript, 'utf-8');
|
|
84
|
+
// Determine appropriate message
|
|
85
|
+
let message;
|
|
86
|
+
if (isUpdate) {
|
|
87
|
+
message = backupPath
|
|
88
|
+
? 'Completion script updated successfully (previous version backed up)'
|
|
89
|
+
: 'Completion script updated successfully';
|
|
90
|
+
}
|
|
91
|
+
else {
|
|
92
|
+
message = 'Completion script installed successfully for Fish';
|
|
93
|
+
}
|
|
94
|
+
return {
|
|
95
|
+
success: true,
|
|
96
|
+
installedPath: targetPath,
|
|
97
|
+
backupPath,
|
|
98
|
+
message,
|
|
99
|
+
instructions: [
|
|
100
|
+
'Fish automatically loads completions from ~/.config/fish/completions/',
|
|
101
|
+
'Completions are available immediately - no shell restart needed.',
|
|
102
|
+
],
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
catch (error) {
|
|
106
|
+
return {
|
|
107
|
+
success: false,
|
|
108
|
+
message: `Failed to install completion script: ${error instanceof Error ? error.message : String(error)}`,
|
|
109
|
+
};
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* Uninstall the completion script
|
|
114
|
+
*
|
|
115
|
+
* @param options - Optional uninstall options
|
|
116
|
+
* @param options.yes - Skip confirmation prompt (handled by command layer)
|
|
117
|
+
* @returns Uninstallation result
|
|
118
|
+
*/
|
|
119
|
+
async uninstall(options) {
|
|
120
|
+
try {
|
|
121
|
+
const targetPath = this.getInstallationPath();
|
|
122
|
+
// Check if installed
|
|
123
|
+
try {
|
|
124
|
+
await fs.access(targetPath);
|
|
125
|
+
}
|
|
126
|
+
catch {
|
|
127
|
+
return {
|
|
128
|
+
success: false,
|
|
129
|
+
message: 'Completion script is not installed',
|
|
130
|
+
};
|
|
131
|
+
}
|
|
132
|
+
const targetDir = path.dirname(targetPath);
|
|
133
|
+
if (!(await FileSystemUtils.canWriteFile(targetDir))) {
|
|
134
|
+
throw new Error(`Path is not writable: ${targetDir}`);
|
|
135
|
+
}
|
|
136
|
+
// Remove the completion script
|
|
137
|
+
await fs.unlink(targetPath);
|
|
138
|
+
return {
|
|
139
|
+
success: true,
|
|
140
|
+
message: 'Completion script uninstalled successfully',
|
|
141
|
+
};
|
|
142
|
+
}
|
|
143
|
+
catch (error) {
|
|
144
|
+
return {
|
|
145
|
+
success: false,
|
|
146
|
+
message: `Failed to uninstall completion script: ${error instanceof Error ? error.message : String(error)}`,
|
|
147
|
+
};
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
//# sourceMappingURL=fish-installer.js.map
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import { InstallationResult } from '../factory.js';
|
|
2
|
+
/**
|
|
3
|
+
* Installer for PowerShell completion scripts.
|
|
4
|
+
* Works with both Windows PowerShell 5.1 and PowerShell Core 7+
|
|
5
|
+
*/
|
|
6
|
+
export declare class PowerShellInstaller {
|
|
7
|
+
private readonly homeDir;
|
|
8
|
+
/**
|
|
9
|
+
* Markers for PowerShell profile configuration management
|
|
10
|
+
*/
|
|
11
|
+
private readonly PROFILE_MARKERS;
|
|
12
|
+
constructor(homeDir?: string);
|
|
13
|
+
/**
|
|
14
|
+
* Detect the encoding of a file by inspecting its BOM (Byte Order Mark).
|
|
15
|
+
* Returns the Node.js BufferEncoding and the raw BOM bytes to preserve on write.
|
|
16
|
+
*/
|
|
17
|
+
private detectEncoding;
|
|
18
|
+
/**
|
|
19
|
+
* Read a profile file, preserving its encoding metadata for round-trip writes.
|
|
20
|
+
* Throws if the file uses UTF-16 BE (unsupported by Node).
|
|
21
|
+
*/
|
|
22
|
+
private readProfileFile;
|
|
23
|
+
/**
|
|
24
|
+
* Write a profile file, preserving the original BOM and encoding.
|
|
25
|
+
*/
|
|
26
|
+
private writeProfileFile;
|
|
27
|
+
/**
|
|
28
|
+
* Get PowerShell profile path
|
|
29
|
+
* Prefers $PROFILE environment variable, falls back to platform defaults
|
|
30
|
+
*
|
|
31
|
+
* @returns Profile path
|
|
32
|
+
*/
|
|
33
|
+
getProfilePath(): string;
|
|
34
|
+
/**
|
|
35
|
+
* Get all PowerShell profile paths to configure.
|
|
36
|
+
* On Windows, returns both PowerShell Core and Windows PowerShell 5.1 paths.
|
|
37
|
+
* On Unix, returns PowerShell Core path only.
|
|
38
|
+
*/
|
|
39
|
+
private getAllProfilePaths;
|
|
40
|
+
/**
|
|
41
|
+
* Get the installation path for the completion script
|
|
42
|
+
*
|
|
43
|
+
* @returns Installation path
|
|
44
|
+
*/
|
|
45
|
+
getInstallationPath(): string;
|
|
46
|
+
/**
|
|
47
|
+
* Backup an existing completion file if it exists
|
|
48
|
+
*
|
|
49
|
+
* @param targetPath - Path to the file to backup
|
|
50
|
+
* @returns Path to the backup file, or undefined if no backup was needed
|
|
51
|
+
*/
|
|
52
|
+
backupExistingFile(targetPath: string): Promise<string | undefined>;
|
|
53
|
+
/**
|
|
54
|
+
* Generate PowerShell profile configuration content
|
|
55
|
+
*
|
|
56
|
+
* @param scriptPath - Path to the completion script
|
|
57
|
+
* @returns Configuration content
|
|
58
|
+
*/
|
|
59
|
+
private generateProfileConfig;
|
|
60
|
+
/**
|
|
61
|
+
* Configure PowerShell profile to source the completion script
|
|
62
|
+
*
|
|
63
|
+
* @param scriptPath - Path to the completion script
|
|
64
|
+
* @returns true if configured successfully, false otherwise
|
|
65
|
+
*/
|
|
66
|
+
configureProfile(scriptPath: string): Promise<boolean>;
|
|
67
|
+
/**
|
|
68
|
+
* Remove PowerShell profile configuration
|
|
69
|
+
* Used during uninstallation
|
|
70
|
+
*
|
|
71
|
+
* @returns true if removed successfully, false otherwise
|
|
72
|
+
*/
|
|
73
|
+
removeProfileConfig(): Promise<boolean>;
|
|
74
|
+
/**
|
|
75
|
+
* Install the completion script
|
|
76
|
+
*
|
|
77
|
+
* @param completionScript - The completion script content to install
|
|
78
|
+
* @returns Installation result with status and instructions
|
|
79
|
+
*/
|
|
80
|
+
install(completionScript: string): Promise<InstallationResult>;
|
|
81
|
+
/**
|
|
82
|
+
* Generate user instructions for enabling completions
|
|
83
|
+
*
|
|
84
|
+
* @param installedPath - Path where the script was installed
|
|
85
|
+
* @returns Array of instruction strings
|
|
86
|
+
*/
|
|
87
|
+
private generateInstructions;
|
|
88
|
+
/**
|
|
89
|
+
* Uninstall the completion script
|
|
90
|
+
*
|
|
91
|
+
* @param options - Optional uninstall options
|
|
92
|
+
* @param options.yes - Skip confirmation prompt (handled by command layer)
|
|
93
|
+
* @returns Uninstallation result
|
|
94
|
+
*/
|
|
95
|
+
uninstall(options?: {
|
|
96
|
+
yes?: boolean;
|
|
97
|
+
}): Promise<{
|
|
98
|
+
success: boolean;
|
|
99
|
+
message: string;
|
|
100
|
+
}>;
|
|
101
|
+
}
|
|
102
|
+
//# sourceMappingURL=powershell-installer.d.ts.map
|