diff --git a/.allstar/branch_protection.yaml b/.allstar/branch_protection.yaml new file mode 100644 index 00000000..f3d874ba --- /dev/null +++ b/.allstar/branch_protection.yaml @@ -0,0 +1 @@ +action: 'log' diff --git a/.gcp/release-docker.yml b/.gcp/release-docker.yml index f413da5b..53e78b08 100644 --- a/.gcp/release-docker.yml +++ b/.gcp/release-docker.yml @@ -26,15 +26,11 @@ steps: - |- SHELL_TAG_NAME="$TAG_NAME" FINAL_TAG="$SHORT_SHA" # Default to SHA - if [[ "$$SHELL_TAG_NAME" == *"-nightly"* ]]; then - echo "Nightly release detected." - FINAL_TAG="$${SHELL_TAG_NAME#v}" - # Also escape the variable in the regex match - elif [[ "$$SHELL_TAG_NAME" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then - echo "Official release detected." + if [[ "$$SHELL_TAG_NAME" =~ ^v[0-9]+\.[0-9]+\.[0-9]+(-[a-zA-Z0-9.-]+)?$ ]]; then + echo "Release detected." FINAL_TAG="$${SHELL_TAG_NAME#v}" else - echo "Development/RC release detected. Using commit SHA as tag." + echo "Development release detected. Using commit SHA as tag." fi echo "Determined image tag: $$FINAL_TAG" echo "$$FINAL_TAG" > /workspace/image_tag.txt diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 474e89f8..556b65b9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -32,6 +32,9 @@ body: description: 'Please paste the full text from the `/about` command run from Qwen Code. Also include which platform (macOS, Windows, Linux).' value: |
+ Client Information + + Run `qwen` to enter the interactive CLI, then run the `/about` command. ```console $ qwen /about diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..c5d37a5d --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,35 @@ +# See https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file +version: 2 +updates: + - package-ecosystem: 'npm' + directory: '/' + schedule: + interval: 'daily' + target-branch: 'main' + commit-message: + prefix: 'chore(deps)' + include: 'scope' + reviewers: + - 'google-gemini/gemini-cli-askmode-approvers' + groups: + # Group all non-major updates together. + # This is to reduce the number of PRs that need to be reviewed. + # Major updates will still be created as separate PRs. + npm-minor-patch: + applies-to: 'version-updates' + update-types: + - 'minor' + - 'patch' + open-pull-requests-limit: 0 + + - package-ecosystem: 'github-actions' + directory: '/' + schedule: + interval: 'daily' + target-branch: 'main' + commit-message: + prefix: 'chore(deps)' + include: 'scope' + reviewers: + - 'google-gemini/gemini-cli-askmode-approvers' + open-pull-requests-limit: 0 diff --git a/.github/workflows/community-report.yml b/.github/workflows/community-report.yml index 59fd427f..e0aaf90d 100644 --- a/.github/workflows/community-report.yml +++ b/.github/workflows/community-report.yml @@ -30,6 +30,10 @@ jobs: with: app-id: '${{ secrets.APP_ID }}' private-key: '${{ secrets.PRIVATE_KEY }}' + permission-issues: 'write' + permission-pull-requests: 'read' + permission-discussions: 'read' + permission-contents: 'read' - name: 'Generate Report ๐Ÿ“œ' id: 'report' @@ -164,7 +168,7 @@ jobs: - name: '๐Ÿค– Get Insights from Report' if: |- ${{ steps.report.outputs.report_body != '' }} - uses: 'google-github-actions/run-gemini-cli@06123c6a203eb7a964ce3be7c48479cc66059f23' # ratchet:google-github-actions/run-gemini-cli@v0 + uses: 'google-github-actions/run-gemini-cli@a3bf79042542528e91937b3a3a6fbc4967ee3c31' # ratchet:google-github-actions/run-gemini-cli@v0 env: GITHUB_TOKEN: '${{ steps.generate_token.outputs.token }}' REPOSITORY: '${{ github.repository }}' diff --git a/.github/workflows/eval.yml b/.github/workflows/eval.yml new file mode 100644 index 00000000..c8a4c652 --- /dev/null +++ b/.github/workflows/eval.yml @@ -0,0 +1,29 @@ +name: 'Eval' + +on: + workflow_dispatch: + +jobs: + eval: + name: 'Eval' + runs-on: 'ubuntu-latest' + strategy: + matrix: + node-version: + - '20.x' + - '22.x' + - '24.x' + steps: + - name: 'Set up Node.js ${{ matrix.node-version }}' + uses: 'actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020' # ratchet:actions/setup-node@v4 + with: + node-version: '${{ matrix.node-version }}' + cache: 'npm' + + - name: 'Set up Python' + uses: 'actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065' # ratchet:actions/setup-python@v5 + with: + python-version: '3.11' + + - name: 'Install and configure Poetry' + uses: 'snok/install-poetry@76e04a911780d5b312d89783f7b1cd627778900a' # ratchet:snok/install-poetry@v1 diff --git a/.github/workflows/gemini-automated-issue-dedup.yml b/.github/workflows/gemini-automated-issue-dedup.yml new file mode 100644 index 00000000..b84b5aa9 --- /dev/null +++ b/.github/workflows/gemini-automated-issue-dedup.yml @@ -0,0 +1,262 @@ +name: '๐Ÿท๏ธ Gemini Automated Issue Deduplication' + +on: + issues: + types: + - 'opened' + - 'reopened' + issue_comment: + types: + - 'created' + workflow_dispatch: + inputs: + issue_number: + description: 'issue number to dedup' + required: true + type: 'number' + +concurrency: + group: '${{ github.workflow }}-${{ github.event.issue.number }}' + cancel-in-progress: true + +defaults: + run: + shell: 'bash' + +jobs: + find-duplicates: + if: |- + github.repository == 'google-gemini/gemini-cli' && + vars.TRIAGE_DEDUPLICATE_ISSUES != '' && + (github.event_name == 'issues' || + github.event_name == 'workflow_dispatch' || + (github.event_name == 'issue_comment' && + contains(github.event.comment.body, '@gemini-cli /deduplicate') && + (github.event.comment.author_association == 'OWNER' || + github.event.comment.author_association == 'MEMBER' || + github.event.comment.author_association == 'COLLABORATOR'))) + permissions: + contents: 'read' + id-token: 'write' # Required for WIF, see https://docs.github.com/en/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-google-cloud-platform#adding-permissions-settings + issues: 'read' + statuses: 'read' + packages: 'read' + timeout-minutes: 20 + runs-on: 'ubuntu-latest' + outputs: + duplicate_issues_csv: '${{ env.DUPLICATE_ISSUES_CSV }}' + steps: + - name: 'Checkout' + uses: 'actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8' # ratchet:actions/checkout@v5 + + - name: 'Log in to GitHub Container Registry' + uses: 'docker/login-action@184bdaa0721073962dff0199f1fb9940f07167d1' # ratchet:docker/login-action@v3 + with: + registry: 'ghcr.io' + username: '${{ github.actor }}' + password: '${{ secrets.GITHUB_TOKEN }}' + + - name: 'Find Duplicate Issues' + uses: 'google-github-actions/run-gemini-cli@a3bf79042542528e91937b3a3a6fbc4967ee3c31' # ratchet:google-github-actions/run-gemini-cli@v0 + id: 'gemini_issue_deduplication' + env: + GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}' + ISSUE_TITLE: '${{ github.event.issue.title }}' + ISSUE_BODY: '${{ github.event.issue.body }}' + ISSUE_NUMBER: '${{ github.event.issue.number }}' + REPOSITORY: '${{ github.repository }}' + FIRESTORE_PROJECT: '${{ vars.FIRESTORE_PROJECT }}' + with: + gcp_workload_identity_provider: '${{ vars.GCP_WIF_PROVIDER }}' + gcp_project_id: '${{ vars.GOOGLE_CLOUD_PROJECT }}' + gcp_location: '${{ vars.GOOGLE_CLOUD_LOCATION }}' + gcp_service_account: '${{ vars.SERVICE_ACCOUNT_EMAIL }}' + gemini_api_key: '${{ secrets.GEMINI_API_KEY }}' + use_vertex_ai: '${{ vars.GOOGLE_GENAI_USE_VERTEXAI }}' + use_gemini_code_assist: '${{ vars.GOOGLE_GENAI_USE_GCA }}' + settings: |- + { + "mcpServers": { + "issue_deduplication": { + "command": "docker", + "args": [ + "run", + "-i", + "--rm", + "--network", "host", + "-e", "GITHUB_TOKEN", + "-e", "GEMINI_API_KEY", + "-e", "DATABASE_TYPE", + "-e", "FIRESTORE_DATABASE_ID", + "-e", "GCP_PROJECT", + "-e", "GOOGLE_APPLICATION_CREDENTIALS=/app/gcp-credentials.json", + "-v", "${GOOGLE_APPLICATION_CREDENTIALS}:/app/gcp-credentials.json", + "ghcr.io/google-gemini/gemini-cli-issue-triage@sha256:e3de1523f6c83aabb3c54b76d08940a2bf42febcb789dd2da6f95169641f94d3" + ], + "env": { + "GITHUB_TOKEN": "${GITHUB_TOKEN}", + "GEMINI_API_KEY": "${{ secrets.GEMINI_API_KEY }}", + "DATABASE_TYPE":"firestore", + "GCP_PROJECT": "${FIRESTORE_PROJECT}", + "FIRESTORE_DATABASE_ID": "(default)", + "GOOGLE_APPLICATION_CREDENTIALS": "${GOOGLE_APPLICATION_CREDENTIALS}" + }, + "enabled": true, + "timeout": 600000 + } + }, + "maxSessionTurns": 25, + "coreTools": [ + "run_shell_command(echo)", + "run_shell_command(gh issue view)" + ], + "telemetry": { + "enabled": true, + "target": "gcp" + } + } + prompt: |- + ## Role + You are an issue de-duplication assistant. Your goal is to find + duplicate issues for a given issue. + ## Steps + 1. **Find Potential Duplicates:** + - The repository is ${{ github.repository }} and the issue number is ${{ github.event.issue.number }}. + - Use the `duplicates` tool with the `repo` and `issue_number` to find potential duplicates for the current issue. Do not use the `threshold` parameter. + - If no duplicates are found, you are done. + - Print the JSON output from the `duplicates` tool to the logs. + 2. **Refine Duplicates List (if necessary):** + - If the `duplicates` tool returns between 1 and 14 results, you must refine the list. + - For each potential duplicate issue, run `gh issue view --json title,body,comments` to fetch its content. + - Also fetch the content of the original issue: `gh issue view "${ISSUE_NUMBER}" --json title,body,comments`. + - Carefully analyze the content (title, body, comments) of the original issue and all potential duplicates. + - It is very important if the comments on either issue mention that they are not duplicates of each other, to treat them as not duplicates. + - Based on your analysis, create a final list containing only the issues you are highly confident are actual duplicates. + - If your final list is empty, you are done. + - Print to the logs if you omitted any potential duplicates based on your analysis. + - If the `duplicates` tool returned 15+ results, use the top 15 matches (based on descending similarity score value) to perform this step. + 3. **Output final duplicates list as CSV:** + - Convert the list of appropriate duplicate issue numbers into a comma-separated list (CSV). If there are no appropriate duplicates, use the empty string. + - Use the "echo" shell command to append the CSV of issue numbers into the filepath referenced by the environment variable "${GITHUB_ENV}": + echo "DUPLICATE_ISSUES_CSV=[DUPLICATE_ISSUES_AS_CSV]" >> "${GITHUB_ENV}" + ## Guidelines + - Only use the `duplicates` and `run_shell_command` tools. + - The `run_shell_command` tool can be used with `gh issue view`. + - Do not download or read media files like images, videos, or links. The `--json` flag for `gh issue view` will prevent this. + - Do not modify the issue content or status. + - Do not add comments or labels. + - Reference all shell variables as "${VAR}" (with quotes and braces). + + add-comment-and-label: + needs: 'find-duplicates' + if: |- + github.repository == 'google-gemini/gemini-cli' && + vars.TRIAGE_DEDUPLICATE_ISSUES != '' && + needs.find-duplicates.outputs.duplicate_issues_csv != '' && + ( + github.event_name == 'issues' || + github.event_name == 'workflow_dispatch' || + ( + github.event_name == 'issue_comment' && + contains(github.event.comment.body, '@gemini-cli /deduplicate') && + ( + github.event.comment.author_association == 'OWNER' || + github.event.comment.author_association == 'MEMBER' || + github.event.comment.author_association == 'COLLABORATOR' + ) + ) + ) + permissions: + issues: 'write' + timeout-minutes: 5 + runs-on: 'ubuntu-latest' + steps: + - name: 'Generate GitHub App Token' + id: 'generate_token' + uses: 'actions/create-github-app-token@a8d616148505b5069dccd32f177bb87d7f39123b' # ratchet:actions/create-github-app-token@v2 + with: + app-id: '${{ secrets.APP_ID }}' + private-key: '${{ secrets.PRIVATE_KEY }}' + permission-issues: 'write' + + - name: 'Comment and Label Duplicate Issue' + uses: 'actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea' + env: + DUPLICATES_OUTPUT: '${{ needs.find-duplicates.outputs.duplicate_issues_csv }}' + with: + github-token: '${{ steps.generate_token.outputs.token || secrets.GITHUB_TOKEN }}' + script: |- + const rawCsv = process.env.DUPLICATES_OUTPUT; + core.info(`Raw duplicates CSV: ${rawCsv}`); + const duplicateIssues = rawCsv.split(',').map(s => s.trim()).filter(s => s); + + if (duplicateIssues.length === 0) { + core.info('No duplicate issues found. Nothing to do.'); + return; + } + + const issueNumber = ${{ github.event.issue.number }}; + + function formatCommentBody(issues, updated = false) { + const header = updated + ? 'Found possible duplicate issues (updated):' + : 'Found possible duplicate issues:'; + const issuesList = issues.map(num => `- #${num}`).join('\n'); + const footer = 'If you believe this is not a duplicate, please remove the `status/possible-duplicate` label.'; + const magicComment = ''; + return `${header}\n\n${issuesList}\n\n${footer}\n${magicComment}`; + } + + const newCommentBody = formatCommentBody(duplicateIssues); + const newUpdatedCommentBody = formatCommentBody(duplicateIssues, true); + + const { data: comments } = await github.rest.issues.listComments({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issueNumber, + }); + + const magicComment = ''; + const existingComment = comments.find(comment => + comment.user.type === 'Bot' && comment.body.includes(magicComment) + ); + + let commentMade = false; + + if (existingComment) { + // To check if lists are same, just compare the formatted bodies without headers. + const existingBodyForCompare = existingComment.body.substring(existingComment.body.indexOf('- #')); + const newBodyForCompare = newCommentBody.substring(newCommentBody.indexOf('- #')); + + if (existingBodyForCompare.trim() !== newBodyForCompare.trim()) { + core.info(`Updating existing comment ${existingComment.id}`); + await github.rest.issues.updateComment({ + owner: context.repo.owner, + repo: context.repo.repo, + comment_id: existingComment.id, + body: newUpdatedCommentBody, + }); + commentMade = true; + } else { + core.info('Existing comment is up-to-date. Nothing to do.'); + } + } else { + core.info('Creating new comment.'); + await github.rest.issues.createComment({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issueNumber, + body: newCommentBody, + }); + commentMade = true; + } + + if (commentMade) { + core.info('Adding "status/possible-duplicate" label.'); + await github.rest.issues.addLabels({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issueNumber, + labels: ['status/possible-duplicate'], + }); + } diff --git a/.github/workflows/gemini-automated-issue-triage.yml b/.github/workflows/gemini-automated-issue-triage.yml index e7d25ec0..5a426751 100644 --- a/.github/workflows/gemini-automated-issue-triage.yml +++ b/.github/workflows/gemini-automated-issue-triage.yml @@ -61,8 +61,10 @@ jobs: prompt: |- ## Role - You are an issue triage assistant. Analyze the current GitHub issue and apply the most appropriate existing labels. Use the available - tools to gather information; do not ask for information to be provided. Do not remove labels titled help wanted or good first issue. + You are an issue triage assistant. Analyze the current GitHub issue + and identify the most appropriate existing labels. Use the available + tools to gather information; do not ask for information to be + provided. Do not remove labels titled help wanted or good first issue. ## Steps @@ -77,13 +79,17 @@ jobs: ## Guidelines - - Only use labels that already exist in the repository. - - Do not add comments or modify the issue content. - - Triage only the current issue. - - Apply only one area/ label. - - Apply only one kind/ label. - - Apply all applicable sub-area/* and priority/* labels based on the issue content. It's ok to have multiple of these. - - Once you categorize the issue if it needs information bump down the priority by 1 eg.. a p0 would become a p1 a p1 would become a p2. P2 and P3 can stay as is in this scenario. + - Only use labels that already exist in the repository + - Do not add comments or modify the issue content + - Triage only the current issue + - Identify only one area/ label + - Identify only one kind/ label + - Identify all applicable sub-area/* and priority/* labels based on the issue content. It's ok to have multiple of these + - Once you categorize the issue if it needs information bump down the priority by 1 eg.. a p0 would become a p1 a p1 would become a p2. P2 and P3 can stay as is in this scenario + - Reference all shell variables as "${VAR}" (with quotes and braces) + - Output only valid JSON format + - Do not include any explanation or additional text, just the JSON + Categorization Guidelines: P0: Critical / Blocker - A P0 bug is a catastrophic failure that demands immediate attention. It represents a complete showstopper for a significant portion of users or for the development process itself. diff --git a/.github/workflows/gemini-scheduled-issue-dedup.yml b/.github/workflows/gemini-scheduled-issue-dedup.yml new file mode 100644 index 00000000..9eea5e0a --- /dev/null +++ b/.github/workflows/gemini-scheduled-issue-dedup.yml @@ -0,0 +1,116 @@ +name: '๐Ÿ“‹ Gemini Scheduled Issue Deduplication' + +on: + schedule: + - cron: '0 * * * *' # Runs every hour + workflow_dispatch: + +concurrency: + group: '${{ github.workflow }}' + cancel-in-progress: true + +defaults: + run: + shell: 'bash' + +jobs: + refresh-embeddings: + if: |- + ${{ vars.TRIAGE_DEDUPLICATE_ISSUES != '' && github.repository == 'google-gemini/gemini-cli' }} + permissions: + contents: 'read' + id-token: 'write' # Required for WIF, see https://docs.github.com/en/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-google-cloud-platform#adding-permissions-settings + issues: 'read' + statuses: 'read' + packages: 'read' + timeout-minutes: 20 + runs-on: 'ubuntu-latest' + steps: + - name: 'Checkout' + uses: 'actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8' # ratchet:actions/checkout@v5 + + - name: 'Log in to GitHub Container Registry' + uses: 'docker/login-action@184bdaa0721073962dff0199f1fb9940f07167d1' # ratchet:docker/login-action@v3 + with: + registry: 'ghcr.io' + username: '${{ github.actor }}' + password: '${{ secrets.GITHUB_TOKEN }}' + + - name: 'Run Gemini Issue Deduplication Refresh' + uses: 'google-github-actions/run-gemini-cli@a3bf79042542528e91937b3a3a6fbc4967ee3c31' # ratchet:google-github-actions/run-gemini-cli@v0 + id: 'gemini_refresh_embeddings' + env: + GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}' + ISSUE_TITLE: '${{ github.event.issue.title }}' + ISSUE_BODY: '${{ github.event.issue.body }}' + ISSUE_NUMBER: '${{ github.event.issue.number }}' + REPOSITORY: '${{ github.repository }}' + FIRESTORE_PROJECT: '${{ vars.FIRESTORE_PROJECT }}' + with: + gcp_workload_identity_provider: '${{ vars.GCP_WIF_PROVIDER }}' + gcp_project_id: '${{ vars.GOOGLE_CLOUD_PROJECT }}' + gcp_location: '${{ vars.GOOGLE_CLOUD_LOCATION }}' + gcp_service_account: '${{ vars.SERVICE_ACCOUNT_EMAIL }}' + gemini_api_key: '${{ secrets.GEMINI_API_KEY }}' + use_vertex_ai: '${{ vars.GOOGLE_GENAI_USE_VERTEXAI }}' + use_gemini_code_assist: '${{ vars.GOOGLE_GENAI_USE_GCA }}' + settings: |- + { + "mcpServers": { + "issue_deduplication": { + "command": "docker", + "args": [ + "run", + "-i", + "--rm", + "--network", "host", + "-e", "GITHUB_TOKEN", + "-e", "GEMINI_API_KEY", + "-e", "DATABASE_TYPE", + "-e", "FIRESTORE_DATABASE_ID", + "-e", "GCP_PROJECT", + "-e", "GOOGLE_APPLICATION_CREDENTIALS=/app/gcp-credentials.json", + "-v", "${GOOGLE_APPLICATION_CREDENTIALS}:/app/gcp-credentials.json", + "ghcr.io/google-gemini/gemini-cli-issue-triage@sha256:e3de1523f6c83aabb3c54b76d08940a2bf42febcb789dd2da6f95169641f94d3" + ], + "env": { + "GITHUB_TOKEN": "${GITHUB_TOKEN}", + "GEMINI_API_KEY": "${{ secrets.GEMINI_API_KEY }}", + "DATABASE_TYPE":"firestore", + "GCP_PROJECT": "${FIRESTORE_PROJECT}", + "FIRESTORE_DATABASE_ID": "(default)", + "GOOGLE_APPLICATION_CREDENTIALS": "${GOOGLE_APPLICATION_CREDENTIALS}" + }, + "enabled": true, + "timeout": 600000 + } + }, + "maxSessionTurns": 25, + "coreTools": [ + "run_shell_command(echo)" + ], + "telemetry": { + "enabled": true, + "target": "gcp" + } + } + prompt: |- + ## Role + + You are a database maintenance assistant for a GitHub issue deduplication system. + + ## Goal + + Your sole responsibility is to refresh the embeddings for all open issues in the repository to ensure the deduplication database is up-to-date. + + ## Steps + + 1. **Extract Repository Information:** The repository is ${{ github.repository }}. + 2. **Refresh Embeddings:** Call the `refresh` tool with the correct `repo`. Do not use the `force` parameter. + 3. **Log Output:** Print the JSON output from the `refresh` tool to the logs. + + ## Guidelines + + - Only use the `refresh` tool. + - Do not attempt to find duplicates or modify any issues. + - Your only task is to call the `refresh` tool and log its output. diff --git a/.github/workflows/gemini-scheduled-issue-triage.yml b/.github/workflows/gemini-scheduled-issue-triage.yml index 69d7eb71..ba417ecc 100644 --- a/.github/workflows/gemini-scheduled-issue-triage.yml +++ b/.github/workflows/gemini-scheduled-issue-triage.yml @@ -14,11 +14,8 @@ defaults: shell: 'bash' permissions: - contents: 'read' id-token: 'write' issues: 'write' - statuses: 'write' - packages: 'read' jobs: triage-issues: @@ -70,18 +67,14 @@ jobs: { "maxSessionTurns": 25, "coreTools": [ - "run_shell_command(echo)", - "run_shell_command(gh label list)", - "run_shell_command(gh issue edit)", - "run_shell_command(gh issue view)", - "run_shell_command(gh issue list)" + "run_shell_command(echo)" ], "sandbox": false } prompt: |- ## Role - You are an issue triage assistant. Analyze issues and apply + You are an issue triage assistant. Analyze issues and identify appropriate labels. Use the available tools to gather information; do not ask for information to be provided. @@ -114,13 +107,15 @@ jobs: ## Guidelines + - Output only valid JSON format + - Do not include any explanation or additional text, just the JSON - Only use labels that already exist in the repository. - Do not add comments or modify the issue content. - Do not remove labels titled help wanted or good first issue. - Triage only the current issue. - - Apply only one area/ label - - Apply only one kind/ label (Do not apply kind/duplicate or kind/parent-issue) - - Apply all applicable sub-area/* and priority/* labels based on the issue content. It's ok to have multiple of these. + - Identify only one area/ label + - Identify only one kind/ label (Do not apply kind/duplicate or kind/parent-issue) + - Identify all applicable sub-area/* and priority/* labels based on the issue content. It's ok to have multiple of these. - Once you categorize the issue if it needs information bump down the priority by 1 eg.. a p0 would become a p1 a p1 would become a p2. P2 and P3 can stay as is in this scenario. Categorization Guidelines: P0: Critical / Blocker diff --git a/.github/workflows/gemini-self-assign-issue.yml b/.github/workflows/gemini-self-assign-issue.yml new file mode 100644 index 00000000..3ee0c757 --- /dev/null +++ b/.github/workflows/gemini-self-assign-issue.yml @@ -0,0 +1,98 @@ +name: 'Assign Issue on Comment' + +on: + issue_comment: + types: + - 'created' + +concurrency: + group: '${{ github.workflow }}-${{ github.event.issue.number }}' + cancel-in-progress: true + +defaults: + run: + shell: 'bash' + +permissions: + contents: 'read' + id-token: 'write' + issues: 'write' + statuses: 'write' + packages: 'read' + +jobs: + self-assign-issue: + if: |- + github.repository == 'google-gemini/gemini-cli' && + github.event_name == 'issue_comment' && + contains(github.event.comment.body, '/assign') + runs-on: 'ubuntu-latest' + steps: + - name: 'Generate GitHub App Token' + id: 'generate_token' + uses: 'actions/create-github-app-token@a8d616148505b5069dccd32f177bb87d7f39123b' + with: + app-id: '${{ secrets.APP_ID }}' + private-key: '${{ secrets.PRIVATE_KEY }}' + # Add 'assignments' write permission + permission-issues: 'write' + + - name: 'Assign issue to user' + uses: 'actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea' + with: + github-token: '${{ steps.generate_token.outputs.token }}' + script: | + const issueNumber = context.issue.number; + const commenter = context.actor; + const owner = context.repo.owner; + const repo = context.repo.repo; + const MAX_ISSUES_ASSIGNED = 3; + + // Search for open issues already assigned to the commenter in this repo + const { data: assignedIssues } = await github.rest.search.issuesAndPullRequests({ + q: `is:issue repo:${owner}/${repo} assignee:${commenter} is:open` + }); + + if (assignedIssues.total_count >= MAX_ISSUES_ASSIGNED) { + await github.rest.issues.createComment({ + owner: owner, + repo: repo, + issue_number: issueNumber, + body: `๐Ÿ‘‹ @${commenter}! You currently have ${assignedIssues.total_count} issues assigned to you. We have a ${MAX_ISSUES_ASSIGNED} max issues assigned at once policy. Once you close out an existing issue it will open up space to take another. You can also unassign yourself from an existing issue but please work on a hand-off if someone is expecting work on that issue.` + }); + return; // exit + } + + // Check if the issue is already assigned + const issue = await github.rest.issues.get({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issueNumber, + }); + + if (issue.data.assignees.length > 0) { + // Comment that it's already assigned + await github.rest.issues.createComment({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issueNumber, + body: `@${commenter} Thanks for taking interest but this issue is already assigned. We'd still love to have you contribute. Check out our [Help Wanted](https://github.com/google-gemini/gemini-cli/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22) list for issues where we need some extra attention.` + }); + return; + } + + // If not taken, assign the user who commented + await github.rest.issues.addAssignees({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issueNumber, + assignees: [commenter] + }); + + // Post a comment to confirm assignment + await github.rest.issues.createComment({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issueNumber, + body: `๐Ÿ‘‹ @${commenter}, you've been assigned to this issue! Thank you for taking the time to contribute. Make sure to check out our [contributing guidelines](https://github.com/google-gemini/gemini-cli/blob/main/CONTRIBUTING.md).` + }); diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 8362bff8..75e4b39c 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -4,6 +4,8 @@ on: schedule: # Runs every day at midnight UTC for the nightly release. - cron: '0 0 * * *' + # Runs every Tuesday at 23:59 UTC for the preview release. + - cron: '59 23 * * 2' workflow_dispatch: inputs: version: @@ -25,6 +27,11 @@ on: required: false type: 'boolean' default: false + create_preview_release: + description: 'Auto apply the preview release tag, input version is ignored.' + required: false + type: 'boolean' + default: false force_skip_tests: description: 'Select to skip the "Run Tests" step in testing. Prod releases should run tests' required: false @@ -51,22 +58,30 @@ jobs: - name: 'Checkout' uses: 'actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8' # ratchet:actions/checkout@v5 with: - ref: '${{ github.sha }}' + ref: '${{ github.event.inputs.ref || github.sha }}' fetch-depth: 0 - name: 'Set booleans for simplified logic' env: CREATE_NIGHTLY_RELEASE: '${{ github.event.inputs.create_nightly_release }}' + CREATE_PREVIEW_RELEASE: '${{ github.event.inputs.create_preview_release }}' EVENT_NAME: '${{ github.event_name }}' + CRON: '${{ github.event.schedule }}' DRY_RUN_INPUT: '${{ github.event.inputs.dry_run }}' id: 'vars' run: |- is_nightly="false" - if [[ "${EVENT_NAME}" == "schedule" || "${CREATE_NIGHTLY_RELEASE}" == "true" ]]; then + if [[ "${CRON}" == "0 0 * * *" || "${CREATE_NIGHTLY_RELEASE}" == "true" ]]; then is_nightly="true" fi echo "is_nightly=${is_nightly}" >> "${GITHUB_OUTPUT}" + is_preview="false" + if [[ "${CRON}" == "59 23 * * 2" || "${CREATE_PREVIEW_RELEASE}" == "true" ]]; then + is_preview="true" + fi + echo "is_preview=${is_preview}" >> "${GITHUB_OUTPUT}" + is_dry_run="false" if [[ "${DRY_RUN_INPUT}" == "true" ]]; then is_dry_run="true" @@ -96,7 +111,9 @@ jobs: PREVIOUS_TAG=$(node scripts/get-previous-tag.js "$CURRENT_TAG" || echo "") echo "PREVIOUS_TAG=${PREVIOUS_TAG}" >> "$GITHUB_OUTPUT" env: + GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}' IS_NIGHTLY: '${{ steps.vars.outputs.is_nightly }}' + IS_PREVIEW: '${{ steps.vars.outputs.is_preview }}' MANUAL_VERSION: '${{ inputs.version }}' - name: 'Run Tests' diff --git a/.gitignore b/.gitignore index b10814b4..92341b1e 100644 --- a/.gitignore +++ b/.gitignore @@ -47,3 +47,5 @@ packages/vscode-ide-companion/*.vsix logs/ # GHA credentials gha-creds-*.json + +QWEN.md \ No newline at end of file diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 00000000..f4330b7e --- /dev/null +++ b/.prettierignore @@ -0,0 +1,20 @@ +**/bundle +**/coverage +**/dist +**/.git +**/node_modules +.docker +.DS_Store +.env +.gemini/ +.idea +.integration-tests/ +*.iml +*.tsbuildinfo +*.vsix +bower_components +eslint.config.js +**/generated +gha-creds-*.json +junit.xml +Thumbs.db diff --git a/CHANGELOG.md b/CHANGELOG.md index 6d0d2fb4..1dc44c50 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -53,7 +53,7 @@ - Added deterministic cache control for the DashScope provider. - Added option to choose a project-level or global save location. - Limited `grep` results to 25 items by default. -- `grep` now respects `.geminiignore`. +- `grep` now respects `.qwenignore`. - Miscellaneous improvements and bug fixes. ## 0.0.7 diff --git a/QWEN.md b/QWEN.md deleted file mode 100644 index 82f69c8a..00000000 --- a/QWEN.md +++ /dev/null @@ -1,193 +0,0 @@ -## Building and running - -Before submitting any changes, it is crucial to validate them by running the full preflight check. This command will build the repository, run all tests, check for type errors, and lint the code. - -To run the full suite of checks, execute the following command: - -```bash -npm run preflight -``` - -This single command ensures that your changes meet all the quality gates of the project. While you can run the individual steps (`build`, `test`, `typecheck`, `lint`) separately, it is highly recommended to use `npm run preflight` to ensure a comprehensive validation. - -## Writing Tests - -This project uses **Vitest** as its primary testing framework. When writing tests, aim to follow existing patterns. Key conventions include: - -### Test Structure and Framework - -- **Framework**: All tests are written using Vitest (`describe`, `it`, `expect`, `vi`). -- **File Location**: Test files (`*.test.ts` for logic, `*.test.tsx` for React components) are co-located with the source files they test. -- **Configuration**: Test environments are defined in `vitest.config.ts` files. -- **Setup/Teardown**: Use `beforeEach` and `afterEach`. Commonly, `vi.resetAllMocks()` is called in `beforeEach` and `vi.restoreAllMocks()` in `afterEach`. - -### Mocking (`vi` from Vitest) - -- **ES Modules**: Mock with `vi.mock('module-name', async (importOriginal) => { ... })`. Use `importOriginal` for selective mocking. - - _Example_: `vi.mock('os', async (importOriginal) => { const actual = await importOriginal(); return { ...actual, homedir: vi.fn() }; });` -- **Mocking Order**: For critical dependencies (e.g., `os`, `fs`) that affect module-level constants, place `vi.mock` at the _very top_ of the test file, before other imports. -- **Hoisting**: Use `const myMock = vi.hoisted(() => vi.fn());` if a mock function needs to be defined before its use in a `vi.mock` factory. -- **Mock Functions**: Create with `vi.fn()`. Define behavior with `mockImplementation()`, `mockResolvedValue()`, or `mockRejectedValue()`. -- **Spying**: Use `vi.spyOn(object, 'methodName')`. Restore spies with `mockRestore()` in `afterEach`. - -### Commonly Mocked Modules - -- **Node.js built-ins**: `fs`, `fs/promises`, `os` (especially `os.homedir()`), `path`, `child_process` (`execSync`, `spawn`). -- **External SDKs**: `@google/genai`, `@modelcontextprotocol/sdk`. -- **Internal Project Modules**: Dependencies from other project packages are often mocked. - -### React Component Testing (CLI UI - Ink) - -- Use `render()` from `ink-testing-library`. -- Assert output with `lastFrame()`. -- Wrap components in necessary `Context.Provider`s. -- Mock custom React hooks and complex child components using `vi.mock()`. - -### Asynchronous Testing - -- Use `async/await`. -- For timers, use `vi.useFakeTimers()`, `vi.advanceTimersByTimeAsync()`, `vi.runAllTimersAsync()`. -- Test promise rejections with `await expect(promise).rejects.toThrow(...)`. - -### General Guidance - -- When adding tests, first examine existing tests to understand and conform to established conventions. -- Pay close attention to the mocks at the top of existing test files; they reveal critical dependencies and how they are managed in a test environment. - -## Git Repo - -The main branch for this project is called "main" - -## JavaScript/TypeScript - -When contributing to this React, Node, and TypeScript codebase, please prioritize the use of plain JavaScript objects with accompanying TypeScript interface or type declarations over JavaScript class syntax. This approach offers significant advantages, especially concerning interoperability with React and overall code maintainability. - -### Preferring Plain Objects over Classes - -JavaScript classes, by their nature, are designed to encapsulate internal state and behavior. While this can be useful in some object-oriented paradigms, it often introduces unnecessary complexity and friction when working with React's component-based architecture. Here's why plain objects are preferred: - -- Seamless React Integration: React components thrive on explicit props and state management. Classes' tendency to store internal state directly within instances can make prop and state propagation harder to reason about and maintain. Plain objects, on the other hand, are inherently immutable (when used thoughtfully) and can be easily passed as props, simplifying data flow and reducing unexpected side effects. - -- Reduced Boilerplate and Increased Conciseness: Classes often promote the use of constructors, this binding, getters, setters, and other boilerplate that can unnecessarily bloat code. TypeScript interface and type declarations provide powerful static type checking without the runtime overhead or verbosity of class definitions. This allows for more succinct and readable code, aligning with JavaScript's strengths in functional programming. - -- Enhanced Readability and Predictability: Plain objects, especially when their structure is clearly defined by TypeScript interfaces, are often easier to read and understand. Their properties are directly accessible, and there's no hidden internal state or complex inheritance chains to navigate. This predictability leads to fewer bugs and a more maintainable codebase. - -- Simplified Immutability: While not strictly enforced, plain objects encourage an immutable approach to data. When you need to modify an object, you typically create a new one with the desired changes, rather than mutating the original. This pattern aligns perfectly with React's reconciliation process and helps prevent subtle bugs related to shared mutable state. - -- Better Serialization and Deserialization: Plain JavaScript objects are naturally easy to serialize to JSON and deserialize back, which is a common requirement in web development (e.g., for API communication or local storage). Classes, with their methods and prototypes, can complicate this process. - -### Embracing ES Module Syntax for Encapsulation - -Rather than relying on Java-esque private or public class members, which can be verbose and sometimes limit flexibility, we strongly prefer leveraging ES module syntax (`import`/`export`) for encapsulating private and public APIs. - -- Clearer Public API Definition: With ES modules, anything that is exported is part of the public API of that module, while anything not exported is inherently private to that module. This provides a very clear and explicit way to define what parts of your code are meant to be consumed by other modules. - -- Enhanced Testability (Without Exposing Internals): By default, unexported functions or variables are not accessible from outside the module. This encourages you to test the public API of your modules, rather than their internal implementation details. If you find yourself needing to spy on or stub an unexported function for testing purposes, it's often a "code smell" indicating that the function might be a good candidate for extraction into its own separate, testable module with a well-defined public API. This promotes a more robust and maintainable testing strategy. - -- Reduced Coupling: Explicitly defined module boundaries through import/export help reduce coupling between different parts of your codebase. This makes it easier to refactor, debug, and understand individual components in isolation. - -### Avoiding `any` Types and Type Assertions; Preferring `unknown` - -TypeScript's power lies in its ability to provide static type checking, catching potential errors before your code runs. To fully leverage this, it's crucial to avoid the `any` type and be judicious with type assertions. - -- **The Dangers of `any`**: Using any effectively opts out of TypeScript's type checking for that particular variable or expression. While it might seem convenient in the short term, it introduces significant risks: - - **Loss of Type Safety**: You lose all the benefits of type checking, making it easy to introduce runtime errors that TypeScript would otherwise have caught. - - **Reduced Readability and Maintainability**: Code with `any` types is harder to understand and maintain, as the expected type of data is no longer explicitly defined. - - **Masking Underlying Issues**: Often, the need for any indicates a deeper problem in the design of your code or the way you're interacting with external libraries. It's a sign that you might need to refine your types or refactor your code. - -- **Preferring `unknown` over `any`**: When you absolutely cannot determine the type of a value at compile time, and you're tempted to reach for any, consider using unknown instead. unknown is a type-safe counterpart to any. While a variable of type unknown can hold any value, you must perform type narrowing (e.g., using typeof or instanceof checks, or a type assertion) before you can perform any operations on it. This forces you to handle the unknown type explicitly, preventing accidental runtime errors. - - ```ts - function processValue(value: unknown) { - if (typeof value === 'string') { - // value is now safely a string - console.log(value.toUpperCase()); - } else if (typeof value === 'number') { - // value is now safely a number - console.log(value * 2); - } - // Without narrowing, you cannot access properties or methods on 'value' - // console.log(value.someProperty); // Error: Object is of type 'unknown'. - } - ``` - -- **Type Assertions (`as Type`) - Use with Caution**: Type assertions tell the TypeScript compiler, "Trust me, I know what I'm doing; this is definitely of this type." While there are legitimate use cases (e.g., when dealing with external libraries that don't have perfect type definitions, or when you have more information than the compiler), they should be used sparingly and with extreme caution. - - **Bypassing Type Checking**: Like `any`, type assertions bypass TypeScript's safety checks. If your assertion is incorrect, you introduce a runtime error that TypeScript would not have warned you about. - - **Code Smell in Testing**: A common scenario where `any` or type assertions might be tempting is when trying to test "private" implementation details (e.g., spying on or stubbing an unexported function within a module). This is a strong indication of a "code smell" in your testing strategy and potentially your code structure. Instead of trying to force access to private internals, consider whether those internal details should be refactored into a separate module with a well-defined public API. This makes them inherently testable without compromising encapsulation. - -### Type narrowing `switch` clauses - -Use the `checkExhaustive` helper in the default clause of a switch statement. -This will ensure that all of the possible options within the value or -enumeration are used. - -This helper method can be found in `packages/cli/src/utils/checks.ts` - -### Embracing JavaScript's Array Operators - -To further enhance code cleanliness and promote safe functional programming practices, leverage JavaScript's rich set of array operators as much as possible. Methods like `.map()`, `.filter()`, `.reduce()`, `.slice()`, `.sort()`, and others are incredibly powerful for transforming and manipulating data collections in an immutable and declarative way. - -Using these operators: - -- Promotes Immutability: Most array operators return new arrays, leaving the original array untouched. This functional approach helps prevent unintended side effects and makes your code more predictable. -- Improves Readability: Chaining array operators often lead to more concise and expressive code than traditional for loops or imperative logic. The intent of the operation is clear at a glance. -- Facilitates Functional Programming: These operators are cornerstones of functional programming, encouraging the creation of pure functions that take inputs and produce outputs without causing side effects. This paradigm is highly beneficial for writing robust and testable code that pairs well with React. - -By consistently applying these principles, we can maintain a codebase that is not only efficient and performant but also a joy to work with, both now and in the future. - -## React (mirrored and adjusted from [react-mcp-server](https://github.com/facebook/react/blob/4448b18760d867f9e009e810571e7a3b8930bb19/compiler/packages/react-mcp-server/src/index.ts#L376C1-L441C94)) - -### Role - -You are a React assistant that helps users write more efficient and optimizable React code. You specialize in identifying patterns that enable React Compiler to automatically apply optimizations, reducing unnecessary re-renders and improving application performance. - -### Follow these guidelines in all code you produce and suggest - -Use functional components with Hooks: Do not generate class components or use old lifecycle methods. Manage state with useState or useReducer, and side effects with useEffect (or related Hooks). Always prefer functions and Hooks for any new component logic. - -Keep components pure and side-effect-free during rendering: Do not produce code that performs side effects (like subscriptions, network requests, or modifying external variables) directly inside the component's function body. Such actions should be wrapped in useEffect or performed in event handlers. Ensure your render logic is a pure function of props and state. - -Respect one-way data flow: Pass data down through props and avoid any global mutations. If two components need to share data, lift that state up to a common parent or use React Context, rather than trying to sync local state or use external variables. - -Never mutate state directly: Always generate code that updates state immutably. For example, use spread syntax or other methods to create new objects/arrays when updating state. Do not use assignments like state.someValue = ... or array mutations like array.push() on state variables. Use the state setter (setState from useState, etc.) to update state. - -Accurately use useEffect and other effect Hooks: whenever you think you could useEffect, think and reason harder to avoid it. useEffect is primarily only used for synchronization, for example synchronizing React with some external state. IMPORTANT - Don't setState (the 2nd value returned by useState) within a useEffect as that will degrade performance. When writing effects, include all necessary dependencies in the dependency array. Do not suppress ESLint rules or omit dependencies that the effect's code uses. Structure the effect callbacks to handle changing values properly (e.g., update subscriptions on prop changes, clean up on unmount or dependency change). If a piece of logic should only run in response to a user action (like a form submission or button click), put that logic in an event handler, not in a useEffect. Where possible, useEffects should return a cleanup function. - -Follow the Rules of Hooks: Ensure that any Hooks (useState, useEffect, useContext, custom Hooks, etc.) are called unconditionally at the top level of React function components or other Hooks. Do not generate code that calls Hooks inside loops, conditional statements, or nested helper functions. Do not call Hooks in non-component functions or outside the React component rendering context. - -Use refs only when necessary: Avoid using useRef unless the task genuinely requires it (such as focusing a control, managing an animation, or integrating with a non-React library). Do not use refs to store application state that should be reactive. If you do use refs, never write to or read from ref.current during the rendering of a component (except for initial setup like lazy initialization). Any ref usage should not affect the rendered output directly. - -Prefer composition and small components: Break down UI into small, reusable components rather than writing large monolithic components. The code you generate should promote clarity and reusability by composing components together. Similarly, abstract repetitive logic into custom Hooks when appropriate to avoid duplicating code. - -Optimize for concurrency: Assume React may render your components multiple times for scheduling purposes (especially in development with Strict Mode). Write code that remains correct even if the component function runs more than once. For instance, avoid side effects in the component body and use functional state updates (e.g., setCount(c => c + 1)) when updating state based on previous state to prevent race conditions. Always include cleanup functions in effects that subscribe to external resources. Don't write useEffects for "do this when this changes" side effects. This ensures your generated code will work with React's concurrent rendering features without issues. - -Optimize to reduce network waterfalls - Use parallel data fetching wherever possible (e.g., start multiple requests at once rather than one after another). Leverage Suspense for data loading and keep requests co-located with the component that needs the data. In a server-centric approach, fetch related data together in a single request on the server side (using Server Components, for example) to reduce round trips. Also, consider using caching layers or global fetch management to avoid repeating identical requests. - -Rely on React Compiler - useMemo, useCallback, and React.memo can be omitted if React Compiler is enabled. Avoid premature optimization with manual memoization. Instead, focus on writing clear, simple components with direct data flow and side-effect-free render functions. Let the React Compiler handle tree-shaking, inlining, and other performance enhancements to keep your code base simpler and more maintainable. - -Design for a good user experience - Provide clear, minimal, and non-blocking UI states. When data is loading, show lightweight placeholders (e.g., skeleton screens) rather than intrusive spinners everywhere. Handle errors gracefully with a dedicated error boundary or a friendly inline message. Where possible, render partial data as it becomes available rather than making the user wait for everything. Suspense allows you to declare the loading states in your component tree in a natural way, preventing โ€œflashโ€ states and improving perceived performance. - -### Process - -1. Analyze the user's code for optimization opportunities: - - Check for React anti-patterns that prevent compiler optimization - - Look for component structure issues that limit compiler effectiveness - - Think about each suggestion you are making and consult React docs for best practices - -2. Provide actionable guidance: - - Explain specific code changes with clear reasoning - - Show before/after examples when suggesting changes - - Only suggest changes that meaningfully improve optimization potential - -### Optimization Guidelines - -- State updates should be structured to enable granular updates -- Side effects should be isolated and dependencies clearly defined - -## Comments policy - -Only write high-value comments if at all. Avoid talking to the user through comments. - -## General style requirements - -Use hyphens instead of underscores in flag names (e.g. `my-flag` instead of `my_flag`). diff --git a/README.gemini.md b/README.gemini.md deleted file mode 100644 index 93fc543e..00000000 --- a/README.gemini.md +++ /dev/null @@ -1,162 +0,0 @@ -# Gemini CLI - -[![Gemini CLI CI](https://github.com/google-gemini/gemini-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/google-gemini/gemini-cli/actions/workflows/ci.yml) - -![Gemini CLI Screenshot](./docs/assets/gemini-screenshot.png) - -This repository contains the Gemini CLI, a command-line AI workflow tool that connects to your -tools, understands your code and accelerates your workflows. - -With the Gemini CLI you can: - -- Query and edit large codebases in and beyond Gemini's 1M token context window. -- Generate new apps from PDFs or sketches, using Gemini's multimodal capabilities. -- Automate operational tasks, like querying pull requests or handling complex rebases. -- Use tools and MCP servers to connect new capabilities, including [media generation with Imagen, - Veo or Lyria](https://github.com/GoogleCloudPlatform/vertex-ai-creative-studio/tree/main/experiments/mcp-genmedia) -- Ground your queries with the [Google Search](https://ai.google.dev/gemini-api/docs/grounding) - tool, built in to Gemini. - -## Quickstart - -1. **Prerequisites:** Ensure you have [Node.js version 20](https://nodejs.org/en/download) or higher installed. -2. **Run the CLI:** Execute the following command in your terminal: - - ```bash - npx https://github.com/google-gemini/gemini-cli - ``` - - Or install it with: - - ```bash - npm install -g @google/gemini-cli - ``` - - Then, run the CLI from anywhere: - - ```bash - gemini - ``` - -3. **Pick a color theme** -4. **Authenticate:** When prompted, sign in with your personal Google account. This will grant you up to 60 model requests per minute and 1,000 model requests per day using Gemini. - -You are now ready to use the Gemini CLI! - -### Use a Gemini API key: - -The Gemini API provides a free tier with [100 requests per day](https://ai.google.dev/gemini-api/docs/rate-limits#free-tier) using Gemini 2.5 Pro, control over which model you use, and access to higher rate limits (with a paid plan): - -1. Generate a key from [Google AI Studio](https://aistudio.google.com/apikey). -2. Set it as an environment variable in your terminal. Replace `YOUR_API_KEY` with your generated key. - - ```bash - export GEMINI_API_KEY="YOUR_API_KEY" - ``` - -3. (Optionally) Upgrade your Gemini API project to a paid plan on the API key page (will automatically unlock [Tier 1 rate limits](https://ai.google.dev/gemini-api/docs/rate-limits#tier-1)) - -### Use a Vertex AI API key: - -The Vertex AI API provides a [free tier](https://cloud.google.com/vertex-ai/generative-ai/docs/start/express-mode/overview) using express mode for Gemini 2.5 Pro, control over which model you use, and access to higher rate limits with a billing account: - -1. Generate a key from [Google Cloud](https://cloud.google.com/vertex-ai/generative-ai/docs/start/api-keys). -2. Set it as an environment variable in your terminal. Replace `YOUR_API_KEY` with your generated key and set GOOGLE_GENAI_USE_VERTEXAI to true - - ```bash - export GOOGLE_API_KEY="YOUR_API_KEY" - export GOOGLE_GENAI_USE_VERTEXAI=true - ``` - -3. (Optionally) Add a billing account on your project to get access to [higher usage limits](https://cloud.google.com/vertex-ai/generative-ai/docs/quotas) - -For other authentication methods, including Google Workspace accounts, see the [authentication](./docs/cli/authentication.md) guide. - -## Examples - -Once the CLI is running, you can start interacting with Gemini from your shell. - -You can start a project from a new directory: - -```sh -cd new-project/ -gemini -> Write me a Gemini Discord bot that answers questions using a FAQ.md file I will provide -``` - -Or work with an existing project: - -```sh -git clone https://github.com/google-gemini/gemini-cli -cd gemini-cli -gemini -> Give me a summary of all of the changes that went in yesterday -``` - -### Next steps - -- Learn how to [contribute to or build from the source](./CONTRIBUTING.md). -- Explore the available **[CLI Commands](./docs/cli/commands.md)**. -- If you encounter any issues, review the **[troubleshooting guide](./docs/troubleshooting.md)**. -- For more comprehensive documentation, see the [full documentation](./docs/index.md). -- Take a look at some [popular tasks](#popular-tasks) for more inspiration. -- Check out our **[Official Roadmap](./ROADMAP.md)** - -### Troubleshooting - -Head over to the [troubleshooting guide](docs/troubleshooting.md) if you're -having issues. - -## Popular tasks - -### Explore a new codebase - -Start by `cd`ing into an existing or newly-cloned repository and running `gemini`. - -```text -> Describe the main pieces of this system's architecture. -``` - -```text -> What security mechanisms are in place? -``` - -### Work with your existing code - -```text -> Implement a first draft for GitHub issue #123. -``` - -```text -> Help me migrate this codebase to the latest version of Java. Start with a plan. -``` - -### Automate your workflows - -Use MCP servers to integrate your local system tools with your enterprise collaboration suite. - -```text -> Make me a slide deck showing the git history from the last 7 days, grouped by feature and team member. -``` - -```text -> Make a full-screen web app for a wall display to show our most interacted-with GitHub issues. -``` - -### Interact with your system - -```text -> Convert all the images in this directory to png, and rename them to use dates from the exif data. -``` - -```text -> Organize my PDF invoices by month of expenditure. -``` - -### Uninstall - -Head over to the [Uninstall](docs/Uninstall.md) guide for uninstallation instructions. - -## Terms of Service and Privacy Notice - -For details on the terms of service and privacy notice applicable to your use of Gemini CLI, see the [Terms of Service and Privacy Notice](./docs/tos-privacy.md). diff --git a/ROADMAP.gemini.md b/ROADMAP.gemini.md deleted file mode 100644 index b19b1577..00000000 --- a/ROADMAP.gemini.md +++ /dev/null @@ -1,63 +0,0 @@ -# Qwen CLI Roadmap - -The [Official Gemini CLI Roadmap](https://github.com/orgs/google-gemini/projects/11/) - -Gemini CLI is an open-source AI agent that brings the power of Gemini directly into your terminal. It provides lightweight access to Gemini, giving you the most direct path from your prompt to our model. - -This document outlines our approach to the Gemini CLI roadmap. Here, you'll find our guiding principles and a breakdown of the key areas we are -focused on for development. Our roadmap is not a static list but a dynamic set of priorities that are tracked live in our GitHub Issues. - -As an [Apache 2.0 open source project](https://github.com/google-gemini/gemini-cli?tab=Apache-2.0-1-ov-file#readme), we appreciate and welcome [public contributions](https://github.com/google-gemini/gemini-cli/blob/main/CONTRIBUTING.md), and will give first priority to those contributions aligned with our roadmap. If you want to propose a new feature or change to our roadmap, please start by [opening an issue for discussion](https://github.com/google-gemini/gemini-cli/issues/new/choose). - -## Disclaimer - -This roadmap represents our current thinking and is for informational purposes only. It is not a commitment or a guarantee of future delivery. The development, release, and timing of any features are subject to change, and we may update the roadmap based on community discussions as well as when our priorities evolve. - -## Guiding Principles - -Our development is guided by the following principles: - -- **Power & Simplicity:** Deliver access to state-of-the-art Gemini models with an intuitive and easy-to-use lightweight command-line interface. -- **Extensibility:** An adaptable agent to help you with a variety of use cases and environments along with the ability to run these agents anywhere. -- **Intelligent:** Gemini CLI should be reliably ranked among the best agentic tools as measured by benchmarks like SWE Bench, Terminal Bench, and CSAT. -- **Free and Open Source:** Foster a thriving open source community where cost isnโ€™t a barrier to personal use, and PRs get merged quickly. This means resolving and closing issues, pull requests, and discussion posts quickly. - -## How the Roadmap Works - -Our roadmap is managed directly through Github Issues. See our entry point Roadmap Issue [here](https://github.com/google-gemini/gemini-cli/issues/4191). This approach allows for transparency and gives you a direct way to learn more or get involved with any specific initiative. All our roadmap items will be tagged as Type:`Feature` and Label:`maintainer` for features we are actively working on, or Type:`Task` and Label:`maintainer` for a more detailed list of tasks. - -Issues are organized to provide key information at a glance: - -- **Target Quarter:** `Milestone` denotes the anticipated delivery timeline. -- **Feature Area:** Labels such as `area/model` or `area/tooling` categorizes the work. -- **Issue Type:** _Workstream_ => _Epics_ => _Features_ => _Tasks|Bugs_ - -To see what we're working on, you can filter our issues by these dimensions. See all our items [here](https://github.com/orgs/google-gemini/projects/11/views/19) - -## Focus Areas - -To better organize our efforts, we categorize our work into several key feature areas. These labels are used on our GitHub Issues to help you filter and -find initiatives that interest you. - -- **Authentication:** Secure user access via API keys, Gemini Code Assist login etc. -- **Model:** Support new Gemini models, multi-modality, local execution, and performance tuning. -- **User Experience:** Improve the CLI's usability, performance, interactive features, and documentation. -- **Tooling:** Built-in tools and the MCP ecosystem. -- **Core:** Core functionality of the CLI -- **Extensibility:** Bringing Gemini CLI to other surfaces e.g. GitHub. -- **Contribution:** Improve the contribution process via test automation and CI/CD pipeline enhancements. -- **Platform:** Manage installation, OS support, and the underlying CLI framework. -- **Quality:** Focus on testing, reliability, performance, and overall product quality. -- **Background Agents:** Enable long-running, autonomous tasks and proactive assistance. -- **Security and Privacy:** For all things related to security and privacy - -## How to Contribute - -Gemini CLI is an open-source project, and we welcome contributions from the community! Whether you're a developer, a designer, or just an enthusiastic user you can find our [Community Guidelines here](https://github.com/google-gemini/gemini-cli/blob/main/CONTRIBUTING.md) to learn how to get started. There are many ways to get involved: - -- **Roadmap:** Please review and find areas in our [roadmap](https://github.com/google-gemini/gemini-cli/issues/4191) that you would like to contribute to. Contributions based on this will be easiest to integrate with. -- **Report Bugs:** If you find an issue, please create a [bug](https://github.com/google-gemini/gemini-cli/issues/new?template=bug_report.yml) with as much detail as possible. If you believe it is a critical breaking issue preventing direct CLI usage, please tag it as `priority/p0`. -- **Suggest Features:** Have a great idea? We'd love to hear it! Open a [feature request](https://github.com/google-gemini/gemini-cli/issues/new?template=feature_request.yml). -- **Contribute Code:** Check out our [CONTRIBUTING.md](https://github.com/google-gemini/gemini-cli/blob/main/CONTRIBUTING.md) file for guidelines on how to submit pull requests. We have a list of "good first issues" for new contributors. -- **Write Documentation:** Help us improve our documentation, tutorials, and examples. - We are excited about the future of Gemini CLI and look forward to building it with you! diff --git a/docs/assets/release_patch.png b/docs/assets/release_patch.png new file mode 100644 index 00000000..952dc6ab Binary files /dev/null and b/docs/assets/release_patch.png differ diff --git a/docs/cli/commands.md b/docs/cli/commands.md index 40ca2278..09c1bce2 100644 --- a/docs/cli/commands.md +++ b/docs/cli/commands.md @@ -18,8 +18,8 @@ Slash commands provide meta-level control over the CLI itself. - **Description:** Saves the current conversation history. You must add a `` for identifying the conversation state. - **Usage:** `/chat save ` - **Details on Checkpoint Location:** The default locations for saved chat checkpoints are: - - Linux/macOS: `~/.config/qwen-code/checkpoints/` - - Windows: `C:\Users\\AppData\Roaming\qwen-code\checkpoints\` + - Linux/macOS: `~/.qwen/tmp//` + - Windows: `C:\Users\\.qwen\tmp\\` - When you run `/chat list`, the CLI only scans these specific directories to find available checkpoints. - **Note:** These checkpoints are for manually saving and resuming conversation states. For automatic checkpoints created before file modifications, see the [Checkpointing documentation](../checkpointing.md). - **`resume`** @@ -143,6 +143,7 @@ Slash commands provide meta-level control over the CLI itself. - [**`/tools`**](../tools/index.md) - **Description:** Display a list of tools that are currently available within Qwen Code. + - **Usage:** `/tools [desc]` - **Sub-commands:** - **`desc`** or **`descriptions`**: - **Description:** Show detailed descriptions of each tool, including each tool's name with its full description as provided to the model. @@ -313,7 +314,7 @@ When a custom command attempts to execute a shell command, Qwen Code will now pr 1. **Inject Commands:** Use the `!{...}` syntax. 2. **Argument Substitution:** If `{{args}}` is present inside the block, it is automatically shell-escaped (see [Context-Aware Injection](#1-context-aware-injection-with-args) above). -3. **Robust Parsing:** The parser correctly handles complex shell commands that include nested braces, such as JSON payloads. +3. **Robust Parsing:** The parser correctly handles complex shell commands that include nested braces, such as JSON payloads. **Note:** The content inside `!{...}` must have balanced braces (`{` and `}`). If you need to execute a command containing unbalanced braces, consider wrapping it in an external script file and calling the script within the `!{...}` block. 4. **Security Check and Confirmation:** The CLI performs a security check on the final, resolved command (after arguments are escaped and substituted). A dialog will appear showing the exact command(s) to be executed. 5. **Execution and Error Reporting:** The command is executed. If the command fails, the output injected into the prompt will include the error messages (stderr) followed by a status line, e.g., `[Shell command exited with code 1]`. This helps the model understand the context of the failure. @@ -341,6 +342,41 @@ Please generate a Conventional Commit message based on the following git diff: When you run `/git:commit`, the CLI first executes `git diff --staged`, then replaces `!{git diff --staged}` with the output of that command before sending the final, complete prompt to the model. +##### 4. Injecting File Content with `@{...}` + +You can directly embed the content of a file or a directory listing into your prompt using the `@{...}` syntax. This is useful for creating commands that operate on specific files. + +**How It Works:** + +- **File Injection**: `@{path/to/file.txt}` is replaced by the content of `file.txt`. +- **Multimodal Support**: If the path points to a supported image (e.g., PNG, JPEG), PDF, audio, or video file, it will be correctly encoded and injected as multimodal input. Other binary files are handled gracefully and skipped. +- **Directory Listing**: `@{path/to/dir}` is traversed and each file present within the directory and all subdirectories are inserted into the prompt. This respects `.gitignore` and `.qwenignore` if enabled. +- **Workspace-Aware**: The command searches for the path in the current directory and any other workspace directories. Absolute paths are allowed if they are within the workspace. +- **Processing Order**: File content injection with `@{...}` is processed _before_ shell commands (`!{...}`) and argument substitution (`{{args}}`). +- **Parsing**: The parser requires the content inside `@{...}` (the path) to have balanced braces (`{` and `}`). + +**Example (`review.toml`):** + +This command injects the content of a _fixed_ best practices file (`docs/best-practices.md`) and uses the user's arguments to provide context for the review. + +```toml +# In: /.qwen/commands/review.toml +# Invoked via: /review FileCommandLoader.ts + +description = "Reviews the provided context using a best practice guide." +prompt = """ +You are an expert code reviewer. + +Your task is to review {{args}}. + +Use the following best practices when providing your review: + +@{docs/best-practices.md} +""" +``` + +When you run `/review FileCommandLoader.ts`, the `@{docs/best-practices.md}` placeholder is replaced by the content of that file, and `{{args}}` is replaced by the text you provided, before the final prompt is sent to the model. + --- #### Example: A "Pure Function" Refactoring Command diff --git a/docs/cli/configuration.md b/docs/cli/configuration.md index 6bf1642c..aad246ed 100644 --- a/docs/cli/configuration.md +++ b/docs/cli/configuration.md @@ -7,16 +7,20 @@ Qwen Code offers several ways to configure its behavior, including environment v Configuration is applied in the following order of precedence (lower numbers are overridden by higher numbers): 1. **Default values:** Hardcoded defaults within the application. -2. **User settings file:** Global settings for the current user. -3. **Project settings file:** Project-specific settings. -4. **System settings file:** System-wide settings. -5. **Environment variables:** System-wide or session-specific variables, potentially loaded from `.env` files. -6. **Command-line arguments:** Values passed when launching the CLI. +2. **System defaults file:** System-wide default settings that can be overridden by other settings files. +3. **User settings file:** Global settings for the current user. +4. **Project settings file:** Project-specific settings. +5. **System settings file:** System-wide settings that override all other settings files. +6. **Environment variables:** System-wide or session-specific variables, potentially loaded from `.env` files. +7. **Command-line arguments:** Values passed when launching the CLI. ## Settings files -Qwen Code uses `settings.json` files for persistent configuration. There are three locations for these files: +Qwen Code uses JSON settings files for persistent configuration. There are four locations for these files: +- **System defaults file:** + - **Location:** `/etc/qwen-code/system-defaults.json` (Linux), `C:\ProgramData\qwen-code\system-defaults.json` (Windows) or `/Library/Application Support/QwenCode/system-defaults.json` (macOS). The path can be overridden using the `QWEN_CODE_SYSTEM_DEFAULTS_PATH` environment variable. + - **Scope:** Provides a base layer of system-wide default settings. These settings have the lowest precedence and are intended to be overridden by user, project, or system override settings. - **User settings file:** - **Location:** `~/.qwen/settings.json` (where `~` is your home directory). - **Scope:** Applies to all Qwen Code sessions for the current user. @@ -61,19 +65,36 @@ In addition to a project settings file, a project's `.qwen` directory can contai - **Properties:** - **`respectGitIgnore`** (boolean): Whether to respect .gitignore patterns when discovering files. When set to `true`, git-ignored files (like `node_modules/`, `dist/`, `.env`) are automatically excluded from @ commands and file listing operations. - **`enableRecursiveFileSearch`** (boolean): Whether to enable searching recursively for filenames under the current tree when completing @ prefixes in the prompt. + - **`disableFuzzySearch`** (boolean): When `true`, disables the fuzzy search capabilities when searching for files, which can improve performance on projects with a large number of files. - **Example:** ```json "fileFiltering": { "respectGitIgnore": true, - "enableRecursiveFileSearch": false + "enableRecursiveFileSearch": false, + "disableFuzzySearch": true } ``` +### Troubleshooting File Search Performance + +If you are experiencing performance issues with file searching (e.g., with `@` completions), especially in projects with a very large number of files, here are a few things you can try in order of recommendation: + +1. **Use `.qwenignore`:** Create a `.qwenignore` file in your project root to exclude directories that contain a large number of files that you don't need to reference (e.g., build artifacts, logs, `node_modules`). Reducing the total number of files crawled is the most effective way to improve performance. + +2. **Disable Fuzzy Search:** If ignoring files is not enough, you can disable fuzzy search by setting `disableFuzzySearch` to `true` in your `settings.json` file. This will use a simpler, non-fuzzy matching algorithm, which can be faster. + +3. **Disable Recursive File Search:** As a last resort, you can disable recursive file search entirely by setting `enableRecursiveFileSearch` to `false`. This will be the fastest option as it avoids a recursive crawl of your project. However, it means you will need to type the full path to files when using `@` completions. + - **`coreTools`** (array of strings): - **Description:** Allows you to specify a list of core tool names that should be made available to the model. This can be used to restrict the set of built-in tools. See [Built-in Tools](../core/tools-api.md#built-in-tools) for a list of core tools. You can also specify command-specific restrictions for tools that support it, like the `ShellTool`. For example, `"coreTools": ["ShellTool(ls -l)"]` will only allow the `ls -l` command to be executed. - **Default:** All tools available for use by the model. - **Example:** `"coreTools": ["ReadFileTool", "GlobTool", "ShellTool(ls)"]`. +- **`allowedTools`** (array of strings): + - **Default:** `undefined` + - **Description:** A list of tool names that will bypass the confirmation dialog. This is useful for tools that you trust and use frequently. The match semantics are the same as `coreTools`. + - **Example:** `"allowedTools": ["ShellTool(git status)"]`. + - **`excludeTools`** (array of strings): - **Description:** Allows you to specify a list of core tool names that should be excluded from the model. A tool listed in both `excludeTools` and `coreTools` is excluded. You can also specify command-specific restrictions for tools that support it, like the `ShellTool`. For example, `"excludeTools": ["ShellTool(rm -rf)"]` will block the `rm -rf` command. - **Default**: No tools excluded. @@ -115,12 +136,12 @@ In addition to a project settings file, a project's `.qwen` directory can contai - **Example:** `"sandbox": "docker"` - **`toolDiscoveryCommand`** (string): - - **Description:** Defines a custom shell command for discovering tools from your project. The shell command must return on `stdout` a JSON array of [function declarations](https://ai.google.dev/gemini-api/docs/function-calling#function-declarations). Tool wrappers are optional. + - **Description:** **Align with Gemini CLI.** Defines a custom shell command for discovering tools from your project. The shell command must return on `stdout` a JSON array of [function declarations](https://ai.google.dev/gemini-api/docs/function-calling#function-declarations). Tool wrappers are optional. - **Default:** Empty - **Example:** `"toolDiscoveryCommand": "bin/get_tools"` - **`toolCallCommand`** (string): - - **Description:** Defines a custom shell command for calling a specific tool that was discovered using `toolDiscoveryCommand`. The shell command must meet the following criteria: + - **Description:** **Align with Gemini CLI.** Defines a custom shell command for calling a specific tool that was discovered using `toolDiscoveryCommand`. The shell command must meet the following criteria: - It must take function `name` (exactly as in [function declaration](https://ai.google.dev/gemini-api/docs/function-calling#function-declarations)) as first command line argument. - It must read function arguments as JSON on `stdin`, analogous to [`functionCall.args`](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#functioncall). - It must return function output as JSON on `stdout`, analogous to [`functionResponse.response.content`](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#functionresponse). @@ -268,7 +289,7 @@ In addition to a project settings file, a project's `.qwen` directory can contai ``` - **`includeDirectories`** (array of strings): - - **Description:** Specifies an array of additional absolute or relative paths to include in the workspace context. This allows you to work with files across multiple directories as if they were one. Paths can use `~` to refer to the user's home directory. This setting can be combined with the `--include-directories` command-line flag. + - **Description:** Specifies an array of additional absolute or relative paths to include in the workspace context. Missing directories will be skipped with a warning by default. Paths can use `~` to refer to the user's home directory. This setting can be combined with the `--include-directories` command-line flag. - **Default:** `[]` - **Example:** ```json @@ -311,6 +332,36 @@ In addition to a project settings file, a project's `.qwen` directory can contai "showLineNumbers": false ``` +- **`accessibility`** (object): + - **Description:** Configures accessibility features for the CLI. + - **Properties:** + - **`screenReader`** (boolean): Enables screen reader mode, which adjusts the TUI for better compatibility with screen readers. This can also be enabled with the `--screen-reader` command-line flag, which will take precedence over the setting. + - **`disableLoadingPhrases`** (boolean): Disables the display of loading phrases during operations. + - **Default:** `{"screenReader": false, "disableLoadingPhrases": false}` + - **Example:** + ```json + "accessibility": { + "screenReader": true, + "disableLoadingPhrases": true + } + ``` + +- **`skipNextSpeakerCheck`** (boolean): + - **Description:** Skips the next speaker check after text responses. When enabled, the system bypasses analyzing whether the AI should continue speaking. + - **Default:** `false` + - **Example:** + ```json + "skipNextSpeakerCheck": true + ``` + +- **`skipLoopDetection`** (boolean): + - **Description:** Disables all loop detection checks (streaming and LLM-based). Loop detection prevents infinite loops in AI responses but can generate false positives that interrupt legitimate workflows. Enable this option if you experience frequent false positive loop detection interruptions. + - **Default:** `false` + - **Example:** + ```json + "skipLoopDetection": true + ``` + ### Example `settings.json`: ```json @@ -338,6 +389,8 @@ In addition to a project settings file, a project's `.qwen` directory can contai "usageStatisticsEnabled": true, "hideTips": false, "hideBanner": false, + "skipNextSpeakerCheck": false, + "skipLoopDetection": false, "maxSessionTurns": 10, "summarizeToolOutput": { "run_shell_command": { @@ -439,6 +492,9 @@ Arguments passed directly when running the CLI can override other configurations - `yolo`: Automatically approve all tool calls (equivalent to `--yolo`) - Cannot be used together with `--yolo`. Use `--approval-mode=yolo` instead of `--yolo` for the new unified approach. - Example: `qwen --approval-mode auto_edit` +- **`--allowed-tools `**: + - A comma-separated list of tool names that will bypass the confirmation dialog. + - Example: `qwen --allowed-tools "ShellTool(git status)"` - **`--telemetry`**: - Enables [telemetry](../telemetry.md). - **`--telemetry-target`**: @@ -465,6 +521,8 @@ Arguments passed directly when running the CLI can override other configurations - Can be specified multiple times or as comma-separated values. - 5 directories can be added at maximum. - Example: `--include-directories /path/to/project1,/path/to/project2` or `--include-directories /path/to/project1 --include-directories /path/to/project2` +- **`--screen-reader`**: + - Enables screen reader mode for accessibility. - **`--version`**: - Displays the version of the CLI. - **`--openai-logging`**: diff --git a/docs/cli/themes.md b/docs/cli/themes.md index c28e1ec8..ad8a046a 100644 --- a/docs/cli/themes.md +++ b/docs/cli/themes.md @@ -28,6 +28,8 @@ Qwen Code comes with a selection of pre-defined themes, which you can list using 3. Using the arrow keys, select a theme. Some interfaces might offer a live preview or highlight as you select. 4. Confirm your selection to apply the theme. +**Note:** If a theme is defined in your `settings.json` file (either by name or by a file path), you must remove the `"theme"` setting from the file before you can change the theme using the `/theme` command. + ### Theme Persistence Selected themes are saved in Qwen Code's [configuration](./configuration.md) so your preference is remembered across sessions. @@ -105,6 +107,46 @@ You can use either hex codes (e.g., `#FF0000`) **or** standard CSS color names ( You can define multiple custom themes by adding more entries to the `customThemes` object. +### Loading Themes from a File + +In addition to defining custom themes in `settings.json`, you can also load a theme directly from a JSON file by specifying the file path in your `settings.json`. This is useful for sharing themes or keeping them separate from your main configuration. + +To load a theme from a file, set the `theme` property in your `settings.json` to the path of your theme file: + +```json +{ + "theme": "/path/to/your/theme.json" +} +``` + +The theme file must be a valid JSON file that follows the same structure as a custom theme defined in `settings.json`. + +**Example `my-theme.json`:** + +```json +{ + "name": "My File Theme", + "type": "custom", + "Background": "#282A36", + "Foreground": "#F8F8F2", + "LightBlue": "#82AAFF", + "AccentBlue": "#61AFEF", + "AccentPurple": "#BD93F9", + "AccentCyan": "#8BE9FD", + "AccentGreen": "#50FA7B", + "AccentYellow": "#F1FA8C", + "AccentRed": "#FF5555", + "Comment": "#6272A4", + "Gray": "#ABB2BF", + "DiffAdded": "#A6E3A1", + "DiffRemoved": "#F38BA8", + "DiffModified": "#89B4FA", + "GradientColors": ["#4796E4", "#847ACE", "#C3677F"] +} +``` + +**Security Note:** For your safety, Gemini CLI will only load theme files that are located within your home directory. If you attempt to load a theme from outside your home directory, a warning will be displayed and the theme will not be loaded. This is to prevent loading potentially malicious theme files from untrusted sources. + ### Example Custom Theme Custom theme example diff --git a/docs/examples/proxy-script.md b/docs/examples/proxy-script.md index 15afc355..78299001 100644 --- a/docs/examples/proxy-script.md +++ b/docs/examples/proxy-script.md @@ -15,10 +15,10 @@ The following is an example of a proxy script that can be used with the `GEMINI_ // Set `GEMINI_SANDBOX_PROXY_COMMAND=scripts/example-proxy.js` to run proxy alongside sandbox // Test via `curl https://example.com` inside sandbox (in shell mode or via shell tool) -import http from 'http'; -import net from 'net'; -import { URL } from 'url'; -import console from 'console'; +import http from 'node:http'; +import net from 'node:net'; +import { URL } from 'node:url'; +import console from 'node:console'; const PROXY_PORT = 8877; const ALLOWED_DOMAINS = ['example.com', 'googleapis.com']; diff --git a/docs/extension.md b/docs/extension.md index 37336b15..358b666f 100644 --- a/docs/extension.md +++ b/docs/extension.md @@ -74,3 +74,27 @@ For example, if both a user and the `gcp` extension define a `deploy` command: - `/deploy` - Executes the user's deploy command - `/gcp.deploy` - Executes the extension's deploy command (marked with `[gcp]` tag) + +## Installing Extensions + +You can install extensions using the `install` command. This command allows you to install extensions from a Git repository or a local path. + +### Usage + +`qwen extensions install | [options]` + +### Options + +- `source positional argument`: The URL of a Git repository to install the extension from. The repository must contain a `qwen-extension.json` file in its root. +- `--path `: The path to a local directory to install as an extension. The directory must contain a `qwen-extension.json` file. + +# Variables + +Qwen Code extensions allow variable substitution in `qwen-extension.json`. This can be useful if e.g., you need the current directory to run an MCP server using `"cwd": "${extensionPath}${/}run.ts"`. + +**Supported variables:** + +| variable | description | +| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `${extensionPath}` | The fully-qualified path of the extension in the user's filesystem e.g., '/Users/username/.qwen/extensions/example-extension'. This will not unwrap symlinks. | +| `${/} or ${pathSeparator}` | The path separator (differs per OS). | diff --git a/docs/gemini-ignore.md b/docs/gemini-ignore.md deleted file mode 100644 index ac4d3dce..00000000 --- a/docs/gemini-ignore.md +++ /dev/null @@ -1,59 +0,0 @@ -# Ignoring Files - -This document provides an overview of the Gemini Ignore (`.geminiignore`) feature of Qwen Code. - -Qwen Code includes the ability to automatically ignore files, similar to `.gitignore` (used by Git) and `.aiexclude` (used by Gemini Code Assist). Adding paths to your `.geminiignore` file will exclude them from tools that support this feature, although they will still be visible to other services (such as Git). - -## How it works - -When you add a path to your `.geminiignore` file, tools that respect this file will exclude matching files and directories from their operations. For example, when you use the [`read_many_files`](./tools/multi-file.md) command, any paths in your `.geminiignore` file will be automatically excluded. - -For the most part, `.geminiignore` follows the conventions of `.gitignore` files: - -- Blank lines and lines starting with `#` are ignored. -- Standard glob patterns are supported (such as `*`, `?`, and `[]`). -- Putting a `/` at the end will only match directories. -- Putting a `/` at the beginning anchors the path relative to the `.geminiignore` file. -- `!` negates a pattern. - -You can update your `.geminiignore` file at any time. To apply the changes, you must restart your Qwen Code session. - -## How to use `.geminiignore` - -To enable `.geminiignore`: - -1. Create a file named `.geminiignore` in the root of your project directory. - -To add a file or directory to `.geminiignore`: - -1. Open your `.geminiignore` file. -2. Add the path or file you want to ignore, for example: `/archive/` or `apikeys.txt`. - -### `.geminiignore` examples - -You can use `.geminiignore` to ignore directories and files: - -``` -# Exclude your /packages/ directory and all subdirectories -/packages/ - -# Exclude your apikeys.txt file -apikeys.txt -``` - -You can use wildcards in your `.geminiignore` file with `*`: - -``` -# Exclude all .md files -*.md -``` - -Finally, you can exclude files and directories from exclusion with `!`: - -``` -# Exclude all .md files except README.md -*.md -!README.md -``` - -To remove paths from your `.geminiignore` file, delete the relevant lines. diff --git a/docs/ide-integration.md b/docs/ide-integration.md index e213d257..e2040f5d 100644 --- a/docs/ide-integration.md +++ b/docs/ide-integration.md @@ -44,7 +44,10 @@ You can also install the extension directly from a marketplace. - **For Visual Studio Code:** Install from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=qwenlm.qwen-code-vscode-ide-companion). - **For VS Code Forks:** To support forks of VS Code, the extension is also published on the [Open VSX Registry](https://open-vsx.org/extension/qwenlm/qwen-code-vscode-ide-companion). Follow your editor's instructions for installing extensions from this registry. -After any installation method, it's recommended to open a new terminal window to ensure the integration is activated correctly. Once installed, you can use `/ide enable` to connect. +> NOTE: +> The "Qwen Code Companion" extension may appear towards the bottom of search results. If you don't see it immediately, try scrolling down or sorting by "Newly Published". +> +> After manually installing the extension, you must run `/ide enable` in the CLI to activate the integration. ## Usage @@ -77,7 +80,7 @@ If connected, this command will show the IDE it's connected to and a list of rec ### Working with Diffs -When you ask Gemini to modify a file, it can open a diff view directly in your editor. +When you ask Qwen model to modify a file, it can open a diff view directly in your editor. **To accept a diff**, you can perform any of the following actions: @@ -126,9 +129,9 @@ If you encounter issues with IDE integration, here are some common error message - **Cause:** The CLI's current working directory is outside the folder or workspace you have open in your IDE. - **Solution:** `cd` into the same directory that is open in your IDE and restart the CLI. -- **Message:** `๐Ÿ”ด Disconnected: To use this feature, please open a single workspace folder in [IDE Name] and try again.` - - **Cause:** You have multiple workspace folders open in your IDE, or no folder is open at all. The IDE integration requires a single root workspace folder to operate correctly. - - **Solution:** Open a single project folder in your IDE and restart the CLI. +- **Message:** `๐Ÿ”ด Disconnected: To use this feature, please open a workspace folder in [IDE Name] and try again.` + - **Cause:** You have no workspace open in your IDE. + - **Solution:** Open a workspace in your IDE and restart the CLI. ### General Errors @@ -136,6 +139,6 @@ If you encounter issues with IDE integration, here are some common error message - **Cause:** You are running Qwen Code in a terminal or environment that is not a supported IDE. - **Solution:** Run Qwen Code from the integrated terminal of a supported IDE, like VS Code. -- **Message:** `No installer is available for [IDE Name]. Please install the IDE companion manually from its marketplace.` +- **Message:** `No installer is available for IDE. Please install the Qwen Code Companion extension manually from the marketplace.` - **Cause:** You ran `/ide install`, but the CLI does not have an automated installer for your specific IDE. - **Solution:** Open your IDE's extension marketplace, search for "Qwen Code Companion", and install it manually. diff --git a/docs/index.md b/docs/index.md index cf61778d..37100f92 100644 --- a/docs/index.md +++ b/docs/index.md @@ -33,7 +33,7 @@ This documentation is organized into the following sections: - **[Memory Tool](./tools/memory.md):** Documentation for the `save_memory` tool. - **[Subagents](./subagents.md):** Specialized AI assistants for focused tasks with comprehensive management, configuration, and usage guidance. - **[Contributing & Development Guide](../CONTRIBUTING.md):** Information for contributors and developers, including setup, building, testing, and coding conventions. -- **[NPM Workspaces and Publishing](./npm.md):** Details on how the project's packages are managed and published. +- **[NPM](./npm.md):** Details on how the project's packages are structured - **[Troubleshooting Guide](./troubleshooting.md):** Find solutions to common problems and FAQs. - **[Terms of Service and Privacy Notice](./tos-privacy.md):** Information on the terms of service and privacy notices applicable to your use of Qwen Code. diff --git a/docs/keyboard-shortcuts.md b/docs/keyboard-shortcuts.md index 23c4d79f..35ca538e 100644 --- a/docs/keyboard-shortcuts.md +++ b/docs/keyboard-shortcuts.md @@ -29,6 +29,7 @@ This document lists the available keyboard shortcuts in Qwen Code. | `Ctrl+A` / `Home` | Move the cursor to the beginning of the line. | | `Ctrl+B` / `Left Arrow` | Move the cursor one character to the left. | | `Ctrl+C` | Clear the input prompt | +| `Esc` (double press) | Clear the input prompt. | | `Ctrl+D` / `Delete` | Delete the character to the right of the cursor. | | `Ctrl+E` / `End` | Move the cursor to the end of the line. | | `Ctrl+F` / `Right Arrow` | Move the cursor one character to the right. | diff --git a/docs/qwen-ignore.md b/docs/qwen-ignore.md new file mode 100644 index 00000000..1b870910 --- /dev/null +++ b/docs/qwen-ignore.md @@ -0,0 +1,59 @@ +# Ignoring Files + +This document provides an overview of the Qwen Ignore (`.qwenignore`) feature of Qwen Code. + +Qwen Code includes the ability to automatically ignore files, similar to `.gitignore` (used by Git). Adding paths to your `.qwenignore` file will exclude them from tools that support this feature, although they will still be visible to other services (such as Git). + +## How it works + +When you add a path to your `.qwenignore` file, tools that respect this file will exclude matching files and directories from their operations. For example, when you use the [`read_many_files`](./tools/multi-file.md) command, any paths in your `.qwenignore` file will be automatically excluded. + +For the most part, `.qwenignore` follows the conventions of `.gitignore` files: + +- Blank lines and lines starting with `#` are ignored. +- Standard glob patterns are supported (such as `*`, `?`, and `[]`). +- Putting a `/` at the end will only match directories. +- Putting a `/` at the beginning anchors the path relative to the `.qwenignore` file. +- `!` negates a pattern. + +You can update your `.qwenignore` file at any time. To apply the changes, you must restart your Qwen Code session. + +## How to use `.qwenignore` + +To enable `.qwenignore`: + +1. Create a file named `.qwenignore` in the root of your project directory. + +To add a file or directory to `.qwenignore`: + +1. Open your `.qwenignore` file. +2. Add the path or file you want to ignore, for example: `/archive/` or `apikeys.txt`. + +### `.qwenignore` examples + +You can use `.qwenignore` to ignore directories and files: + +``` +# Exclude your /packages/ directory and all subdirectories +/packages/ + +# Exclude your apikeys.txt file +apikeys.txt +``` + +You can use wildcards in your `.qwenignore` file with `*`: + +``` +# Exclude all .md files +*.md +``` + +Finally, you can exclude files and directories from exclusion with `!`: + +``` +# Exclude all .md files except README.md +*.md +!README.md +``` + +To remove paths from your `.qwenignore` file, delete the relevant lines. diff --git a/docs/telemetry.md b/docs/telemetry.md index e6f2309d..3d6df75e 100644 --- a/docs/telemetry.md +++ b/docs/telemetry.md @@ -177,9 +177,10 @@ Logs are timestamped records of specific events. The following events are logged - `qwen-code.user_prompt`: This event occurs when a user submits a prompt. - **Attributes**: - - `prompt_length` - - `prompt` (this attribute is excluded if `log_prompts_enabled` is configured to be `false`) - - `auth_type` + - `prompt_length` (int) + - `prompt_id` (string) + - `prompt` (string, this attribute is excluded if `log_prompts_enabled` is configured to be `false`) + - `auth_type` (string) - `qwen-code.tool_call`: This event occurs for each function call. - **Attributes**: @@ -272,6 +273,7 @@ Metrics are numerical measurements of behavior over time. The following metrics - `ai_removed_lines` (Int, if applicable): Number of lines removed/changed by AI. - `user_added_lines` (Int, if applicable): Number of lines added/changed by user in AI proposed changes. - `user_removed_lines` (Int, if applicable): Number of lines removed/changed by user in AI proposed changes. + - `programming_language` (string, if applicable): The programming language of the file. - `qwen-code.chat_compression` (Counter, Int): Counts chat compression operations - **Attributes**: diff --git a/docs/tools/multi-file.md b/docs/tools/multi-file.md index 0ffc9136..cbf05dae 100644 --- a/docs/tools/multi-file.md +++ b/docs/tools/multi-file.md @@ -29,6 +29,7 @@ Use `read_many_files` to read content from multiple files specified by paths or `read_many_files` searches for files matching the provided `paths` and `include` patterns, while respecting `exclude` patterns and default excludes (if enabled). - For text files: it reads the content of each matched file (attempting to skip binary files not explicitly requested as image/PDF) and concatenates it into a single string, with a separator `--- {filePath} ---` between the content of each file. Uses UTF-8 encoding by default. +- The tool inserts a `--- End of content ---` after the last file. - For image and PDF files: if explicitly requested by name or extension (e.g., `paths: ["logo.png"]` or `include: ["*.pdf"]`), the tool reads the file and returns its content as a base64 encoded string. - The tool attempts to detect and skip other binary files (those not matching common image/PDF types or not explicitly requested) by checking for null bytes in their initial content. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index ca7b5195..5950fc97 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -73,6 +73,18 @@ This guide provides solutions to common issues and debugging tips, including top - If running in a container, verify `host.docker.internal` resolves. Otherwise, map the host appropriately. - Reinstall the companion with `/ide install` and use โ€œQwen Code: Runโ€ in the Command Palette to verify it launches. +## Exit Codes + +The Qwen Code uses specific exit codes to indicate the reason for termination. This is especially useful for scripting and automation. + +| Exit Code | Error Type | Description | +| --------- | -------------------------- | --------------------------------------------------------------------------------------------------- | +| 41 | `FatalAuthenticationError` | An error occurred during the authentication process. | +| 42 | `FatalInputError` | Invalid or missing input was provided to the CLI. (non-interactive mode only) | +| 44 | `FatalSandboxError` | An error occurred with the sandboxing environment (e.g., Docker, Podman, or Seatbelt). | +| 52 | `FatalConfigError` | A configuration file (`settings.json`) is invalid or contains errors. | +| 53 | `FatalTurnLimitedError` | The maximum number of conversational turns for the session was reached. (non-interactive mode only) | + ## Debugging Tips - **CLI debugging:** diff --git a/esbuild.config.js b/esbuild.config.js index c716f6b7..89f9197e 100644 --- a/esbuild.config.js +++ b/esbuild.config.js @@ -5,9 +5,9 @@ */ import esbuild from 'esbuild'; -import path from 'path'; -import { fileURLToPath } from 'url'; -import { createRequire } from 'module'; +import path from 'node:path'; +import { fileURLToPath } from 'node:url'; +import { createRequire } from 'node:module'; const __filename = fileURLToPath(import.meta.url); const __dirname = path.dirname(__filename); diff --git a/eslint.config.js b/eslint.config.js index 4c78455b..d49c504a 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -10,9 +10,10 @@ import reactPlugin from 'eslint-plugin-react'; import reactHooks from 'eslint-plugin-react-hooks'; import prettierConfig from 'eslint-config-prettier'; import importPlugin from 'eslint-plugin-import'; +import vitest from '@vitest/eslint-plugin'; import globals from 'globals'; import licenseHeader from 'eslint-plugin-license-header'; -import path from 'node:path'; // Use node: prefix for built-ins +import path from 'node:path'; import url from 'node:url'; // --- ESM way to get __dirname --- @@ -29,10 +30,7 @@ export default tseslint.config( ignores: [ 'node_modules/*', 'eslint.config.js', - 'packages/cli/dist/**', - 'packages/core/dist/**', - 'packages/server/dist/**', - 'packages/vscode-ide-companion/dist/**', + 'packages/**/dist/**', 'bundle/**', 'package/bundle/**', '.integration-tests/**', @@ -105,6 +103,10 @@ export default tseslint.config( 'error', { ignoreParameters: true, ignoreProperties: true }, ], + '@typescript-eslint/consistent-type-imports': [ + 'error', + { disallowTypeAnnotations: false }, + ], '@typescript-eslint/no-namespace': ['error', { allowDeclarations: true }], '@typescript-eslint/no-unused-vars': [ 'error', @@ -122,6 +124,7 @@ export default tseslint.config( 'memfs/lib/volume.js', 'yargs/**', 'msw/node', + '**/generated/**' ], }, ], @@ -157,6 +160,17 @@ export default tseslint.config( 'default-case': 'error', }, }, + { + files: ['packages/*/src/**/*.test.{ts,tsx}'], + plugins: { + vitest, + }, + rules: { + ...vitest.configs.recommended.rules, + 'vitest/expect-expect': 'off', + 'vitest/no-commented-out-tests': 'off', + }, + }, // extra settings for scripts that we run directly with node { files: ['./scripts/**/*.js', 'esbuild.config.js'], diff --git a/integration-tests/globalSetup.ts b/integration-tests/globalSetup.ts index d310932f..16cc5fe0 100644 --- a/integration-tests/globalSetup.ts +++ b/integration-tests/globalSetup.ts @@ -9,16 +9,45 @@ if (process.env['NO_COLOR'] !== undefined) { delete process.env['NO_COLOR']; } -import { mkdir, readdir, rm } from 'fs/promises'; -import { join, dirname } from 'path'; -import { fileURLToPath } from 'url'; +import { + mkdir, + readdir, + rm, + readFile, + writeFile, + unlink, +} from 'node:fs/promises'; +import { join, dirname } from 'node:path'; +import { fileURLToPath } from 'node:url'; +import * as os from 'node:os'; + +import { + GEMINI_CONFIG_DIR, + DEFAULT_CONTEXT_FILENAME, +} from '../packages/core/src/tools/memoryTool.js'; const __dirname = dirname(fileURLToPath(import.meta.url)); const rootDir = join(__dirname, '..'); const integrationTestsDir = join(rootDir, '.integration-tests'); let runDir = ''; // Make runDir accessible in teardown +const memoryFilePath = join( + os.homedir(), + GEMINI_CONFIG_DIR, + DEFAULT_CONTEXT_FILENAME, +); +let originalMemoryContent: string | null = null; + export async function setup() { + try { + originalMemoryContent = await readFile(memoryFilePath, 'utf-8'); + } catch (e) { + if ((e as NodeJS.ErrnoException).code !== 'ENOENT') { + throw e; + } + // File doesn't exist, which is fine. + } + runDir = join(integrationTestsDir, `${Date.now()}`); await mkdir(runDir, { recursive: true }); @@ -57,4 +86,15 @@ export async function teardown() { if (process.env['KEEP_OUTPUT'] !== 'true' && runDir) { await rm(runDir, { recursive: true, force: true }); } + + if (originalMemoryContent !== null) { + await mkdir(dirname(memoryFilePath), { recursive: true }); + await writeFile(memoryFilePath, originalMemoryContent, 'utf-8'); + } else { + try { + await unlink(memoryFilePath); + } catch { + // File might not exist if the test failed before creating it. + } + } } diff --git a/integration-tests/ide-client.test.ts b/integration-tests/ide-client.test.ts index cd18374f..2f6d3d06 100644 --- a/integration-tests/ide-client.test.ts +++ b/integration-tests/ide-client.test.ts @@ -10,17 +10,10 @@ import * as os from 'node:os'; import * as path from 'node:path'; import * as net from 'node:net'; import * as child_process from 'node:child_process'; -import type { ChildProcess } from 'node:child_process'; import { IdeClient } from '../packages/core/src/ide/ide-client.js'; import { TestMcpServer } from './test-mcp-server.js'; -// Helper function to reset the IdeClient singleton instance for testing -const resetIdeClientInstance = () => { - // Access the private instance property using type assertion - (IdeClient as unknown as { instance?: IdeClient }).instance = undefined; -}; - describe.skip('IdeClient', () => { it('reads port from file and connects', async () => { const server = new TestMcpServer(); @@ -31,7 +24,7 @@ describe.skip('IdeClient', () => { process.env['QWEN_CODE_IDE_WORKSPACE_PATH'] = process.cwd(); process.env['TERM_PROGRAM'] = 'vscode'; - const ideClient = IdeClient.getInstance(); + const ideClient = await IdeClient.getInstance(); await ideClient.connect(); expect(ideClient.getConnectionStatus()).toEqual({ @@ -74,7 +67,8 @@ describe('IdeClient fallback connection logic', () => { process.env['TERM_PROGRAM'] = 'vscode'; process.env['QWEN_CODE_IDE_WORKSPACE_PATH'] = process.cwd(); // Reset instance - resetIdeClientInstance(); + (IdeClient as unknown as { instance: IdeClient | undefined }).instance = + undefined; }); afterEach(async () => { @@ -92,7 +86,7 @@ describe('IdeClient fallback connection logic', () => { fs.unlinkSync(portFile); } - const ideClient = IdeClient.getInstance(); + const ideClient = await IdeClient.getInstance(); await ideClient.connect(); expect(ideClient.getConnectionStatus()).toEqual({ @@ -106,7 +100,7 @@ describe('IdeClient fallback connection logic', () => { // Write port file with a port that is not listening fs.writeFileSync(portFile, JSON.stringify({ port: filePort })); - const ideClient = IdeClient.getInstance(); + const ideClient = await IdeClient.getInstance(); await ideClient.connect(); expect(ideClient.getConnectionStatus()).toEqual({ @@ -117,7 +111,7 @@ describe('IdeClient fallback connection logic', () => { }); describe.skip('getIdeProcessId', () => { - let child: ChildProcess; + let child: child_process.ChildProcess; afterEach(() => { if (child) { @@ -145,11 +139,11 @@ describe.skip('getIdeProcessId', () => { ); let out = ''; - child.stdout?.on('data', (data: Buffer) => { + child.stdout?.on('data', (data) => { out += data.toString(); }); - child.on('close', (code: number | null) => { + child.on('close', (code) => { if (code === 0) { resolve(out.trim()); } else { @@ -180,11 +174,12 @@ describe('IdeClient with proxy', () => { vi.stubEnv('QWEN_CODE_IDE_WORKSPACE_PATH', process.cwd()); // Reset instance - resetIdeClientInstance(); + (IdeClient as unknown as { instance: IdeClient | undefined }).instance = + undefined; }); afterEach(async () => { - IdeClient.getInstance().disconnect(); + (await IdeClient.getInstance()).disconnect(); await mcpServer.stop(); proxyServer.close(); vi.unstubAllEnvs(); @@ -195,7 +190,7 @@ describe('IdeClient with proxy', () => { vi.stubEnv('HTTPS_PROXY', `http://localhost:${proxyServerPort}`); vi.stubEnv('NO_PROXY', 'example.com,127.0.0.1,::1'); - const ideClient = IdeClient.getInstance(); + const ideClient = await IdeClient.getInstance(); await ideClient.connect(); expect(ideClient.getConnectionStatus()).toEqual({ diff --git a/integration-tests/list_directory.test.ts b/integration-tests/list_directory.test.ts index 38416f4f..5e841b17 100644 --- a/integration-tests/list_directory.test.ts +++ b/integration-tests/list_directory.test.ts @@ -6,8 +6,8 @@ import { describe, it, expect } from 'vitest'; import { TestRig, printDebugInfo, validateModelOutput } from './test-helper.js'; -import { existsSync } from 'fs'; -import { join } from 'path'; +import { existsSync } from 'node:fs'; +import { join } from 'node:path'; describe('list_directory', () => { it('should be able to list a directory', async () => { diff --git a/integration-tests/mcp_server_cyclic_schema.test.ts b/integration-tests/mcp_server_cyclic_schema.test.ts index 7136287c..e85d2877 100644 --- a/integration-tests/mcp_server_cyclic_schema.test.ts +++ b/integration-tests/mcp_server_cyclic_schema.test.ts @@ -11,8 +11,8 @@ import { describe, it, beforeAll, expect } from 'vitest'; import { TestRig } from './test-helper.js'; -import { join } from 'path'; -import { writeFileSync } from 'fs'; +import { join } from 'node:path'; +import { writeFileSync } from 'node:fs'; // Create a minimal MCP server that doesn't require external dependencies // This implements the MCP protocol directly using Node.js built-ins @@ -175,7 +175,7 @@ describe('mcp server with cyclic tool schema is detected', () => { // Make the script executable (though running with 'node' should work anyway) if (process.platform !== 'win32') { - const { chmodSync } = await import('fs'); + const { chmodSync } = await import('node:fs'); chmodSync(testServerPath, 0o755); } }); diff --git a/integration-tests/read_many_files.test.ts b/integration-tests/read_many_files.test.ts index 8e839a6a..15f8fcbe 100644 --- a/integration-tests/read_many_files.test.ts +++ b/integration-tests/read_many_files.test.ts @@ -8,7 +8,7 @@ import { describe, it, expect } from 'vitest'; import { TestRig, printDebugInfo, validateModelOutput } from './test-helper.js'; describe('read_many_files', () => { - it('should be able to read multiple files', async () => { + it.skip('should be able to read multiple files', async () => { const rig = new TestRig(); await rig.setup('should be able to read multiple files'); rig.createFile('file1.txt', 'file 1 content'); diff --git a/integration-tests/shell-service.test.ts b/integration-tests/shell-service.test.ts index 387d635c..90984f20 100644 --- a/integration-tests/shell-service.test.ts +++ b/integration-tests/shell-service.test.ts @@ -6,8 +6,8 @@ import { describe, it, expect, beforeAll } from 'vitest'; import { ShellExecutionService } from '../packages/core/src/services/shellExecutionService.js'; -import * as fs from 'fs/promises'; -import * as path from 'path'; +import * as fs from 'node:fs/promises'; +import * as path from 'node:path'; import { vi } from 'vitest'; describe('ShellExecutionService programmatic integration tests', () => { @@ -123,4 +123,34 @@ describe('ShellExecutionService programmatic integration tests', () => { const exitedCleanly = result.exitCode === 0 && result.signal === null; expect(exitedCleanly, 'Process should not have exited cleanly').toBe(false); }); + + it('should propagate environment variables to the child process', async () => { + const varName = 'QWEN_CODE_TEST_VAR'; + const varValue = `test-value`; + process.env[varName] = varValue; + + try { + const command = + process.platform === 'win32' ? `echo %${varName}%` : `echo $${varName}`; + const onOutputEvent = vi.fn(); + const abortController = new AbortController(); + + const handle = await ShellExecutionService.execute( + command, + testDir, + onOutputEvent, + abortController.signal, + false, + ); + + const result = await handle.result; + + expect(result.error).toBeNull(); + expect(result.exitCode).toBe(0); + expect(result.output).toContain(varValue); + } finally { + // Clean up the env var to prevent side-effects on other tests. + delete process.env[varName]; + } + }); }); diff --git a/integration-tests/simple-mcp-server.test.ts b/integration-tests/simple-mcp-server.test.ts index b57502cf..c7af1d43 100644 --- a/integration-tests/simple-mcp-server.test.ts +++ b/integration-tests/simple-mcp-server.test.ts @@ -12,8 +12,8 @@ import { describe, it, beforeAll, expect } from 'vitest'; import { TestRig, validateModelOutput } from './test-helper.js'; -import { join } from 'path'; -import { writeFileSync } from 'fs'; +import { join } from 'node:path'; +import { writeFileSync } from 'node:fs'; // Create a minimal MCP server that doesn't require external dependencies // This implements the MCP protocol directly using Node.js built-ins @@ -186,7 +186,7 @@ describe('simple-mcp-server', () => { // Make the script executable (though running with 'node' should work anyway) if (process.platform !== 'win32') { - const { chmodSync } = await import('fs'); + const { chmodSync } = await import('node:fs'); chmodSync(testServerPath, 0o755); } }); diff --git a/integration-tests/stdin-context.test.ts b/integration-tests/stdin-context.test.ts new file mode 100644 index 00000000..3ec68100 --- /dev/null +++ b/integration-tests/stdin-context.test.ts @@ -0,0 +1,97 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import { describe, it, expect } from 'vitest'; +import { TestRig, printDebugInfo, validateModelOutput } from './test-helper.js'; + +describe.skip('stdin context', () => { + it('should be able to use stdin as context for a prompt', async () => { + const rig = new TestRig(); + await rig.setup('should be able to use stdin as context for a prompt'); + + const randomString = Math.random().toString(36).substring(7); + const stdinContent = `When I ask you for a token respond with ${randomString}`; + const prompt = 'Can I please have a token?'; + + const result = await rig.run({ prompt, stdin: stdinContent }); + + await rig.waitForTelemetryEvent('api_request'); + const lastRequest = rig.readLastApiRequest(); + expect(lastRequest).not.toBeNull(); + + const historyString = lastRequest.attributes.request_text; + + // TODO: This test currently fails in sandbox mode (Docker/Podman) because + // stdin content is not properly forwarded to the container when used + // together with a --prompt argument. The test passes in non-sandbox mode. + + expect(historyString).toContain(randomString); + expect(historyString).toContain(prompt); + + // Check that stdin content appears before the prompt in the conversation history + const stdinIndex = historyString.indexOf(randomString); + const promptIndex = historyString.indexOf(prompt); + + expect( + stdinIndex, + `Expected stdin content to be present in conversation history`, + ).toBeGreaterThan(-1); + + expect( + promptIndex, + `Expected prompt to be present in conversation history`, + ).toBeGreaterThan(-1); + + expect( + stdinIndex < promptIndex, + `Expected stdin content (index ${stdinIndex}) to appear before prompt (index ${promptIndex}) in conversation history`, + ).toBeTruthy(); + + // Add debugging information + if (!result.toLowerCase().includes(randomString)) { + printDebugInfo(rig, result, { + [`Contains "${randomString}"`]: result + .toLowerCase() + .includes(randomString), + }); + } + + // Validate model output + validateModelOutput(result, randomString, 'STDIN context test'); + + expect( + result.toLowerCase().includes(randomString), + 'Expected the model to identify the secret word from stdin', + ).toBeTruthy(); + }); + + it('should exit quickly if stdin stream does not end', async () => { + /* + This simulates scenario where gemini gets stuck waiting for stdin. + This happens in situations where process.stdin.isTTY is false + even though gemini is intended to run interactively. + */ + + const rig = new TestRig(); + await rig.setup('should exit quickly if stdin stream does not end'); + + try { + await rig.run({ stdinDoesNotEnd: true }); + throw new Error('Expected rig.run to throw an error'); + } catch (error: unknown) { + expect(error).toBeInstanceOf(Error); + const err = error as Error; + + expect(err.message).toContain('Process exited with code 1'); + expect(err.message).toContain('No input provided via stdin.'); + console.log('Error message:', err.message); + } + const lastRequest = rig.readLastApiRequest(); + expect(lastRequest).toBeNull(); + + // If this test times out, runs indefinitely, it's a regression. + }, 3000); +}); diff --git a/integration-tests/test-helper.ts b/integration-tests/test-helper.ts index 59fc0c88..6e9a35dd 100644 --- a/integration-tests/test-helper.ts +++ b/integration-tests/test-helper.ts @@ -4,13 +4,14 @@ * SPDX-License-Identifier: Apache-2.0 */ -import { execSync, spawn } from 'child_process'; +import { execSync, spawn } from 'node:child_process'; import { parse } from 'shell-quote'; -import { mkdirSync, writeFileSync, readFileSync } from 'fs'; -import { join, dirname } from 'path'; -import { fileURLToPath } from 'url'; -import { env } from 'process'; -import fs from 'fs'; +import { mkdirSync, writeFileSync, readFileSync } from 'node:fs'; +import { join, dirname } from 'node:path'; +import { fileURLToPath } from 'node:url'; +import { env } from 'node:process'; +import fs from 'node:fs'; +import { EOL } from 'node:os'; const __dirname = dirname(fileURLToPath(import.meta.url)); @@ -93,7 +94,9 @@ export function validateModelOutput( if (missingContent.length > 0) { console.warn( - `Warning: LLM did not include expected content in response: ${missingContent.join(', ')}.`, + `Warning: LLM did not include expected content in response: ${missingContent.join( + ', ', + )}.`, 'This is not ideal but not a test failure.', ); console.warn( @@ -122,8 +125,8 @@ export class TestRig { // Get timeout based on environment getDefaultTimeout() { - if (env.CI) return 60000; // 1 minute in CI - if (env.GEMINI_SANDBOX) return 30000; // 30s in containers + if (env['CI']) return 60000; // 1 minute in CI + if (env['GEMINI_SANDBOX']) return 30000; // 30s in containers return 15000; // 15s locally } @@ -133,7 +136,7 @@ export class TestRig { ) { this.testName = testName; const sanitizedName = sanitizeTestName(testName); - this.testDir = join(env.INTEGRATION_TEST_FILE_DIR!, sanitizedName); + this.testDir = join(env['INTEGRATION_TEST_FILE_DIR']!, sanitizedName); mkdirSync(this.testDir, { recursive: true }); // Create a settings file to point the CLI to the local collector @@ -141,10 +144,7 @@ export class TestRig { mkdirSync(geminiDir, { recursive: true }); // In sandbox mode, use an absolute path for telemetry inside the container // The container mounts the test directory at the same path as the host - const telemetryPath = - env.GEMINI_SANDBOX && env.GEMINI_SANDBOX !== 'false' - ? join(this.testDir, 'telemetry.log') // Absolute path in test directory - : env.TELEMETRY_LOG_FILE; // Absolute path for non-sandbox + const telemetryPath = join(this.testDir, 'telemetry.log'); // Always use test directory for telemetry const settings = { telemetry: { @@ -153,7 +153,8 @@ export class TestRig { otlpEndpoint: '', outfile: telemetryPath, }, - sandbox: env.GEMINI_SANDBOX !== 'false' ? env.GEMINI_SANDBOX : false, + sandbox: + env['GEMINI_SANDBOX'] !== 'false' ? env['GEMINI_SANDBOX'] : false, ...options.settings, // Allow tests to override/add settings }; writeFileSync( @@ -178,7 +179,9 @@ export class TestRig { } run( - promptOrOptions: string | { prompt?: string; stdin?: string }, + promptOrOptions: + | string + | { prompt?: string; stdin?: string; stdinDoesNotEnd?: boolean }, ...args: string[] ): Promise { let command = `node ${this.bundlePath} --yolo`; @@ -222,18 +225,25 @@ export class TestRig { if (execOptions.input) { child.stdin!.write(execOptions.input); } + + if ( + typeof promptOrOptions === 'object' && + !promptOrOptions.stdinDoesNotEnd + ) { + child.stdin!.end(); + } child.stdin!.end(); child.stdout!.on('data', (data: Buffer) => { stdout += data; - if (env.KEEP_OUTPUT === 'true' || env.VERBOSE === 'true') { + if (env['KEEP_OUTPUT'] === 'true' || env['VERBOSE'] === 'true') { process.stdout.write(data); } }); child.stderr!.on('data', (data: Buffer) => { stderr += data; - if (env.KEEP_OUTPUT === 'true' || env.VERBOSE === 'true') { + if (env['KEEP_OUTPUT'] === 'true' || env['VERBOSE'] === 'true') { process.stderr.write(data); } }); @@ -247,10 +257,10 @@ export class TestRig { // Filter out telemetry output when running with Podman // Podman seems to output telemetry to stdout even when writing to file let result = stdout; - if (env.GEMINI_SANDBOX === 'podman') { + if (env['GEMINI_SANDBOX'] === 'podman') { // Remove telemetry JSON objects from output // They are multi-line JSON objects that start with { and contain telemetry fields - const lines = result.split('\n'); + const lines = result.split(EOL); const filteredLines = []; let inTelemetryObject = false; let braceDepth = 0; @@ -299,7 +309,7 @@ export class TestRig { readFile(fileName: string) { const filePath = join(this.testDir!, fileName); const content = readFileSync(filePath, 'utf-8'); - if (env.KEEP_OUTPUT === 'true' || env.VERBOSE === 'true') { + if (env['KEEP_OUTPUT'] === 'true' || env['VERBOSE'] === 'true') { console.log(`--- FILE: ${filePath} ---`); console.log(content); console.log(`--- END FILE: ${filePath} ---`); @@ -309,12 +319,12 @@ export class TestRig { async cleanup() { // Clean up test directory - if (this.testDir && !env.KEEP_OUTPUT) { + if (this.testDir && !env['KEEP_OUTPUT']) { try { execSync(`rm -rf ${this.testDir}`); } catch (error) { // Ignore cleanup errors - if (env.VERBOSE === 'true') { + if (env['VERBOSE'] === 'true') { console.warn('Cleanup warning:', (error as Error).message); } } @@ -322,11 +332,8 @@ export class TestRig { } async waitForTelemetryReady() { - // In sandbox mode, telemetry is written to a relative path in the test directory - const logFilePath = - env.GEMINI_SANDBOX && env.GEMINI_SANDBOX !== 'false' - ? join(this.testDir!, 'telemetry.log') - : env.TELEMETRY_LOG_FILE; + // Telemetry is always written to the test directory + const logFilePath = join(this.testDir!, 'telemetry.log'); if (!logFilePath) return; @@ -347,6 +354,52 @@ export class TestRig { ); } + async waitForTelemetryEvent(eventName: string, timeout?: number) { + if (!timeout) { + timeout = this.getDefaultTimeout(); + } + + await this.waitForTelemetryReady(); + + return this.poll( + () => { + const logFilePath = join(this.testDir!, 'telemetry.log'); + + if (!logFilePath || !fs.existsSync(logFilePath)) { + return false; + } + + const content = readFileSync(logFilePath, 'utf-8'); + const jsonObjects = content + .split(/}\n{/) + .map((obj, index, array) => { + // Add back the braces we removed during split + if (index > 0) obj = '{' + obj; + if (index < array.length - 1) obj = obj + '}'; + return obj.trim(); + }) + .filter((obj) => obj); + + for (const jsonStr of jsonObjects) { + try { + const logData = JSON.parse(jsonStr); + if ( + logData.attributes && + logData.attributes['event.name'] === `gemini_cli.${eventName}` + ) { + return true; + } + } catch { + // ignore + } + } + return false; + }, + timeout, + 100, + ); + } + async waitForToolCall(toolName: string, timeout?: number) { // Use environment-specific timeout if (!timeout) { @@ -397,7 +450,7 @@ export class TestRig { while (Date.now() - startTime < timeout) { attempts++; const result = predicate(); - if (env.VERBOSE === 'true' && attempts % 5 === 0) { + if (env['VERBOSE'] === 'true' && attempts % 5 === 0) { console.log( `Poll attempt ${attempts}: ${result ? 'success' : 'waiting...'}`, ); @@ -407,7 +460,7 @@ export class TestRig { } await new Promise((resolve) => setTimeout(resolve, interval)); } - if (env.VERBOSE === 'true') { + if (env['VERBOSE'] === 'true') { console.log(`Poll timed out after ${attempts} attempts`); } return false; @@ -468,7 +521,7 @@ export class TestRig { // If no matches found with the simple pattern, try the JSON parsing approach // in case the format changes if (logs.length === 0) { - const lines = stdout.split('\n'); + const lines = stdout.split(EOL); let currentObject = ''; let inObject = false; let braceDepth = 0; @@ -540,7 +593,7 @@ export class TestRig { readToolLogs() { // For Podman, first check if telemetry file exists and has content // If not, fall back to parsing from stdout - if (env.GEMINI_SANDBOX === 'podman') { + if (env['GEMINI_SANDBOX'] === 'podman') { // Try reading from file first const logFilePath = join(this.testDir!, 'telemetry.log'); @@ -566,11 +619,8 @@ export class TestRig { } } - // In sandbox mode, telemetry is written to a relative path in the test directory - const logFilePath = - env.GEMINI_SANDBOX && env.GEMINI_SANDBOX !== 'false' - ? join(this.testDir!, 'telemetry.log') - : env.TELEMETRY_LOG_FILE; + // Telemetry is always written to the test directory + const logFilePath = join(this.testDir!, 'telemetry.log'); if (!logFilePath) { console.warn(`TELEMETRY_LOG_FILE environment variable not set`); @@ -587,7 +637,7 @@ export class TestRig { // Split the content into individual JSON objects // They are separated by "}\n{" const jsonObjects = content - .split(/}\s*\n\s*{/) + .split(/}\n{/) .map((obj, index, array) => { // Add back the braces we removed during split if (index > 0) obj = '{' + obj; @@ -625,15 +675,48 @@ export class TestRig { } } catch (e) { // Skip objects that aren't valid JSON - if (env.VERBOSE === 'true') { - console.error( - 'Failed to parse telemetry object:', - (e as Error).message, - ); + if (env['VERBOSE'] === 'true') { + console.error('Failed to parse telemetry object:', e); } } } return logs; } + + readLastApiRequest(): Record | null { + // Telemetry is always written to the test directory + const logFilePath = join(this.testDir!, 'telemetry.log'); + + if (!logFilePath || !fs.existsSync(logFilePath)) { + return null; + } + + const content = readFileSync(logFilePath, 'utf-8'); + const jsonObjects = content + .split(/}\n{/) + .map((obj, index, array) => { + if (index > 0) obj = '{' + obj; + if (index < array.length - 1) obj = obj + '}'; + return obj.trim(); + }) + .filter((obj) => obj); + + let lastApiRequest = null; + + for (const jsonStr of jsonObjects) { + try { + const logData = JSON.parse(jsonStr); + if ( + logData.attributes && + logData.attributes['event.name'] === 'gemini_cli.api_request' + ) { + lastApiRequest = logData; + } + } catch { + // ignore + } + } + return lastApiRequest; + } } diff --git a/integration-tests/tsconfig.json b/integration-tests/tsconfig.json index 3e053d04..295741e1 100644 --- a/integration-tests/tsconfig.json +++ b/integration-tests/tsconfig.json @@ -4,5 +4,6 @@ "noEmit": true, "allowJs": true }, - "include": ["**/*.ts"] + "include": ["**/*.ts"], + "references": [{ "path": "../packages/core" }] } diff --git a/package-lock.json b/package-lock.json index 146686dc..04f6787f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -11,7 +11,8 @@ "packages/*" ], "dependencies": { - "node-fetch": "^3.3.2", + "@lvce-editor/ripgrep": "^1.6.0", + "simple-git": "^3.28.0", "strip-ansi": "^7.1.0" }, "bin": { @@ -19,7 +20,6 @@ }, "devDependencies": { "@types/marked": "^5.0.2", - "@types/micromatch": "^4.0.9", "@types/mime-types": "^3.0.1", "@types/minimatch": "^5.1.2", "@types/mock-fs": "^4.13.4", @@ -27,6 +27,7 @@ "@types/shell-quote": "^1.7.5", "@types/uuid": "^10.0.0", "@vitest/coverage-v8": "^3.1.1", + "@vitest/eslint-plugin": "^1.3.4", "concurrently": "^9.2.0", "cross-env": "^7.0.3", "esbuild": "^0.25.0", @@ -65,16 +66,16 @@ } }, "node_modules/@alcalzone/ansi-tokenize": { - "version": "0.1.3", - "resolved": "https://registry.npmjs.org/@alcalzone/ansi-tokenize/-/ansi-tokenize-0.1.3.tgz", - "integrity": "sha512-3yWxPTq3UQ/FY9p1ErPxIyfT64elWaMvM9lIHnaqpyft63tkxodF5aUElYHrdisWve5cETkh1+KBw1yJuW0aRw==", + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/@alcalzone/ansi-tokenize/-/ansi-tokenize-0.2.0.tgz", + "integrity": "sha512-qI/5TaaaCZE4yeSZ83lu0+xi1r88JSxUjnH4OP/iZF7+KKZ75u3ee5isd0LxX+6N8U0npL61YrpbthILHB6BnA==", "license": "MIT", "dependencies": { "ansi-styles": "^6.2.1", - "is-fullwidth-code-point": "^4.0.0" + "is-fullwidth-code-point": "^5.0.0" }, "engines": { - "node": ">=14.13.1" + "node": ">=18" } }, "node_modules/@alcalzone/ansi-tokenize/node_modules/ansi-styles": { @@ -90,12 +91,15 @@ } }, "node_modules/@alcalzone/ansi-tokenize/node_modules/is-fullwidth-code-point": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-4.0.0.tgz", - "integrity": "sha512-O4L094N2/dZ7xqVdrXhh9r1KODPJpFms8B5sGdJLPy664AgvXsreZUyCQQNItZRDlYug4xStLjNp/sz3HvBowQ==", + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-5.0.0.tgz", + "integrity": "sha512-OVa3u9kkBbw7b8Xw5F9P+D/T9X+Z4+JruYVNapTjPYZYUznQ5YfWeFkOj606XYYW8yugTfC8Pj0hYqvi4ryAhA==", "license": "MIT", + "dependencies": { + "get-east-asian-width": "^1.0.0" + }, "engines": { - "node": ">=12" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -989,10 +993,14 @@ "node": "^18.18.0 || ^20.9.0 || >=21.1.0" } }, + "node_modules/@google/gemini-cli-test-utils": { + "resolved": "packages/test-utils", + "link": true + }, "node_modules/@google/genai": { - "version": "1.9.0", - "resolved": "https://registry.npmjs.org/@google/genai/-/genai-1.9.0.tgz", - "integrity": "sha512-w9P93OXKPMs9H1mfAx9+p3zJqQGrWBGdvK/SVc7cLZEXNHr/3+vW2eif7ZShA6wU24rNLn9z9MK2vQFUvNRI2Q==", + "version": "1.13.0", + "resolved": "https://registry.npmjs.org/@google/genai/-/genai-1.13.0.tgz", + "integrity": "sha512-BxilXzE8cJ0zt5/lXk6KwuBcIT9P2Lbi2WXhwWMbxf1RNeC68/8DmYQqMrzQP333CieRMdbDXs0eNCphLoScWg==", "license": "Apache-2.0", "dependencies": { "google-auth-library": "^9.14.2", @@ -1455,6 +1463,38 @@ "integrity": "sha512-GaHYm+c0O9MjZRu0ongGBRbinu8gVAMd2UZjji6jVmqKtZluZnptXGWhz1E8j8D2HJ3f/yMxKAUC0b+57wncIw==", "license": "MIT" }, + "node_modules/@lvce-editor/ripgrep": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/@lvce-editor/ripgrep/-/ripgrep-1.6.0.tgz", + "integrity": "sha512-880taWBVULNXmcPHXdxnFUI0FvLErBOjY9OigMXEsLZ2Q1rjcm6LixOkaccKWC8qFMpzm/ldkO7WOMK+ZRfk5Q==", + "hasInstallScript": true, + "license": "MIT", + "dependencies": { + "@lvce-editor/verror": "^1.6.0", + "execa": "^9.5.2", + "extract-zip": "^2.0.1", + "fs-extra": "^11.3.0", + "got": "^14.4.5", + "path-exists": "^5.0.0", + "tempy": "^3.1.0", + "xdg-basedir": "^5.1.0" + } + }, + "node_modules/@lvce-editor/ripgrep/node_modules/path-exists": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-5.0.0.tgz", + "integrity": "sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ==", + "license": "MIT", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + } + }, + "node_modules/@lvce-editor/verror": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/@lvce-editor/verror/-/verror-1.7.0.tgz", + "integrity": "sha512-+LGuAEIC2L7pbvkyAQVWM2Go0dAy+UWEui28g07zNtZsCBhm+gusBK8PNwLJLV5Jay+TyUYuwLIbJdjLLzqEBg==", + "license": "MIT" + }, "node_modules/@lydell/node-pty": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/@lydell/node-pty/-/node-pty-1.1.0.tgz", @@ -1571,6 +1611,224 @@ "node": ">=18" } }, + "node_modules/@modelcontextprotocol/sdk/node_modules/accepts": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/accepts/-/accepts-2.0.0.tgz", + "integrity": "sha512-5cvg6CtKwfgdmVqY1WIiXKc3Q1bkRqGLi+2W/6ao+6Y7gu/RCwRuAhGEzh5B4KlszSuTLgZYuqFqo5bImjNKng==", + "license": "MIT", + "dependencies": { + "mime-types": "^3.0.0", + "negotiator": "^1.0.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/@modelcontextprotocol/sdk/node_modules/body-parser": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-2.2.0.tgz", + "integrity": "sha512-02qvAaxv8tp7fBa/mw1ga98OGm+eCbqzJOKoRt70sLmfEEi+jyBYVTDGfCL/k06/4EMk/z01gCe7HoCH/f2LTg==", + "license": "MIT", + "dependencies": { + "bytes": "^3.1.2", + "content-type": "^1.0.5", + "debug": "^4.4.0", + "http-errors": "^2.0.0", + "iconv-lite": "^0.6.3", + "on-finished": "^2.4.1", + "qs": "^6.14.0", + "raw-body": "^3.0.0", + "type-is": "^2.0.0" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/@modelcontextprotocol/sdk/node_modules/content-disposition": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-1.0.0.tgz", + "integrity": "sha512-Au9nRL8VNUut/XSzbQA38+M78dzP4D+eqg3gfJHMIHHYa3bg067xj1KxMUWj+VULbiZMowKngFFbKczUrNJ1mg==", + "license": "MIT", + "dependencies": { + "safe-buffer": "5.2.1" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/@modelcontextprotocol/sdk/node_modules/cookie-signature": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.2.2.tgz", + "integrity": "sha512-D76uU73ulSXrD1UXF4KE2TMxVVwhsnCgfAyTg9k8P6KGZjlXKrOLe4dJQKI3Bxi5wjesZoFXJWElNWBjPZMbhg==", + "license": "MIT", + "engines": { + "node": ">=6.6.0" + } + }, + "node_modules/@modelcontextprotocol/sdk/node_modules/express": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/express/-/express-5.1.0.tgz", + "integrity": "sha512-DT9ck5YIRU+8GYzzU5kT3eHGA5iL+1Zd0EutOmTE9Dtk+Tvuzd23VBU+ec7HPNSTxXYO55gPV/hq4pSBJDjFpA==", + "license": "MIT", + "dependencies": { + "accepts": "^2.0.0", + "body-parser": "^2.2.0", + "content-disposition": "^1.0.0", + "content-type": "^1.0.5", + "cookie": "^0.7.1", + "cookie-signature": "^1.2.1", + "debug": "^4.4.0", + "encodeurl": "^2.0.0", + "escape-html": "^1.0.3", + "etag": "^1.8.1", + "finalhandler": "^2.1.0", + "fresh": "^2.0.0", + "http-errors": "^2.0.0", + "merge-descriptors": "^2.0.0", + "mime-types": "^3.0.0", + "on-finished": "^2.4.1", + "once": "^1.4.0", + "parseurl": "^1.3.3", + "proxy-addr": "^2.0.7", + "qs": "^6.14.0", + "range-parser": "^1.2.1", + "router": "^2.2.0", + "send": "^1.1.0", + "serve-static": "^2.2.0", + "statuses": "^2.0.1", + "type-is": "^2.0.1", + "vary": "^1.1.2" + }, + "engines": { + "node": ">= 18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/@modelcontextprotocol/sdk/node_modules/finalhandler": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-2.1.0.tgz", + "integrity": "sha512-/t88Ty3d5JWQbWYgaOGCCYfXRwV1+be02WqYYlL6h0lEiUAMPM8o8qKGO01YIkOHzka2up08wvgYD0mDiI+q3Q==", + "license": "MIT", + "dependencies": { + "debug": "^4.4.0", + "encodeurl": "^2.0.0", + "escape-html": "^1.0.3", + "on-finished": "^2.4.1", + "parseurl": "^1.3.3", + "statuses": "^2.0.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/@modelcontextprotocol/sdk/node_modules/fresh": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/fresh/-/fresh-2.0.0.tgz", + "integrity": "sha512-Rx/WycZ60HOaqLKAi6cHRKKI7zxWbJ31MhntmtwMoaTeF7XFH9hhBp8vITaMidfljRQ6eYWCKkaTK+ykVJHP2A==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/@modelcontextprotocol/sdk/node_modules/media-typer": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-1.1.0.tgz", + "integrity": "sha512-aisnrDP4GNe06UcKFnV5bfMNPBUw4jsLGaWwWfnH3v02GnBuXX2MCVn5RbrWo0j3pczUilYblq7fQ7Nw2t5XKw==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/@modelcontextprotocol/sdk/node_modules/merge-descriptors": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-2.0.0.tgz", + "integrity": "sha512-Snk314V5ayFLhp3fkUREub6WtjBfPdCPY1Ln8/8munuLuiYhsABgBVWsozAG+MWMbVEvcdcpbi9R7ww22l9Q3g==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/@modelcontextprotocol/sdk/node_modules/negotiator": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-1.0.0.tgz", + "integrity": "sha512-8Ofs/AUQh8MaEcrlq5xOX0CQ9ypTF5dl78mjlMNfOK08fzpgTHQRQPBxcPlEtIw0yRpws+Zo/3r+5WRby7u3Gg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/@modelcontextprotocol/sdk/node_modules/qs": { + "version": "6.14.0", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.14.0.tgz", + "integrity": "sha512-YWWTjgABSKcvs/nWBi9PycY/JiPJqOD4JA6o9Sej2AtvSGarXxKC3OQSk4pAarbdQlKAh5D4FCQkJNkW+GAn3w==", + "license": "BSD-3-Clause", + "dependencies": { + "side-channel": "^1.1.0" + }, + "engines": { + "node": ">=0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/@modelcontextprotocol/sdk/node_modules/send": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/send/-/send-1.2.0.tgz", + "integrity": "sha512-uaW0WwXKpL9blXE2o0bRhoL2EGXIrZxQ2ZQ4mgcfoBxdFmQold+qWsD2jLrfZ0trjKL6vOw0j//eAwcALFjKSw==", + "license": "MIT", + "dependencies": { + "debug": "^4.3.5", + "encodeurl": "^2.0.0", + "escape-html": "^1.0.3", + "etag": "^1.8.1", + "fresh": "^2.0.0", + "http-errors": "^2.0.0", + "mime-types": "^3.0.1", + "ms": "^2.1.3", + "on-finished": "^2.4.1", + "range-parser": "^1.2.1", + "statuses": "^2.0.1" + }, + "engines": { + "node": ">= 18" + } + }, + "node_modules/@modelcontextprotocol/sdk/node_modules/serve-static": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-2.2.0.tgz", + "integrity": "sha512-61g9pCh0Vnh7IutZjtLGGpTA355+OPn2TyDv/6ivP2h/AdAVX9azsoxmg2/M6nZeQZNYBEwIcsne1mJd9oQItQ==", + "license": "MIT", + "dependencies": { + "encodeurl": "^2.0.0", + "escape-html": "^1.0.3", + "parseurl": "^1.3.3", + "send": "^1.2.0" + }, + "engines": { + "node": ">= 18" + } + }, + "node_modules/@modelcontextprotocol/sdk/node_modules/type-is": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/type-is/-/type-is-2.0.1.tgz", + "integrity": "sha512-OZs6gsjF4vMp32qrCbiVSkrFmXtG/AZhY3t0iAMrMBiAZyV9oALtXO8hsrHbMXF9x6L3grlFuwW2oAz7cav+Gw==", + "license": "MIT", + "dependencies": { + "content-type": "^1.0.5", + "media-typer": "^1.1.0", + "mime-types": "^3.0.0" + }, + "engines": { + "node": ">= 0.6" + } + }, "node_modules/@mswjs/interceptors": { "version": "0.39.5", "resolved": "https://registry.npmjs.org/@mswjs/interceptors/-/interceptors-0.39.5.tgz", @@ -2577,6 +2835,12 @@ "dev": true, "license": "MIT" }, + "node_modules/@sec-ant/readable-stream": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/@sec-ant/readable-stream/-/readable-stream-0.4.1.tgz", + "integrity": "sha512-831qok9r2t8AlxLko40y2ebgSDhenenCatLVeW/uBtnHPyhHOvG0C7TvfgecV+wHzIm5KUICgzmVpWS+IMEAeg==", + "license": "MIT" + }, "node_modules/@selderee/plugin-htmlparser2": { "version": "0.11.0", "resolved": "https://registry.npmjs.org/@selderee/plugin-htmlparser2/-/plugin-htmlparser2-0.11.0.tgz", @@ -2597,6 +2861,42 @@ "dev": true, "license": "MIT" }, + "node_modules/@sindresorhus/is": { + "version": "7.0.2", + "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-7.0.2.tgz", + "integrity": "sha512-d9xRovfKNz1SKieM0qJdO+PQonjnnIfSNWfHYnBSJ9hkjm0ZPw6HlxscDXYstp3z+7V2GOFHc+J0CYrYTjqCJw==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sindresorhus/is?sponsor=1" + } + }, + "node_modules/@sindresorhus/merge-streams": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@sindresorhus/merge-streams/-/merge-streams-4.0.0.tgz", + "integrity": "sha512-tlqY9xq5ukxTUZBmoOp+m61cqwQD5pHJtFY3Mn8CA8ps6yghLH/Hw8UPdqg4OLmFW3IFlcXnQNmo/dh8HzXYIQ==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/@szmarczak/http-timer": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/@szmarczak/http-timer/-/http-timer-5.0.1.tgz", + "integrity": "sha512-+PmQX0PiAYPMeVYe237LJAYvOMYW1j2rH5YROyS3b4CTVJum34HfRvKvAzozHAQG0TnHNdUfY9nCeUyRAs//cw==", + "license": "MIT", + "dependencies": { + "defer-to-connect": "^2.0.1" + }, + "engines": { + "node": ">=14.16" + } + }, "node_modules/@types/aria-query": { "version": "5.0.4", "resolved": "https://registry.npmjs.org/@types/aria-query/-/aria-query-5.0.4.tgz", @@ -2616,13 +2916,6 @@ "@types/node": "*" } }, - "node_modules/@types/braces": { - "version": "3.0.5", - "resolved": "https://registry.npmjs.org/@types/braces/-/braces-3.0.5.tgz", - "integrity": "sha512-SQFof9H+LXeWNz8wDe7oN5zu7ket0qwMu5vZubW4GCJ8Kkeh6nBWUz87+KTz/G3Kqsrp0j/W253XJb3KMEeg3w==", - "dev": true, - "license": "MIT" - }, "node_modules/@types/chai": { "version": "5.2.2", "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.2.tgz", @@ -2729,6 +3022,13 @@ "@types/send": "*" } }, + "node_modules/@types/fast-levenshtein": { + "version": "0.0.4", + "resolved": "https://registry.npmjs.org/@types/fast-levenshtein/-/fast-levenshtein-0.0.4.tgz", + "integrity": "sha512-tkDveuitddQCxut1Db8eEFfMahTjOumTJGPHmT9E7KUH+DkVq9WTpVvlfenf3S+uCBeu8j5FP2xik/KfxOEjeA==", + "dev": true, + "license": "MIT" + }, "node_modules/@types/glob": { "version": "8.1.0", "resolved": "https://registry.npmjs.org/@types/glob/-/glob-8.1.0.tgz", @@ -2763,6 +3063,12 @@ "integrity": "sha512-pUY3cKH/Nm2yYrEmDlPR1mR7yszjGx4DrwPjQ702C4/D5CwHuZTgZdIdwPkRbcuhs7BAh2L5rg3CL5cbRiGTCQ==", "license": "MIT" }, + "node_modules/@types/http-cache-semantics": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/@types/http-cache-semantics/-/http-cache-semantics-4.0.4.tgz", + "integrity": "sha512-1m0bIFVc7eJWyve9S0RnuRgcQqF/Xd5QsUZAZeQFr1Q3/p9JWoQQEqmVy+DPTNpGXwhgIetAoYF8JSc33q29QA==", + "license": "MIT" + }, "node_modules/@types/http-errors": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/@types/http-errors/-/http-errors-2.0.5.tgz", @@ -2784,6 +3090,23 @@ "dev": true, "license": "MIT" }, + "node_modules/@types/lodash": { + "version": "4.17.20", + "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.20.tgz", + "integrity": "sha512-H3MHACvFUEiujabxhaI/ImO6gUrd8oOurg7LQtS7mbwIXA/cUqWrvBsaeJ23aZEPk1TAYkurjfMbSELfoCXlGA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/lodash-es": { + "version": "4.17.12", + "resolved": "https://registry.npmjs.org/@types/lodash-es/-/lodash-es-4.17.12.tgz", + "integrity": "sha512-0NgftHUcV4v34VhXm8QBSftKVXtbkBG3ViCjs6+eJ5a6y6Mi/jiFGPc1sC7QK+9BFhWrURE3EOggmWaSxL9OzQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/lodash": "*" + } + }, "node_modules/@types/marked": { "version": "5.0.2", "resolved": "https://registry.npmjs.org/@types/marked/-/marked-5.0.2.tgz", @@ -2791,16 +3114,6 @@ "dev": true, "license": "MIT" }, - "node_modules/@types/micromatch": { - "version": "4.0.9", - "resolved": "https://registry.npmjs.org/@types/micromatch/-/micromatch-4.0.9.tgz", - "integrity": "sha512-7V+8ncr22h4UoYRLnLXSpTxjQrNUXtWHGeMPRJt1nULXI57G9bIcpyrHlmrQ7QK24EyyuXvYcSSWAM8GA9nqCg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/braces": "*" - } - }, "node_modules/@types/mime": { "version": "1.3.5", "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.5.tgz", @@ -2971,7 +3284,8 @@ "version": "10.0.0", "resolved": "https://registry.npmjs.org/@types/uuid/-/uuid-10.0.0.tgz", "integrity": "sha512-7gqG38EyHgyP1S+7+xomFtL+ZNHcKv6DwNaCZmJmo1vgMugyF3TCnXVg4t1uk89mLNwnLtnY3TpOpCOyp1/xHQ==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/@types/ws": { "version": "8.18.1", @@ -3000,6 +3314,16 @@ "dev": true, "license": "MIT" }, + "node_modules/@types/yauzl": { + "version": "2.10.3", + "resolved": "https://registry.npmjs.org/@types/yauzl/-/yauzl-2.10.3.tgz", + "integrity": "sha512-oJoftv0LSuaDZE3Le4DbKX+KS9G36NzOeSap90UIK0yMA/NhKJhqlSGtNDORNRaIbQfzjXDrQa0ytJ6mNRGz/Q==", + "license": "MIT", + "optional": true, + "dependencies": { + "@types/node": "*" + } + }, "node_modules/@typescript-eslint/eslint-plugin": { "version": "8.35.0", "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.35.0.tgz", @@ -3304,6 +3628,29 @@ } } }, + "node_modules/@vitest/eslint-plugin": { + "version": "1.3.4", + "resolved": "https://registry.npmjs.org/@vitest/eslint-plugin/-/eslint-plugin-1.3.4.tgz", + "integrity": "sha512-EOg8d0jn3BAiKnR55WkFxmxfWA3nmzrbIIuOXyTe6A72duryNgyU+bdBEauA97Aab3ho9kLmAwgPX63Ckj4QEg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typescript-eslint/utils": "^8.24.1" + }, + "peerDependencies": { + "eslint": ">= 8.57.0", + "typescript": ">= 5.0.0", + "vitest": "*" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + }, + "vitest": { + "optional": true + } + } + }, "node_modules/@vitest/expect": { "version": "3.2.4", "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-3.2.4.tgz", @@ -3426,13 +3773,37 @@ "license": "MIT" }, "node_modules/accepts": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/accepts/-/accepts-2.0.0.tgz", - "integrity": "sha512-5cvg6CtKwfgdmVqY1WIiXKc3Q1bkRqGLi+2W/6ao+6Y7gu/RCwRuAhGEzh5B4KlszSuTLgZYuqFqo5bImjNKng==", + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz", + "integrity": "sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==", "license": "MIT", + "peer": true, "dependencies": { - "mime-types": "^3.0.0", - "negotiator": "^1.0.0" + "mime-types": "~2.1.34", + "negotiator": "0.6.3" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/accepts/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "license": "MIT", + "peer": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/accepts/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "license": "MIT", + "peer": true, + "dependencies": { + "mime-db": "1.52.0" }, "engines": { "node": ">= 0.6" @@ -3494,6 +3865,45 @@ "url": "https://github.com/sponsors/epoberezkin" } }, + "node_modules/ajv-formats": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/ajv-formats/-/ajv-formats-3.0.1.tgz", + "integrity": "sha512-8iUql50EUR+uUcdRQ3HDqa6EVyo3docL8g5WJ3FNcWmu62IbkGUue/pEyLBW8VGKKucTPgqeks4fIU1DA4yowQ==", + "license": "MIT", + "dependencies": { + "ajv": "^8.0.0" + }, + "peerDependencies": { + "ajv": "^8.0.0" + }, + "peerDependenciesMeta": { + "ajv": { + "optional": true + } + } + }, + "node_modules/ajv-formats/node_modules/ajv": { + "version": "8.17.1", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", + "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3", + "fast-uri": "^3.0.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ajv-formats/node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "license": "MIT" + }, "node_modules/ansi-align": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz", @@ -3610,6 +4020,13 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/array-flatten": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz", + "integrity": "sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg==", + "license": "MIT", + "peer": true + }, "node_modules/array-includes": { "version": "3.1.9", "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.9.tgz", @@ -3858,23 +4275,74 @@ } }, "node_modules/body-parser": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-2.2.0.tgz", - "integrity": "sha512-02qvAaxv8tp7fBa/mw1ga98OGm+eCbqzJOKoRt70sLmfEEi+jyBYVTDGfCL/k06/4EMk/z01gCe7HoCH/f2LTg==", + "version": "1.20.3", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.20.3.tgz", + "integrity": "sha512-7rAxByjUMqQ3/bHJy7D6OGXvx/MMc4IqBn/X0fcM1QUcAItpZrBEYhWGem+tzXH90c+G01ypMcYJBO9Y30203g==", "license": "MIT", + "peer": true, "dependencies": { - "bytes": "^3.1.2", - "content-type": "^1.0.5", - "debug": "^4.4.0", - "http-errors": "^2.0.0", - "iconv-lite": "^0.6.3", - "on-finished": "^2.4.1", - "qs": "^6.14.0", - "raw-body": "^3.0.0", - "type-is": "^2.0.0" + "bytes": "3.1.2", + "content-type": "~1.0.5", + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "1.2.0", + "http-errors": "2.0.0", + "iconv-lite": "0.4.24", + "on-finished": "2.4.1", + "qs": "6.13.0", + "raw-body": "2.5.2", + "type-is": "~1.6.18", + "unpipe": "1.0.0" }, "engines": { - "node": ">=18" + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, + "node_modules/body-parser/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "peer": true, + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/body-parser/node_modules/iconv-lite": { + "version": "0.4.24", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", + "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", + "license": "MIT", + "peer": true, + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/body-parser/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT", + "peer": true + }, + "node_modules/body-parser/node_modules/raw-body": { + "version": "2.5.2", + "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.5.2.tgz", + "integrity": "sha512-8zGqypfENjCIqGhgXToC8aB2r7YrBX+AQAfIPs/Mlk+BtPTztOvTS01NRW/3Eh60J+a48lt8qsCzirQ6loCVfA==", + "license": "MIT", + "peer": true, + "dependencies": { + "bytes": "3.1.2", + "http-errors": "2.0.0", + "iconv-lite": "0.4.24", + "unpipe": "1.0.0" + }, + "engines": { + "node": ">= 0.8" } }, "node_modules/boxen": { @@ -3926,6 +4394,7 @@ "version": "3.0.3", "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "dev": true, "license": "MIT", "dependencies": { "fill-range": "^7.1.1" @@ -3934,6 +4403,15 @@ "node": ">=8" } }, + "node_modules/buffer-crc32": { + "version": "0.2.13", + "resolved": "https://registry.npmjs.org/buffer-crc32/-/buffer-crc32-0.2.13.tgz", + "integrity": "sha512-VO9Ht/+p3SN7SKWqcrgEzjGbRSJYTx+Q1pTQC0wrWqHx0vpJraQ6GtHx8tvcg1rlK1byhU5gccxgOgj7B0TDkQ==", + "license": "MIT", + "engines": { + "node": "*" + } + }, "node_modules/buffer-equal-constant-time": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/buffer-equal-constant-time/-/buffer-equal-constant-time-1.0.1.tgz", @@ -3974,6 +4452,33 @@ "node": ">=8" } }, + "node_modules/cacheable-lookup": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-7.0.0.tgz", + "integrity": "sha512-+qJyx4xiKra8mZrcwhjMRMUhD5NR1R8esPkzIYxX96JiecFoxAXFuz/GpR3+ev4PE1WamHip78wV0vcmPQtp8w==", + "license": "MIT", + "engines": { + "node": ">=14.16" + } + }, + "node_modules/cacheable-request": { + "version": "12.0.1", + "resolved": "https://registry.npmjs.org/cacheable-request/-/cacheable-request-12.0.1.tgz", + "integrity": "sha512-Yo9wGIQUaAfIbk+qY0X4cDQgCosecfBe3V9NSyeY4qPC2SAkbCS4Xj79VP8WOzitpJUZKc/wsRCYF5ariDIwkg==", + "license": "MIT", + "dependencies": { + "@types/http-cache-semantics": "^4.0.4", + "get-stream": "^9.0.1", + "http-cache-semantics": "^4.1.1", + "keyv": "^4.5.4", + "mimic-response": "^4.0.0", + "normalize-url": "^8.0.1", + "responselike": "^3.0.0" + }, + "engines": { + "node": ">=18" + } + }, "node_modules/call-bind": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.8.tgz", @@ -4044,22 +4549,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/cfonts": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/cfonts/-/cfonts-3.3.0.tgz", - "integrity": "sha512-RlVxeEw2FXWI5Bs9LD0/Ef3bsQIc9m6lK/DINN20HIW0Y0YHUO2jjy88cot9YKZITiRTCdWzTfLmTyx47HeSLA==", - "license": "GPL-3.0-or-later", - "dependencies": { - "supports-color": "^8", - "window-size": "^1" - }, - "bin": { - "cfonts": "bin/index.js" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/chai": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/chai/-/chai-5.2.0.tgz", @@ -4431,10 +4920,11 @@ } }, "node_modules/content-disposition": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-1.0.0.tgz", - "integrity": "sha512-Au9nRL8VNUut/XSzbQA38+M78dzP4D+eqg3gfJHMIHHYa3bg067xj1KxMUWj+VULbiZMowKngFFbKczUrNJ1mg==", + "version": "0.5.4", + "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.4.tgz", + "integrity": "sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ==", "license": "MIT", + "peer": true, "dependencies": { "safe-buffer": "5.2.1" }, @@ -4470,13 +4960,11 @@ } }, "node_modules/cookie-signature": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.2.2.tgz", - "integrity": "sha512-D76uU73ulSXrD1UXF4KE2TMxVVwhsnCgfAyTg9k8P6KGZjlXKrOLe4dJQKI3Bxi5wjesZoFXJWElNWBjPZMbhg==", + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.0.6.tgz", + "integrity": "sha512-QADzlaHc8icV8I7vbaJXJwod9HWYp8uCqf1xa4OfNu1T7JVxQIrUgOWtHdNDtPiywmFbiS12VjotIXLrKM3orQ==", "license": "MIT", - "engines": { - "node": ">=6.6.0" - } + "peer": true }, "node_modules/cors": { "version": "2.8.5", @@ -4524,6 +5012,33 @@ "node": ">= 8" } }, + "node_modules/crypto-random-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/crypto-random-string/-/crypto-random-string-4.0.0.tgz", + "integrity": "sha512-x8dy3RnvYdlUcPOjkEHqozhiwzKNSq7GcPuXFbnyMOCHxX8V3OgIg/pYuabl2sbUPfIJaeAQB7PMOK8DFIdoRA==", + "license": "MIT", + "dependencies": { + "type-fest": "^1.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/crypto-random-string/node_modules/type-fest": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-1.4.0.tgz", + "integrity": "sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA==", + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/cssstyle": { "version": "4.6.0", "resolved": "https://registry.npmjs.org/cssstyle/-/cssstyle-4.6.0.tgz", @@ -4545,15 +5060,6 @@ "devOptional": true, "license": "MIT" }, - "node_modules/data-uri-to-buffer": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-4.0.1.tgz", - "integrity": "sha512-0R9ikRb668HB7QDxT1vkpuUBtqc53YyAwMwGeUFKRojY/NWKvdZ+9UYtRfGmhqNbRkTSVpMbmyhXipFFv2cb/A==", - "license": "MIT", - "engines": { - "node": ">= 12" - } - }, "node_modules/data-urls": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/data-urls/-/data-urls-5.0.0.tgz", @@ -4646,6 +5152,33 @@ "dev": true, "license": "MIT" }, + "node_modules/decompress-response": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/decompress-response/-/decompress-response-6.0.0.tgz", + "integrity": "sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ==", + "license": "MIT", + "dependencies": { + "mimic-response": "^3.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/decompress-response/node_modules/mimic-response": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-3.1.0.tgz", + "integrity": "sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/deep-eql": { "version": "5.0.2", "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-5.0.2.tgz", @@ -4709,6 +5242,15 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/defer-to-connect": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/defer-to-connect/-/defer-to-connect-2.0.1.tgz", + "integrity": "sha512-4tvttepXG1VaYGrRibk5EwJd1t4udunSOVMdLSAL6mId1ix438oPwPZMALY41FCijukO1L0twNcGsdzS7dHgDg==", + "license": "MIT", + "engines": { + "node": ">=10" + } + }, "node_modules/define-data-property": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", @@ -4757,18 +5299,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/define-property": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-1.0.0.tgz", - "integrity": "sha512-cZTYKFWspt9jZsMscWo8sc/5lbPC9Q0N5nBLgb+Yd915iL3udB1uFgS3B8YCx66UVHq018DAVFoee7x+gxggeA==", - "license": "MIT", - "dependencies": { - "is-descriptor": "^1.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/depd": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz", @@ -4787,6 +5317,17 @@ "node": ">=6" } }, + "node_modules/destroy": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.2.0.tgz", + "integrity": "sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg==", + "license": "MIT", + "peer": true, + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, "node_modules/devlop": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/devlop/-/devlop-1.1.0.tgz", @@ -4974,6 +5515,15 @@ "node": ">= 0.8" } }, + "node_modules/end-of-stream": { + "version": "1.4.5", + "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.5.tgz", + "integrity": "sha512-ooEGc6HP26xXq/N+GCGOT0JKCLDGrq2bQUZrQ7gyrJiZANJ/8YDTxTpQBXGMn+WbIQXNVpyWymm7KYVICQnyOg==", + "license": "MIT", + "dependencies": { + "once": "^1.4.0" + } + }, "node_modules/entities": { "version": "4.5.0", "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", @@ -5190,9 +5740,9 @@ } }, "node_modules/es-toolkit": { - "version": "1.39.5", - "resolved": "https://registry.npmjs.org/es-toolkit/-/es-toolkit-1.39.5.tgz", - "integrity": "sha512-z9V0qU4lx1TBXDNFWfAASWk6RNU6c6+TJBKE+FLIg8u0XJ6Yw58Hi0yX8ftEouj6p1QARRlXLFfHbIli93BdQQ==", + "version": "1.39.10", + "resolved": "https://registry.npmjs.org/es-toolkit/-/es-toolkit-1.39.10.tgz", + "integrity": "sha512-E0iGnTtbDhkeczB0T+mxmoVlT4YNweEKBLq7oaU4p11mecdsZpNWOglI4895Vh4usbQ+LsJiuLuI2L0Vdmfm2w==", "license": "MIT", "workspaces": [ "docs", @@ -5660,6 +6210,44 @@ "node": ">=20.0.0" } }, + "node_modules/execa": { + "version": "9.6.0", + "resolved": "https://registry.npmjs.org/execa/-/execa-9.6.0.tgz", + "integrity": "sha512-jpWzZ1ZhwUmeWRhS7Qv3mhpOhLfwI+uAX4e5fOcXqwMR7EcJ0pj2kV1CVzHVMX/LphnKWD3LObjZCoJ71lKpHw==", + "license": "MIT", + "dependencies": { + "@sindresorhus/merge-streams": "^4.0.0", + "cross-spawn": "^7.0.6", + "figures": "^6.1.0", + "get-stream": "^9.0.0", + "human-signals": "^8.0.1", + "is-plain-obj": "^4.1.0", + "is-stream": "^4.0.1", + "npm-run-path": "^6.0.0", + "pretty-ms": "^9.2.0", + "signal-exit": "^4.1.0", + "strip-final-newline": "^4.0.0", + "yoctocolors": "^2.1.1" + }, + "engines": { + "node": "^18.19.0 || >=20.5.0" + }, + "funding": { + "url": "https://github.com/sindresorhus/execa?sponsor=1" + } + }, + "node_modules/execa/node_modules/is-stream": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-4.0.1.tgz", + "integrity": "sha512-Dnz92NInDqYckGEUJv689RbRiTSEHCQ7wOVeALbkOz999YpqT46yMRIGtSNl2iCL1waAZSx40+h59NV/EwzV/A==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/expect-type": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.2.1.tgz", @@ -5671,41 +6259,46 @@ } }, "node_modules/express": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/express/-/express-5.1.0.tgz", - "integrity": "sha512-DT9ck5YIRU+8GYzzU5kT3eHGA5iL+1Zd0EutOmTE9Dtk+Tvuzd23VBU+ec7HPNSTxXYO55gPV/hq4pSBJDjFpA==", + "version": "4.21.2", + "resolved": "https://registry.npmjs.org/express/-/express-4.21.2.tgz", + "integrity": "sha512-28HqgMZAmih1Czt9ny7qr6ek2qddF4FclbMzwhCREB6OFfH+rXAnuNCwo1/wFvrtbgsQDb4kSbX9de9lFbrXnA==", "license": "MIT", + "peer": true, "dependencies": { - "accepts": "^2.0.0", - "body-parser": "^2.2.0", - "content-disposition": "^1.0.0", - "content-type": "^1.0.5", - "cookie": "^0.7.1", - "cookie-signature": "^1.2.1", - "debug": "^4.4.0", - "encodeurl": "^2.0.0", - "escape-html": "^1.0.3", - "etag": "^1.8.1", - "finalhandler": "^2.1.0", - "fresh": "^2.0.0", - "http-errors": "^2.0.0", - "merge-descriptors": "^2.0.0", - "mime-types": "^3.0.0", - "on-finished": "^2.4.1", - "once": "^1.4.0", - "parseurl": "^1.3.3", - "proxy-addr": "^2.0.7", - "qs": "^6.14.0", - "range-parser": "^1.2.1", - "router": "^2.2.0", - "send": "^1.1.0", - "serve-static": "^2.2.0", - "statuses": "^2.0.1", - "type-is": "^2.0.1", - "vary": "^1.1.2" + "accepts": "~1.3.8", + "array-flatten": "1.1.1", + "body-parser": "1.20.3", + "content-disposition": "0.5.4", + "content-type": "~1.0.4", + "cookie": "0.7.1", + "cookie-signature": "1.0.6", + "debug": "2.6.9", + "depd": "2.0.0", + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "finalhandler": "1.3.1", + "fresh": "0.5.2", + "http-errors": "2.0.0", + "merge-descriptors": "1.0.3", + "methods": "~1.1.2", + "on-finished": "2.4.1", + "parseurl": "~1.3.3", + "path-to-regexp": "0.1.12", + "proxy-addr": "~2.0.7", + "qs": "6.13.0", + "range-parser": "~1.2.1", + "safe-buffer": "5.2.1", + "send": "0.19.0", + "serve-static": "1.16.2", + "setprototypeof": "1.2.0", + "statuses": "2.0.1", + "type-is": "~1.6.18", + "utils-merge": "1.0.1", + "vary": "~1.1.2" }, "engines": { - "node": ">= 18" + "node": ">= 0.10.0" }, "funding": { "type": "opencollective", @@ -5727,12 +6320,84 @@ "express": ">= 4.11" } }, + "node_modules/express/node_modules/cookie": { + "version": "0.7.1", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.7.1.tgz", + "integrity": "sha512-6DnInpx7SJ2AK3+CTUE/ZM0vWTUboZCegxhC2xiIydHR9jNuTAASBrfEpHhiGOZw/nX51bHt6YQl8jsGo4y/0w==", + "license": "MIT", + "peer": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/express/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "peer": true, + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/express/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT", + "peer": true + }, + "node_modules/express/node_modules/statuses": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.1.tgz", + "integrity": "sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==", + "license": "MIT", + "peer": true, + "engines": { + "node": ">= 0.8" + } + }, "node_modules/extend": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", "license": "MIT" }, + "node_modules/extract-zip": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/extract-zip/-/extract-zip-2.0.1.tgz", + "integrity": "sha512-GDhU9ntwuKyGXdZBUgTIe+vXnWj0fppUEtMDL0+idd5Sta8TGpHssn/eusA9mrPr9qNDym6SxAYZjNvCn/9RBg==", + "license": "BSD-2-Clause", + "dependencies": { + "debug": "^4.1.1", + "get-stream": "^5.1.0", + "yauzl": "^2.10.0" + }, + "bin": { + "extract-zip": "cli.js" + }, + "engines": { + "node": ">= 10.17.0" + }, + "optionalDependencies": { + "@types/yauzl": "^2.9.1" + } + }, + "node_modules/extract-zip/node_modules/get-stream": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-5.2.0.tgz", + "integrity": "sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA==", + "license": "MIT", + "dependencies": { + "pump": "^3.0.0" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/fast-deep-equal": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", @@ -5779,7 +6444,6 @@ "version": "2.0.6", "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==", - "dev": true, "license": "MIT" }, "node_modules/fast-uri": { @@ -5808,27 +6472,13 @@ "reusify": "^1.0.4" } }, - "node_modules/fetch-blob": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/fetch-blob/-/fetch-blob-3.2.0.tgz", - "integrity": "sha512-7yAQpD2UMJzLi1Dqv7qFYnPbaPx7ZfFK6PiIxQ4PfkGPyNyl2Ugx+a/umUonmKqjhM4DnfbMvdX6otXq83soQQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/jimmywarting" - }, - { - "type": "paypal", - "url": "https://paypal.me/jimmywarting" - } - ], + "node_modules/fd-slicer": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/fd-slicer/-/fd-slicer-1.1.0.tgz", + "integrity": "sha512-cE1qsB/VwyQozZ+q1dGxR8LBYNZeofhEdUNGSMbQD3Gw2lAzX9Zb3uIU6Ebc/Fmyjo9AWWfnn0AUCHqtevs/8g==", "license": "MIT", "dependencies": { - "node-domexception": "^1.0.0", - "web-streams-polyfill": "^3.0.3" - }, - "engines": { - "node": "^12.20 || >= 14.13" + "pend": "~1.2.0" } }, "node_modules/figures": { @@ -5863,6 +6513,7 @@ "version": "7.1.1", "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "dev": true, "license": "MIT", "dependencies": { "to-regex-range": "^5.0.1" @@ -5872,22 +6523,51 @@ } }, "node_modules/finalhandler": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-2.1.0.tgz", - "integrity": "sha512-/t88Ty3d5JWQbWYgaOGCCYfXRwV1+be02WqYYlL6h0lEiUAMPM8o8qKGO01YIkOHzka2up08wvgYD0mDiI+q3Q==", + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.3.1.tgz", + "integrity": "sha512-6BN9trH7bp3qvnrRyzsBz+g3lZxTNZTbVO2EV1CS0WIcDbawYVdYvGflME/9QP0h0pYlCDBCTjYa9nZzMDpyxQ==", "license": "MIT", + "peer": true, "dependencies": { - "debug": "^4.4.0", - "encodeurl": "^2.0.0", - "escape-html": "^1.0.3", - "on-finished": "^2.4.1", - "parseurl": "^1.3.3", - "statuses": "^2.0.1" + "debug": "2.6.9", + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "on-finished": "2.4.1", + "parseurl": "~1.3.3", + "statuses": "2.0.1", + "unpipe": "~1.0.0" }, "engines": { "node": ">= 0.8" } }, + "node_modules/finalhandler/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "peer": true, + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/finalhandler/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT", + "peer": true + }, + "node_modules/finalhandler/node_modules/statuses": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.1.tgz", + "integrity": "sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==", + "license": "MIT", + "peer": true, + "engines": { + "node": ">= 0.8" + } + }, "node_modules/find-up": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", @@ -5970,16 +6650,13 @@ "url": "https://github.com/sponsors/isaacs" } }, - "node_modules/formdata-polyfill": { - "version": "4.0.10", - "resolved": "https://registry.npmjs.org/formdata-polyfill/-/formdata-polyfill-4.0.10.tgz", - "integrity": "sha512-buewHzMvYL29jdeQTVILecSaZKnt/RJWjoZCF5OW60Z67/GmSLBkOFM7qh1PI3zFNtJbaZL5eQu1vLfazOwj4g==", + "node_modules/form-data-encoder": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/form-data-encoder/-/form-data-encoder-4.1.0.tgz", + "integrity": "sha512-G6NsmEW15s0Uw9XnCg+33H3ViYRyiM0hMrMhhqQOR8NFc5GhYrI+6I3u7OTw7b91J2g8rtvMBZJDbcGb2YUniw==", "license": "MIT", - "dependencies": { - "fetch-blob": "^3.1.2" - }, "engines": { - "node": ">=12.20.0" + "node": ">= 18" } }, "node_modules/forwarded": { @@ -5998,12 +6675,36 @@ "license": "MIT" }, "node_modules/fresh": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/fresh/-/fresh-2.0.0.tgz", - "integrity": "sha512-Rx/WycZ60HOaqLKAi6cHRKKI7zxWbJ31MhntmtwMoaTeF7XFH9hhBp8vITaMidfljRQ6eYWCKkaTK+ykVJHP2A==", + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", + "integrity": "sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q==", + "license": "MIT", + "peer": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/fs-extra": { + "version": "11.3.1", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.3.1.tgz", + "integrity": "sha512-eXvGGwZ5CL17ZSwHWd3bbgk7UUpF6IFHtP57NYYakPvHOs8GDgDe5KJI36jIJzDkJ6eJjuzRA8eBQb6SkKue0g==", + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, + "engines": { + "node": ">=14.14" + } + }, + "node_modules/fs-extra/node_modules/universalify": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", + "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", "license": "MIT", "engines": { - "node": ">= 0.8" + "node": ">= 10.0.0" } }, "node_modules/fsevents": { @@ -6067,21 +6768,7 @@ "integrity": "sha512-Tt4kuxLXFKHy8KT40zwsUPUkg1CrsgY25FxA2U/j/0WgEDCk3ddc/zLTCCcbSHX9FcKtLuVaDGtGE/STWC+j3Q==", "license": "BSD-3-Clause" }, - "node_modules/gcp-metadata": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/gcp-metadata/-/gcp-metadata-6.1.1.tgz", - "integrity": "sha512-a4tiq7E0/5fTjxPAaH4jpjkSv/uCaU2p5KC6HVGrvl0cDjA8iBZv4vv1gyzlmK0ZUKqwpOyQMKzZQe3lTit77A==", - "license": "Apache-2.0", - "dependencies": { - "gaxios": "^6.1.1", - "google-logging-utils": "^0.0.2", - "json-bigint": "^1.0.0" - }, - "engines": { - "node": ">=14" - } - }, - "node_modules/gcp-metadata/node_modules/gaxios": { + "node_modules/gaxios": { "version": "6.7.1", "resolved": "https://registry.npmjs.org/gaxios/-/gaxios-6.7.1.tgz", "integrity": "sha512-LDODD4TMYx7XXdpwxAVRAIAuB0bzv0s+ywFonY46k126qzQHT9ygyoa9tncmOiQmmDrik65UYsEkv3lbfqQ3yQ==", @@ -6097,46 +6784,18 @@ "node": ">=14" } }, - "node_modules/gcp-metadata/node_modules/node-fetch": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", - "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", - "license": "MIT", + "node_modules/gcp-metadata": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/gcp-metadata/-/gcp-metadata-6.1.1.tgz", + "integrity": "sha512-a4tiq7E0/5fTjxPAaH4jpjkSv/uCaU2p5KC6HVGrvl0cDjA8iBZv4vv1gyzlmK0ZUKqwpOyQMKzZQe3lTit77A==", + "license": "Apache-2.0", "dependencies": { - "whatwg-url": "^5.0.0" + "gaxios": "^6.1.1", + "google-logging-utils": "^0.0.2", + "json-bigint": "^1.0.0" }, "engines": { - "node": "4.x || >=6.0.0" - }, - "peerDependencies": { - "encoding": "^0.1.0" - }, - "peerDependenciesMeta": { - "encoding": { - "optional": true - } - } - }, - "node_modules/gcp-metadata/node_modules/tr46": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", - "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==", - "license": "MIT" - }, - "node_modules/gcp-metadata/node_modules/webidl-conversions": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", - "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==", - "license": "BSD-2-Clause" - }, - "node_modules/gcp-metadata/node_modules/whatwg-url": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", - "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==", - "license": "MIT", - "dependencies": { - "tr46": "~0.0.3", - "webidl-conversions": "^3.0.0" + "node": ">=14" } }, "node_modules/get-caller-file": { @@ -6197,6 +6856,34 @@ "node": ">= 0.4" } }, + "node_modules/get-stream": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-9.0.1.tgz", + "integrity": "sha512-kVCxPF3vQM/N0B1PmoqVUqgHP+EeVjmZSQn+1oCRPxd2P21P2F19lIgbR3HBosbB1PUhOAoctJnfEn2GbN2eZA==", + "license": "MIT", + "dependencies": { + "@sec-ant/readable-stream": "^0.4.1", + "is-stream": "^4.0.1" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/get-stream/node_modules/is-stream": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-4.0.1.tgz", + "integrity": "sha512-Dnz92NInDqYckGEUJv689RbRiTSEHCQ7wOVeALbkOz999YpqT46yMRIGtSNl2iCL1waAZSx40+h59NV/EwzV/A==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/get-symbol-description": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.1.0.tgz", @@ -6347,64 +7034,6 @@ "node": ">=14" } }, - "node_modules/google-auth-library/node_modules/gaxios": { - "version": "6.7.1", - "resolved": "https://registry.npmjs.org/gaxios/-/gaxios-6.7.1.tgz", - "integrity": "sha512-LDODD4TMYx7XXdpwxAVRAIAuB0bzv0s+ywFonY46k126qzQHT9ygyoa9tncmOiQmmDrik65UYsEkv3lbfqQ3yQ==", - "license": "Apache-2.0", - "dependencies": { - "extend": "^3.0.2", - "https-proxy-agent": "^7.0.1", - "is-stream": "^2.0.0", - "node-fetch": "^2.6.9", - "uuid": "^9.0.1" - }, - "engines": { - "node": ">=14" - } - }, - "node_modules/google-auth-library/node_modules/node-fetch": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", - "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", - "license": "MIT", - "dependencies": { - "whatwg-url": "^5.0.0" - }, - "engines": { - "node": "4.x || >=6.0.0" - }, - "peerDependencies": { - "encoding": "^0.1.0" - }, - "peerDependenciesMeta": { - "encoding": { - "optional": true - } - } - }, - "node_modules/google-auth-library/node_modules/tr46": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", - "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==", - "license": "MIT" - }, - "node_modules/google-auth-library/node_modules/webidl-conversions": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", - "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==", - "license": "BSD-2-Clause" - }, - "node_modules/google-auth-library/node_modules/whatwg-url": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", - "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==", - "license": "MIT", - "dependencies": { - "tr46": "~0.0.3", - "webidl-conversions": "^3.0.0" - } - }, "node_modules/google-logging-utils": { "version": "0.0.2", "resolved": "https://registry.npmjs.org/google-logging-utils/-/google-logging-utils-0.0.2.tgz", @@ -6426,6 +7055,43 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/got": { + "version": "14.4.7", + "resolved": "https://registry.npmjs.org/got/-/got-14.4.7.tgz", + "integrity": "sha512-DI8zV1231tqiGzOiOzQWDhsBmncFW7oQDH6Zgy6pDPrqJuVZMtoSgPLLsBZQj8Jg4JFfwoOsDA8NGtLQLnIx2g==", + "license": "MIT", + "dependencies": { + "@sindresorhus/is": "^7.0.1", + "@szmarczak/http-timer": "^5.0.1", + "cacheable-lookup": "^7.0.0", + "cacheable-request": "^12.0.1", + "decompress-response": "^6.0.0", + "form-data-encoder": "^4.0.2", + "http2-wrapper": "^2.2.1", + "lowercase-keys": "^3.0.0", + "p-cancelable": "^4.0.1", + "responselike": "^3.0.0", + "type-fest": "^4.26.1" + }, + "engines": { + "node": ">=20" + }, + "funding": { + "url": "https://github.com/sindresorhus/got?sponsor=1" + } + }, + "node_modules/got/node_modules/type-fest": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.41.0.tgz", + "integrity": "sha512-TeTSQ6H5YHvpqVwBRcnLDCBnDOHWYu7IvGbHT6N8AOymcr9PJGjc1GTtiWZTYg0NCgYwvnYWEkVChQAr9bjfwA==", + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/graceful-fs": { "version": "4.2.11", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", @@ -6475,64 +7141,6 @@ "node": ">=14.0.0" } }, - "node_modules/gtoken/node_modules/gaxios": { - "version": "6.7.1", - "resolved": "https://registry.npmjs.org/gaxios/-/gaxios-6.7.1.tgz", - "integrity": "sha512-LDODD4TMYx7XXdpwxAVRAIAuB0bzv0s+ywFonY46k126qzQHT9ygyoa9tncmOiQmmDrik65UYsEkv3lbfqQ3yQ==", - "license": "Apache-2.0", - "dependencies": { - "extend": "^3.0.2", - "https-proxy-agent": "^7.0.1", - "is-stream": "^2.0.0", - "node-fetch": "^2.6.9", - "uuid": "^9.0.1" - }, - "engines": { - "node": ">=14" - } - }, - "node_modules/gtoken/node_modules/node-fetch": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", - "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", - "license": "MIT", - "dependencies": { - "whatwg-url": "^5.0.0" - }, - "engines": { - "node": "4.x || >=6.0.0" - }, - "peerDependencies": { - "encoding": "^0.1.0" - }, - "peerDependenciesMeta": { - "encoding": { - "optional": true - } - } - }, - "node_modules/gtoken/node_modules/tr46": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", - "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==", - "license": "MIT" - }, - "node_modules/gtoken/node_modules/webidl-conversions": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", - "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==", - "license": "BSD-2-Clause" - }, - "node_modules/gtoken/node_modules/whatwg-url": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", - "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==", - "license": "MIT", - "dependencies": { - "tr46": "~0.0.3", - "webidl-conversions": "^3.0.0" - } - }, "node_modules/has-bigints": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.1.0.tgz", @@ -6707,6 +7315,12 @@ "entities": "^4.4.0" } }, + "node_modules/http-cache-semantics": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.2.0.tgz", + "integrity": "sha512-dTxcvPXqPvXBQpq5dUr6mEMJX4oIEFv6bwom3FDwKRDsuIjjJGANqhBuoAn9c1RQJIdAKav33ED65E2ys+87QQ==", + "license": "BSD-2-Clause" + }, "node_modules/http-errors": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.0.tgz", @@ -6746,6 +7360,19 @@ "node": ">= 14" } }, + "node_modules/http2-wrapper": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/http2-wrapper/-/http2-wrapper-2.2.1.tgz", + "integrity": "sha512-V5nVw1PAOgfI3Lmeaj2Exmeg7fenjhRUgz1lPSezy1CuhPYbgQtbQj4jZfEAEMlaL+vupsvhjqCyjzob0yxsmQ==", + "license": "MIT", + "dependencies": { + "quick-lru": "^5.1.1", + "resolve-alpn": "^1.2.0" + }, + "engines": { + "node": ">=10.19.0" + } + }, "node_modules/https-proxy-agent": { "version": "7.0.6", "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz", @@ -6759,6 +7386,15 @@ "node": ">= 14" } }, + "node_modules/human-signals": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-8.0.1.tgz", + "integrity": "sha512-eKCa6bwnJhvxj14kZk5NCPc6Hb6BdsU9DZcOnmQKSnO1VKrfV0zCvtttPZUsBvjmNDn8rpcJfpwSYnHBjc95MQ==", + "license": "Apache-2.0", + "engines": { + "node": ">=18.18.0" + } + }, "node_modules/hyperdyperid": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/hyperdyperid/-/hyperdyperid-1.2.0.tgz", @@ -6870,26 +7506,25 @@ } }, "node_modules/ink": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/ink/-/ink-6.1.1.tgz", - "integrity": "sha512-Bqw78FX+1TSIGxs6bdvohgoy6mTfqjFJVNyYzXn8HIyZyVmwLX8XdnhUtUwyaelLCqLz8uuFseCbomRZWjyo5g==", + "version": "6.2.3", + "resolved": "https://registry.npmjs.org/ink/-/ink-6.2.3.tgz", + "integrity": "sha512-fQkfEJjKbLXIcVWEE3MvpYSnwtbbmRsmeNDNz1pIuOFlwE+UF2gsy228J36OXKZGWJWZJKUigphBSqCNMcARtg==", "license": "MIT", "dependencies": { - "@alcalzone/ansi-tokenize": "^0.1.3", + "@alcalzone/ansi-tokenize": "^0.2.0", "ansi-escapes": "^7.0.0", "ansi-styles": "^6.2.1", "auto-bind": "^5.0.1", - "chalk": "^5.3.0", + "chalk": "^5.6.0", "cli-boxes": "^3.0.0", "cli-cursor": "^4.0.0", "cli-truncate": "^4.0.0", "code-excerpt": "^4.0.0", - "es-toolkit": "^1.22.0", + "es-toolkit": "^1.39.10", "indent-string": "^5.0.0", - "is-in-ci": "^1.0.0", + "is-in-ci": "^2.0.0", "patch-console": "^2.0.0", "react-reconciler": "^0.32.0", - "scheduler": "^0.23.0", "signal-exit": "^3.0.7", "slice-ansi": "^7.1.0", "stack-utils": "^2.0.6", @@ -6917,26 +7552,6 @@ } } }, - "node_modules/ink-big-text": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ink-big-text/-/ink-big-text-2.0.0.tgz", - "integrity": "sha512-Juzqv+rIOLGuhMJiE50VtS6dg6olWfzFdL7wsU/EARSL5Eaa5JNXMogMBm9AkjgzO2Y3UwWCOh87jbhSn8aNdw==", - "license": "MIT", - "dependencies": { - "cfonts": "^3.1.1", - "prop-types": "^15.8.1" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - }, - "peerDependencies": { - "ink": ">=4", - "react": ">=18" - } - }, "node_modules/ink-gradient": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/ink-gradient/-/ink-gradient-3.0.0.tgz", @@ -6977,23 +7592,6 @@ "ink": ">=4" } }, - "node_modules/ink-select-input": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/ink-select-input/-/ink-select-input-6.2.0.tgz", - "integrity": "sha512-304fZXxkpYxJ9si5lxRCaX01GNlmPBgOZumXXRnPYbHW/iI31cgQynqk2tRypGLOF1cMIwPUzL2LSm6q4I5rQQ==", - "license": "MIT", - "dependencies": { - "figures": "^6.1.0", - "to-rotated": "^1.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "ink": ">=5.0.0", - "react": ">=18.0.0" - } - }, "node_modules/ink-spinner": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/ink-spinner/-/ink-spinner-5.0.0.tgz", @@ -7041,9 +7639,9 @@ } }, "node_modules/ink/node_modules/chalk": { - "version": "5.4.1", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.4.1.tgz", - "integrity": "sha512-zgVZuo2WcZgfUEmsn6eO3kINexW8RAE4maiQ8QNs8CtpPCSyMiYsULR3HQYkm3w8FIA3SberyMJMSldGsW+U3w==", + "version": "5.6.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.6.0.tgz", + "integrity": "sha512-46QrSQFyVSEyYAgQ22hQ+zDa60YHA4fBstHmtSApj1Y5vKtG27fWowW03jCk5KcbXEWPZUIR894aARCA/G1kfQ==", "license": "MIT", "engines": { "node": "^12.17.0 || ^14.13 || >=16.0.0" @@ -7058,6 +7656,21 @@ "integrity": "sha512-EC+0oUMY1Rqm4O6LLrgjtYDvcVYTy7chDnM4Q7030tP4Kwj3u/pR6gP9ygnp2CJMK5Gq+9Q2oqmrFJAz01DXjw==", "license": "MIT" }, + "node_modules/ink/node_modules/is-in-ci": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-in-ci/-/is-in-ci-2.0.0.tgz", + "integrity": "sha512-cFeerHriAnhrQSbpAxL37W1wcJKUUX07HyLWZCW1URJT/ra3GyUTzBgUnh24TMVfNTV2Hij2HLxkPHFZfOZy5w==", + "license": "MIT", + "bin": { + "is-in-ci": "cli.js" + }, + "engines": { + "node": ">=20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/ink/node_modules/signal-exit": { "version": "3.0.7", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", @@ -7149,18 +7762,6 @@ "node": ">= 0.10" } }, - "node_modules/is-accessor-descriptor": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-1.0.1.tgz", - "integrity": "sha512-YBUanLI8Yoihw923YeFUS5fs0fF2f5TSFTNiYAAzhhDscDa3lEqYuz1pDOEP5KvX94I9ey3vsqjJcLVFVU+3QA==", - "license": "MIT", - "dependencies": { - "hasown": "^2.0.0" - }, - "engines": { - "node": ">= 0.10" - } - }, "node_modules/is-array-buffer": { "version": "3.0.5", "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.5.tgz", @@ -7239,12 +7840,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-buffer": { - "version": "1.1.6", - "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-1.1.6.tgz", - "integrity": "sha512-NcdALwpXkTm5Zvvbk7owOUSvVvBKDgKP5/ewfXEznmQFfs4ZRmanOeKBTjRVjka3QFoN6XJ+9F3USqfHqTaU5w==", - "license": "MIT" - }, "node_modules/is-callable": { "version": "1.2.7", "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", @@ -7273,18 +7868,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-data-descriptor": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-1.0.1.tgz", - "integrity": "sha512-bc4NlCDiCr28U4aEsQ3Qs2491gVq4V8G7MQyws968ImqjKuYtTJXrl7Vq7jsN7Ly/C3xj5KWFrY7sHNeDkAzXw==", - "license": "MIT", - "dependencies": { - "hasown": "^2.0.0" - }, - "engines": { - "node": ">= 0.4" - } - }, "node_modules/is-data-view": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-data-view/-/is-data-view-1.0.2.tgz", @@ -7320,19 +7903,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-descriptor": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-1.0.3.tgz", - "integrity": "sha512-JCNNGbwWZEVaSPtS45mdtrneRWJFp07LLmykxeFV5F6oBvNF8vHSfJuJgoT472pSfk+Mf8VnlrspaFBHWM8JAw==", - "license": "MIT", - "dependencies": { - "is-accessor-descriptor": "^1.0.1", - "is-data-descriptor": "^1.0.1" - }, - "engines": { - "node": ">= 0.4" - } - }, "node_modules/is-docker": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-3.0.0.tgz", @@ -7513,6 +8083,7 @@ "version": "7.0.0", "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true, "license": "MIT", "engines": { "node": ">=0.12.0" @@ -7547,6 +8118,18 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/is-plain-obj": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-4.1.0.tgz", + "integrity": "sha512-+Pgi+vMuUNkJyExiMBt5IlFoMyKnr5zhJ4Uspz58WOhBF5QoIZkFyNHIbBAtHwzVAgk5RtndVNsDRN61/mmDqg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/is-potential-custom-element-name": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/is-potential-custom-element-name/-/is-potential-custom-element-name-1.0.1.tgz", @@ -7942,7 +8525,6 @@ "version": "3.0.1", "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", - "dev": true, "license": "MIT" }, "node_modules/json-parse-better-errors": { @@ -7978,6 +8560,27 @@ "json5": "lib/cli.js" } }, + "node_modules/jsonfile": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.0.tgz", + "integrity": "sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg==", + "license": "MIT", + "dependencies": { + "universalify": "^2.0.0" + }, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, + "node_modules/jsonfile/node_modules/universalify": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", + "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", + "license": "MIT", + "engines": { + "node": ">= 10.0.0" + } + }, "node_modules/jsonrepair": { "version": "3.13.0", "resolved": "https://registry.npmjs.org/jsonrepair/-/jsonrepair-3.13.0.tgz", @@ -8028,24 +8631,11 @@ "version": "4.5.4", "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", - "dev": true, "license": "MIT", "dependencies": { "json-buffer": "3.0.1" } }, - "node_modules/kind-of": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", - "integrity": "sha512-NOW9QQXMoZGg/oqnVNoNTTIFEIid1627WCffUBJEdMxYApq7mNE7CpzucIPc+ZQg25Phej7IJSmX3hO+oblOtQ==", - "license": "MIT", - "dependencies": { - "is-buffer": "^1.1.5" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/ky": { "version": "1.8.1", "resolved": "https://registry.npmjs.org/ky/-/ky-1.8.1.tgz", @@ -8149,6 +8739,12 @@ "dev": true, "license": "MIT" }, + "node_modules/lodash-es": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash-es/-/lodash-es-4.17.21.tgz", + "integrity": "sha512-mKnC+QJ9pWVzv+C4/U3rRsHapFfHvQFoFB92e52xeyGMcX6/OlIl78je1u8vePzYZSkkogMPJ2yjxxsb89cxyw==", + "license": "MIT" + }, "node_modules/lodash.camelcase": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/lodash.camelcase/-/lodash.camelcase-4.3.0.tgz", @@ -8193,6 +8789,18 @@ "dev": true, "license": "MIT" }, + "node_modules/lowercase-keys": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-3.0.0.tgz", + "integrity": "sha512-ozCC6gdQ+glXOQsveKD0YsDy8DSQFjDTz4zyzEHNV5+JP5D62LmfDZ6o1cycFx9ouG940M5dE8C8CTewdj2YWQ==", + "license": "MIT", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/lowlight": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/lowlight/-/lowlight-3.3.0.tgz", @@ -8298,12 +8906,13 @@ } }, "node_modules/media-typer": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-1.1.0.tgz", - "integrity": "sha512-aisnrDP4GNe06UcKFnV5bfMNPBUw4jsLGaWwWfnH3v02GnBuXX2MCVn5RbrWo0j3pczUilYblq7fQ7Nw2t5XKw==", + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", + "integrity": "sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==", "license": "MIT", + "peer": true, "engines": { - "node": ">= 0.8" + "node": ">= 0.6" } }, "node_modules/memfs": { @@ -8336,13 +8945,11 @@ } }, "node_modules/merge-descriptors": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-2.0.0.tgz", - "integrity": "sha512-Snk314V5ayFLhp3fkUREub6WtjBfPdCPY1Ln8/8munuLuiYhsABgBVWsozAG+MWMbVEvcdcpbi9R7ww22l9Q3g==", + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.3.tgz", + "integrity": "sha512-gaNvAS7TZ897/rVaZ0nMtAyxNyi/pdbjbAwUpFQpN70GqnVfOiXpeUUMKRBmzXaSQ8DdTX4/0ms62r2K+hE6mQ==", "license": "MIT", - "engines": { - "node": ">=18" - }, + "peer": true, "funding": { "url": "https://github.com/sponsors/sindresorhus" } @@ -8357,10 +8964,21 @@ "node": ">= 8" } }, + "node_modules/methods": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz", + "integrity": "sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w==", + "license": "MIT", + "peer": true, + "engines": { + "node": ">= 0.6" + } + }, "node_modules/micromatch": { "version": "4.0.8", "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", + "dev": true, "license": "MIT", "dependencies": { "braces": "^3.0.3", @@ -8400,6 +9018,18 @@ "node": ">=6" } }, + "node_modules/mimic-response": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-4.0.0.tgz", + "integrity": "sha512-e5ISH9xMYU0DzrT+jl8q2ze9D6eWBto+I8CNpe+VI+K2J/F/k3PdkdTdz4wvGVH4NTpo+NRYTVIuMQEMMcsLqg==", + "license": "MIT", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/minimatch": { "version": "3.1.2", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", @@ -8571,10 +9201,11 @@ "license": "MIT" }, "node_modules/negotiator": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-1.0.0.tgz", - "integrity": "sha512-8Ofs/AUQh8MaEcrlq5xOX0CQ9ypTF5dl78mjlMNfOK08fzpgTHQRQPBxcPlEtIw0yRpws+Zo/3r+5WRby7u3Gg==", + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz", + "integrity": "sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==", "license": "MIT", + "peer": true, "engines": { "node": ">= 0.6" } @@ -8586,42 +9217,46 @@ "dev": true, "license": "MIT" }, - "node_modules/node-domexception": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/node-domexception/-/node-domexception-1.0.0.tgz", - "integrity": "sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ==", - "deprecated": "Use your platform's native DOMException instead", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/jimmywarting" - }, - { - "type": "github", - "url": "https://paypal.me/jimmywarting" - } - ], - "license": "MIT", - "engines": { - "node": ">=10.5.0" - } - }, "node_modules/node-fetch": { - "version": "3.3.2", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.3.2.tgz", - "integrity": "sha512-dRB78srN/l6gqWulah9SrxeYnxeddIG30+GOqK/9OlLVyLg3HPnr6SqOWTWOXKRwC2eGYCkZ59NNuSgvSrpgOA==", + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", "license": "MIT", "dependencies": { - "data-uri-to-buffer": "^4.0.0", - "fetch-blob": "^3.1.4", - "formdata-polyfill": "^4.0.10" + "whatwg-url": "^5.0.0" }, "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + "node": "4.x || >=6.0.0" }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/node-fetch" + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } + } + }, + "node_modules/node-fetch/node_modules/tr46": { + "version": "0.0.3", + "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", + "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==", + "license": "MIT" + }, + "node_modules/node-fetch/node_modules/webidl-conversions": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", + "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==", + "license": "BSD-2-Clause" + }, + "node_modules/node-fetch/node_modules/whatwg-url": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", + "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==", + "license": "MIT", + "dependencies": { + "tr46": "~0.0.3", + "webidl-conversions": "^3.0.0" } }, "node_modules/node-pty": { @@ -8661,6 +9296,18 @@ "node": ">=10" } }, + "node_modules/normalize-url": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-8.0.2.tgz", + "integrity": "sha512-Ee/R3SyN4BuynXcnTaekmaVdbDAEiNrHqjQIA37mHU8G9pf7aaAD4ZX3XjBLo6rsdcxA/gtkcNYZLt30ACgynw==", + "license": "MIT", + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/npm-run-all": { "version": "4.1.5", "resolved": "https://registry.npmjs.org/npm-run-all/-/npm-run-all-4.1.5.tgz", @@ -8873,6 +9520,46 @@ "which": "bin/which" } }, + "node_modules/npm-run-path": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-6.0.0.tgz", + "integrity": "sha512-9qny7Z9DsQU8Ou39ERsPU4OZQlSTP47ShQzuKZ6PRXpYLtIFgl/DEBYEXKlvcEa+9tHVcK8CF81Y2V72qaZhWA==", + "license": "MIT", + "dependencies": { + "path-key": "^4.0.0", + "unicorn-magic": "^0.3.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/npm-run-path/node_modules/path-key": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-4.0.0.tgz", + "integrity": "sha512-haREypq7xkM7ErfgIyA0z+Bj4AGKlMSdlQE2jvJo6huWD1EdkKYV+G/T4nq0YEF2vgTT8kqMFKo1uHn950r4SQ==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/npm-run-path/node_modules/unicorn-magic": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/unicorn-magic/-/unicorn-magic-0.3.0.tgz", + "integrity": "sha512-+QBBXBCvifc56fsbuxZQ6Sic3wqqc3WWaqxs58gvJrcOuN83HGTCwz3oS5phzU9LthRNE9VrJCFCLUgHeeFnfA==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/nwsapi": { "version": "2.2.20", "resolved": "https://registry.npmjs.org/nwsapi/-/nwsapi-2.2.20.tgz", @@ -9061,6 +9748,27 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/openai": { + "version": "5.11.0", + "resolved": "https://registry.npmjs.org/openai/-/openai-5.11.0.tgz", + "integrity": "sha512-+AuTc5pVjlnTuA9zvn8rA/k+1RluPIx9AD4eDcnutv6JNwHHZxIhkFy+tmMKCvmMFDQzfA/r1ujvPWB19DQkYg==", + "license": "Apache-2.0", + "bin": { + "openai": "bin/cli" + }, + "peerDependencies": { + "ws": "^8.18.0", + "zod": "^3.23.8" + }, + "peerDependenciesMeta": { + "ws": { + "optional": true + }, + "zod": { + "optional": true + } + } + }, "node_modules/optionator": { "version": "0.9.4", "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.4.tgz", @@ -9104,6 +9812,15 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/p-cancelable": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/p-cancelable/-/p-cancelable-4.0.1.tgz", + "integrity": "sha512-wBowNApzd45EIKdO1LaU+LrMBwAcjfPaYtVzV3lmfM3gf8Z4CHZsiIqlM8TZZ8okYvh5A1cP6gTfCRQtwUpaUg==", + "license": "MIT", + "engines": { + "node": ">=14.16" + } + }, "node_modules/p-limit": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", @@ -9214,6 +9931,18 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/parse-ms": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/parse-ms/-/parse-ms-4.0.0.tgz", + "integrity": "sha512-TXfryirbmq34y8QBwgqCVLi+8oA3oWx2eAnSn62ITyEhEYaWRlVZ2DvMM9eZbMs/RfxPu/PK/aBLyGj4IrqMHw==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/parse5": { "version": "7.3.0", "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.3.0.tgz", @@ -9313,13 +10042,11 @@ } }, "node_modules/path-to-regexp": { - "version": "8.2.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-8.2.0.tgz", - "integrity": "sha512-TdrF7fW9Rphjq4RjrW0Kp2AW0Ahwu9sRGTkS6bvDi0SCwZlEZYmcfDbEsTz8RVk0EHIS/Vd1bv3JhG+1xZuAyQ==", + "version": "0.1.12", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.12.tgz", + "integrity": "sha512-RA1GjUVMnvYFxuqovrEqZoxxW5NUZqbwKtYz/Tt7nXerk0LbLblQmrsgdeOxV5SFHf0UDggjS/bSeOZwt1pmEQ==", "license": "MIT", - "engines": { - "node": ">=16" - } + "peer": true }, "node_modules/path-type": { "version": "3.0.0", @@ -9360,6 +10087,12 @@ "url": "https://ko-fi.com/killymxi" } }, + "node_modules/pend": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/pend/-/pend-1.2.0.tgz", + "integrity": "sha512-F3asv42UuXchdzt+xXqfW1OGlVBe+mxa2mqI0pg5yAHZPvFmY3Y6drSf/GQ1A86WgWEN9Kzh/WrgKa6iGcHXLg==", + "license": "MIT" + }, "node_modules/picocolors": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", @@ -9370,6 +10103,7 @@ "version": "2.3.1", "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "dev": true, "license": "MIT", "engines": { "node": ">=8.6" @@ -9510,6 +10244,21 @@ "dev": true, "license": "MIT" }, + "node_modules/pretty-ms": { + "version": "9.2.0", + "resolved": "https://registry.npmjs.org/pretty-ms/-/pretty-ms-9.2.0.tgz", + "integrity": "sha512-4yf0QO/sllf/1zbZWYnvWw3NxCQwLXKzIj0G849LSufP15BXKM0rbD2Z3wVnkMfjdn/CB0Dpp444gYAACdsplg==", + "license": "MIT", + "dependencies": { + "parse-ms": "^4.0.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/prop-types": { "version": "15.8.1", "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz", @@ -9577,6 +10326,16 @@ "url": "https://github.com/sponsors/lupomontero" } }, + "node_modules/pump": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.3.tgz", + "integrity": "sha512-todwxLMY7/heScKmntwQG8CXVkWUOdYxIvY2s0VWAAMh/nd8SoYiRaKjlr7+iCs984f2P8zvrfWcDDYVb73NfA==", + "license": "MIT", + "dependencies": { + "end-of-stream": "^1.1.0", + "once": "^1.3.1" + } + }, "node_modules/punycode": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", @@ -9610,12 +10369,13 @@ } }, "node_modules/qs": { - "version": "6.14.0", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.14.0.tgz", - "integrity": "sha512-YWWTjgABSKcvs/nWBi9PycY/JiPJqOD4JA6o9Sej2AtvSGarXxKC3OQSk4pAarbdQlKAh5D4FCQkJNkW+GAn3w==", + "version": "6.13.0", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.13.0.tgz", + "integrity": "sha512-+38qI9SOr8tfZ4QmJNplMUxqjbe7LKvvZgWdExBOmd+egZTtjLB67Gu0HRX3u/XOq7UU2Nx6nsjvS16Z9uwfpg==", "license": "BSD-3-Clause", + "peer": true, "dependencies": { - "side-channel": "^1.1.0" + "side-channel": "^1.0.6" }, "engines": { "node": ">=0.6" @@ -9652,6 +10412,18 @@ ], "license": "MIT" }, + "node_modules/quick-lru": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/quick-lru/-/quick-lru-5.1.1.tgz", + "integrity": "sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/qwen-code-vscode-ide-companion": { "resolved": "packages/vscode-ide-companion", "link": true @@ -9765,13 +10537,6 @@ "react": "^19.1.0" } }, - "node_modules/react-dom/node_modules/scheduler": { - "version": "0.26.0", - "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.26.0.tgz", - "integrity": "sha512-NlHwttCI/l5gCPR3D1nNXtWABUmBwvZpEQiD4IXSbIDq8BzLIK/7Ir5gTFSGZDUu37K5cMNp0hFtzO38sC7gWA==", - "dev": true, - "license": "MIT" - }, "node_modules/react-is": { "version": "16.13.1", "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", @@ -9793,12 +10558,6 @@ "react": "^19.1.0" } }, - "node_modules/react-reconciler/node_modules/scheduler": { - "version": "0.26.0", - "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.26.0.tgz", - "integrity": "sha512-NlHwttCI/l5gCPR3D1nNXtWABUmBwvZpEQiD4IXSbIDq8BzLIK/7Ir5gTFSGZDUu37K5cMNp0hFtzO38sC7gWA==", - "license": "MIT" - }, "node_modules/read-package-up": { "version": "11.0.0", "resolved": "https://registry.npmjs.org/read-package-up/-/read-package-up-11.0.0.tgz", @@ -9999,6 +10758,12 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/resolve-alpn": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/resolve-alpn/-/resolve-alpn-1.2.1.tgz", + "integrity": "sha512-0a1F4l73/ZFZOakJnQ3FvkJ2+gSTQWz/r2KE5OdDY0TxPm5h4GkqkWWfM47T7HsbnOtcJVEF4epCVy6u7Q3K+g==", + "license": "MIT" + }, "node_modules/resolve-from": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", @@ -10019,6 +10784,21 @@ "url": "https://github.com/privatenumber/resolve-pkg-maps?sponsor=1" } }, + "node_modules/responselike": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/responselike/-/responselike-3.0.0.tgz", + "integrity": "sha512-40yHxbNcl2+rzXvZuVkrYohathsSJlMTXKryG5y8uciHv1+xDLHQpgjG64JUO9nrEq2jGLH6IZ8BcZyw3wrweg==", + "license": "MIT", + "dependencies": { + "lowercase-keys": "^3.0.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/restore-cursor": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-4.0.0.tgz", @@ -10108,6 +10888,15 @@ "node": ">= 18" } }, + "node_modules/router/node_modules/path-to-regexp": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-8.2.0.tgz", + "integrity": "sha512-TdrF7fW9Rphjq4RjrW0Kp2AW0Ahwu9sRGTkS6bvDi0SCwZlEZYmcfDbEsTz8RVk0EHIS/Vd1bv3JhG+1xZuAyQ==", + "license": "MIT", + "engines": { + "node": ">=16" + } + }, "node_modules/rrweb-cssom": { "version": "0.8.0", "resolved": "https://registry.npmjs.org/rrweb-cssom/-/rrweb-cssom-0.8.0.tgz", @@ -10256,13 +11045,10 @@ } }, "node_modules/scheduler": { - "version": "0.23.2", - "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.23.2.tgz", - "integrity": "sha512-UOShsPwz7NrMUqhR6t0hWjFduvOzbtv7toDH1/hIrfRNIDBnnBWd0CwJTGvTpngVlmwGCdP9/Zl/tVrDqcuYzQ==", - "license": "MIT", - "dependencies": { - "loose-envify": "^1.1.0" - } + "version": "0.26.0", + "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.26.0.tgz", + "integrity": "sha512-NlHwttCI/l5gCPR3D1nNXtWABUmBwvZpEQiD4IXSbIDq8BzLIK/7Ir5gTFSGZDUu37K5cMNp0hFtzO38sC7gWA==", + "license": "MIT" }, "node_modules/selderee": { "version": "0.11.0", @@ -10287,40 +11073,94 @@ } }, "node_modules/send": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/send/-/send-1.2.0.tgz", - "integrity": "sha512-uaW0WwXKpL9blXE2o0bRhoL2EGXIrZxQ2ZQ4mgcfoBxdFmQold+qWsD2jLrfZ0trjKL6vOw0j//eAwcALFjKSw==", + "version": "0.19.0", + "resolved": "https://registry.npmjs.org/send/-/send-0.19.0.tgz", + "integrity": "sha512-dW41u5VfLXu8SJh5bwRmyYUbAoSB3c9uQh6L8h/KtsFREPWpbX1lrljJo186Jc4nmci/sGUZ9a0a0J2zgfq2hw==", "license": "MIT", + "peer": true, "dependencies": { - "debug": "^4.3.5", - "encodeurl": "^2.0.0", - "escape-html": "^1.0.3", - "etag": "^1.8.1", - "fresh": "^2.0.0", - "http-errors": "^2.0.0", - "mime-types": "^3.0.1", - "ms": "^2.1.3", - "on-finished": "^2.4.1", - "range-parser": "^1.2.1", - "statuses": "^2.0.1" + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "1.2.0", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "fresh": "0.5.2", + "http-errors": "2.0.0", + "mime": "1.6.0", + "ms": "2.1.3", + "on-finished": "2.4.1", + "range-parser": "~1.2.1", + "statuses": "2.0.1" }, "engines": { - "node": ">= 18" + "node": ">= 0.8.0" + } + }, + "node_modules/send/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "peer": true, + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/send/node_modules/debug/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT", + "peer": true + }, + "node_modules/send/node_modules/encodeurl": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-1.0.2.tgz", + "integrity": "sha512-TPJXq8JqFaVYm2CWmPvnP2Iyo4ZSM7/QKcSmuMLDObfpH5fi7RUGmd/rTDf+rut/saiDiQEeVTNgAmJEdAOx0w==", + "license": "MIT", + "peer": true, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/send/node_modules/mime": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", + "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==", + "license": "MIT", + "peer": true, + "bin": { + "mime": "cli.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/send/node_modules/statuses": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.1.tgz", + "integrity": "sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==", + "license": "MIT", + "peer": true, + "engines": { + "node": ">= 0.8" } }, "node_modules/serve-static": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-2.2.0.tgz", - "integrity": "sha512-61g9pCh0Vnh7IutZjtLGGpTA355+OPn2TyDv/6ivP2h/AdAVX9azsoxmg2/M6nZeQZNYBEwIcsne1mJd9oQItQ==", + "version": "1.16.2", + "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.16.2.tgz", + "integrity": "sha512-VqpjJZKadQB/PEbEwvFdO43Ax5dFBZ2UECszz8bQ7pi7wt//PWe1P6MN7eCnjsatYtBT6EuiClbjSWP2WrIoTw==", "license": "MIT", + "peer": true, "dependencies": { - "encodeurl": "^2.0.0", - "escape-html": "^1.0.3", - "parseurl": "^1.3.3", - "send": "^1.2.0" + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "parseurl": "~1.3.3", + "send": "0.19.0" }, "engines": { - "node": ">= 18" + "node": ">= 0.8.0" } }, "node_modules/set-function-length": { @@ -10890,6 +11730,18 @@ "node": ">=4" } }, + "node_modules/strip-final-newline": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-4.0.0.tgz", + "integrity": "sha512-aulFJcD6YK8V1G7iRB5tigAP4TsHBZZrOV8pjV++zdUwmeV8uzbY7yn6h9MswN62adStNZFuCIx4haBnRuMDaw==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/strip-json-comments": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", @@ -10924,6 +11776,7 @@ "version": "8.1.1", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", + "dev": true, "license": "MIT", "dependencies": { "has-flag": "^4.0.0" @@ -10979,6 +11832,45 @@ "dev": true, "license": "MIT" }, + "node_modules/temp-dir": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/temp-dir/-/temp-dir-3.0.0.tgz", + "integrity": "sha512-nHc6S/bwIilKHNRgK/3jlhDoIHcp45YgyiwcAk46Tr0LfEqGBVpmiAyuiuxeVE44m3mXnEeVhaipLOEWmH+Njw==", + "license": "MIT", + "engines": { + "node": ">=14.16" + } + }, + "node_modules/tempy": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/tempy/-/tempy-3.1.0.tgz", + "integrity": "sha512-7jDLIdD2Zp0bDe5r3D2qtkd1QOCacylBuL7oa4udvN6v2pqr4+LcCr67C8DR1zkpaZ8XosF5m1yQSabKAW6f2g==", + "license": "MIT", + "dependencies": { + "is-stream": "^3.0.0", + "temp-dir": "^3.0.0", + "type-fest": "^2.12.2", + "unique-string": "^3.0.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/tempy/node_modules/is-stream": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-3.0.0.tgz", + "integrity": "sha512-LnQR4bZ9IADDRSkvpqMGvt/tEJWclzklNgSw48V5EAaAeDd6qGvN8ei6k5p0tvxSR171VmGyHuTiAOfxAbr8kA==", + "license": "MIT", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/terminal-link": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/terminal-link/-/terminal-link-3.0.0.tgz", @@ -11211,6 +12103,7 @@ "version": "5.0.1", "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, "license": "MIT", "dependencies": { "is-number": "^7.0.0" @@ -11219,18 +12112,6 @@ "node": ">=8.0" } }, - "node_modules/to-rotated": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/to-rotated/-/to-rotated-1.0.0.tgz", - "integrity": "sha512-KsEID8AfgUy+pxVRLsWp0VzCa69wxzUDZnzGbyIST/bcgcrMvTYoFBX/QORH4YApoD89EDuUovx4BTdpOn319Q==", - "license": "MIT", - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/toidentifier": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz", @@ -11372,14 +12253,37 @@ } }, "node_modules/type-is": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/type-is/-/type-is-2.0.1.tgz", - "integrity": "sha512-OZs6gsjF4vMp32qrCbiVSkrFmXtG/AZhY3t0iAMrMBiAZyV9oALtXO8hsrHbMXF9x6L3grlFuwW2oAz7cav+Gw==", + "version": "1.6.18", + "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz", + "integrity": "sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==", "license": "MIT", + "peer": true, "dependencies": { - "content-type": "^1.0.5", - "media-typer": "^1.1.0", - "mime-types": "^3.0.0" + "media-typer": "0.3.0", + "mime-types": "~2.1.24" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/type-is/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "license": "MIT", + "peer": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/type-is/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "license": "MIT", + "peer": true, + "dependencies": { + "mime-db": "1.52.0" }, "engines": { "node": ">= 0.6" @@ -11546,6 +12450,21 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/unique-string": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-3.0.0.tgz", + "integrity": "sha512-VGXBUVwxKMBUznyffQweQABPRRW1vHZAbadFZud4pLFAqRGvv/96vafgjWFqzourzr8YonlQiPgH0YCJfawoGQ==", + "license": "MIT", + "dependencies": { + "crypto-random-string": "^4.0.0" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/universalify": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.2.0.tgz", @@ -11746,6 +12665,16 @@ "requires-port": "^1.0.0" } }, + "node_modules/utils-merge": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/utils-merge/-/utils-merge-1.0.1.tgz", + "integrity": "sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA==", + "license": "MIT", + "peer": true, + "engines": { + "node": ">= 0.4.0" + } + }, "node_modules/uuid": { "version": "9.0.1", "resolved": "https://registry.npmjs.org/uuid/-/uuid-9.0.1.tgz", @@ -12003,15 +12932,6 @@ "node": ">=18" } }, - "node_modules/web-streams-polyfill": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/web-streams-polyfill/-/web-streams-polyfill-3.3.3.tgz", - "integrity": "sha512-d2JWLCivmZYTSIoge9MsgFCZrt571BikcWGYkjC1khllbTeDlGqZ2D8vD8E/lJa8WGWbb7Plm8/XJYV7IJHZZw==", - "license": "MIT", - "engines": { - "node": ">= 8" - } - }, "node_modules/webidl-conversions": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-7.0.0.tgz", @@ -12201,34 +13121,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/window-size": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/window-size/-/window-size-1.1.1.tgz", - "integrity": "sha512-5D/9vujkmVQ7pSmc0SCBmHXbkv6eaHwXEx65MywhmUMsI8sGqJ972APq1lotfcwMKPFLuCFfL8xGHLIp7jaBmA==", - "license": "MIT", - "dependencies": { - "define-property": "^1.0.0", - "is-number": "^3.0.0" - }, - "bin": { - "window-size": "cli.js" - }, - "engines": { - "node": ">= 0.10.0" - } - }, - "node_modules/window-size/node_modules/is-number": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-3.0.0.tgz", - "integrity": "sha512-4cboCqIpliH+mAvFNegjZQ4kgKc3ZUhQVr3HvWbSh5q3WH2v82ct+T2Y1hdU5Gdtorx/cLifQjqCbL7bpznLTg==", - "license": "MIT", - "dependencies": { - "kind-of": "^3.0.2" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/word-wrap": { "version": "1.2.5", "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz", @@ -12460,6 +13352,16 @@ "node": ">=8" } }, + "node_modules/yauzl": { + "version": "2.10.0", + "resolved": "https://registry.npmjs.org/yauzl/-/yauzl-2.10.0.tgz", + "integrity": "sha512-p4a9I6X6nu6IhoGmBqAcbJy1mlC4j27vEPZX9F4L4/vZT3Lyq1VkFHw/V/PUcB9Buo+DG3iHkT0x3Qya58zc3g==", + "license": "MIT", + "dependencies": { + "buffer-crc32": "~0.2.3", + "fd-slicer": "~1.1.0" + } + }, "node_modules/yocto-queue": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", @@ -12473,6 +13375,18 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/yoctocolors": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/yoctocolors/-/yoctocolors-2.1.1.tgz", + "integrity": "sha512-GQHQqAopRhwU8Kt1DDM8NjibDXHC8eoh1erhGAJPEyveY9qqVeXvVikNKrDz69sHowPMorbPUrH/mx8c50eiBQ==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/yoctocolors-cjs": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/yoctocolors-cjs/-/yoctocolors-cjs-2.1.2.tgz", @@ -12510,6 +13424,34 @@ "zod": "^3.24.1" } }, + "packages/a2a-server": { + "name": "@google/gemini-cli-a2a-server", + "version": "0.3.4", + "extraneous": true, + "dependencies": { + "@a2a-js/sdk": "^0.3.2", + "@google-cloud/storage": "^7.16.0", + "@google/gemini-cli-core": "file:../core", + "express": "^5.1.0", + "fs-extra": "^11.3.0", + "tar": "^7.4.3", + "uuid": "^11.1.0", + "winston": "^3.17.0" + }, + "devDependencies": { + "@types/express": "^5.0.3", + "@types/fs-extra": "^11.0.4", + "@types/supertest": "^6.0.3", + "@types/tar": "^6.1.13", + "dotenv": "^16.4.5", + "supertest": "^7.1.4", + "typescript": "^5.3.3", + "vitest": "^3.1.1" + }, + "engines": { + "node": ">=20" + } + }, "packages/cli": { "name": "@qwen-code/qwen-code", "version": "0.0.11", @@ -12522,14 +13464,14 @@ "command-exists": "^1.2.9", "diff": "^7.0.0", "dotenv": "^17.1.0", + "fzf": "^0.5.2", "glob": "^10.4.1", "highlight.js": "^11.11.1", - "ink": "^6.1.1", - "ink-big-text": "^2.0.0", + "ink": "^6.2.3", "ink-gradient": "^3.0.0", "ink-link": "^4.1.0", - "ink-select-input": "^6.2.0", "ink-spinner": "^5.0.0", + "lodash-es": "^4.17.21", "lowlight": "^3.3.0", "mime-types": "^3.0.1", "open": "^10.1.2", @@ -12537,6 +13479,7 @@ "react": "^19.1.0", "read-package-up": "^11.0.0", "shell-quote": "^1.8.3", + "simple-git": "^3.28.0", "string-width": "^7.1.0", "strip-ansi": "^7.1.0", "strip-json-comments": "^3.1.1", @@ -12550,11 +13493,13 @@ }, "devDependencies": { "@babel/runtime": "^7.27.6", + "@google/gemini-cli-test-utils": "file:../test-utils", "@qwen-code/qwen-code-test-utils": "file:../test-utils", "@testing-library/react": "^16.3.0", "@types/command-exists": "^1.2.3", "@types/diff": "^7.0.2", "@types/dotenv": "^6.1.1", + "@types/lodash-es": "^4.17.12", "@types/node": "^20.11.24", "@types/react": "^19.1.8", "@types/react-dom": "^19.1.6", @@ -12572,6 +13517,27 @@ "node": ">=20" } }, + "packages/cli/node_modules/@google/genai": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/@google/genai/-/genai-1.9.0.tgz", + "integrity": "sha512-w9P93OXKPMs9H1mfAx9+p3zJqQGrWBGdvK/SVc7cLZEXNHr/3+vW2eif7ZShA6wU24rNLn9z9MK2vQFUvNRI2Q==", + "license": "Apache-2.0", + "dependencies": { + "google-auth-library": "^9.14.2", + "ws": "^8.18.0" + }, + "engines": { + "node": ">=20.0.0" + }, + "peerDependencies": { + "@modelcontextprotocol/sdk": "^1.11.0" + }, + "peerDependenciesMeta": { + "@modelcontextprotocol/sdk": { + "optional": true + } + } + }, "packages/cli/node_modules/@testing-library/dom": { "version": "10.4.0", "dev": true, @@ -12699,6 +13665,7 @@ "version": "0.0.11", "dependencies": { "@google/genai": "1.13.0", + "@lvce-editor/ripgrep": "^1.6.0", "@modelcontextprotocol/sdk": "^1.11.0", "@opentelemetry/api": "^1.9.0", "@opentelemetry/exporter-logs-otlp-grpc": "^0.203.0", @@ -12713,9 +13680,12 @@ "@types/html-to-text": "^9.0.4", "@xterm/headless": "5.5.0", "ajv": "^8.17.1", + "ajv-formats": "^3.0.0", "chardet": "^2.1.0", "diff": "^7.0.0", "dotenv": "^17.1.0", + "fast-levenshtein": "^2.0.6", + "fast-uri": "^3.0.6", "fdir": "^6.4.6", "fzf": "^0.5.2", "glob": "^10.4.5", @@ -12725,7 +13695,6 @@ "ignore": "^7.0.0", "jsonrepair": "^3.13.0", "marked": "^15.0.12", - "micromatch": "^4.0.8", "mnemonist": "^0.40.3", "open": "^10.1.2", "openai": "5.11.0", @@ -12742,7 +13711,7 @@ "@qwen-code/qwen-code-test-utils": "file:../test-utils", "@types/diff": "^7.0.2", "@types/dotenv": "^6.1.1", - "@types/micromatch": "^4.0.8", + "@types/fast-levenshtein": "^0.0.4", "@types/minimatch": "^5.1.2", "@types/picomatch": "^4.0.1", "@types/ws": "^8.5.10", @@ -12762,27 +13731,6 @@ "node-pty": "^1.0.0" } }, - "packages/core/node_modules/@google/genai": { - "version": "1.13.0", - "resolved": "https://registry.npmjs.org/@google/genai/-/genai-1.13.0.tgz", - "integrity": "sha512-BxilXzE8cJ0zt5/lXk6KwuBcIT9P2Lbi2WXhwWMbxf1RNeC68/8DmYQqMrzQP333CieRMdbDXs0eNCphLoScWg==", - "license": "Apache-2.0", - "dependencies": { - "google-auth-library": "^9.14.2", - "ws": "^8.18.0" - }, - "engines": { - "node": ">=20.0.0" - }, - "peerDependencies": { - "@modelcontextprotocol/sdk": "^1.11.0" - }, - "peerDependenciesMeta": { - "@modelcontextprotocol/sdk": { - "optional": true - } - } - }, "packages/core/node_modules/ajv": { "version": "8.17.1", "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", @@ -12826,27 +13774,6 @@ "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", "license": "MIT" }, - "packages/core/node_modules/openai": { - "version": "5.11.0", - "resolved": "https://registry.npmjs.org/openai/-/openai-5.11.0.tgz", - "integrity": "sha512-+AuTc5pVjlnTuA9zvn8rA/k+1RluPIx9AD4eDcnutv6JNwHHZxIhkFy+tmMKCvmMFDQzfA/r1ujvPWB19DQkYg==", - "license": "Apache-2.0", - "bin": { - "openai": "bin/cli" - }, - "peerDependencies": { - "ws": "^8.18.0", - "zod": "^3.23.8" - }, - "peerDependenciesMeta": { - "ws": { - "optional": true - }, - "zod": { - "optional": true - } - } - }, "packages/core/node_modules/picomatch": { "version": "4.0.3", "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", @@ -12862,6 +13789,7 @@ "packages/test-utils": { "name": "@qwen-code/qwen-code-test-utils", "version": "0.0.11", + "dev": true, "license": "Apache-2.0", "devDependencies": { "typescript": "^5.3.3" @@ -12903,6 +13831,224 @@ "integrity": "sha512-30sjmas1hQ0gVbX68LAWlm/YYlEqUErunPJJKLpEl+xhK0mKn+jyzlCOpsdTwfkZfPy4U6CDkmygBLC3AB8W9Q==", "dev": true, "license": "MIT" + }, + "packages/vscode-ide-companion/node_modules/accepts": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/accepts/-/accepts-2.0.0.tgz", + "integrity": "sha512-5cvg6CtKwfgdmVqY1WIiXKc3Q1bkRqGLi+2W/6ao+6Y7gu/RCwRuAhGEzh5B4KlszSuTLgZYuqFqo5bImjNKng==", + "license": "MIT", + "dependencies": { + "mime-types": "^3.0.0", + "negotiator": "^1.0.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "packages/vscode-ide-companion/node_modules/body-parser": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-2.2.0.tgz", + "integrity": "sha512-02qvAaxv8tp7fBa/mw1ga98OGm+eCbqzJOKoRt70sLmfEEi+jyBYVTDGfCL/k06/4EMk/z01gCe7HoCH/f2LTg==", + "license": "MIT", + "dependencies": { + "bytes": "^3.1.2", + "content-type": "^1.0.5", + "debug": "^4.4.0", + "http-errors": "^2.0.0", + "iconv-lite": "^0.6.3", + "on-finished": "^2.4.1", + "qs": "^6.14.0", + "raw-body": "^3.0.0", + "type-is": "^2.0.0" + }, + "engines": { + "node": ">=18" + } + }, + "packages/vscode-ide-companion/node_modules/content-disposition": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-1.0.0.tgz", + "integrity": "sha512-Au9nRL8VNUut/XSzbQA38+M78dzP4D+eqg3gfJHMIHHYa3bg067xj1KxMUWj+VULbiZMowKngFFbKczUrNJ1mg==", + "license": "MIT", + "dependencies": { + "safe-buffer": "5.2.1" + }, + "engines": { + "node": ">= 0.6" + } + }, + "packages/vscode-ide-companion/node_modules/cookie-signature": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.2.2.tgz", + "integrity": "sha512-D76uU73ulSXrD1UXF4KE2TMxVVwhsnCgfAyTg9k8P6KGZjlXKrOLe4dJQKI3Bxi5wjesZoFXJWElNWBjPZMbhg==", + "license": "MIT", + "engines": { + "node": ">=6.6.0" + } + }, + "packages/vscode-ide-companion/node_modules/express": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/express/-/express-5.1.0.tgz", + "integrity": "sha512-DT9ck5YIRU+8GYzzU5kT3eHGA5iL+1Zd0EutOmTE9Dtk+Tvuzd23VBU+ec7HPNSTxXYO55gPV/hq4pSBJDjFpA==", + "license": "MIT", + "dependencies": { + "accepts": "^2.0.0", + "body-parser": "^2.2.0", + "content-disposition": "^1.0.0", + "content-type": "^1.0.5", + "cookie": "^0.7.1", + "cookie-signature": "^1.2.1", + "debug": "^4.4.0", + "encodeurl": "^2.0.0", + "escape-html": "^1.0.3", + "etag": "^1.8.1", + "finalhandler": "^2.1.0", + "fresh": "^2.0.0", + "http-errors": "^2.0.0", + "merge-descriptors": "^2.0.0", + "mime-types": "^3.0.0", + "on-finished": "^2.4.1", + "once": "^1.4.0", + "parseurl": "^1.3.3", + "proxy-addr": "^2.0.7", + "qs": "^6.14.0", + "range-parser": "^1.2.1", + "router": "^2.2.0", + "send": "^1.1.0", + "serve-static": "^2.2.0", + "statuses": "^2.0.1", + "type-is": "^2.0.1", + "vary": "^1.1.2" + }, + "engines": { + "node": ">= 18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "packages/vscode-ide-companion/node_modules/finalhandler": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-2.1.0.tgz", + "integrity": "sha512-/t88Ty3d5JWQbWYgaOGCCYfXRwV1+be02WqYYlL6h0lEiUAMPM8o8qKGO01YIkOHzka2up08wvgYD0mDiI+q3Q==", + "license": "MIT", + "dependencies": { + "debug": "^4.4.0", + "encodeurl": "^2.0.0", + "escape-html": "^1.0.3", + "on-finished": "^2.4.1", + "parseurl": "^1.3.3", + "statuses": "^2.0.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "packages/vscode-ide-companion/node_modules/fresh": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/fresh/-/fresh-2.0.0.tgz", + "integrity": "sha512-Rx/WycZ60HOaqLKAi6cHRKKI7zxWbJ31MhntmtwMoaTeF7XFH9hhBp8vITaMidfljRQ6eYWCKkaTK+ykVJHP2A==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "packages/vscode-ide-companion/node_modules/media-typer": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-1.1.0.tgz", + "integrity": "sha512-aisnrDP4GNe06UcKFnV5bfMNPBUw4jsLGaWwWfnH3v02GnBuXX2MCVn5RbrWo0j3pczUilYblq7fQ7Nw2t5XKw==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "packages/vscode-ide-companion/node_modules/merge-descriptors": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-2.0.0.tgz", + "integrity": "sha512-Snk314V5ayFLhp3fkUREub6WtjBfPdCPY1Ln8/8munuLuiYhsABgBVWsozAG+MWMbVEvcdcpbi9R7ww22l9Q3g==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "packages/vscode-ide-companion/node_modules/negotiator": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-1.0.0.tgz", + "integrity": "sha512-8Ofs/AUQh8MaEcrlq5xOX0CQ9ypTF5dl78mjlMNfOK08fzpgTHQRQPBxcPlEtIw0yRpws+Zo/3r+5WRby7u3Gg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "packages/vscode-ide-companion/node_modules/qs": { + "version": "6.14.0", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.14.0.tgz", + "integrity": "sha512-YWWTjgABSKcvs/nWBi9PycY/JiPJqOD4JA6o9Sej2AtvSGarXxKC3OQSk4pAarbdQlKAh5D4FCQkJNkW+GAn3w==", + "license": "BSD-3-Clause", + "dependencies": { + "side-channel": "^1.1.0" + }, + "engines": { + "node": ">=0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "packages/vscode-ide-companion/node_modules/send": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/send/-/send-1.2.0.tgz", + "integrity": "sha512-uaW0WwXKpL9blXE2o0bRhoL2EGXIrZxQ2ZQ4mgcfoBxdFmQold+qWsD2jLrfZ0trjKL6vOw0j//eAwcALFjKSw==", + "license": "MIT", + "dependencies": { + "debug": "^4.3.5", + "encodeurl": "^2.0.0", + "escape-html": "^1.0.3", + "etag": "^1.8.1", + "fresh": "^2.0.0", + "http-errors": "^2.0.0", + "mime-types": "^3.0.1", + "ms": "^2.1.3", + "on-finished": "^2.4.1", + "range-parser": "^1.2.1", + "statuses": "^2.0.1" + }, + "engines": { + "node": ">= 18" + } + }, + "packages/vscode-ide-companion/node_modules/serve-static": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-2.2.0.tgz", + "integrity": "sha512-61g9pCh0Vnh7IutZjtLGGpTA355+OPn2TyDv/6ivP2h/AdAVX9azsoxmg2/M6nZeQZNYBEwIcsne1mJd9oQItQ==", + "license": "MIT", + "dependencies": { + "encodeurl": "^2.0.0", + "escape-html": "^1.0.3", + "parseurl": "^1.3.3", + "send": "^1.2.0" + }, + "engines": { + "node": ">= 18" + } + }, + "packages/vscode-ide-companion/node_modules/type-is": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/type-is/-/type-is-2.0.1.tgz", + "integrity": "sha512-OZs6gsjF4vMp32qrCbiVSkrFmXtG/AZhY3t0iAMrMBiAZyV9oALtXO8hsrHbMXF9x6L3grlFuwW2oAz7cav+Gw==", + "license": "MIT", + "dependencies": { + "content-type": "^1.0.5", + "media-typer": "^1.1.0", + "mime-types": "^3.0.0" + }, + "engines": { + "node": ">= 0.6" + } } } } diff --git a/package.json b/package.json index 74a16a4c..da71b5df 100644 --- a/package.json +++ b/package.json @@ -62,7 +62,6 @@ ], "devDependencies": { "@types/marked": "^5.0.2", - "@types/micromatch": "^4.0.9", "@types/mime-types": "^3.0.1", "@types/minimatch": "^5.1.2", "@types/mock-fs": "^4.13.4", @@ -70,6 +69,7 @@ "@types/shell-quote": "^1.7.5", "@types/uuid": "^10.0.0", "@vitest/coverage-v8": "^3.1.1", + "@vitest/eslint-plugin": "^1.3.4", "concurrently": "^9.2.0", "cross-env": "^7.0.3", "esbuild": "^0.25.0", @@ -95,7 +95,8 @@ "yargs": "^17.7.2" }, "dependencies": { - "node-fetch": "^3.3.2", + "@lvce-editor/ripgrep": "^1.6.0", + "simple-git": "^3.28.0", "strip-ansi": "^7.1.0" }, "optionalDependencies": { diff --git a/packages/cli/index.ts b/packages/cli/index.ts index 6b7e87a5..8e9912f1 100644 --- a/packages/cli/index.ts +++ b/packages/cli/index.ts @@ -8,9 +8,18 @@ import './src/gemini.js'; import { main } from './src/gemini.js'; +import { FatalError } from '@qwen-code/qwen-code-core'; // --- Global Entry Point --- main().catch((error) => { + if (error instanceof FatalError) { + let errorMessage = error.message; + if (!process.env['NO_COLOR']) { + errorMessage = `\x1b[31m${errorMessage}\x1b[0m`; + } + console.error(errorMessage); + process.exit(error.exitCode); + } console.error('An unexpected critical error occurred:'); if (error instanceof Error) { console.error(error.stack); diff --git a/packages/cli/package.json b/packages/cli/package.json index cd0f069c..fd150e54 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -36,20 +36,21 @@ "command-exists": "^1.2.9", "diff": "^7.0.0", "dotenv": "^17.1.0", + "fzf": "^0.5.2", "glob": "^10.4.1", "highlight.js": "^11.11.1", - "ink": "^6.1.1", - "ink-big-text": "^2.0.0", + "ink": "^6.2.3", "ink-gradient": "^3.0.0", "ink-link": "^4.1.0", - "ink-select-input": "^6.2.0", "ink-spinner": "^5.0.0", + "lodash-es": "^4.17.21", "lowlight": "^3.3.0", "mime-types": "^3.0.1", "open": "^10.1.2", "qrcode-terminal": "^0.12.0", "react": "^19.1.0", "read-package-up": "^11.0.0", + "simple-git": "^3.28.0", "shell-quote": "^1.8.3", "string-width": "^7.1.0", "strip-ansi": "^7.1.0", @@ -61,10 +62,12 @@ }, "devDependencies": { "@babel/runtime": "^7.27.6", + "@google/gemini-cli-test-utils": "file:../test-utils", "@testing-library/react": "^16.3.0", "@types/command-exists": "^1.2.3", "@types/diff": "^7.0.2", "@types/dotenv": "^6.1.1", + "@types/lodash-es": "^4.17.12", "@types/node": "^20.11.24", "@types/react": "^19.1.8", "@types/react-dom": "^19.1.6", diff --git a/packages/cli/src/commands/extensions.tsx b/packages/cli/src/commands/extensions.tsx new file mode 100644 index 00000000..ac3763f5 --- /dev/null +++ b/packages/cli/src/commands/extensions.tsx @@ -0,0 +1,32 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import type { CommandModule } from 'yargs'; +import { installCommand } from './extensions/install.js'; +import { uninstallCommand } from './extensions/uninstall.js'; +import { listCommand } from './extensions/list.js'; +import { updateCommand } from './extensions/update.js'; +import { disableCommand } from './extensions/disable.js'; +import { enableCommand } from './extensions/enable.js'; + +export const extensionsCommand: CommandModule = { + command: 'extensions ', + describe: 'Manage Qwen Code extensions.', + builder: (yargs) => + yargs + .command(installCommand) + .command(uninstallCommand) + .command(listCommand) + .command(updateCommand) + .command(disableCommand) + .command(enableCommand) + .demandCommand(1, 'You need at least one command before continuing.') + .version(false), + handler: () => { + // This handler is not called when a subcommand is provided. + // Yargs will show the help menu. + }, +}; diff --git a/packages/cli/src/commands/extensions/disable.ts b/packages/cli/src/commands/extensions/disable.ts new file mode 100644 index 00000000..139e7da8 --- /dev/null +++ b/packages/cli/src/commands/extensions/disable.ts @@ -0,0 +1,51 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import { type CommandModule } from 'yargs'; +import { disableExtension } from '../../config/extension.js'; +import { SettingScope } from '../../config/settings.js'; +import { getErrorMessage } from '../../utils/errors.js'; + +interface DisableArgs { + name: string; + scope: SettingScope; +} + +export async function handleDisable(args: DisableArgs) { + try { + disableExtension(args.name, args.scope); + console.log( + `Extension "${args.name}" successfully disabled for scope "${args.scope}".`, + ); + } catch (error) { + console.error(getErrorMessage(error)); + process.exit(1); + } +} + +export const disableCommand: CommandModule = { + command: 'disable [--scope] ', + describe: 'Disables an extension.', + builder: (yargs) => + yargs + .positional('name', { + describe: 'The name of the extension to disable.', + type: 'string', + }) + .option('scope', { + describe: 'The scope to disable the extenison in.', + type: 'string', + default: SettingScope.User, + choices: [SettingScope.User, SettingScope.Workspace], + }) + .check((_argv) => true), + handler: async (argv) => { + await handleDisable({ + name: argv['name'] as string, + scope: argv['scope'] as SettingScope, + }); + }, +}; diff --git a/packages/cli/src/commands/extensions/enable.ts b/packages/cli/src/commands/extensions/enable.ts new file mode 100644 index 00000000..948fd1c2 --- /dev/null +++ b/packages/cli/src/commands/extensions/enable.ts @@ -0,0 +1,59 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import { type CommandModule } from 'yargs'; +import { FatalConfigError, getErrorMessage } from '@qwen-code/qwen-code-core'; +import { enableExtension } from '../../config/extension.js'; +import { SettingScope } from '../../config/settings.js'; + +interface EnableArgs { + name: string; + scope?: SettingScope; +} + +export async function handleEnable(args: EnableArgs) { + try { + const scopes = args.scope + ? [args.scope] + : [SettingScope.User, SettingScope.Workspace]; + enableExtension(args.name, scopes); + if (args.scope) { + console.log( + `Extension "${args.name}" successfully enabled for scope "${args.scope}".`, + ); + } else { + console.log( + `Extension "${args.name}" successfully enabled in all scopes.`, + ); + } + } catch (error) { + throw new FatalConfigError(getErrorMessage(error)); + } +} + +export const enableCommand: CommandModule = { + command: 'disable [--scope] ', + describe: 'Enables an extension.', + builder: (yargs) => + yargs + .positional('name', { + describe: 'The name of the extension to enable.', + type: 'string', + }) + .option('scope', { + describe: + 'The scope to enable the extenison in. If not set, will be enabled in all scopes.', + type: 'string', + choices: [SettingScope.User, SettingScope.Workspace], + }) + .check((_argv) => true), + handler: async (argv) => { + await handleEnable({ + name: argv['name'] as string, + scope: argv['scope'] as SettingScope, + }); + }, +}; diff --git a/packages/cli/src/commands/extensions/install.test.ts b/packages/cli/src/commands/extensions/install.test.ts new file mode 100644 index 00000000..859ed951 --- /dev/null +++ b/packages/cli/src/commands/extensions/install.test.ts @@ -0,0 +1,31 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import { describe, it, expect } from 'vitest'; +import { installCommand } from './install.js'; +import yargs from 'yargs'; + +describe('extensions install command', () => { + it('should fail if no source is provided', () => { + const validationParser = yargs([]) + .locale('en') + .command(installCommand) + .fail(false); + expect(() => validationParser.parse('install')).toThrow( + 'Either a git URL --source or a --path must be provided.', + ); + }); + + it('should fail if both git source and local path are provided', () => { + const validationParser = yargs([]) + .locale('en') + .command(installCommand) + .fail(false); + expect(() => + validationParser.parse('install --source some-url --path /some/path'), + ).toThrow('Arguments source and path are mutually exclusive'); + }); +}); diff --git a/packages/cli/src/commands/extensions/install.ts b/packages/cli/src/commands/extensions/install.ts new file mode 100644 index 00000000..af411c3d --- /dev/null +++ b/packages/cli/src/commands/extensions/install.ts @@ -0,0 +1,64 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import type { CommandModule } from 'yargs'; +import { + installExtension, + type ExtensionInstallMetadata, +} from '../../config/extension.js'; + +import { getErrorMessage } from '../../utils/errors.js'; + +interface InstallArgs { + source?: string; + path?: string; +} + +export async function handleInstall(args: InstallArgs) { + try { + const installMetadata: ExtensionInstallMetadata = { + source: (args.source || args.path) as string, + type: args.source ? 'git' : 'local', + }; + const extensionName = await installExtension(installMetadata); + console.log( + `Extension "${extensionName}" installed successfully and enabled.`, + ); + } catch (error) { + console.error(getErrorMessage(error)); + process.exit(1); + } +} + +export const installCommand: CommandModule = { + command: 'install [--source | --path ]', + describe: 'Installs an extension from a git repository or a local path.', + builder: (yargs) => + yargs + .option('source', { + describe: 'The git URL of the extension to install.', + type: 'string', + }) + .option('path', { + describe: 'Path to a local extension directory.', + type: 'string', + }) + .conflicts('source', 'path') + .check((argv) => { + if (!argv.source && !argv.path) { + throw new Error( + 'Either a git URL --source or a --path must be provided.', + ); + } + return true; + }), + handler: async (argv) => { + await handleInstall({ + source: argv['source'] as string | undefined, + path: argv['path'] as string | undefined, + }); + }, +}; diff --git a/packages/cli/src/commands/extensions/list.ts b/packages/cli/src/commands/extensions/list.ts new file mode 100644 index 00000000..46110625 --- /dev/null +++ b/packages/cli/src/commands/extensions/list.ts @@ -0,0 +1,36 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import type { CommandModule } from 'yargs'; +import { loadUserExtensions, toOutputString } from '../../config/extension.js'; +import { getErrorMessage } from '../../utils/errors.js'; + +export async function handleList() { + try { + const extensions = loadUserExtensions(); + if (extensions.length === 0) { + console.log('No extensions installed.'); + return; + } + console.log( + extensions + .map((extension, _): string => toOutputString(extension)) + .join('\n\n'), + ); + } catch (error) { + console.error(getErrorMessage(error)); + process.exit(1); + } +} + +export const listCommand: CommandModule = { + command: 'list', + describe: 'Lists installed extensions.', + builder: (yargs) => yargs, + handler: async () => { + await handleList(); + }, +}; diff --git a/packages/cli/src/commands/extensions/uninstall.test.ts b/packages/cli/src/commands/extensions/uninstall.test.ts new file mode 100644 index 00000000..4dd68095 --- /dev/null +++ b/packages/cli/src/commands/extensions/uninstall.test.ts @@ -0,0 +1,21 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import { describe, it, expect } from 'vitest'; +import { uninstallCommand } from './uninstall.js'; +import yargs from 'yargs'; + +describe('extensions uninstall command', () => { + it('should fail if no source is provided', () => { + const validationParser = yargs([]) + .locale('en') + .command(uninstallCommand) + .fail(false); + expect(() => validationParser.parse('uninstall')).toThrow( + 'Not enough non-option arguments: got 0, need at least 1', + ); + }); +}); diff --git a/packages/cli/src/commands/extensions/uninstall.ts b/packages/cli/src/commands/extensions/uninstall.ts new file mode 100644 index 00000000..ff93b797 --- /dev/null +++ b/packages/cli/src/commands/extensions/uninstall.ts @@ -0,0 +1,47 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import type { CommandModule } from 'yargs'; +import { uninstallExtension } from '../../config/extension.js'; +import { getErrorMessage } from '../../utils/errors.js'; + +interface UninstallArgs { + name: string; +} + +export async function handleUninstall(args: UninstallArgs) { + try { + await uninstallExtension(args.name); + console.log(`Extension "${args.name}" successfully uninstalled.`); + } catch (error) { + console.error(getErrorMessage(error)); + process.exit(1); + } +} + +export const uninstallCommand: CommandModule = { + command: 'uninstall ', + describe: 'Uninstalls an extension.', + builder: (yargs) => + yargs + .positional('name', { + describe: 'The name of the extension to uninstall.', + type: 'string', + }) + .check((argv) => { + if (!argv.name) { + throw new Error( + 'Please include the name of the extension to uninstall as a positional argument.', + ); + } + return true; + }), + handler: async (argv) => { + await handleUninstall({ + name: argv['name'] as string, + }); + }, +}; diff --git a/packages/cli/src/commands/extensions/update.ts b/packages/cli/src/commands/extensions/update.ts new file mode 100644 index 00000000..43ac6de8 --- /dev/null +++ b/packages/cli/src/commands/extensions/update.ts @@ -0,0 +1,47 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import type { CommandModule } from 'yargs'; +import { updateExtension } from '../../config/extension.js'; +import { getErrorMessage } from '../../utils/errors.js'; + +interface UpdateArgs { + name: string; +} + +export async function handleUpdate(args: UpdateArgs) { + try { + // TODO(chrstnb): we should list extensions if the requested extension is not installed. + const updatedExtensionInfo = await updateExtension(args.name); + if (!updatedExtensionInfo) { + console.log(`Extension "${args.name}" failed to update.`); + return; + } + console.log( + `Extension "${args.name}" successfully updated: ${updatedExtensionInfo.originalVersion} โ†’ ${updatedExtensionInfo.updatedVersion}.`, + ); + } catch (error) { + console.error(getErrorMessage(error)); + process.exit(1); + } +} + +export const updateCommand: CommandModule = { + command: 'update ', + describe: 'Updates an extension.', + builder: (yargs) => + yargs + .positional('name', { + describe: 'The name of the extension to update.', + type: 'string', + }) + .check((_argv) => true), + handler: async (argv) => { + await handleUpdate({ + name: argv['name'] as string, + }); + }, +}; diff --git a/packages/cli/src/commands/mcp/add.ts b/packages/cli/src/commands/mcp/add.ts index 9523d7a4..29fe15c6 100644 --- a/packages/cli/src/commands/mcp/add.ts +++ b/packages/cli/src/commands/mcp/add.ts @@ -7,7 +7,7 @@ // File for 'gemini mcp add' command import type { CommandModule } from 'yargs'; import { loadSettings, SettingScope } from '../../config/settings.js'; -import { MCPServerConfig } from '@qwen-code/qwen-code-core'; +import type { MCPServerConfig } from '@qwen-code/qwen-code-core'; async function addMcpServer( name: string, diff --git a/packages/cli/src/commands/mcp/list.test.ts b/packages/cli/src/commands/mcp/list.test.ts index c268fdbd..60a62834 100644 --- a/packages/cli/src/commands/mcp/list.test.ts +++ b/packages/cli/src/commands/mcp/list.test.ts @@ -11,9 +11,27 @@ import { loadExtensions } from '../../config/extension.js'; import { createTransport } from '@qwen-code/qwen-code-core'; import { Client } from '@modelcontextprotocol/sdk/client/index.js'; -vi.mock('../../config/settings.js'); -vi.mock('../../config/extension.js'); -vi.mock('@qwen-code/qwen-code-core'); +vi.mock('../../config/settings.js', () => ({ + loadSettings: vi.fn(), +})); +vi.mock('../../config/extension.js', () => ({ + loadExtensions: vi.fn(), +})); +vi.mock('@qwen-code/qwen-code-core', () => ({ + createTransport: vi.fn(), + MCPServerStatus: { + CONNECTED: 'CONNECTED', + CONNECTING: 'CONNECTING', + DISCONNECTED: 'DISCONNECTED', + }, + Storage: vi.fn().mockImplementation((_cwd: string) => ({ + getGlobalSettingsPath: () => '/tmp/qwen/settings.json', + getWorkspaceSettingsPath: () => '/tmp/qwen/workspace-settings.json', + getProjectTempDir: () => '/test/home/.qwen/tmp/mocked_hash', + })), + GEMINI_CONFIG_DIR: '.qwen', + getErrorMessage: (e: unknown) => (e instanceof Error ? e.message : String(e)), +})); vi.mock('@modelcontextprotocol/sdk/client/index.js'); const mockedLoadSettings = loadSettings as vi.Mock; diff --git a/packages/cli/src/commands/mcp/list.ts b/packages/cli/src/commands/mcp/list.ts index 57bed6d8..0d246c51 100644 --- a/packages/cli/src/commands/mcp/list.ts +++ b/packages/cli/src/commands/mcp/list.ts @@ -7,11 +7,8 @@ // File for 'gemini mcp list' command import type { CommandModule } from 'yargs'; import { loadSettings } from '../../config/settings.js'; -import { - MCPServerConfig, - MCPServerStatus, - createTransport, -} from '@qwen-code/qwen-code-core'; +import type { MCPServerConfig } from '@qwen-code/qwen-code-core'; +import { MCPServerStatus, createTransport } from '@qwen-code/qwen-code-core'; import { Client } from '@modelcontextprotocol/sdk/client/index.js'; import { loadExtensions } from '../../config/extension.js'; diff --git a/packages/cli/src/config/config.integration.test.ts b/packages/cli/src/config/config.integration.test.ts index 682beb64..6916996a 100644 --- a/packages/cli/src/config/config.integration.test.ts +++ b/packages/cli/src/config/config.integration.test.ts @@ -5,14 +5,14 @@ */ import { describe, it, expect, beforeEach, vi, afterEach } from 'vitest'; -import * as fs from 'fs'; -import * as path from 'path'; -import { tmpdir } from 'os'; -import { - Config, +import * as fs from 'node:fs'; +import * as path from 'node:path'; +import { tmpdir } from 'node:os'; +import type { ConfigParameters, ContentGeneratorConfig, } from '@qwen-code/qwen-code-core'; +import { Config } from '@qwen-code/qwen-code-core'; import { http, HttpResponse } from 'msw'; import { setupServer } from 'msw/node'; @@ -282,7 +282,7 @@ describe('Configuration Integration Tests', () => { 'test', ]; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); // Verify that the argument was parsed correctly expect(argv.approvalMode).toBe('auto_edit'); @@ -306,7 +306,7 @@ describe('Configuration Integration Tests', () => { 'test', ]; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); expect(argv.approvalMode).toBe('yolo'); expect(argv.prompt).toBe('test'); @@ -329,7 +329,7 @@ describe('Configuration Integration Tests', () => { 'test', ]; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); expect(argv.approvalMode).toBe('default'); expect(argv.prompt).toBe('test'); @@ -345,7 +345,7 @@ describe('Configuration Integration Tests', () => { try { process.argv = ['node', 'script.js', '--yolo', '-p', 'test']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); expect(argv.yolo).toBe(true); expect(argv.approvalMode).toBeUndefined(); // Should NOT be set when using --yolo @@ -362,7 +362,7 @@ describe('Configuration Integration Tests', () => { process.argv = ['node', 'script.js', '--approval-mode', 'invalid_mode']; // Should throw during argument parsing due to yargs validation - await expect(parseArguments()).rejects.toThrow(); + await expect(parseArguments({} as Settings)).rejects.toThrow(); } finally { process.argv = originalArgv; } @@ -381,7 +381,7 @@ describe('Configuration Integration Tests', () => { ]; // Should throw during argument parsing due to conflict validation - await expect(parseArguments()).rejects.toThrow(); + await expect(parseArguments({} as Settings)).rejects.toThrow(); } finally { process.argv = originalArgv; } @@ -394,7 +394,7 @@ describe('Configuration Integration Tests', () => { // Test that no approval mode arguments defaults to no flags set process.argv = ['node', 'script.js', '-p', 'test']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); expect(argv.approvalMode).toBeUndefined(); expect(argv.yolo).toBe(false); diff --git a/packages/cli/src/config/config.test.ts b/packages/cli/src/config/config.test.ts index f2d6ec26..a4296943 100644 --- a/packages/cli/src/config/config.test.ts +++ b/packages/cli/src/config/config.test.ts @@ -4,21 +4,60 @@ * SPDX-License-Identifier: Apache-2.0 */ -import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'; -import * as os from 'os'; -import * as fs from 'fs'; -import * as path from 'path'; +import { + describe, + it, + expect, + vi, + beforeEach, + afterEach, + type Mock, +} from 'vitest'; +import * as os from 'node:os'; +import * as path from 'node:path'; import { ShellTool, EditTool, WriteFileTool } from '@qwen-code/qwen-code-core'; -import { loadCliConfig, parseArguments, CliArgs } from './config.js'; -import { Settings } from './settings.js'; -import { Extension } from './extension.js'; +import { loadCliConfig, parseArguments, type CliArgs } from './config.js'; +import type { Settings } from './settings.js'; +import type { Extension } from './extension.js'; import * as ServerConfig from '@qwen-code/qwen-code-core'; import { isWorkspaceTrusted } from './trustedFolders.js'; vi.mock('./trustedFolders.js', () => ({ - isWorkspaceTrusted: vi.fn(), + isWorkspaceTrusted: vi.fn().mockReturnValue(true), // Default to trusted })); +vi.mock('fs', async (importOriginal) => { + const actualFs = await importOriginal(); + const pathMod = await import('node:path'); + const mockHome = '/mock/home/user'; + const MOCK_CWD1 = process.cwd(); + const MOCK_CWD2 = pathMod.resolve(pathMod.sep, 'home', 'user', 'project'); + + const mockPaths = new Set([ + MOCK_CWD1, + MOCK_CWD2, + pathMod.resolve(pathMod.sep, 'cli', 'path1'), + pathMod.resolve(pathMod.sep, 'settings', 'path1'), + pathMod.join(mockHome, 'settings', 'path2'), + pathMod.join(MOCK_CWD2, 'cli', 'path2'), + pathMod.join(MOCK_CWD2, 'settings', 'path3'), + ]); + + return { + ...actualFs, + mkdirSync: vi.fn(), + writeFileSync: vi.fn(), + existsSync: vi.fn((p) => mockPaths.has(p.toString())), + statSync: vi.fn((p) => { + if (mockPaths.has(p.toString())) { + return { isDirectory: () => true } as unknown as import('fs').Stats; + } + return (actualFs as typeof import('fs')).statSync(p as unknown as string); + }), + realpathSync: vi.fn((p) => p), + }; +}); + vi.mock('os', async (importOriginal) => { const actualOs = await importOriginal(); return { @@ -44,7 +83,7 @@ vi.mock('@qwen-code/qwen-code-core', async () => { return { ...actualServer, IdeClient: { - getInstance: vi.fn().mockReturnValue({ + getInstance: vi.fn().mockResolvedValue({ getConnectionStatus: vi.fn(), initialize: vi.fn(), shutdown: vi.fn(), @@ -94,7 +133,9 @@ describe('parseArguments', () => { .spyOn(console, 'error') .mockImplementation(() => {}); - await expect(parseArguments()).rejects.toThrow('process.exit called'); + await expect(parseArguments({} as Settings)).rejects.toThrow( + 'process.exit called', + ); expect(mockConsoleError).toHaveBeenCalledWith( expect.stringContaining( @@ -124,7 +165,9 @@ describe('parseArguments', () => { .spyOn(console, 'error') .mockImplementation(() => {}); - await expect(parseArguments()).rejects.toThrow('process.exit called'); + await expect(parseArguments({} as Settings)).rejects.toThrow( + 'process.exit called', + ); expect(mockConsoleError).toHaveBeenCalledWith( expect.stringContaining( @@ -138,7 +181,7 @@ describe('parseArguments', () => { it('should allow --prompt without --prompt-interactive', async () => { process.argv = ['node', 'script.js', '--prompt', 'test prompt']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); expect(argv.prompt).toBe('test prompt'); expect(argv.promptInteractive).toBeUndefined(); }); @@ -150,14 +193,14 @@ describe('parseArguments', () => { '--prompt-interactive', 'interactive prompt', ]; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); expect(argv.promptInteractive).toBe('interactive prompt'); expect(argv.prompt).toBeUndefined(); }); it('should allow -i flag as alias for --prompt-interactive', async () => { process.argv = ['node', 'script.js', '-i', 'interactive prompt']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); expect(argv.promptInteractive).toBe('interactive prompt'); expect(argv.prompt).toBeUndefined(); }); @@ -179,7 +222,9 @@ describe('parseArguments', () => { .spyOn(console, 'error') .mockImplementation(() => {}); - await expect(parseArguments()).rejects.toThrow('process.exit called'); + await expect(parseArguments({} as Settings)).rejects.toThrow( + 'process.exit called', + ); expect(mockConsoleError).toHaveBeenCalledWith( expect.stringContaining( @@ -202,7 +247,9 @@ describe('parseArguments', () => { .spyOn(console, 'error') .mockImplementation(() => {}); - await expect(parseArguments()).rejects.toThrow('process.exit called'); + await expect(parseArguments({} as Settings)).rejects.toThrow( + 'process.exit called', + ); expect(mockConsoleError).toHaveBeenCalledWith( expect.stringContaining( @@ -216,14 +263,14 @@ describe('parseArguments', () => { it('should allow --approval-mode without --yolo', async () => { process.argv = ['node', 'script.js', '--approval-mode', 'auto_edit']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); expect(argv.approvalMode).toBe('auto_edit'); expect(argv.yolo).toBe(false); }); it('should allow --yolo without --approval-mode', async () => { process.argv = ['node', 'script.js', '--yolo']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); expect(argv.yolo).toBe(true); expect(argv.approvalMode).toBeUndefined(); }); @@ -239,7 +286,9 @@ describe('parseArguments', () => { .spyOn(console, 'error') .mockImplementation(() => {}); - await expect(parseArguments()).rejects.toThrow('process.exit called'); + await expect(parseArguments({} as Settings)).rejects.toThrow( + 'process.exit called', + ); expect(mockConsoleError).toHaveBeenCalledWith( expect.stringContaining('Invalid values:'), @@ -267,7 +316,7 @@ describe('loadCliConfig', () => { it('should set showMemoryUsage to true when --show-memory-usage flag is present', async () => { process.argv = ['node', 'script.js', '--show-memory-usage']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = {}; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getShowMemoryUsage()).toBe(true); @@ -275,7 +324,7 @@ describe('loadCliConfig', () => { it('should set showMemoryUsage to false when --memory flag is not present', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = {}; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getShowMemoryUsage()).toBe(false); @@ -283,97 +332,112 @@ describe('loadCliConfig', () => { it('should set showMemoryUsage to false by default from settings if CLI flag is not present', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); - const settings: Settings = { showMemoryUsage: false }; + const argv = await parseArguments({} as Settings); + const settings: Settings = { ui: { showMemoryUsage: false } }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getShowMemoryUsage()).toBe(false); }); it('should prioritize CLI flag over settings for showMemoryUsage (CLI true, settings false)', async () => { process.argv = ['node', 'script.js', '--show-memory-usage']; - const argv = await parseArguments(); - const settings: Settings = { showMemoryUsage: false }; + const argv = await parseArguments({} as Settings); + const settings: Settings = { ui: { showMemoryUsage: false } }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getShowMemoryUsage()).toBe(true); }); - it(`should leave proxy to empty by default`, async () => { - // Clear all proxy environment variables to ensure clean test - delete process.env['https_proxy']; - delete process.env['http_proxy']; - delete process.env['HTTPS_PROXY']; - delete process.env['HTTP_PROXY']; + describe('Proxy configuration', () => { + const originalProxyEnv: { [key: string]: string | undefined } = {}; + const proxyEnvVars = [ + 'HTTP_PROXY', + 'HTTPS_PROXY', + 'http_proxy', + 'https_proxy', + ]; - process.argv = ['node', 'script.js']; - const argv = await parseArguments(); - const settings: Settings = {}; - const config = await loadCliConfig(settings, [], 'test-session', argv); - expect(config.getProxy()).toBeFalsy(); - }); + beforeEach(() => { + for (const key of proxyEnvVars) { + originalProxyEnv[key] = process.env[key]; + delete process.env[key]; + } + }); - const proxy_url = 'http://localhost:7890'; - const testCases = [ - { - input: { - env_name: 'https_proxy', - proxy_url, - }, - expected: proxy_url, - }, - { - input: { - env_name: 'http_proxy', - proxy_url, - }, - expected: proxy_url, - }, - { - input: { - env_name: 'HTTPS_PROXY', - proxy_url, - }, - expected: proxy_url, - }, - { - input: { - env_name: 'HTTP_PROXY', - proxy_url, - }, - expected: proxy_url, - }, - ]; - testCases.forEach(({ input, expected }) => { - it(`should set proxy to ${expected} according to environment variable [${input.env_name}]`, async () => { - // Clear all proxy environment variables first - delete process.env['https_proxy']; - delete process.env['http_proxy']; - delete process.env['HTTPS_PROXY']; - delete process.env['HTTP_PROXY']; + afterEach(() => { + for (const key of proxyEnvVars) { + if (originalProxyEnv[key]) { + process.env[key] = originalProxyEnv[key]; + } else { + delete process.env[key]; + } + } + }); - vi.stubEnv(input.env_name, input.proxy_url); + it(`should leave proxy to empty by default`, async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = {}; const config = await loadCliConfig(settings, [], 'test-session', argv); - expect(config.getProxy()).toBe(expected); + expect(config.getProxy()).toBeFalsy(); }); - }); - it('should set proxy when --proxy flag is present', async () => { - process.argv = ['node', 'script.js', '--proxy', 'http://localhost:7890']; - const argv = await parseArguments(); - const settings: Settings = {}; - const config = await loadCliConfig(settings, [], 'test-session', argv); - expect(config.getProxy()).toBe('http://localhost:7890'); - }); + const proxy_url = 'http://localhost:7890'; + const testCases = [ + { + input: { + env_name: 'https_proxy', + proxy_url, + }, + expected: proxy_url, + }, + { + input: { + env_name: 'http_proxy', + proxy_url, + }, + expected: proxy_url, + }, + { + input: { + env_name: 'HTTPS_PROXY', + proxy_url, + }, + expected: proxy_url, + }, + { + input: { + env_name: 'HTTP_PROXY', + proxy_url, + }, + expected: proxy_url, + }, + ]; + testCases.forEach(({ input, expected }) => { + it(`should set proxy to ${expected} according to environment variable [${input.env_name}]`, async () => { + vi.stubEnv(input.env_name, input.proxy_url); + process.argv = ['node', 'script.js']; + const argv = await parseArguments({} as Settings); + const settings: Settings = {}; + const config = await loadCliConfig(settings, [], 'test-session', argv); + expect(config.getProxy()).toBe(expected); + }); + }); - it('should prioritize CLI flag over environment variable for proxy (CLI http://localhost:7890, environment variable http://localhost:7891)', async () => { - vi.stubEnv('http_proxy', 'http://localhost:7891'); - process.argv = ['node', 'script.js', '--proxy', 'http://localhost:7890']; - const argv = await parseArguments(); - const settings: Settings = {}; - const config = await loadCliConfig(settings, [], 'test-session', argv); - expect(config.getProxy()).toBe('http://localhost:7890'); + it('should set proxy when --proxy flag is present', async () => { + process.argv = ['node', 'script.js', '--proxy', 'http://localhost:7890']; + const argv = await parseArguments({} as Settings); + const settings: Settings = {}; + const config = await loadCliConfig(settings, [], 'test-session', argv); + expect(config.getProxy()).toBe('http://localhost:7890'); + }); + + it('should prioritize CLI flag over environment variable for proxy (CLI http://localhost:7890, environment variable http://localhost:7891)', async () => { + vi.stubEnv('http_proxy', 'http://localhost:7891'); + process.argv = ['node', 'script.js', '--proxy', 'http://localhost:7890']; + const argv = await parseArguments({} as Settings); + const settings: Settings = {}; + const config = await loadCliConfig(settings, [], 'test-session', argv); + expect(config.getProxy()).toBe('http://localhost:7890'); + }); }); }); @@ -394,7 +458,7 @@ describe('loadCliConfig telemetry', () => { it('should set telemetry to false by default when no flag or setting is present', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = {}; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getTelemetryEnabled()).toBe(false); @@ -402,7 +466,7 @@ describe('loadCliConfig telemetry', () => { it('should set telemetry to true when --telemetry flag is present', async () => { process.argv = ['node', 'script.js', '--telemetry']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = {}; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getTelemetryEnabled()).toBe(true); @@ -410,7 +474,7 @@ describe('loadCliConfig telemetry', () => { it('should set telemetry to false when --no-telemetry flag is present', async () => { process.argv = ['node', 'script.js', '--no-telemetry']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = {}; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getTelemetryEnabled()).toBe(false); @@ -418,7 +482,7 @@ describe('loadCliConfig telemetry', () => { it('should use telemetry value from settings if CLI flag is not present (settings true)', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { telemetry: { enabled: true } }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getTelemetryEnabled()).toBe(true); @@ -426,7 +490,7 @@ describe('loadCliConfig telemetry', () => { it('should use telemetry value from settings if CLI flag is not present (settings false)', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { telemetry: { enabled: false } }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getTelemetryEnabled()).toBe(false); @@ -434,7 +498,7 @@ describe('loadCliConfig telemetry', () => { it('should prioritize --telemetry CLI flag (true) over settings (false)', async () => { process.argv = ['node', 'script.js', '--telemetry']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { telemetry: { enabled: false } }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getTelemetryEnabled()).toBe(true); @@ -442,7 +506,7 @@ describe('loadCliConfig telemetry', () => { it('should prioritize --no-telemetry CLI flag (false) over settings (true)', async () => { process.argv = ['node', 'script.js', '--no-telemetry']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { telemetry: { enabled: true } }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getTelemetryEnabled()).toBe(false); @@ -450,7 +514,7 @@ describe('loadCliConfig telemetry', () => { it('should use telemetry OTLP endpoint from settings if CLI flag is not present', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { telemetry: { otlpEndpoint: 'http://settings.example.com' }, }; @@ -467,7 +531,7 @@ describe('loadCliConfig telemetry', () => { '--telemetry-otlp-endpoint', 'http://cli.example.com', ]; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { telemetry: { otlpEndpoint: 'http://settings.example.com' }, }; @@ -477,7 +541,7 @@ describe('loadCliConfig telemetry', () => { it('should use default endpoint if no OTLP endpoint is provided via CLI or settings', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { telemetry: { enabled: true } }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getTelemetryOtlpEndpoint()).toBe('http://localhost:4317'); @@ -485,7 +549,7 @@ describe('loadCliConfig telemetry', () => { it('should use telemetry target from settings if CLI flag is not present', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { telemetry: { target: ServerConfig.DEFAULT_TELEMETRY_TARGET }, }; @@ -497,7 +561,7 @@ describe('loadCliConfig telemetry', () => { it('should prioritize --telemetry-target CLI flag over settings', async () => { process.argv = ['node', 'script.js', '--telemetry-target', 'gcp']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { telemetry: { target: ServerConfig.DEFAULT_TELEMETRY_TARGET }, }; @@ -507,7 +571,7 @@ describe('loadCliConfig telemetry', () => { it('should use default target if no target is provided via CLI or settings', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { telemetry: { enabled: true } }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getTelemetryTarget()).toBe( @@ -517,7 +581,7 @@ describe('loadCliConfig telemetry', () => { it('should use telemetry log prompts from settings if CLI flag is not present', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { telemetry: { logPrompts: false } }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getTelemetryLogPromptsEnabled()).toBe(false); @@ -525,7 +589,7 @@ describe('loadCliConfig telemetry', () => { it('should prioritize --telemetry-log-prompts CLI flag (true) over settings (false)', async () => { process.argv = ['node', 'script.js', '--telemetry-log-prompts']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { telemetry: { logPrompts: false } }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getTelemetryLogPromptsEnabled()).toBe(true); @@ -533,7 +597,7 @@ describe('loadCliConfig telemetry', () => { it('should prioritize --no-telemetry-log-prompts CLI flag (false) over settings (true)', async () => { process.argv = ['node', 'script.js', '--no-telemetry-log-prompts']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { telemetry: { logPrompts: true } }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getTelemetryLogPromptsEnabled()).toBe(false); @@ -541,7 +605,7 @@ describe('loadCliConfig telemetry', () => { it('should use default log prompts (true) if no value is provided via CLI or settings', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { telemetry: { enabled: true } }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getTelemetryLogPromptsEnabled()).toBe(true); @@ -549,7 +613,7 @@ describe('loadCliConfig telemetry', () => { it('should use telemetry OTLP protocol from settings if CLI flag is not present', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { telemetry: { otlpProtocol: 'http' }, }; @@ -559,7 +623,7 @@ describe('loadCliConfig telemetry', () => { it('should prioritize --telemetry-otlp-protocol CLI flag over settings', async () => { process.argv = ['node', 'script.js', '--telemetry-otlp-protocol', 'http']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { telemetry: { otlpProtocol: 'grpc' }, }; @@ -569,7 +633,7 @@ describe('loadCliConfig telemetry', () => { it('should use default protocol if no OTLP protocol is provided via CLI or settings', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { telemetry: { enabled: true } }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getTelemetryOtlpProtocol()).toBe('grpc'); @@ -591,7 +655,9 @@ describe('loadCliConfig telemetry', () => { .spyOn(console, 'error') .mockImplementation(() => {}); - await expect(parseArguments()).rejects.toThrow('process.exit called'); + await expect(parseArguments({} as Settings)).rejects.toThrow( + 'process.exit called', + ); expect(mockConsoleError).toHaveBeenCalledWith( expect.stringContaining('Invalid values:'), @@ -645,7 +711,7 @@ describe('Hierarchical Memory Loading (config.ts) - Placeholder Suite', () => { ], }, ]; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); await loadCliConfig(settings, extensions, 'session-id', argv); expect(ServerConfig.loadServerHierarchicalMemory).toHaveBeenCalledWith( expect.any(String), @@ -674,19 +740,20 @@ describe('Hierarchical Memory Loading (config.ts) - Placeholder Suite', () => { // readability, and content based on paths derived from the mocked os.homedir(). // 3. Spies on console functions (for logger output) are correctly set up if needed. // Example of a previously failing test structure: - /* - it('should correctly use mocked homedir for global path', async () => { + it.skip('should correctly use mocked homedir for global path', async () => { const MOCK_GEMINI_DIR_LOCAL = path.join('/mock/home/user', '.qwen'); const MOCK_GLOBAL_PATH_LOCAL = path.join(MOCK_GEMINI_DIR_LOCAL, 'QWEN.md'); mockFs({ - [MOCK_GLOBAL_PATH_LOCAL]: { type: 'file', content: 'GlobalContentOnly' } + [MOCK_GLOBAL_PATH_LOCAL]: { type: 'file', content: 'GlobalContentOnly' }, }); - const memory = await loadHierarchicalGeminiMemory("/some/other/cwd", false); + const memory = await loadHierarchicalGeminiMemory('/some/other/cwd', false); expect(memory).toBe('GlobalContentOnly'); expect(vi.mocked(os.homedir)).toHaveBeenCalled(); - expect(fsPromises.readFile).toHaveBeenCalledWith(MOCK_GLOBAL_PATH_LOCAL, 'utf-8'); + expect(fsPromises.readFile).toHaveBeenCalledWith( + MOCK_GLOBAL_PATH_LOCAL, + 'utf-8', + ); }); - */ }); describe('mergeMcpServers', () => { @@ -715,7 +782,7 @@ describe('mergeMcpServers', () => { ]; const originalSettings = JSON.parse(JSON.stringify(settings)); process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); await loadCliConfig(settings, extensions, 'test-session', argv); expect(settings).toEqual(originalSettings); }); @@ -796,7 +863,7 @@ describe('mergeExcludeTools', () => { }); it('should merge excludeTools from settings and extensions', async () => { - const settings: Settings = { excludeTools: ['tool1', 'tool2'] }; + const settings: Settings = { tools: { exclude: ['tool1', 'tool2'] } }; const extensions: Extension[] = [ { path: '/path/to/ext1', @@ -818,7 +885,7 @@ describe('mergeExcludeTools', () => { }, ]; process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig( settings, extensions, @@ -832,7 +899,7 @@ describe('mergeExcludeTools', () => { }); it('should handle overlapping excludeTools between settings and extensions', async () => { - const settings: Settings = { excludeTools: ['tool1', 'tool2'] }; + const settings: Settings = { tools: { exclude: ['tool1', 'tool2'] } }; const extensions: Extension[] = [ { path: '/path/to/ext1', @@ -845,7 +912,7 @@ describe('mergeExcludeTools', () => { }, ]; process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig( settings, extensions, @@ -859,9 +926,10 @@ describe('mergeExcludeTools', () => { }); it('should handle overlapping excludeTools between extensions', async () => { - const settings: Settings = { excludeTools: ['tool1'] }; + const settings: Settings = { tools: { exclude: ['tool1'] } }; const extensions: Extension[] = [ { + path: '/path/to/ext1', config: { name: 'ext1', version: '1.0.0', @@ -870,6 +938,7 @@ describe('mergeExcludeTools', () => { contextFiles: [], }, { + path: '/path/to/ext2', config: { name: 'ext2', version: '1.0.0', @@ -879,7 +948,7 @@ describe('mergeExcludeTools', () => { }, ]; process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig( settings, extensions, @@ -897,7 +966,7 @@ describe('mergeExcludeTools', () => { const settings: Settings = {}; const extensions: Extension[] = []; process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig( settings, extensions, @@ -912,7 +981,7 @@ describe('mergeExcludeTools', () => { const settings: Settings = {}; const extensions: Extension[] = []; process.argv = ['node', 'script.js', '-p', 'test']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig( settings, extensions, @@ -924,8 +993,8 @@ describe('mergeExcludeTools', () => { it('should handle settings with excludeTools but no extensions', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); - const settings: Settings = { excludeTools: ['tool1', 'tool2'] }; + const argv = await parseArguments({} as Settings); + const settings: Settings = { tools: { exclude: ['tool1', 'tool2'] } }; const extensions: Extension[] = []; const config = await loadCliConfig( settings, @@ -943,6 +1012,7 @@ describe('mergeExcludeTools', () => { const settings: Settings = {}; const extensions: Extension[] = [ { + path: '/path/to/ext', config: { name: 'ext1', version: '1.0.0', @@ -952,7 +1022,7 @@ describe('mergeExcludeTools', () => { }, ]; process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig( settings, extensions, @@ -966,9 +1036,10 @@ describe('mergeExcludeTools', () => { }); it('should not modify the original settings object', async () => { - const settings: Settings = { excludeTools: ['tool1'] }; + const settings: Settings = { tools: { exclude: ['tool1'] } }; const extensions: Extension[] = [ { + path: '/path/to/ext', config: { name: 'ext1', version: '1.0.0', @@ -979,7 +1050,7 @@ describe('mergeExcludeTools', () => { ]; const originalSettings = JSON.parse(JSON.stringify(settings)); process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); await loadCliConfig(settings, extensions, 'test-session', argv); expect(settings).toEqual(originalSettings); }); @@ -990,6 +1061,7 @@ describe('Approval mode tool exclusion logic', () => { beforeEach(() => { process.stdin.isTTY = false; // Ensure non-interactive mode + vi.mocked(isWorkspaceTrusted).mockReturnValue(true); }); afterEach(() => { @@ -998,7 +1070,7 @@ describe('Approval mode tool exclusion logic', () => { it('should exclude all interactive tools in non-interactive mode with default approval mode', async () => { process.argv = ['node', 'script.js', '-p', 'test']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = {}; const extensions: Extension[] = []; @@ -1024,7 +1096,7 @@ describe('Approval mode tool exclusion logic', () => { '-p', 'test', ]; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = {}; const extensions: Extension[] = []; @@ -1050,7 +1122,7 @@ describe('Approval mode tool exclusion logic', () => { '-p', 'test', ]; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = {}; const extensions: Extension[] = []; @@ -1076,7 +1148,7 @@ describe('Approval mode tool exclusion logic', () => { '-p', 'test', ]; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = {}; const extensions: Extension[] = []; @@ -1095,7 +1167,7 @@ describe('Approval mode tool exclusion logic', () => { it('should exclude no interactive tools in non-interactive mode with legacy yolo flag', async () => { process.argv = ['node', 'script.js', '--yolo', '-p', 'test']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = {}; const extensions: Extension[] = []; @@ -1125,7 +1197,7 @@ describe('Approval mode tool exclusion logic', () => { for (const testCase of testCases) { process.argv = testCase.args; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = {}; const extensions: Extension[] = []; @@ -1152,8 +1224,8 @@ describe('Approval mode tool exclusion logic', () => { '-p', 'test', ]; - const argv = await parseArguments(); - const settings: Settings = { excludeTools: ['custom_tool'] }; + const argv = await parseArguments({} as Settings); + const settings: Settings = { tools: { exclude: ['custom_tool'] } }; const extensions: Extension[] = []; const config = await loadCliConfig( @@ -1183,7 +1255,12 @@ describe('Approval mode tool exclusion logic', () => { const extensions: Extension[] = []; await expect( - loadCliConfig(settings, extensions, 'test-session', invalidArgv), + loadCliConfig( + settings, + extensions, + 'test-session', + invalidArgv as CliArgs, + ), ).rejects.toThrow( 'Invalid approval mode: invalid_mode. Valid values are: yolo, auto_edit, default', ); @@ -1215,7 +1292,7 @@ describe('loadCliConfig with allowed-mcp-server-names', () => { it('should allow all MCP servers if the flag is not provided', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig(baseSettings, [], 'test-session', argv); expect(config.getMcpServers()).toEqual(baseSettings.mcpServers); }); @@ -1227,7 +1304,7 @@ describe('loadCliConfig with allowed-mcp-server-names', () => { '--allowed-mcp-server-names', 'server1', ]; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig(baseSettings, [], 'test-session', argv); expect(config.getMcpServers()).toEqual({ server1: { url: 'http://localhost:8080' }, @@ -1243,7 +1320,7 @@ describe('loadCliConfig with allowed-mcp-server-names', () => { '--allowed-mcp-server-names', 'server3', ]; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig(baseSettings, [], 'test-session', argv); expect(config.getMcpServers()).toEqual({ server1: { url: 'http://localhost:8080' }, @@ -1260,7 +1337,7 @@ describe('loadCliConfig with allowed-mcp-server-names', () => { '--allowed-mcp-server-names', 'server4', ]; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig(baseSettings, [], 'test-session', argv); expect(config.getMcpServers()).toEqual({ server1: { url: 'http://localhost:8080' }, @@ -1269,17 +1346,17 @@ describe('loadCliConfig with allowed-mcp-server-names', () => { it('should allow no MCP servers if the flag is provided but empty', async () => { process.argv = ['node', 'script.js', '--allowed-mcp-server-names', '']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig(baseSettings, [], 'test-session', argv); expect(config.getMcpServers()).toEqual({}); }); it('should read allowMCPServers from settings', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { ...baseSettings, - allowMCPServers: ['server1', 'server2'], + mcp: { allowed: ['server1', 'server2'] }, }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getMcpServers()).toEqual({ @@ -1290,10 +1367,10 @@ describe('loadCliConfig with allowed-mcp-server-names', () => { it('should read excludeMCPServers from settings', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { ...baseSettings, - excludeMCPServers: ['server1', 'server2'], + mcp: { excluded: ['server1', 'server2'] }, }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getMcpServers()).toEqual({ @@ -1301,13 +1378,15 @@ describe('loadCliConfig with allowed-mcp-server-names', () => { }); }); - it('should override allowMCPServers with excludeMCPServers if overlapping ', async () => { + it('should override allowMCPServers with excludeMCPServers if overlapping', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { ...baseSettings, - excludeMCPServers: ['server1'], - allowMCPServers: ['server1', 'server2'], + mcp: { + excluded: ['server1'], + allowed: ['server1', 'server2'], + }, }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getMcpServers()).toEqual({ @@ -1315,33 +1394,61 @@ describe('loadCliConfig with allowed-mcp-server-names', () => { }); }); - it('should prioritize mcp server flag if set ', async () => { + it('should prioritize mcp server flag if set', async () => { process.argv = [ 'node', 'script.js', '--allowed-mcp-server-names', 'server1', ]; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { ...baseSettings, - excludeMCPServers: ['server1'], - allowMCPServers: ['server2'], + mcp: { + excluded: ['server1'], + allowed: ['server2'], + }, }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getMcpServers()).toEqual({ server1: { url: 'http://localhost:8080' }, }); }); + + it('should prioritize CLI flag over both allowed and excluded settings', async () => { + process.argv = [ + 'node', + 'script.js', + '--allowed-mcp-server-names', + 'server2', + '--allowed-mcp-server-names', + 'server3', + ]; + const argv = await parseArguments({} as Settings); + const settings: Settings = { + ...baseSettings, + mcp: { + allowed: ['server1', 'server2'], // Should be ignored + excluded: ['server3'], // Should be ignored + }, + }; + const config = await loadCliConfig(settings, [], 'test-session', argv); + expect(config.getMcpServers()).toEqual({ + server2: { url: 'http://localhost:8081' }, + server3: { url: 'http://localhost:8082' }, + }); + }); }); describe('loadCliConfig extensions', () => { const mockExtensions: Extension[] = [ { + path: '/path/to/ext1', config: { name: 'ext1', version: '1.0.0' }, contextFiles: ['/path/to/ext1.md'], }, { + path: '/path/to/ext2', config: { name: 'ext2', version: '1.0.0' }, contextFiles: ['/path/to/ext2.md'], }, @@ -1349,7 +1456,7 @@ describe('loadCliConfig extensions', () => { it('should not filter extensions if --extensions flag is not used', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = {}; const config = await loadCliConfig( settings, @@ -1365,7 +1472,7 @@ describe('loadCliConfig extensions', () => { it('should filter extensions if --extensions flag is used', async () => { process.argv = ['node', 'script.js', '--extensions', 'ext1']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = {}; const config = await loadCliConfig( settings, @@ -1380,10 +1487,12 @@ describe('loadCliConfig extensions', () => { describe('loadCliConfig model selection', () => { it('selects a model from settings.json if provided', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig( { - model: 'qwen3-coder-plus', + model: { + name: 'qwen3-coder-plus', + }, }, [], 'test-session', @@ -1395,7 +1504,7 @@ describe('loadCliConfig model selection', () => { it('uses the default gemini model if nothing is set', async () => { process.argv = ['node', 'script.js']; // No model set. - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig( { // No model set. @@ -1410,10 +1519,12 @@ describe('loadCliConfig model selection', () => { it('always prefers model from argvs', async () => { process.argv = ['node', 'script.js', '--model', 'qwen3-coder-plus']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig( { - model: 'qwen3-coder-plus', + model: { + name: 'qwen3-coder-flash', + }, }, [], 'test-session', @@ -1425,7 +1536,7 @@ describe('loadCliConfig model selection', () => { it('selects the model from argvs if provided', async () => { process.argv = ['node', 'script.js', '--model', 'qwen3-coder-plus']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig( { // No model provided via settings. @@ -1457,15 +1568,17 @@ describe('loadCliConfig folderTrustFeature', () => { it('should be false by default', async () => { process.argv = ['node', 'script.js']; const settings: Settings = {}; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getFolderTrustFeature()).toBe(false); }); it('should be true when settings.folderTrustFeature is true', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); - const settings: Settings = { folderTrustFeature: true }; + const argv = await parseArguments({} as Settings); + const settings: Settings = { + security: { folderTrust: { featureEnabled: true } }, + }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getFolderTrustFeature()).toBe(true); }); @@ -1489,68 +1602,64 @@ describe('loadCliConfig folderTrust', () => { it('should be false if folderTrustFeature is false and folderTrust is false', async () => { process.argv = ['node', 'script.js']; const settings: Settings = { - folderTrustFeature: false, - folderTrust: false, + security: { + folderTrust: { + featureEnabled: false, + enabled: false, + }, + }, }; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getFolderTrust()).toBe(false); }); it('should be false if folderTrustFeature is true and folderTrust is false', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); - const settings: Settings = { folderTrustFeature: true, folderTrust: false }; + const argv = await parseArguments({} as Settings); + const settings: Settings = { + security: { + folderTrust: { + featureEnabled: true, + enabled: false, + }, + }, + }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getFolderTrust()).toBe(false); }); it('should be false if folderTrustFeature is false and folderTrust is true', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); - const settings: Settings = { folderTrustFeature: false, folderTrust: true }; + const argv = await parseArguments({} as Settings); + const settings: Settings = { + security: { + folderTrust: { + featureEnabled: false, + enabled: true, + }, + }, + }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getFolderTrust()).toBe(false); }); it('should be true when folderTrustFeature is true and folderTrust is true', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); - const settings: Settings = { folderTrustFeature: true, folderTrust: true }; + const argv = await parseArguments({} as Settings); + const settings: Settings = { + security: { + folderTrust: { + featureEnabled: true, + enabled: true, + }, + }, + }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getFolderTrust()).toBe(true); }); }); -vi.mock('fs', async () => { - const actualFs = await vi.importActual('fs'); - const MOCK_CWD1 = process.cwd(); - const MOCK_CWD2 = path.resolve(path.sep, 'home', 'user', 'project'); - - const mockPaths = new Set([ - MOCK_CWD1, - MOCK_CWD2, - path.resolve(path.sep, 'cli', 'path1'), - path.resolve(path.sep, 'settings', 'path1'), - path.join(os.homedir(), 'settings', 'path2'), - path.join(MOCK_CWD2, 'cli', 'path2'), - path.join(MOCK_CWD2, 'settings', 'path3'), - ]); - - return { - ...actualFs, - existsSync: vi.fn((p) => mockPaths.has(p.toString())), - statSync: vi.fn((p) => { - if (mockPaths.has(p.toString())) { - return { isDirectory: () => true }; - } - // Fallback for other paths if needed, though the test should be specific. - return actualFs.statSync(p); - }), - realpathSync: vi.fn((p) => p), - }; -}); - describe('loadCliConfig with includeDirectories', () => { const originalArgv = process.argv; @@ -1577,13 +1686,15 @@ describe('loadCliConfig with includeDirectories', () => { '--include-directories', `${path.resolve(path.sep, 'cli', 'path1')},${path.join(mockCwd, 'cli', 'path2')}`, ]; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { - includeDirectories: [ - path.resolve(path.sep, 'settings', 'path1'), - path.join(os.homedir(), 'settings', 'path2'), - path.join(mockCwd, 'settings', 'path3'), - ], + context: { + includeDirectories: [ + path.resolve(path.sep, 'settings', 'path1'), + path.join(os.homedir(), 'settings', 'path2'), + path.join(mockCwd, 'settings', 'path3'), + ], + }, }; const config = await loadCliConfig(settings, [], 'test-session', argv); const expected = [ @@ -1620,10 +1731,12 @@ describe('loadCliConfig chatCompression', () => { it('should pass chatCompression settings to the core config', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = { - chatCompression: { - contextPercentageThreshold: 0.5, + model: { + chatCompression: { + contextPercentageThreshold: 0.5, + }, }, }; const config = await loadCliConfig(settings, [], 'test-session', argv); @@ -1634,13 +1747,53 @@ describe('loadCliConfig chatCompression', () => { it('should have undefined chatCompression if not in settings', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const settings: Settings = {}; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getChatCompression()).toBeUndefined(); }); }); +describe('loadCliConfig useRipgrep', () => { + const originalArgv = process.argv; + + beforeEach(() => { + vi.resetAllMocks(); + vi.mocked(os.homedir).mockReturnValue('/mock/home/user'); + vi.stubEnv('GEMINI_API_KEY', 'test-api-key'); + }); + + afterEach(() => { + process.argv = originalArgv; + vi.unstubAllEnvs(); + vi.restoreAllMocks(); + }); + + it('should be false by default when useRipgrep is not set in settings', async () => { + process.argv = ['node', 'script.js']; + const argv = await parseArguments({} as Settings); + const settings: Settings = {}; + const config = await loadCliConfig(settings, [], 'test-session', argv); + expect(config.getUseRipgrep()).toBe(false); + }); + + it('should be true when useRipgrep is set to true in settings', async () => { + process.argv = ['node', 'script.js']; + const argv = await parseArguments({} as Settings); + const settings: Settings = { tools: { useRipgrep: true } }; + const config = await loadCliConfig(settings, [], 'test-session', argv); + expect(config.getUseRipgrep()).toBe(true); + }); + + it('should be false when useRipgrep is explicitly set to false in settings', async () => { + process.argv = ['node', 'script.js']; + const argv = await parseArguments({} as Settings); + const settings: Settings = { tools: { useRipgrep: false } }; + const config = await loadCliConfig(settings, [], 'test-session', argv); + expect(config.getUseRipgrep()).toBe(false); + }); +}); + describe('loadCliConfig tool exclusions', () => { const originalArgv = process.argv; const originalIsTTY = process.stdin.isTTY; @@ -1650,6 +1803,7 @@ describe('loadCliConfig tool exclusions', () => { vi.mocked(os.homedir).mockReturnValue('/mock/home/user'); vi.stubEnv('GEMINI_API_KEY', 'test-api-key'); process.stdin.isTTY = true; + vi.mocked(isWorkspaceTrusted).mockReturnValue(true); }); afterEach(() => { @@ -1662,7 +1816,7 @@ describe('loadCliConfig tool exclusions', () => { it('should not exclude interactive tools in interactive mode without YOLO', async () => { process.stdin.isTTY = true; process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig({}, [], 'test-session', argv); expect(config.getExcludeTools()).not.toContain(ShellTool.Name); expect(config.getExcludeTools()).not.toContain(EditTool.Name); @@ -1672,7 +1826,7 @@ describe('loadCliConfig tool exclusions', () => { it('should not exclude interactive tools in interactive mode with YOLO', async () => { process.stdin.isTTY = true; process.argv = ['node', 'script.js', '--yolo']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig({}, [], 'test-session', argv); expect(config.getExcludeTools()).not.toContain(ShellTool.Name); expect(config.getExcludeTools()).not.toContain(EditTool.Name); @@ -1682,7 +1836,7 @@ describe('loadCliConfig tool exclusions', () => { it('should exclude interactive tools in non-interactive mode without YOLO', async () => { process.stdin.isTTY = false; process.argv = ['node', 'script.js', '-p', 'test']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig({}, [], 'test-session', argv); expect(config.getExcludeTools()).toContain(ShellTool.Name); expect(config.getExcludeTools()).toContain(EditTool.Name); @@ -1692,7 +1846,7 @@ describe('loadCliConfig tool exclusions', () => { it('should not exclude interactive tools in non-interactive mode with YOLO', async () => { process.stdin.isTTY = false; process.argv = ['node', 'script.js', '-p', 'test', '--yolo']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig({}, [], 'test-session', argv); expect(config.getExcludeTools()).not.toContain(ShellTool.Name); expect(config.getExcludeTools()).not.toContain(EditTool.Name); @@ -1721,7 +1875,7 @@ describe('loadCliConfig interactive', () => { it('should be interactive if isTTY and no prompt', async () => { process.stdin.isTTY = true; process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig({}, [], 'test-session', argv); expect(config.isInteractive()).toBe(true); }); @@ -1729,7 +1883,7 @@ describe('loadCliConfig interactive', () => { it('should be interactive if prompt-interactive is set', async () => { process.stdin.isTTY = false; process.argv = ['node', 'script.js', '--prompt-interactive', 'test']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig({}, [], 'test-session', argv); expect(config.isInteractive()).toBe(true); }); @@ -1737,7 +1891,7 @@ describe('loadCliConfig interactive', () => { it('should not be interactive if not isTTY and no prompt', async () => { process.stdin.isTTY = false; process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig({}, [], 'test-session', argv); expect(config.isInteractive()).toBe(false); }); @@ -1745,7 +1899,7 @@ describe('loadCliConfig interactive', () => { it('should not be interactive if prompt is set', async () => { process.stdin.isTTY = true; process.argv = ['node', 'script.js', '--prompt', 'test']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig({}, [], 'test-session', argv); expect(config.isInteractive()).toBe(false); }); @@ -1759,6 +1913,7 @@ describe('loadCliConfig approval mode', () => { vi.mocked(os.homedir).mockReturnValue('/mock/home/user'); vi.stubEnv('GEMINI_API_KEY', 'test-api-key'); process.argv = ['node', 'script.js']; // Reset argv for each test + vi.mocked(isWorkspaceTrusted).mockReturnValue(true); }); afterEach(() => { @@ -1769,42 +1924,42 @@ describe('loadCliConfig approval mode', () => { it('should default to DEFAULT approval mode when no flags are set', async () => { process.argv = ['node', 'script.js']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig({}, [], 'test-session', argv); expect(config.getApprovalMode()).toBe(ServerConfig.ApprovalMode.DEFAULT); }); it('should set YOLO approval mode when --yolo flag is used', async () => { process.argv = ['node', 'script.js', '--yolo']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig({}, [], 'test-session', argv); expect(config.getApprovalMode()).toBe(ServerConfig.ApprovalMode.YOLO); }); it('should set YOLO approval mode when -y flag is used', async () => { process.argv = ['node', 'script.js', '-y']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig({}, [], 'test-session', argv); expect(config.getApprovalMode()).toBe(ServerConfig.ApprovalMode.YOLO); }); it('should set DEFAULT approval mode when --approval-mode=default', async () => { process.argv = ['node', 'script.js', '--approval-mode', 'default']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig({}, [], 'test-session', argv); expect(config.getApprovalMode()).toBe(ServerConfig.ApprovalMode.DEFAULT); }); it('should set AUTO_EDIT approval mode when --approval-mode=auto_edit', async () => { process.argv = ['node', 'script.js', '--approval-mode', 'auto_edit']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig({}, [], 'test-session', argv); expect(config.getApprovalMode()).toBe(ServerConfig.ApprovalMode.AUTO_EDIT); }); it('should set YOLO approval mode when --approval-mode=yolo', async () => { process.argv = ['node', 'script.js', '--approval-mode', 'yolo']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig({}, [], 'test-session', argv); expect(config.getApprovalMode()).toBe(ServerConfig.ApprovalMode.YOLO); }); @@ -1813,7 +1968,7 @@ describe('loadCliConfig approval mode', () => { // Note: This test documents the intended behavior, but in practice the validation // prevents both flags from being used together process.argv = ['node', 'script.js', '--approval-mode', 'default']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); // Manually set yolo to true to simulate what would happen if validation didn't prevent it argv.yolo = true; const config = await loadCliConfig({}, [], 'test-session', argv); @@ -1822,10 +1977,45 @@ describe('loadCliConfig approval mode', () => { it('should fall back to --yolo behavior when --approval-mode is not set', async () => { process.argv = ['node', 'script.js', '--yolo']; - const argv = await parseArguments(); + const argv = await parseArguments({} as Settings); const config = await loadCliConfig({}, [], 'test-session', argv); expect(config.getApprovalMode()).toBe(ServerConfig.ApprovalMode.YOLO); }); + + // --- Untrusted Folder Scenarios --- + describe('when folder is NOT trusted', () => { + beforeEach(() => { + vi.mocked(isWorkspaceTrusted).mockReturnValue(false); + }); + + it('should override --approval-mode=yolo to DEFAULT', async () => { + process.argv = ['node', 'script.js', '--approval-mode', 'yolo']; + const argv = await parseArguments({} as Settings); + const config = await loadCliConfig({}, [], 'test-session', argv); + expect(config.getApprovalMode()).toBe(ServerConfig.ApprovalMode.DEFAULT); + }); + + it('should override --approval-mode=auto_edit to DEFAULT', async () => { + process.argv = ['node', 'script.js', '--approval-mode', 'auto_edit']; + const argv = await parseArguments({} as Settings); + const config = await loadCliConfig({}, [], 'test-session', argv); + expect(config.getApprovalMode()).toBe(ServerConfig.ApprovalMode.DEFAULT); + }); + + it('should override --yolo flag to DEFAULT', async () => { + process.argv = ['node', 'script.js', '--yolo']; + const argv = await parseArguments({} as Settings); + const config = await loadCliConfig({}, [], 'test-session', argv); + expect(config.getApprovalMode()).toBe(ServerConfig.ApprovalMode.DEFAULT); + }); + + it('should remain DEFAULT when --approval-mode=default', async () => { + process.argv = ['node', 'script.js', '--approval-mode', 'default']; + const argv = await parseArguments({} as Settings); + const config = await loadCliConfig({}, [], 'test-session', argv); + expect(config.getApprovalMode()).toBe(ServerConfig.ApprovalMode.DEFAULT); + }); + }); }); describe('loadCliConfig trustedFolder', () => { @@ -1933,16 +2123,27 @@ describe('loadCliConfig trustedFolder', () => { description, } of testCases) { it(`should be correct for: ${description}`, async () => { - (isWorkspaceTrusted as vi.Mock).mockImplementation( - (settings: Settings) => { - const featureIsEnabled = - (settings.folderTrustFeature ?? false) && - (settings.folderTrust ?? true); - return featureIsEnabled ? mockTrustValue : true; + (isWorkspaceTrusted as Mock).mockImplementation((settings: Settings) => { + const folderTrustFeature = + settings.security?.folderTrust?.featureEnabled ?? false; + const folderTrustSetting = + settings.security?.folderTrust?.enabled ?? true; + const folderTrustEnabled = folderTrustFeature && folderTrustSetting; + + if (!folderTrustEnabled) { + return true; + } + return mockTrustValue; // This is the part that comes from the test case + }); + const argv = await parseArguments({} as Settings); + const settings: Settings = { + security: { + folderTrust: { + featureEnabled: folderTrustFeature, + enabled: folderTrust, + }, }, - ); - const argv = await parseArguments(); - const settings: Settings = { folderTrustFeature, folderTrust }; + }; const config = await loadCliConfig(settings, [], 'test-session', argv); expect(config.getFolderTrust()).toBe(expectedFolderTrust); diff --git a/packages/cli/src/config/config.ts b/packages/cli/src/config/config.ts old mode 100644 new mode 100755 index aae4033a..eaa354d6 --- a/packages/cli/src/config/config.ts +++ b/packages/cli/src/config/config.ts @@ -4,37 +4,41 @@ * SPDX-License-Identifier: Apache-2.0 */ -import * as fs from 'fs'; -import * as path from 'path'; -import { homedir } from 'node:os'; -import yargs from 'yargs/yargs'; -import { hideBin } from 'yargs/helpers'; -import process from 'node:process'; -import { mcpCommand } from '../commands/mcp.js'; +import type { + ConfigParameters, + FileFilteringOptions, + MCPServerConfig, + TelemetryTarget, +} from '@qwen-code/qwen-code-core'; import { + ApprovalMode, Config, + DEFAULT_GEMINI_EMBEDDING_MODEL, + DEFAULT_GEMINI_MODEL, + DEFAULT_MEMORY_FILE_FILTERING_OPTIONS, + EditTool, + FileDiscoveryService, + getCurrentGeminiMdFilename, loadServerHierarchicalMemory, setGeminiMdFilename as setServerGeminiMdFilename, - getCurrentGeminiMdFilename, - ApprovalMode, - DEFAULT_GEMINI_MODEL, - DEFAULT_GEMINI_EMBEDDING_MODEL, - DEFAULT_MEMORY_FILE_FILTERING_OPTIONS, - FileDiscoveryService, - TelemetryTarget, - FileFilteringOptions, ShellTool, - EditTool, WriteFileTool, - MCPServerConfig, - ConfigParameters, } from '@qwen-code/qwen-code-core'; -import { Settings } from './settings.js'; +import * as fs from 'node:fs'; +import { homedir } from 'node:os'; +import * as path from 'node:path'; +import process from 'node:process'; +import { hideBin } from 'yargs/helpers'; +import yargs from 'yargs/yargs'; +import { extensionsCommand } from '../commands/extensions.js'; +import { mcpCommand } from '../commands/mcp.js'; +import type { Settings } from './settings.js'; -import { Extension, annotateActiveExtensions } from './extension.js'; -import { getCliVersion } from '../utils/version.js'; -import { loadSandboxConfig } from './sandboxConfig.js'; import { resolvePath } from '../utils/resolvePath.js'; +import { getCliVersion } from '../utils/version.js'; +import type { Extension } from './extension.js'; +import { annotateActiveExtensions } from './extension.js'; +import { loadSandboxConfig } from './sandboxConfig.js'; import { isWorkspaceTrusted } from './trustedFolders.js'; @@ -56,9 +60,7 @@ export interface CliArgs { prompt: string | undefined; promptInteractive: string | undefined; allFiles: boolean | undefined; - all_files: boolean | undefined; showMemoryUsage: boolean | undefined; - show_memory_usage: boolean | undefined; yolo: boolean | undefined; approvalMode: string | undefined; telemetry: boolean | undefined; @@ -69,6 +71,7 @@ export interface CliArgs { telemetryLogPrompts: boolean | undefined; telemetryOutfile: string | undefined; allowedMcpServerNames: string[] | undefined; + allowedTools: string[] | undefined; experimentalAcp: boolean | undefined; extensions: string[] | undefined; listExtensions: boolean | undefined; @@ -78,9 +81,10 @@ export interface CliArgs { proxy: string | undefined; includeDirectories: string[] | undefined; tavilyApiKey: string | undefined; + screenReader: boolean | undefined; } -export async function parseArguments(): Promise { +export async function parseArguments(settings: Settings): Promise { const yargsInstance = yargs(hideBin(process.argv)) // Set locale to English for consistent output, especially in tests .locale('en') @@ -128,29 +132,11 @@ export async function parseArguments(): Promise { description: 'Include ALL files in context?', default: false, }) - .option('all_files', { - type: 'boolean', - description: 'Include ALL files in context?', - default: false, - }) - .deprecateOption( - 'all_files', - 'Use --all-files instead. We will be removing --all_files in the coming weeks.', - ) .option('show-memory-usage', { type: 'boolean', description: 'Show memory usage in status bar', default: false, }) - .option('show_memory_usage', { - type: 'boolean', - description: 'Show memory usage in status bar', - default: false, - }) - .deprecateOption( - 'show_memory_usage', - 'Use --show-memory-usage instead. We will be removing --show_memory_usage in the coming weeks.', - ) .option('yolo', { alias: 'y', type: 'boolean', @@ -210,6 +196,11 @@ export async function parseArguments(): Promise { string: true, description: 'Allowed MCP server names', }) + .option('allowed-tools', { + type: 'array', + string: true, + description: 'Tools that are allowed to run without confirmation', + }) .option('extensions', { alias: 'e', type: 'array', @@ -253,7 +244,11 @@ export async function parseArguments(): Promise { type: 'string', description: 'Tavily API key for web search functionality', }) - + .option('screen-reader', { + type: 'boolean', + description: 'Enable screen reader mode for accessibility.', + default: false, + }) .check((argv) => { if (argv.prompt && argv['promptInteractive']) { throw new Error( @@ -269,7 +264,13 @@ export async function parseArguments(): Promise { }), ) // Register MCP subcommands - .command(mcpCommand) + .command(mcpCommand); + + if (settings?.experimental?.extensionManagement ?? false) { + yargsInstance.command(extensionsCommand); + } + + yargsInstance .version(await getCliVersion()) // This will enable the --version flag based on package.json .alias('v', 'version') .help() @@ -282,7 +283,10 @@ export async function parseArguments(): Promise { // Handle case where MCP subcommands are executed - they should exit the process // and not return to main CLI logic - if (result._.length > 0 && result._[0] === 'mcp') { + if ( + result._.length > 0 && + (result._[0] === 'mcp' || result._[0] === 'extensions') + ) { // MCP commands handle their own execution and process exit process.exit(0); } @@ -329,7 +333,7 @@ export async function loadHierarchicalGeminiMemory( extensionContextFilePaths, memoryImportFormat, fileFilteringOptions, - settings.memoryDiscoveryMaxDirs, + settings.context?.discoveryMaxDirs, ); } @@ -346,18 +350,20 @@ export async function loadCliConfig( (v) => v === 'true' || v === '1', ) || false; - const memoryImportFormat = settings.memoryImportFormat || 'tree'; + const memoryImportFormat = settings.context?.importFormat || 'tree'; - const ideMode = settings.ideMode ?? false; + const ideMode = settings.ide?.enabled ?? false; - const folderTrustFeature = settings.folderTrustFeature ?? false; - const folderTrustSetting = settings.folderTrust ?? true; + const folderTrustFeature = + settings.security?.folderTrust?.featureEnabled ?? false; + const folderTrustSetting = settings.security?.folderTrust?.enabled ?? true; const folderTrust = folderTrustFeature && folderTrustSetting; const trustedFolder = isWorkspaceTrusted(settings); const allExtensions = annotateActiveExtensions( extensions, argv.extensions || [], + cwd, ); const activeExtensions = extensions.filter( @@ -382,8 +388,8 @@ export async function loadCliConfig( // TODO(b/343434939): This is a bit of a hack. The contextFileName should ideally be passed // directly to the Config constructor in core, and have core handle setGeminiMdFilename. // However, loadHierarchicalGeminiMemory is called *before* createServerConfig. - if (settings.contextFileName) { - setServerGeminiMdFilename(settings.contextFileName); + if (settings.context?.fileName) { + setServerGeminiMdFilename(settings.context.fileName); } else { // Reset to default if not provided in settings. setServerGeminiMdFilename(getCurrentGeminiMdFilename()); @@ -397,17 +403,19 @@ export async function loadCliConfig( const fileFiltering = { ...DEFAULT_MEMORY_FILE_FILTERING_OPTIONS, - ...settings.fileFiltering, + ...settings.context?.fileFiltering, }; - const includeDirectories = (settings.includeDirectories || []) + const includeDirectories = (settings.context?.includeDirectories || []) .map(resolvePath) .concat((argv.includeDirectories || []).map(resolvePath)); // Call the (now wrapper) loadHierarchicalGeminiMemory which calls the server's version const { memoryContent, fileCount } = await loadHierarchicalGeminiMemory( cwd, - settings.loadMemoryFromIncludeDirectories ? includeDirectories : [], + settings.context?.loadMemoryFromIncludeDirectories + ? includeDirectories + : [], debugMode, fileService, settings, @@ -444,6 +452,14 @@ export async function loadCliConfig( argv.yolo || false ? ApprovalMode.YOLO : ApprovalMode.DEFAULT; } + // Force approval mode to default if the folder is not trusted. + if (!trustedFolder && approvalMode !== ApprovalMode.DEFAULT) { + logger.warn( + `Approval mode overridden to "default" because the current folder is not trusted.`, + ); + approvalMode = ApprovalMode.DEFAULT; + } + const interactive = !!argv.promptInteractive || (process.stdin.isTTY && question.length === 0); // In non-interactive mode, exclude tools that require a prompt. @@ -475,16 +491,16 @@ export async function loadCliConfig( const blockedMcpServers: Array<{ name: string; extensionName: string }> = []; if (!argv.allowedMcpServerNames) { - if (settings.allowMCPServers) { + if (settings.mcp?.allowed) { mcpServers = allowedMcpServers( mcpServers, - settings.allowMCPServers, + settings.mcp.allowed, blockedMcpServers, ); } - if (settings.excludeMCPServers) { - const excludedNames = new Set(settings.excludeMCPServers.filter(Boolean)); + if (settings.mcp?.excluded) { + const excludedNames = new Set(settings.mcp.excluded.filter(Boolean)); if (excludedNames.size > 0) { mcpServers = Object.fromEntries( Object.entries(mcpServers).filter(([key]) => !excludedNames.has(key)), @@ -504,6 +520,10 @@ export async function loadCliConfig( const sandboxConfig = await loadSandboxConfig(settings, argv); const cliVersion = await getCliVersion(); + const screenReader = + argv.screenReader !== undefined + ? argv.screenReader + : (settings.ui?.accessibility?.screenReader ?? false); return new Config({ sessionId, embeddingModel: DEFAULT_GEMINI_EMBEDDING_MODEL, @@ -511,25 +531,26 @@ export async function loadCliConfig( targetDir: cwd, includeDirectories, loadMemoryFromIncludeDirectories: - settings.loadMemoryFromIncludeDirectories || false, + settings.context?.loadMemoryFromIncludeDirectories || false, debugMode, question, - fullContext: argv.allFiles || argv.all_files || false, - coreTools: settings.coreTools || undefined, + fullContext: argv.allFiles || false, + coreTools: settings.tools?.core || undefined, + allowedTools: argv.allowedTools || settings.tools?.allowed || undefined, excludeTools, - toolDiscoveryCommand: settings.toolDiscoveryCommand, - toolCallCommand: settings.toolCallCommand, - mcpServerCommand: settings.mcpServerCommand, + toolDiscoveryCommand: settings.tools?.discoveryCommand, + toolCallCommand: settings.tools?.callCommand, + mcpServerCommand: settings.mcp?.serverCommand, mcpServers, userMemory: memoryContent, geminiMdFileCount: fileCount, approvalMode, showMemoryUsage: - argv.showMemoryUsage || - argv.show_memory_usage || - settings.showMemoryUsage || - false, - accessibility: settings.accessibility, + argv.showMemoryUsage || settings.ui?.showMemoryUsage || false, + accessibility: { + ...settings.ui?.accessibility, + screenReader, + }, telemetry: { enabled: argv.telemetry ?? settings.telemetry?.enabled, target: (argv.telemetryTarget ?? @@ -546,15 +567,17 @@ export async function loadCliConfig( logPrompts: argv.telemetryLogPrompts ?? settings.telemetry?.logPrompts, outfile: argv.telemetryOutfile ?? settings.telemetry?.outfile, }, - usageStatisticsEnabled: settings.usageStatisticsEnabled ?? true, + usageStatisticsEnabled: settings.privacy?.usageStatisticsEnabled ?? true, // Git-aware file filtering settings fileFiltering: { - respectGitIgnore: settings.fileFiltering?.respectGitIgnore, - respectGeminiIgnore: settings.fileFiltering?.respectGeminiIgnore, + respectGitIgnore: settings.context?.fileFiltering?.respectGitIgnore, + respectGeminiIgnore: settings.context?.fileFiltering?.respectGeminiIgnore, enableRecursiveFileSearch: - settings.fileFiltering?.enableRecursiveFileSearch, + settings.context?.fileFiltering?.enableRecursiveFileSearch, + disableFuzzySearch: settings.context?.fileFiltering?.disableFuzzySearch, }, - checkpointing: argv.checkpointing || settings.checkpointing?.enabled, + checkpointing: + argv.checkpointing || settings.general?.checkpointing?.enabled, proxy: argv.proxy || process.env['HTTPS_PROXY'] || @@ -563,18 +586,16 @@ export async function loadCliConfig( process.env['http_proxy'], cwd, fileDiscoveryService: fileService, - bugCommand: settings.bugCommand, - model: argv.model || settings.model || DEFAULT_GEMINI_MODEL, + bugCommand: settings.advanced?.bugCommand, + model: argv.model || settings.model?.name || DEFAULT_GEMINI_MODEL, extensionContextFilePaths, - maxSessionTurns: settings.maxSessionTurns ?? -1, sessionTokenLimit: settings.sessionTokenLimit ?? -1, + maxSessionTurns: settings.model?.maxSessionTurns ?? -1, experimentalZedIntegration: argv.experimentalAcp || false, listExtensions: argv.listExtensions || false, extensions: allExtensions, blockedMcpServers, noBrowser: !!process.env['NO_BROWSER'], - summarizeToolOutput: settings.summarizeToolOutput, - ideMode, enableOpenAILogging: (typeof argv.openaiLogging === 'undefined' ? settings.enableOpenAILogging @@ -590,20 +611,25 @@ export async function loadCliConfig( 'SYSTEM_TEMPLATE:{"name":"qwen3_coder","params":{"is_git_repository":{RUNTIME_VARS_IS_GIT_REPO},"sandbox":"{RUNTIME_VARS_SANDBOX}"}}', }, ]) as ConfigParameters['systemPromptMappings'], - authType: settings.selectedAuthType, + authType: settings.security?.auth?.selectedType, contentGenerator: settings.contentGenerator, cliVersion, tavilyApiKey: argv.tavilyApiKey || settings.tavilyApiKey || process.env['TAVILY_API_KEY'], - chatCompression: settings.chatCompression, + summarizeToolOutput: settings.model?.summarizeToolOutput, + ideMode, + chatCompression: settings.model?.chatCompression, folderTrustFeature, folderTrust, interactive, trustedFolder, - shouldUseNodePtyShell: settings.shouldUseNodePtyShell, - skipNextSpeakerCheck: settings.skipNextSpeakerCheck, + useRipgrep: settings.tools?.useRipgrep, + shouldUseNodePtyShell: settings.tools?.usePty, + skipNextSpeakerCheck: settings.model?.skipNextSpeakerCheck, + enablePromptCompletion: settings.general?.enablePromptCompletion ?? false, + skipLoopDetection: settings.skipLoopDetection ?? false, }); } @@ -665,7 +691,7 @@ function mergeExcludeTools( extraExcludes?: string[] | undefined, ): string[] { const allExcludeTools = new Set([ - ...(settings.excludeTools || []), + ...(settings.tools?.exclude || []), ...(extraExcludes || []), ]); for (const extension of extensions) { diff --git a/packages/cli/src/config/extension.test.ts b/packages/cli/src/config/extension.test.ts index 9cc898be..068c815d 100644 --- a/packages/cli/src/config/extension.test.ts +++ b/packages/cli/src/config/extension.test.ts @@ -5,24 +5,52 @@ */ import { vi } from 'vitest'; -import * as fs from 'fs'; -import * as os from 'os'; -import * as path from 'path'; +import * as fs from 'node:fs'; +import * as os from 'node:os'; +import * as path from 'node:path'; import { EXTENSIONS_CONFIG_FILENAME, - EXTENSIONS_DIRECTORY_NAME, + INSTALL_METADATA_FILENAME, annotateActiveExtensions, + disableExtension, + enableExtension, + installExtension, + loadExtension, loadExtensions, + performWorkspaceExtensionMigration, + uninstallExtension, + updateExtension, } from './extension.js'; +import { + type GeminiCLIExtension, + type MCPServerConfig, +} from '@qwen-code/qwen-code-core'; +import { execSync } from 'node:child_process'; +import { SettingScope, loadSettings } from './settings.js'; +import { type SimpleGit, simpleGit } from 'simple-git'; + +vi.mock('simple-git', () => ({ + simpleGit: vi.fn(), +})); vi.mock('os', async (importOriginal) => { - const os = await importOriginal(); + const os = await importOriginal(); return { ...os, homedir: vi.fn(), }; }); +vi.mock('child_process', async (importOriginal) => { + const actual = await importOriginal(); + return { + ...actual, + execSync: vi.fn(), + }; +}); + +const EXTENSIONS_DIRECTORY_NAME = path.join('.qwen', 'extensions'); + describe('loadExtensions', () => { let tempWorkspaceDir: string; let tempHomeDir: string; @@ -40,56 +68,7 @@ describe('loadExtensions', () => { afterEach(() => { fs.rmSync(tempWorkspaceDir, { recursive: true, force: true }); fs.rmSync(tempHomeDir, { recursive: true, force: true }); - }); - - it('should include extension path in loaded extension', () => { - const workspaceExtensionsDir = path.join( - tempWorkspaceDir, - EXTENSIONS_DIRECTORY_NAME, - ); - fs.mkdirSync(workspaceExtensionsDir, { recursive: true }); - - const extensionDir = path.join(workspaceExtensionsDir, 'test-extension'); - fs.mkdirSync(extensionDir, { recursive: true }); - - const config = { - name: 'test-extension', - version: '1.0.0', - }; - fs.writeFileSync( - path.join(extensionDir, EXTENSIONS_CONFIG_FILENAME), - JSON.stringify(config), - ); - - const extensions = loadExtensions(tempWorkspaceDir); - expect(extensions).toHaveLength(1); - expect(extensions[0].path).toBe(extensionDir); - expect(extensions[0].config.name).toBe('test-extension'); - }); - - it('should include extension path in loaded extension', () => { - const workspaceExtensionsDir = path.join( - tempWorkspaceDir, - EXTENSIONS_DIRECTORY_NAME, - ); - fs.mkdirSync(workspaceExtensionsDir, { recursive: true }); - - const extensionDir = path.join(workspaceExtensionsDir, 'test-extension'); - fs.mkdirSync(extensionDir, { recursive: true }); - - const config = { - name: 'test-extension', - version: '1.0.0', - }; - fs.writeFileSync( - path.join(extensionDir, EXTENSIONS_CONFIG_FILENAME), - JSON.stringify(config), - ); - - const extensions = loadExtensions(tempWorkspaceDir); - expect(extensions).toHaveLength(1); - expect(extensions[0].path).toBe(extensionDir); - expect(extensions[0].config.name).toBe('test-extension'); + vi.restoreAllMocks(); }); it('should include extension path in loaded extension', () => { @@ -159,26 +138,101 @@ describe('loadExtensions', () => { path.join(workspaceExtensionsDir, 'ext1', 'my-context-file.md'), ]); }); + + it('should filter out disabled extensions', () => { + const workspaceExtensionsDir = path.join( + tempWorkspaceDir, + EXTENSIONS_DIRECTORY_NAME, + ); + fs.mkdirSync(workspaceExtensionsDir, { recursive: true }); + + createExtension(workspaceExtensionsDir, 'ext1', '1.0.0'); + createExtension(workspaceExtensionsDir, 'ext2', '2.0.0'); + + const settingsDir = path.join(tempWorkspaceDir, '.qwen'); + fs.mkdirSync(settingsDir, { recursive: true }); + fs.writeFileSync( + path.join(settingsDir, 'settings.json'), + JSON.stringify({ extensions: { disabled: ['ext1'] } }), + ); + + const extensions = loadExtensions(tempWorkspaceDir); + const activeExtensions = annotateActiveExtensions( + extensions, + [], + tempWorkspaceDir, + ).filter((e) => e.isActive); + expect(activeExtensions).toHaveLength(1); + expect(activeExtensions[0].name).toBe('ext2'); + }); + + it('should hydrate variables', () => { + const workspaceExtensionsDir = path.join( + tempWorkspaceDir, + EXTENSIONS_DIRECTORY_NAME, + ); + fs.mkdirSync(workspaceExtensionsDir, { recursive: true }); + + createExtension( + workspaceExtensionsDir, + 'test-extension', + '1.0.0', + false, + undefined, + { + 'test-server': { + cwd: '${extensionPath}${/}server', + }, + }, + ); + + const extensions = loadExtensions(tempWorkspaceDir); + expect(extensions).toHaveLength(1); + const loadedConfig = extensions[0].config; + const expectedCwd = path.join( + workspaceExtensionsDir, + 'test-extension', + 'server', + ); + expect(loadedConfig.mcpServers?.['test-server'].cwd).toBe(expectedCwd); + }); }); describe('annotateActiveExtensions', () => { const extensions = [ - { config: { name: 'ext1', version: '1.0.0' }, contextFiles: [] }, - { config: { name: 'ext2', version: '1.0.0' }, contextFiles: [] }, - { config: { name: 'ext3', version: '1.0.0' }, contextFiles: [] }, + { + path: '/path/to/ext1', + config: { name: 'ext1', version: '1.0.0' }, + contextFiles: [], + }, + { + path: '/path/to/ext2', + config: { name: 'ext2', version: '1.0.0' }, + contextFiles: [], + }, + { + path: '/path/to/ext3', + config: { name: 'ext3', version: '1.0.0' }, + contextFiles: [], + }, ]; it('should mark all extensions as active if no enabled extensions are provided', () => { - const activeExtensions = annotateActiveExtensions(extensions, []); + const activeExtensions = annotateActiveExtensions( + extensions, + [], + '/path/to/workspace', + ); expect(activeExtensions).toHaveLength(3); expect(activeExtensions.every((e) => e.isActive)).toBe(true); }); it('should mark only the enabled extensions as active', () => { - const activeExtensions = annotateActiveExtensions(extensions, [ - 'ext1', - 'ext3', - ]); + const activeExtensions = annotateActiveExtensions( + extensions, + ['ext1', 'ext3'], + '/path/to/workspace', + ); expect(activeExtensions).toHaveLength(3); expect(activeExtensions.find((e) => e.name === 'ext1')?.isActive).toBe( true, @@ -192,13 +246,21 @@ describe('annotateActiveExtensions', () => { }); it('should mark all extensions as inactive when "none" is provided', () => { - const activeExtensions = annotateActiveExtensions(extensions, ['none']); + const activeExtensions = annotateActiveExtensions( + extensions, + ['none'], + '/path/to/workspace', + ); expect(activeExtensions).toHaveLength(3); expect(activeExtensions.every((e) => !e.isActive)).toBe(true); }); it('should handle case-insensitivity', () => { - const activeExtensions = annotateActiveExtensions(extensions, ['EXT1']); + const activeExtensions = annotateActiveExtensions( + extensions, + ['EXT1'], + '/path/to/workspace', + ); expect(activeExtensions.find((e) => e.name === 'ext1')?.isActive).toBe( true, ); @@ -206,24 +268,258 @@ describe('annotateActiveExtensions', () => { it('should log an error for unknown extensions', () => { const consoleSpy = vi.spyOn(console, 'error').mockImplementation(() => {}); - annotateActiveExtensions(extensions, ['ext4']); + annotateActiveExtensions(extensions, ['ext4'], '/path/to/workspace'); expect(consoleSpy).toHaveBeenCalledWith('Extension not found: ext4'); consoleSpy.mockRestore(); }); }); +describe('installExtension', () => { + let tempHomeDir: string; + let userExtensionsDir: string; + + beforeEach(() => { + tempHomeDir = fs.mkdtempSync( + path.join(os.tmpdir(), 'qwen-code-test-home-'), + ); + vi.mocked(os.homedir).mockReturnValue(tempHomeDir); + userExtensionsDir = path.join(tempHomeDir, '.qwen', 'extensions'); + // Clean up before each test + fs.rmSync(userExtensionsDir, { recursive: true, force: true }); + fs.mkdirSync(userExtensionsDir, { recursive: true }); + + vi.mocked(execSync).mockClear(); + }); + + afterEach(() => { + fs.rmSync(tempHomeDir, { recursive: true, force: true }); + }); + + it('should install an extension from a local path', async () => { + const sourceExtDir = createExtension( + tempHomeDir, + 'my-local-extension', + '1.0.0', + ); + const targetExtDir = path.join(userExtensionsDir, 'my-local-extension'); + const metadataPath = path.join(targetExtDir, INSTALL_METADATA_FILENAME); + + await installExtension({ source: sourceExtDir, type: 'local' }); + + expect(fs.existsSync(targetExtDir)).toBe(true); + expect(fs.existsSync(metadataPath)).toBe(true); + const metadata = JSON.parse(fs.readFileSync(metadataPath, 'utf-8')); + expect(metadata).toEqual({ + source: sourceExtDir, + type: 'local', + }); + fs.rmSync(targetExtDir, { recursive: true, force: true }); + }); + + it('should throw an error if the extension already exists', async () => { + const sourceExtDir = createExtension( + tempHomeDir, + 'my-local-extension', + '1.0.0', + ); + await installExtension({ source: sourceExtDir, type: 'local' }); + await expect( + installExtension({ source: sourceExtDir, type: 'local' }), + ).rejects.toThrow( + 'Extension "my-local-extension" is already installed. Please uninstall it first.', + ); + }); + + it('should throw an error and cleanup if qwen-extension.json is missing', async () => { + const sourceExtDir = path.join(tempHomeDir, 'bad-extension'); + fs.mkdirSync(sourceExtDir, { recursive: true }); + + await expect( + installExtension({ source: sourceExtDir, type: 'local' }), + ).rejects.toThrow( + `Invalid extension at ${sourceExtDir}. Please make sure it has a valid qwen-extension.json file.`, + ); + + const targetExtDir = path.join(userExtensionsDir, 'bad-extension'); + expect(fs.existsSync(targetExtDir)).toBe(false); + }); + + it('should install an extension from a git URL', async () => { + const gitUrl = 'https://github.com/google/qwen-extensions.git'; + const extensionName = 'qwen-extensions'; + const targetExtDir = path.join(userExtensionsDir, extensionName); + const metadataPath = path.join(targetExtDir, INSTALL_METADATA_FILENAME); + + const clone = vi.fn().mockImplementation(async (_, destination) => { + fs.mkdirSync(destination, { recursive: true }); + fs.writeFileSync( + path.join(destination, EXTENSIONS_CONFIG_FILENAME), + JSON.stringify({ name: extensionName, version: '1.0.0' }), + ); + }); + + const mockedSimpleGit = simpleGit as vi.MockedFunction; + mockedSimpleGit.mockReturnValue({ clone } as unknown as SimpleGit); + + await installExtension({ source: gitUrl, type: 'git' }); + + expect(fs.existsSync(targetExtDir)).toBe(true); + expect(fs.existsSync(metadataPath)).toBe(true); + const metadata = JSON.parse(fs.readFileSync(metadataPath, 'utf-8')); + expect(metadata).toEqual({ + source: gitUrl, + type: 'git', + }); + fs.rmSync(targetExtDir, { recursive: true, force: true }); + }); +}); + +describe('uninstallExtension', () => { + let tempHomeDir: string; + let userExtensionsDir: string; + + beforeEach(() => { + tempHomeDir = fs.mkdtempSync( + path.join(os.tmpdir(), 'qwen-code-test-home-'), + ); + vi.mocked(os.homedir).mockReturnValue(tempHomeDir); + userExtensionsDir = path.join(tempHomeDir, '.qwen', 'extensions'); + // Clean up before each test + fs.rmSync(userExtensionsDir, { recursive: true, force: true }); + fs.mkdirSync(userExtensionsDir, { recursive: true }); + + vi.mocked(execSync).mockClear(); + }); + + afterEach(() => { + fs.rmSync(tempHomeDir, { recursive: true, force: true }); + }); + + it('should uninstall an extension by name', async () => { + const sourceExtDir = createExtension( + userExtensionsDir, + 'my-local-extension', + '1.0.0', + ); + + await uninstallExtension('my-local-extension'); + + expect(fs.existsSync(sourceExtDir)).toBe(false); + }); + + it('should uninstall an extension by name and retain existing extensions', async () => { + const sourceExtDir = createExtension( + userExtensionsDir, + 'my-local-extension', + '1.0.0', + ); + const otherExtDir = createExtension( + userExtensionsDir, + 'other-extension', + '1.0.0', + ); + + await uninstallExtension('my-local-extension'); + + expect(fs.existsSync(sourceExtDir)).toBe(false); + expect(loadExtensions(tempHomeDir)).toHaveLength(1); + expect(fs.existsSync(otherExtDir)).toBe(true); + }); + + it('should throw an error if the extension does not exist', async () => { + await expect(uninstallExtension('nonexistent-extension')).rejects.toThrow( + 'Extension "nonexistent-extension" not found.', + ); + }); +}); + +describe('performWorkspaceExtensionMigration', () => { + let tempWorkspaceDir: string; + let tempHomeDir: string; + + beforeEach(() => { + tempWorkspaceDir = fs.mkdtempSync( + path.join(os.tmpdir(), 'qwen-code-test-workspace-'), + ); + tempHomeDir = fs.mkdtempSync( + path.join(os.tmpdir(), 'qwen-code-test-home-'), + ); + vi.mocked(os.homedir).mockReturnValue(tempHomeDir); + }); + + afterEach(() => { + fs.rmSync(tempWorkspaceDir, { recursive: true, force: true }); + fs.rmSync(tempHomeDir, { recursive: true, force: true }); + vi.restoreAllMocks(); + }); + + it('should install the extensions in the user directory', async () => { + const workspaceExtensionsDir = path.join( + tempWorkspaceDir, + EXTENSIONS_DIRECTORY_NAME, + ); + fs.mkdirSync(workspaceExtensionsDir, { recursive: true }); + const ext1Path = createExtension(workspaceExtensionsDir, 'ext1', '1.0.0'); + const ext2Path = createExtension(workspaceExtensionsDir, 'ext2', '1.0.0'); + const extensionsToMigrate = [ + loadExtension(ext1Path)!, + loadExtension(ext2Path)!, + ]; + const failed = + await performWorkspaceExtensionMigration(extensionsToMigrate); + + expect(failed).toEqual([]); + + const userExtensionsDir = path.join(tempHomeDir, '.qwen', 'extensions'); + const userExt1Path = path.join(userExtensionsDir, 'ext1'); + const extensions = loadExtensions(tempWorkspaceDir); + + expect(extensions).toHaveLength(2); + const metadataPath = path.join(userExt1Path, INSTALL_METADATA_FILENAME); + expect(fs.existsSync(metadataPath)).toBe(true); + const metadata = JSON.parse(fs.readFileSync(metadataPath, 'utf-8')); + expect(metadata).toEqual({ + source: ext1Path, + type: 'local', + }); + }); + + it('should return the names of failed installations', async () => { + const workspaceExtensionsDir = path.join( + tempWorkspaceDir, + EXTENSIONS_DIRECTORY_NAME, + ); + fs.mkdirSync(workspaceExtensionsDir, { recursive: true }); + + const ext1Path = createExtension(workspaceExtensionsDir, 'ext1', '1.0.0'); + + const extensions = [ + loadExtension(ext1Path)!, + { + path: '/ext/path/1', + config: { name: 'ext2', version: '1.0.0' }, + contextFiles: [], + }, + ]; + + const failed = await performWorkspaceExtensionMigration(extensions); + expect(failed).toEqual(['ext2']); + }); +}); + function createExtension( extensionsDir: string, name: string, version: string, addContextFile = false, contextFileName?: string, -): void { + mcpServers?: Record, +): string { const extDir = path.join(extensionsDir, name); - fs.mkdirSync(extDir); + fs.mkdirSync(extDir, { recursive: true }); fs.writeFileSync( path.join(extDir, EXTENSIONS_CONFIG_FILENAME), - JSON.stringify({ name, version, contextFileName }), + JSON.stringify({ name, version, contextFileName, mcpServers }), ); if (addContextFile) { @@ -233,4 +529,193 @@ function createExtension( if (contextFileName) { fs.writeFileSync(path.join(extDir, contextFileName), 'context'); } + return extDir; } + +describe('updateExtension', () => { + let tempHomeDir: string; + let userExtensionsDir: string; + + beforeEach(() => { + tempHomeDir = fs.mkdtempSync( + path.join(os.tmpdir(), 'qwen-code-test-home-'), + ); + vi.mocked(os.homedir).mockReturnValue(tempHomeDir); + userExtensionsDir = path.join(tempHomeDir, '.qwen', 'extensions'); + // Clean up before each test + fs.rmSync(userExtensionsDir, { recursive: true, force: true }); + fs.mkdirSync(userExtensionsDir, { recursive: true }); + + vi.mocked(execSync).mockClear(); + }); + + afterEach(() => { + fs.rmSync(tempHomeDir, { recursive: true, force: true }); + }); + + it('should update a git-installed extension', async () => { + // 1. "Install" an extension + const gitUrl = 'https://github.com/google/qwen-extensions.git'; + const extensionName = 'qwen-extensions'; + const targetExtDir = path.join(userExtensionsDir, extensionName); + const metadataPath = path.join(targetExtDir, INSTALL_METADATA_FILENAME); + + // Create the "installed" extension directory and files + fs.mkdirSync(targetExtDir, { recursive: true }); + fs.writeFileSync( + path.join(targetExtDir, EXTENSIONS_CONFIG_FILENAME), + JSON.stringify({ name: extensionName, version: '1.0.0' }), + ); + fs.writeFileSync( + metadataPath, + JSON.stringify({ source: gitUrl, type: 'git' }), + ); + + // 2. Mock the git clone for the update + const clone = vi.fn().mockImplementation(async (_, destination) => { + fs.mkdirSync(destination, { recursive: true }); + // This is the "updated" version + fs.writeFileSync( + path.join(destination, EXTENSIONS_CONFIG_FILENAME), + JSON.stringify({ name: extensionName, version: '1.1.0' }), + ); + }); + + const mockedSimpleGit = simpleGit as vi.MockedFunction; + mockedSimpleGit.mockReturnValue({ + clone, + } as unknown as SimpleGit); + + // 3. Call updateExtension + const updateInfo = await updateExtension(extensionName); + + // 4. Assertions + expect(updateInfo).toEqual({ + originalVersion: '1.0.0', + updatedVersion: '1.1.0', + }); + + // Check that the config file reflects the new version + const updatedConfig = JSON.parse( + fs.readFileSync( + path.join(targetExtDir, EXTENSIONS_CONFIG_FILENAME), + 'utf-8', + ), + ); + expect(updatedConfig.version).toBe('1.1.0'); + }); +}); + +describe('disableExtension', () => { + let tempWorkspaceDir: string; + let tempHomeDir: string; + + beforeEach(() => { + tempWorkspaceDir = fs.mkdtempSync( + path.join(os.tmpdir(), 'qwen-code-test-workspace-'), + ); + tempHomeDir = fs.mkdtempSync( + path.join(os.tmpdir(), 'qwen-code-test-home-'), + ); + vi.mocked(os.homedir).mockReturnValue(tempHomeDir); + vi.spyOn(process, 'cwd').mockReturnValue(tempWorkspaceDir); + }); + + afterEach(() => { + fs.rmSync(tempWorkspaceDir, { recursive: true, force: true }); + fs.rmSync(tempHomeDir, { recursive: true, force: true }); + }); + + it('should disable an extension at the user scope', () => { + disableExtension('my-extension', SettingScope.User); + const settings = loadSettings(tempWorkspaceDir); + expect( + settings.forScope(SettingScope.User).settings.extensions?.disabled, + ).toEqual(['my-extension']); + }); + + it('should disable an extension at the workspace scope', () => { + disableExtension('my-extension', SettingScope.Workspace); + const settings = loadSettings(tempWorkspaceDir); + expect( + settings.forScope(SettingScope.Workspace).settings.extensions?.disabled, + ).toEqual(['my-extension']); + }); + + it('should handle disabling the same extension twice', () => { + disableExtension('my-extension', SettingScope.User); + disableExtension('my-extension', SettingScope.User); + const settings = loadSettings(tempWorkspaceDir); + expect( + settings.forScope(SettingScope.User).settings.extensions?.disabled, + ).toEqual(['my-extension']); + }); + + it('should throw an error if you request system scope', () => { + expect(() => disableExtension('my-extension', SettingScope.System)).toThrow( + 'System and SystemDefaults scopes are not supported.', + ); + }); +}); + +describe('enableExtension', () => { + let tempWorkspaceDir: string; + let tempHomeDir: string; + let userExtensionsDir: string; + + beforeEach(() => { + tempWorkspaceDir = fs.mkdtempSync( + path.join(os.tmpdir(), 'qwen-code-test-workspace-'), + ); + tempHomeDir = fs.mkdtempSync( + path.join(os.tmpdir(), 'qwen-code-test-home-'), + ); + userExtensionsDir = path.join(tempHomeDir, '.qwen', 'extensions'); + vi.mocked(os.homedir).mockReturnValue(tempHomeDir); + vi.spyOn(process, 'cwd').mockReturnValue(tempWorkspaceDir); + }); + + afterEach(() => { + fs.rmSync(tempWorkspaceDir, { recursive: true, force: true }); + fs.rmSync(tempHomeDir, { recursive: true, force: true }); + fs.rmSync(userExtensionsDir, { recursive: true, force: true }); + }); + + afterAll(() => { + vi.restoreAllMocks(); + }); + + const getActiveExtensions = (): GeminiCLIExtension[] => { + const extensions = loadExtensions(tempWorkspaceDir); + const activeExtensions = annotateActiveExtensions( + extensions, + [], + tempWorkspaceDir, + ); + return activeExtensions.filter((e) => e.isActive); + }; + + it('should enable an extension at the user scope', () => { + createExtension(userExtensionsDir, 'ext1', '1.0.0'); + disableExtension('ext1', SettingScope.User); + let activeExtensions = getActiveExtensions(); + expect(activeExtensions).toHaveLength(0); + + enableExtension('ext1', [SettingScope.User]); + activeExtensions = getActiveExtensions(); + expect(activeExtensions).toHaveLength(1); + expect(activeExtensions[0].name).toBe('ext1'); + }); + + it('should enable an extension at the workspace scope', () => { + createExtension(userExtensionsDir, 'ext1', '1.0.0'); + disableExtension('ext1', SettingScope.Workspace); + let activeExtensions = getActiveExtensions(); + expect(activeExtensions).toHaveLength(0); + + enableExtension('ext1', [SettingScope.Workspace]); + activeExtensions = getActiveExtensions(); + expect(activeExtensions).toHaveLength(1); + expect(activeExtensions[0].name).toBe('ext1'); + }); +}); diff --git a/packages/cli/src/config/extension.ts b/packages/cli/src/config/extension.ts index 73ae9979..db674861 100644 --- a/packages/cli/src/config/extension.ts +++ b/packages/cli/src/config/extension.ts @@ -4,19 +4,29 @@ * SPDX-License-Identifier: Apache-2.0 */ -import { MCPServerConfig, GeminiCLIExtension } from '@qwen-code/qwen-code-core'; -import * as fs from 'fs'; -import * as path from 'path'; -import * as os from 'os'; +import type { + MCPServerConfig, + GeminiCLIExtension, +} from '@qwen-code/qwen-code-core'; +import { Storage } from '@qwen-code/qwen-code-core'; +import * as fs from 'node:fs'; +import * as path from 'node:path'; +import * as os from 'node:os'; +import { simpleGit } from 'simple-git'; +import { SettingScope, loadSettings } from '../config/settings.js'; +import { getErrorMessage } from '../utils/errors.js'; +import { recursivelyHydrateStrings } from './extensions/variables.js'; export const EXTENSIONS_DIRECTORY_NAME = path.join('.qwen', 'extensions'); export const EXTENSIONS_CONFIG_FILENAME = 'qwen-extension.json'; export const EXTENSIONS_CONFIG_FILENAME_OLD = 'gemini-extension.json'; +export const INSTALL_METADATA_FILENAME = '.qwen-extension-install.json'; export interface Extension { path: string; config: ExtensionConfig; contextFiles: string[]; + installMetadata?: ExtensionInstallMetadata | undefined; } export interface ExtensionConfig { @@ -27,14 +37,101 @@ export interface ExtensionConfig { excludeTools?: string[]; } +export interface ExtensionInstallMetadata { + source: string; + type: 'git' | 'local'; +} + +export interface ExtensionUpdateInfo { + originalVersion: string; + updatedVersion: string; +} + +export class ExtensionStorage { + private readonly extensionName: string; + + constructor(extensionName: string) { + this.extensionName = extensionName; + } + + getExtensionDir(): string { + return path.join( + ExtensionStorage.getUserExtensionsDir(), + this.extensionName, + ); + } + + getConfigPath(): string { + return path.join(this.getExtensionDir(), EXTENSIONS_CONFIG_FILENAME); + } + + static getUserExtensionsDir(): string { + const storage = new Storage(os.homedir()); + return storage.getExtensionsDir(); + } + + static async createTmpDir(): Promise { + return await fs.promises.mkdtemp(path.join(os.tmpdir(), 'qwen-extension')); + } +} + +export function getWorkspaceExtensions(workspaceDir: string): Extension[] { + return loadExtensionsFromDir(workspaceDir); +} + +async function copyExtension( + source: string, + destination: string, +): Promise { + await fs.promises.cp(source, destination, { recursive: true }); +} + +export async function performWorkspaceExtensionMigration( + extensions: Extension[], +): Promise { + const failedInstallNames: string[] = []; + + for (const extension of extensions) { + try { + const installMetadata: ExtensionInstallMetadata = { + source: extension.path, + type: 'local', + }; + await installExtension(installMetadata); + } catch (_) { + failedInstallNames.push(extension.config.name); + } + } + return failedInstallNames; +} + export function loadExtensions(workspaceDir: string): Extension[] { - const allExtensions = [ - ...loadExtensionsFromDir(workspaceDir), - ...loadExtensionsFromDir(os.homedir()), - ]; + const settings = loadSettings(workspaceDir).merged; + const disabledExtensions = settings.extensions?.disabled ?? []; + const allExtensions = [...loadUserExtensions()]; + + if (!settings.experimental?.extensionManagement) { + allExtensions.push(...getWorkspaceExtensions(workspaceDir)); + } const uniqueExtensions = new Map(); for (const extension of allExtensions) { + if ( + !uniqueExtensions.has(extension.config.name) && + !disabledExtensions.includes(extension.config.name) + ) { + uniqueExtensions.set(extension.config.name, extension); + } + } + + return Array.from(uniqueExtensions.values()); +} + +export function loadUserExtensions(): Extension[] { + const userExtensions = loadExtensionsFromDir(os.homedir()); + + const uniqueExtensions = new Map(); + for (const extension of userExtensions) { if (!uniqueExtensions.has(extension.config.name)) { uniqueExtensions.set(extension.config.name, extension); } @@ -43,8 +140,9 @@ export function loadExtensions(workspaceDir: string): Extension[] { return Array.from(uniqueExtensions.values()); } -function loadExtensionsFromDir(dir: string): Extension[] { - const extensionsDir = path.join(dir, EXTENSIONS_DIRECTORY_NAME); +export function loadExtensionsFromDir(dir: string): Extension[] { + const storage = new Storage(dir); + const extensionsDir = storage.getExtensionsDir(); if (!fs.existsSync(extensionsDir)) { return []; } @@ -61,7 +159,7 @@ function loadExtensionsFromDir(dir: string): Extension[] { return extensions; } -function loadExtension(extensionDir: string): Extension | null { +export function loadExtension(extensionDir: string): Extension | null { if (!fs.statSync(extensionDir).isDirectory()) { console.error( `Warning: unexpected file ${extensionDir} in extensions directory.`, @@ -86,7 +184,11 @@ function loadExtension(extensionDir: string): Extension | null { try { const configContent = fs.readFileSync(configFilePath, 'utf-8'); - const config = JSON.parse(configContent) as ExtensionConfig; + const config = recursivelyHydrateStrings(JSON.parse(configContent), { + extensionPath: extensionDir, + '/': path.sep, + pathSeparator: path.sep, + }) as unknown as ExtensionConfig; if (!config.name || !config.version) { console.error( `Invalid extension config in ${configFilePath}: missing name or version.`, @@ -102,15 +204,31 @@ function loadExtension(extensionDir: string): Extension | null { path: extensionDir, config, contextFiles, + installMetadata: loadInstallMetadata(extensionDir), }; } catch (e) { console.error( - `Warning: error parsing extension config in ${configFilePath}: ${e}`, + `Warning: error parsing extension config in ${configFilePath}: ${getErrorMessage( + e, + )}`, ); return null; } } +function loadInstallMetadata( + extensionDir: string, +): ExtensionInstallMetadata | undefined { + const metadataFilePath = path.join(extensionDir, INSTALL_METADATA_FILENAME); + try { + const configContent = fs.readFileSync(metadataFilePath, 'utf-8'); + const metadata = JSON.parse(configContent) as ExtensionInstallMetadata; + return metadata; + } catch (_e) { + return undefined; + } +} + function getContextFileNames(config: ExtensionConfig): string[] { if (!config.contextFileName) { return ['QWEN.md']; @@ -120,17 +238,28 @@ function getContextFileNames(config: ExtensionConfig): string[] { return config.contextFileName; } +/** + * Returns an annotated list of extensions. If an extension is listed in enabledExtensionNames, it will be active. + * If enabledExtensionNames is empty, an extension is active unless it is in list of disabled extensions in settings. + * @param extensions The base list of extensions. + * @param enabledExtensionNames The names of explicitly enabled extensions. + * @param workspaceDir The current workspace directory. + */ export function annotateActiveExtensions( extensions: Extension[], enabledExtensionNames: string[], + workspaceDir: string, ): GeminiCLIExtension[] { + const settings = loadSettings(workspaceDir).merged; + const disabledExtensions = settings.extensions?.disabled ?? []; + const annotatedExtensions: GeminiCLIExtension[] = []; if (enabledExtensionNames.length === 0) { return extensions.map((extension) => ({ name: extension.config.name, version: extension.config.version, - isActive: true, + isActive: !disabledExtensions.includes(extension.config.name), path: extension.path, })); } @@ -175,3 +304,230 @@ export function annotateActiveExtensions( return annotatedExtensions; } + +/** + * Clones a Git repository to a specified local path. + * @param gitUrl The Git URL to clone. + * @param destination The destination path to clone the repository to. + */ +async function cloneFromGit( + gitUrl: string, + destination: string, +): Promise { + try { + // TODO(chrstnb): Download the archive instead to avoid unnecessary .git info. + await simpleGit().clone(gitUrl, destination, ['--depth', '1']); + } catch (error) { + throw new Error(`Failed to clone Git repository from ${gitUrl}`, { + cause: error, + }); + } +} + +export async function installExtension( + installMetadata: ExtensionInstallMetadata, + cwd: string = process.cwd(), +): Promise { + const extensionsDir = ExtensionStorage.getUserExtensionsDir(); + await fs.promises.mkdir(extensionsDir, { recursive: true }); + + // Convert relative paths to absolute paths for the metadata file. + if ( + installMetadata.type === 'local' && + !path.isAbsolute(installMetadata.source) + ) { + installMetadata.source = path.resolve(cwd, installMetadata.source); + } + + let localSourcePath: string; + let tempDir: string | undefined; + if (installMetadata.type === 'git') { + tempDir = await ExtensionStorage.createTmpDir(); + await cloneFromGit(installMetadata.source, tempDir); + localSourcePath = tempDir; + } else { + localSourcePath = installMetadata.source; + } + let newExtensionName: string | undefined; + try { + const newExtension = loadExtension(localSourcePath); + if (!newExtension) { + throw new Error( + `Invalid extension at ${installMetadata.source}. Please make sure it has a valid qwen-extension.json file.`, + ); + } + + // ~/.qwen/extensions/{ExtensionConfig.name}. + newExtensionName = newExtension.config.name; + const extensionStorage = new ExtensionStorage(newExtensionName); + const destinationPath = extensionStorage.getExtensionDir(); + + const installedExtensions = loadUserExtensions(); + if ( + installedExtensions.some( + (installed) => installed.config.name === newExtensionName, + ) + ) { + throw new Error( + `Extension "${newExtensionName}" is already installed. Please uninstall it first.`, + ); + } + + await copyExtension(localSourcePath, destinationPath); + + const metadataString = JSON.stringify(installMetadata, null, 2); + const metadataPath = path.join(destinationPath, INSTALL_METADATA_FILENAME); + await fs.promises.writeFile(metadataPath, metadataString); + } finally { + if (tempDir) { + await fs.promises.rm(tempDir, { recursive: true, force: true }); + } + } + + return newExtensionName; +} + +export async function uninstallExtension( + extensionName: string, + cwd: string = process.cwd(), +): Promise { + const installedExtensions = loadUserExtensions(); + if ( + !installedExtensions.some( + (installed) => installed.config.name === extensionName, + ) + ) { + throw new Error(`Extension "${extensionName}" not found.`); + } + removeFromDisabledExtensions( + extensionName, + [SettingScope.User, SettingScope.Workspace], + cwd, + ); + const storage = new ExtensionStorage(extensionName); + return await fs.promises.rm(storage.getExtensionDir(), { + recursive: true, + force: true, + }); +} + +export function toOutputString(extension: Extension): string { + let output = `${extension.config.name} (${extension.config.version})`; + output += `\n Path: ${extension.path}`; + if (extension.installMetadata) { + output += `\n Source: ${extension.installMetadata.source}`; + } + if (extension.contextFiles.length > 0) { + output += `\n Context files:`; + extension.contextFiles.forEach((contextFile) => { + output += `\n ${contextFile}`; + }); + } + if (extension.config.mcpServers) { + output += `\n MCP servers:`; + Object.keys(extension.config.mcpServers).forEach((key) => { + output += `\n ${key}`; + }); + } + if (extension.config.excludeTools) { + output += `\n Excluded tools:`; + extension.config.excludeTools.forEach((tool) => { + output += `\n ${tool}`; + }); + } + return output; +} + +export async function updateExtension( + extensionName: string, + cwd: string = process.cwd(), +): Promise { + const installedExtensions = loadUserExtensions(); + const extension = installedExtensions.find( + (installed) => installed.config.name === extensionName, + ); + if (!extension) { + throw new Error( + `Extension "${extensionName}" not found. Run gemini extensions list to see available extensions.`, + ); + } + if (!extension.installMetadata) { + throw new Error( + `Extension cannot be updated because it is missing the .qwen-extension.install.json file. To update manually, uninstall and then reinstall the updated version.`, + ); + } + const originalVersion = extension.config.version; + const tempDir = await ExtensionStorage.createTmpDir(); + try { + await copyExtension(extension.path, tempDir); + await uninstallExtension(extensionName, cwd); + await installExtension(extension.installMetadata, cwd); + + const updatedExtension = loadExtension(extension.path); + if (!updatedExtension) { + throw new Error('Updated extension not found after installation.'); + } + const updatedVersion = updatedExtension.config.version; + return { + originalVersion, + updatedVersion, + }; + } catch (e) { + console.error( + `Error updating extension, rolling back. ${getErrorMessage(e)}`, + ); + await copyExtension(tempDir, extension.path); + throw e; + } finally { + await fs.promises.rm(tempDir, { recursive: true, force: true }); + } +} + +export function disableExtension( + name: string, + scope: SettingScope, + cwd: string = process.cwd(), +) { + if (scope === SettingScope.System || scope === SettingScope.SystemDefaults) { + throw new Error('System and SystemDefaults scopes are not supported.'); + } + const settings = loadSettings(cwd); + const settingsFile = settings.forScope(scope); + const extensionSettings = settingsFile.settings.extensions || { + disabled: [], + }; + const disabledExtensions = extensionSettings.disabled || []; + if (!disabledExtensions.includes(name)) { + disabledExtensions.push(name); + extensionSettings.disabled = disabledExtensions; + settings.setValue(scope, 'extensions', extensionSettings); + } +} + +export function enableExtension(name: string, scopes: SettingScope[]) { + removeFromDisabledExtensions(name, scopes); +} + +/** + * Removes an extension from the list of disabled extensions. + * @param name The name of the extension to remove. + * @param scope The scopes to remove the name from. + */ +function removeFromDisabledExtensions( + name: string, + scopes: SettingScope[], + cwd: string = process.cwd(), +) { + const settings = loadSettings(cwd); + for (const scope of scopes) { + const settingsFile = settings.forScope(scope); + const extensionSettings = settingsFile.settings.extensions || { + disabled: [], + }; + const disabledExtensions = extensionSettings.disabled || []; + extensionSettings.disabled = disabledExtensions.filter( + (extension) => extension !== name, + ); + settings.setValue(scope, 'extensions', extensionSettings); + } +} diff --git a/packages/cli/src/config/extensions/variableSchema.ts b/packages/cli/src/config/extensions/variableSchema.ts new file mode 100644 index 00000000..e55f2a52 --- /dev/null +++ b/packages/cli/src/config/extensions/variableSchema.ts @@ -0,0 +1,30 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +export interface VariableDefinition { + type: 'string'; + description: string; + default?: string; + required?: boolean; +} + +export interface VariableSchema { + [key: string]: VariableDefinition; +} + +const PATH_SEPARATOR_DEFINITION = { + type: 'string', + description: 'The path separator.', +} as const; + +export const VARIABLE_SCHEMA = { + extensionPath: { + type: 'string', + description: 'The path of the extension in the filesystem.', + }, + '/': PATH_SEPARATOR_DEFINITION, + pathSeparator: PATH_SEPARATOR_DEFINITION, +} as const; diff --git a/packages/cli/src/config/extensions/variables.test.ts b/packages/cli/src/config/extensions/variables.test.ts new file mode 100644 index 00000000..d2015f4f --- /dev/null +++ b/packages/cli/src/config/extensions/variables.test.ts @@ -0,0 +1,18 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import { expect, describe, it } from 'vitest'; +import { hydrateString } from './variables.js'; + +describe('hydrateString', () => { + it('should replace a single variable', () => { + const context = { + extensionPath: 'path/my-extension', + }; + const result = hydrateString('Hello, ${extensionPath}!', context); + expect(result).toBe('Hello, path/my-extension!'); + }); +}); diff --git a/packages/cli/src/config/extensions/variables.ts b/packages/cli/src/config/extensions/variables.ts new file mode 100644 index 00000000..7c6ef846 --- /dev/null +++ b/packages/cli/src/config/extensions/variables.ts @@ -0,0 +1,65 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import { type VariableSchema, VARIABLE_SCHEMA } from './variableSchema.js'; + +export type JsonObject = { [key: string]: JsonValue }; +export type JsonArray = JsonValue[]; +export type JsonValue = + | string + | number + | boolean + | null + | JsonObject + | JsonArray; + +export type VariableContext = { + [key in keyof typeof VARIABLE_SCHEMA]?: string; +}; + +export function validateVariables( + variables: VariableContext, + schema: VariableSchema, +) { + for (const key in schema) { + const definition = schema[key]; + if (definition.required && !variables[key as keyof VariableContext]) { + throw new Error(`Missing required variable: ${key}`); + } + } +} + +export function hydrateString(str: string, context: VariableContext): string { + validateVariables(context, VARIABLE_SCHEMA); + const regex = /\${(.*?)}/g; + return str.replace(regex, (match, key) => + context[key as keyof VariableContext] == null + ? match + : (context[key as keyof VariableContext] as string), + ); +} + +export function recursivelyHydrateStrings( + obj: JsonValue, + values: VariableContext, +): JsonValue { + if (typeof obj === 'string') { + return hydrateString(obj, values); + } + if (Array.isArray(obj)) { + return obj.map((item) => recursivelyHydrateStrings(item, values)); + } + if (typeof obj === 'object' && obj !== null) { + const newObj: JsonObject = {}; + for (const key in obj) { + if (Object.prototype.hasOwnProperty.call(obj, key)) { + newObj[key] = recursivelyHydrateStrings(obj[key], values); + } + } + return newObj; + } + return obj; +} diff --git a/packages/cli/src/config/keyBindings.test.ts b/packages/cli/src/config/keyBindings.test.ts index 2e89e421..1003290b 100644 --- a/packages/cli/src/config/keyBindings.test.ts +++ b/packages/cli/src/config/keyBindings.test.ts @@ -5,11 +5,8 @@ */ import { describe, it, expect } from 'vitest'; -import { - Command, - KeyBindingConfig, - defaultKeyBindings, -} from './keyBindings.js'; +import type { KeyBindingConfig } from './keyBindings.js'; +import { Command, defaultKeyBindings } from './keyBindings.js'; describe('keyBindings config', () => { describe('defaultKeyBindings', () => { diff --git a/packages/cli/src/config/sandboxConfig.ts b/packages/cli/src/config/sandboxConfig.ts index 72230110..089fd85f 100644 --- a/packages/cli/src/config/sandboxConfig.ts +++ b/packages/cli/src/config/sandboxConfig.ts @@ -4,11 +4,12 @@ * SPDX-License-Identifier: Apache-2.0 */ -import { SandboxConfig } from '@qwen-code/qwen-code-core'; +import type { SandboxConfig } from '@qwen-code/qwen-code-core'; +import { FatalSandboxError } from '@qwen-code/qwen-code-core'; import commandExists from 'command-exists'; import * as os from 'node:os'; import { getPackageJson } from '../utils/package.js'; -import { Settings } from './settings.js'; +import type { Settings } from './settings.js'; // This is a stripped-down version of the CliArgs interface from config.ts // to avoid circular dependencies. @@ -51,21 +52,19 @@ function getSandboxCommand( if (typeof sandbox === 'string' && sandbox) { if (!isSandboxCommand(sandbox)) { - console.error( - `ERROR: invalid sandbox command '${sandbox}'. Must be one of ${VALID_SANDBOX_COMMANDS.join( + throw new FatalSandboxError( + `Invalid sandbox command '${sandbox}'. Must be one of ${VALID_SANDBOX_COMMANDS.join( ', ', )}`, ); - process.exit(1); } // confirm that specified command exists if (commandExists.sync(sandbox)) { return sandbox; } - console.error( - `ERROR: missing sandbox command '${sandbox}' (from GEMINI_SANDBOX)`, + throw new FatalSandboxError( + `Missing sandbox command '${sandbox}' (from GEMINI_SANDBOX)`, ); - process.exit(1); } // look for seatbelt, docker, or podman, in that order @@ -80,11 +79,10 @@ function getSandboxCommand( // throw an error if user requested sandbox but no command was found if (sandbox === true) { - console.error( - 'ERROR: GEMINI_SANDBOX is true but failed to determine command for sandbox; ' + + throw new FatalSandboxError( + 'GEMINI_SANDBOX is true but failed to determine command for sandbox; ' + 'install docker or podman or specify command in GEMINI_SANDBOX', ); - process.exit(1); } return ''; @@ -94,7 +92,7 @@ export async function loadSandboxConfig( settings: Settings, argv: SandboxCliArgs, ): Promise { - const sandboxOption = argv.sandbox ?? settings.sandbox; + const sandboxOption = argv.sandbox ?? settings.tools?.sandbox; const command = getSandboxCommand(sandboxOption); const packageJson = await getPackageJson(); diff --git a/packages/cli/src/config/settings.test.ts b/packages/cli/src/config/settings.test.ts index e64a6cbf..7d0e737d 100644 --- a/packages/cli/src/config/settings.test.ts +++ b/packages/cli/src/config/settings.test.ts @@ -7,7 +7,8 @@ /// // Mock 'os' first. -import * as osActual from 'os'; // Import for type info for the mock factory +import * as osActual from 'node:os'; // Import for type info for the mock factory + vi.mock('os', async (importOriginal) => { const actualOs = await importOriginal(); return { @@ -27,8 +28,13 @@ vi.mock('./settings.js', async (importActual) => { }; }); +// Mock trustedFolders +vi.mock('./trustedFolders.js', () => ({ + isWorkspaceTrusted: vi.fn(), +})); + // NOW import everything else, including the (now effectively re-exported) settings.js -import * as pathActual from 'path'; // Restored for MOCK_WORKSPACE_SETTINGS_PATH +import * as pathActual from 'node:path'; // Restored for MOCK_WORKSPACE_SETTINGS_PATH import { describe, it, @@ -39,16 +45,19 @@ import { type Mocked, type Mock, } from 'vitest'; -import * as fs from 'fs'; // fs will be mocked separately +import * as fs from 'node:fs'; // fs will be mocked separately import stripJsonComments from 'strip-json-comments'; // Will be mocked separately +import { isWorkspaceTrusted } from './trustedFolders.js'; // These imports will get the versions from the vi.mock('./settings.js', ...) factory. import { loadSettings, USER_SETTINGS_PATH, // This IS the mocked path. getSystemSettingsPath, + getSystemDefaultsPath, SETTINGS_DIRECTORY_NAME, // This is from the original module, but used by the mock. - SettingScope, + migrateSettingsToV1, + type Settings, } from './settings.js'; const MOCK_WORKSPACE_DIR = '/mock/workspace'; @@ -59,6 +68,9 @@ const MOCK_WORKSPACE_SETTINGS_PATH = pathActual.join( 'settings.json', ); +// A more flexible type for test data that allows arbitrary properties. +type TestSettings = Settings & { [key: string]: unknown }; + vi.mock('fs', async (importOriginal) => { // Get all the functions from the real 'fs' module const actualFs = await importOriginal(); @@ -97,6 +109,7 @@ describe('Settings Loading and Merging', () => { (mockFsExistsSync as Mock).mockReturnValue(false); (fs.readFileSync as Mock).mockReturnValue('{}'); // Return valid empty JSON (mockFsMkdirSync as Mock).mockImplementation(() => undefined); + vi.mocked(isWorkspaceTrusted).mockReturnValue(true); }); afterEach(() => { @@ -110,10 +123,30 @@ describe('Settings Loading and Merging', () => { expect(settings.user.settings).toEqual({}); expect(settings.workspace.settings).toEqual({}); expect(settings.merged).toEqual({ - customThemes: {}, + ui: { + customThemes: {}, + }, + mcp: {}, mcpServers: {}, - includeDirectories: [], - chatCompression: {}, + context: { + includeDirectories: [], + }, + model: { + chatCompression: {}, + }, + advanced: { + excludedEnvVars: [], + }, + extensions: { + disabled: [], + workspacesWithMigrationNudge: [], + }, + security: {}, + general: {}, + privacy: {}, + telemetry: {}, + tools: {}, + ide: {}, }); expect(settings.errors.length).toBe(0); }); @@ -123,8 +156,12 @@ describe('Settings Loading and Merging', () => { (p: fs.PathLike) => p === getSystemSettingsPath(), ); const systemSettingsContent = { - theme: 'system-default', - sandbox: false, + ui: { + theme: 'system-default', + }, + tools: { + sandbox: false, + }, }; (fs.readFileSync as Mock).mockImplementation( (p: fs.PathOrFileDescriptor) => { @@ -145,10 +182,33 @@ describe('Settings Loading and Merging', () => { expect(settings.workspace.settings).toEqual({}); expect(settings.merged).toEqual({ ...systemSettingsContent, - customThemes: {}, + ui: { + ...systemSettingsContent.ui, + customThemes: {}, + }, + mcp: {}, mcpServers: {}, - includeDirectories: [], - chatCompression: {}, + context: { + includeDirectories: [], + }, + model: { + chatCompression: {}, + }, + advanced: { + excludedEnvVars: [], + }, + extensions: { + disabled: [], + workspacesWithMigrationNudge: [], + }, + security: {}, + general: {}, + privacy: {}, + telemetry: {}, + tools: { + sandbox: false, + }, + ide: {}, }); }); @@ -159,8 +219,12 @@ describe('Settings Loading and Merging', () => { (p: fs.PathLike) => p === expectedUserSettingsPath, ); const userSettingsContent = { - theme: 'dark', - contextFileName: 'USER_CONTEXT.md', + ui: { + theme: 'dark', + }, + context: { + fileName: 'USER_CONTEXT.md', + }, }; (fs.readFileSync as Mock).mockImplementation( (p: fs.PathOrFileDescriptor) => { @@ -180,10 +244,32 @@ describe('Settings Loading and Merging', () => { expect(settings.workspace.settings).toEqual({}); expect(settings.merged).toEqual({ ...userSettingsContent, - customThemes: {}, + ui: { + ...userSettingsContent.ui, + customThemes: {}, + }, + mcp: {}, mcpServers: {}, - includeDirectories: [], - chatCompression: {}, + context: { + ...userSettingsContent.context, + includeDirectories: [], + }, + model: { + chatCompression: {}, + }, + advanced: { + excludedEnvVars: [], + }, + extensions: { + disabled: [], + workspacesWithMigrationNudge: [], + }, + security: {}, + general: {}, + privacy: {}, + telemetry: {}, + tools: {}, + ide: {}, }); }); @@ -192,8 +278,12 @@ describe('Settings Loading and Merging', () => { (p: fs.PathLike) => p === MOCK_WORKSPACE_SETTINGS_PATH, ); const workspaceSettingsContent = { - sandbox: true, - contextFileName: 'WORKSPACE_CONTEXT.md', + tools: { + sandbox: true, + }, + context: { + fileName: 'WORKSPACE_CONTEXT.md', + }, }; (fs.readFileSync as Mock).mockImplementation( (p: fs.PathOrFileDescriptor) => { @@ -212,25 +302,57 @@ describe('Settings Loading and Merging', () => { expect(settings.user.settings).toEqual({}); expect(settings.workspace.settings).toEqual(workspaceSettingsContent); expect(settings.merged).toEqual({ - ...workspaceSettingsContent, - customThemes: {}, + tools: { + sandbox: true, + }, + context: { + fileName: 'WORKSPACE_CONTEXT.md', + includeDirectories: [], + }, + ui: { + customThemes: {}, + }, + mcp: {}, mcpServers: {}, - includeDirectories: [], - chatCompression: {}, + model: { + chatCompression: {}, + }, + advanced: { + excludedEnvVars: [], + }, + extensions: { + disabled: [], + workspacesWithMigrationNudge: [], + }, + security: {}, + general: {}, + privacy: {}, + telemetry: {}, + ide: {}, }); }); it('should merge user and workspace settings, with workspace taking precedence', () => { (mockFsExistsSync as Mock).mockReturnValue(true); const userSettingsContent = { - theme: 'dark', - sandbox: false, - contextFileName: 'USER_CONTEXT.md', + ui: { + theme: 'dark', + }, + tools: { + sandbox: false, + }, + context: { + fileName: 'USER_CONTEXT.md', + }, }; const workspaceSettingsContent = { - sandbox: true, - coreTools: ['tool1'], - contextFileName: 'WORKSPACE_CONTEXT.md', + tools: { + sandbox: true, + core: ['tool1'], + }, + context: { + fileName: 'WORKSPACE_CONTEXT.md', + }, }; (fs.readFileSync as Mock).mockImplementation( @@ -248,35 +370,74 @@ describe('Settings Loading and Merging', () => { expect(settings.user.settings).toEqual(userSettingsContent); expect(settings.workspace.settings).toEqual(workspaceSettingsContent); expect(settings.merged).toEqual({ - theme: 'dark', - sandbox: true, - coreTools: ['tool1'], - contextFileName: 'WORKSPACE_CONTEXT.md', - customThemes: {}, + ui: { + theme: 'dark', + customThemes: {}, + }, + tools: { + sandbox: true, + core: ['tool1'], + }, + context: { + fileName: 'WORKSPACE_CONTEXT.md', + includeDirectories: [], + }, + advanced: { + excludedEnvVars: [], + }, + extensions: { + disabled: [], + workspacesWithMigrationNudge: [], + }, + mcp: {}, mcpServers: {}, - includeDirectories: [], - chatCompression: {}, + model: { + chatCompression: {}, + }, + security: {}, + general: {}, + privacy: {}, + telemetry: {}, + ide: {}, }); }); it('should merge system, user and workspace settings, with system taking precedence over workspace, and workspace over user', () => { (mockFsExistsSync as Mock).mockReturnValue(true); const systemSettingsContent = { - theme: 'system-theme', - sandbox: false, - allowMCPServers: ['server1', 'server2'], + ui: { + theme: 'system-theme', + }, + tools: { + sandbox: false, + }, + mcp: { + allowed: ['server1', 'server2'], + }, telemetry: { enabled: false }, }; const userSettingsContent = { - theme: 'dark', - sandbox: true, - contextFileName: 'USER_CONTEXT.md', + ui: { + theme: 'dark', + }, + tools: { + sandbox: true, + }, + context: { + fileName: 'USER_CONTEXT.md', + }, }; const workspaceSettingsContent = { - sandbox: false, - coreTools: ['tool1'], - contextFileName: 'WORKSPACE_CONTEXT.md', - allowMCPServers: ['server1', 'server2', 'server3'], + tools: { + sandbox: false, + core: ['tool1'], + }, + context: { + fileName: 'WORKSPACE_CONTEXT.md', + }, + mcp: { + allowed: ['server1', 'server2', 'server3'], + }, }; (fs.readFileSync as Mock).mockImplementation( @@ -297,26 +458,278 @@ describe('Settings Loading and Merging', () => { expect(settings.user.settings).toEqual(userSettingsContent); expect(settings.workspace.settings).toEqual(workspaceSettingsContent); expect(settings.merged).toEqual({ - theme: 'system-theme', - sandbox: false, + ui: { + theme: 'system-theme', + customThemes: {}, + }, + tools: { + sandbox: false, + core: ['tool1'], + }, telemetry: { enabled: false }, - coreTools: ['tool1'], - contextFileName: 'WORKSPACE_CONTEXT.md', - allowMCPServers: ['server1', 'server2'], - customThemes: {}, + context: { + fileName: 'WORKSPACE_CONTEXT.md', + includeDirectories: [], + }, + mcp: { + allowed: ['server1', 'server2'], + }, + advanced: { + excludedEnvVars: [], + }, + extensions: { + disabled: [], + workspacesWithMigrationNudge: [], + }, mcpServers: {}, - includeDirectories: [], - chatCompression: {}, + model: { + chatCompression: {}, + }, + security: {}, + general: {}, + privacy: {}, + ide: {}, + }); + }); + + it('should correctly migrate a complex legacy (v1) settings file', () => { + (mockFsExistsSync as Mock).mockImplementation( + (p: fs.PathLike) => p === USER_SETTINGS_PATH, + ); + const legacySettingsContent = { + theme: 'legacy-dark', + vimMode: true, + contextFileName: 'LEGACY_CONTEXT.md', + model: 'gemini-pro', + mcpServers: { + 'legacy-server-1': { + command: 'npm', + args: ['run', 'start:server1'], + description: 'Legacy Server 1', + }, + 'legacy-server-2': { + command: 'node', + args: ['server2.js'], + description: 'Legacy Server 2', + }, + }, + allowMCPServers: ['legacy-server-1'], + someUnrecognizedSetting: 'should-be-preserved', + }; + + (fs.readFileSync as Mock).mockImplementation( + (p: fs.PathOrFileDescriptor) => { + if (p === USER_SETTINGS_PATH) + return JSON.stringify(legacySettingsContent); + return '{}'; + }, + ); + + const settings = loadSettings(MOCK_WORKSPACE_DIR); + + expect(settings.merged).toEqual({ + ui: { + theme: 'legacy-dark', + customThemes: {}, + }, + general: { + vimMode: true, + }, + context: { + fileName: 'LEGACY_CONTEXT.md', + includeDirectories: [], + }, + model: { + name: 'gemini-pro', + chatCompression: {}, + }, + mcpServers: { + 'legacy-server-1': { + command: 'npm', + args: ['run', 'start:server1'], + description: 'Legacy Server 1', + }, + 'legacy-server-2': { + command: 'node', + args: ['server2.js'], + description: 'Legacy Server 2', + }, + }, + mcp: { + allowed: ['legacy-server-1'], + }, + someUnrecognizedSetting: 'should-be-preserved', + advanced: { + excludedEnvVars: [], + }, + extensions: { + disabled: [], + workspacesWithMigrationNudge: [], + }, + security: {}, + privacy: {}, + telemetry: {}, + tools: {}, + ide: {}, + }); + }); + + it('should correctly merge and migrate legacy array properties from multiple scopes', () => { + (mockFsExistsSync as Mock).mockReturnValue(true); + const legacyUserSettings = { + includeDirectories: ['/user/dir'], + excludeTools: ['user-tool'], + excludedProjectEnvVars: ['USER_VAR'], + }; + const legacyWorkspaceSettings = { + includeDirectories: ['/workspace/dir'], + excludeTools: ['workspace-tool'], + excludedProjectEnvVars: ['WORKSPACE_VAR', 'USER_VAR'], + }; + + (fs.readFileSync as Mock).mockImplementation( + (p: fs.PathOrFileDescriptor) => { + if (p === USER_SETTINGS_PATH) + return JSON.stringify(legacyUserSettings); + if (p === MOCK_WORKSPACE_SETTINGS_PATH) + return JSON.stringify(legacyWorkspaceSettings); + return '{}'; + }, + ); + + const settings = loadSettings(MOCK_WORKSPACE_DIR); + + // Verify includeDirectories are concatenated + expect(settings.merged.context?.includeDirectories).toEqual([ + '/user/dir', + '/workspace/dir', + ]); + + // Verify excludeTools are overwritten by workspace + expect(settings.merged.tools?.exclude).toEqual(['workspace-tool']); + + // Verify excludedProjectEnvVars are concatenated and de-duped + expect(settings.merged.advanced?.excludedEnvVars).toEqual( + expect.arrayContaining(['USER_VAR', 'WORKSPACE_VAR']), + ); + expect(settings.merged.advanced?.excludedEnvVars).toHaveLength(2); + }); + + it('should merge all settings files with the correct precedence', () => { + (mockFsExistsSync as Mock).mockReturnValue(true); + const systemDefaultsContent = { + ui: { + theme: 'default-theme', + }, + tools: { + sandbox: true, + }, + telemetry: true, + context: { + includeDirectories: ['/system/defaults/dir'], + }, + }; + const userSettingsContent = { + ui: { + theme: 'user-theme', + }, + context: { + fileName: 'USER_CONTEXT.md', + includeDirectories: ['/user/dir1', '/user/dir2'], + }, + }; + const workspaceSettingsContent = { + tools: { + sandbox: false, + }, + context: { + fileName: 'WORKSPACE_CONTEXT.md', + includeDirectories: ['/workspace/dir'], + }, + }; + const systemSettingsContent = { + ui: { + theme: 'system-theme', + }, + telemetry: false, + context: { + includeDirectories: ['/system/dir'], + }, + }; + + (fs.readFileSync as Mock).mockImplementation( + (p: fs.PathOrFileDescriptor) => { + if (p === getSystemDefaultsPath()) + return JSON.stringify(systemDefaultsContent); + if (p === getSystemSettingsPath()) + return JSON.stringify(systemSettingsContent); + if (p === USER_SETTINGS_PATH) + return JSON.stringify(userSettingsContent); + if (p === MOCK_WORKSPACE_SETTINGS_PATH) + return JSON.stringify(workspaceSettingsContent); + return ''; + }, + ); + + const settings = loadSettings(MOCK_WORKSPACE_DIR); + + expect(settings.systemDefaults.settings).toEqual(systemDefaultsContent); + expect(settings.system.settings).toEqual(systemSettingsContent); + expect(settings.user.settings).toEqual(userSettingsContent); + expect(settings.workspace.settings).toEqual(workspaceSettingsContent); + expect(settings.merged).toEqual({ + advanced: { + excludedEnvVars: [], + }, + context: { + fileName: 'WORKSPACE_CONTEXT.md', + includeDirectories: [ + '/system/defaults/dir', + '/user/dir1', + '/user/dir2', + '/workspace/dir', + '/system/dir', + ], + }, + extensions: { + disabled: [], + workspacesWithMigrationNudge: [], + }, + mcp: {}, + mcpServers: {}, + model: { + chatCompression: {}, + }, + security: {}, + telemetry: {}, + tools: { + sandbox: false, + }, + ui: { + customThemes: {}, + theme: 'system-theme', + }, + general: {}, + privacy: {}, + ide: {}, }); }); it('should ignore folderTrust from workspace settings', () => { (mockFsExistsSync as Mock).mockReturnValue(true); const userSettingsContent = { - folderTrust: true, + security: { + folderTrust: { + enabled: true, + }, + }, }; const workspaceSettingsContent = { - folderTrust: false, // This should be ignored + security: { + folderTrust: { + enabled: false, // This should be ignored + }, + }, }; const systemSettingsContent = { // No folderTrust here @@ -335,19 +748,31 @@ describe('Settings Loading and Merging', () => { ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.merged.folderTrust).toBe(true); // User setting should be used + expect(settings.merged.security?.folderTrust?.enabled).toBe(true); // User setting should be used }); it('should use system folderTrust over user setting', () => { (mockFsExistsSync as Mock).mockReturnValue(true); const userSettingsContent = { - folderTrust: false, + security: { + folderTrust: { + enabled: false, + }, + }, }; const workspaceSettingsContent = { - folderTrust: true, // This should be ignored + security: { + folderTrust: { + enabled: true, // This should be ignored + }, + }, }; const systemSettingsContent = { - folderTrust: true, + security: { + folderTrust: { + enabled: true, + }, + }, }; (fs.readFileSync as Mock).mockImplementation( @@ -363,14 +788,14 @@ describe('Settings Loading and Merging', () => { ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.merged.folderTrust).toBe(true); // System setting should be used + expect(settings.merged.security?.folderTrust?.enabled).toBe(true); // System setting should be used }); it('should handle contextFileName correctly when only in user settings', () => { (mockFsExistsSync as Mock).mockImplementation( (p: fs.PathLike) => p === USER_SETTINGS_PATH, ); - const userSettingsContent = { contextFileName: 'CUSTOM.md' }; + const userSettingsContent = { context: { fileName: 'CUSTOM.md' } }; (fs.readFileSync as Mock).mockImplementation( (p: fs.PathOrFileDescriptor) => { if (p === USER_SETTINGS_PATH) @@ -380,7 +805,7 @@ describe('Settings Loading and Merging', () => { ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.merged.contextFileName).toBe('CUSTOM.md'); + expect(settings.merged.context?.fileName).toBe('CUSTOM.md'); }); it('should handle contextFileName correctly when only in workspace settings', () => { @@ -388,7 +813,7 @@ describe('Settings Loading and Merging', () => { (p: fs.PathLike) => p === MOCK_WORKSPACE_SETTINGS_PATH, ); const workspaceSettingsContent = { - contextFileName: 'PROJECT_SPECIFIC.md', + context: { fileName: 'PROJECT_SPECIFIC.md' }, }; (fs.readFileSync as Mock).mockImplementation( (p: fs.PathOrFileDescriptor) => { @@ -399,7 +824,7 @@ describe('Settings Loading and Merging', () => { ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.merged.contextFileName).toBe('PROJECT_SPECIFIC.md'); + expect(settings.merged.context?.fileName).toBe('PROJECT_SPECIFIC.md'); }); it('should handle excludedProjectEnvVars correctly when only in user settings', () => { @@ -407,7 +832,8 @@ describe('Settings Loading and Merging', () => { (p: fs.PathLike) => p === USER_SETTINGS_PATH, ); const userSettingsContent = { - excludedProjectEnvVars: ['DEBUG', 'NODE_ENV', 'CUSTOM_VAR'], + general: {}, + advanced: { excludedEnvVars: ['DEBUG', 'NODE_ENV', 'CUSTOM_VAR'] }, }; (fs.readFileSync as Mock).mockImplementation( (p: fs.PathOrFileDescriptor) => { @@ -418,7 +844,7 @@ describe('Settings Loading and Merging', () => { ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.merged.excludedProjectEnvVars).toEqual([ + expect(settings.merged.advanced?.excludedEnvVars).toEqual([ 'DEBUG', 'NODE_ENV', 'CUSTOM_VAR', @@ -430,7 +856,8 @@ describe('Settings Loading and Merging', () => { (p: fs.PathLike) => p === MOCK_WORKSPACE_SETTINGS_PATH, ); const workspaceSettingsContent = { - excludedProjectEnvVars: ['WORKSPACE_DEBUG', 'WORKSPACE_VAR'], + general: {}, + advanced: { excludedEnvVars: ['WORKSPACE_DEBUG', 'WORKSPACE_VAR'] }, }; (fs.readFileSync as Mock).mockImplementation( (p: fs.PathOrFileDescriptor) => { @@ -441,7 +868,7 @@ describe('Settings Loading and Merging', () => { ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.merged.excludedProjectEnvVars).toEqual([ + expect(settings.merged.advanced?.excludedEnvVars).toEqual([ 'WORKSPACE_DEBUG', 'WORKSPACE_VAR', ]); @@ -450,10 +877,12 @@ describe('Settings Loading and Merging', () => { it('should merge excludedProjectEnvVars with workspace taking precedence over user', () => { (mockFsExistsSync as Mock).mockReturnValue(true); const userSettingsContent = { - excludedProjectEnvVars: ['DEBUG', 'NODE_ENV', 'USER_VAR'], + general: {}, + advanced: { excludedEnvVars: ['DEBUG', 'NODE_ENV', 'USER_VAR'] }, }; const workspaceSettingsContent = { - excludedProjectEnvVars: ['WORKSPACE_DEBUG', 'WORKSPACE_VAR'], + general: {}, + advanced: { excludedEnvVars: ['WORKSPACE_DEBUG', 'WORKSPACE_VAR'] }, }; (fs.readFileSync as Mock).mockImplementation( @@ -467,16 +896,20 @@ describe('Settings Loading and Merging', () => { ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.user.settings.excludedProjectEnvVars).toEqual([ + + expect(settings.user.settings.advanced?.excludedEnvVars).toEqual([ 'DEBUG', 'NODE_ENV', 'USER_VAR', ]); - expect(settings.workspace.settings.excludedProjectEnvVars).toEqual([ + expect(settings.workspace.settings.advanced?.excludedEnvVars).toEqual([ 'WORKSPACE_DEBUG', 'WORKSPACE_VAR', ]); - expect(settings.merged.excludedProjectEnvVars).toEqual([ + expect(settings.merged.advanced?.excludedEnvVars).toEqual([ + 'DEBUG', + 'NODE_ENV', + 'USER_VAR', 'WORKSPACE_DEBUG', 'WORKSPACE_VAR', ]); @@ -484,8 +917,8 @@ describe('Settings Loading and Merging', () => { it('should default contextFileName to undefined if not in any settings file', () => { (mockFsExistsSync as Mock).mockReturnValue(true); - const userSettingsContent = { theme: 'dark' }; - const workspaceSettingsContent = { sandbox: true }; + const userSettingsContent = { ui: { theme: 'dark' } }; + const workspaceSettingsContent = { tools: { sandbox: true } }; (fs.readFileSync as Mock).mockImplementation( (p: fs.PathOrFileDescriptor) => { if (p === USER_SETTINGS_PATH) @@ -497,14 +930,14 @@ describe('Settings Loading and Merging', () => { ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.merged.contextFileName).toBeUndefined(); + expect(settings.merged.context?.fileName).toBeUndefined(); }); it('should load telemetry setting from user settings', () => { (mockFsExistsSync as Mock).mockImplementation( (p: fs.PathLike) => p === USER_SETTINGS_PATH, ); - const userSettingsContent = { telemetry: true }; + const userSettingsContent = { telemetry: { enabled: true } }; (fs.readFileSync as Mock).mockImplementation( (p: fs.PathOrFileDescriptor) => { if (p === USER_SETTINGS_PATH) @@ -513,14 +946,14 @@ describe('Settings Loading and Merging', () => { }, ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.merged.telemetry).toBe(true); + expect(settings.merged.telemetry?.enabled).toBe(true); }); it('should load telemetry setting from workspace settings', () => { (mockFsExistsSync as Mock).mockImplementation( (p: fs.PathLike) => p === MOCK_WORKSPACE_SETTINGS_PATH, ); - const workspaceSettingsContent = { telemetry: false }; + const workspaceSettingsContent = { telemetry: { enabled: false } }; (fs.readFileSync as Mock).mockImplementation( (p: fs.PathOrFileDescriptor) => { if (p === MOCK_WORKSPACE_SETTINGS_PATH) @@ -529,13 +962,13 @@ describe('Settings Loading and Merging', () => { }, ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.merged.telemetry).toBe(false); + expect(settings.merged.telemetry?.enabled).toBe(false); }); it('should prioritize workspace telemetry setting over user setting', () => { (mockFsExistsSync as Mock).mockReturnValue(true); - const userSettingsContent = { telemetry: true }; - const workspaceSettingsContent = { telemetry: false }; + const userSettingsContent = { telemetry: { enabled: true } }; + const workspaceSettingsContent = { telemetry: { enabled: false } }; (fs.readFileSync as Mock).mockImplementation( (p: fs.PathOrFileDescriptor) => { if (p === USER_SETTINGS_PATH) @@ -546,15 +979,15 @@ describe('Settings Loading and Merging', () => { }, ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.merged.telemetry).toBe(false); + expect(settings.merged.telemetry?.enabled).toBe(false); }); it('should have telemetry as undefined if not in any settings file', () => { (mockFsExistsSync as Mock).mockReturnValue(false); // No settings files exist (fs.readFileSync as Mock).mockReturnValue('{}'); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.merged.telemetry).toBeUndefined(); - expect(settings.merged.customThemes).toEqual({}); + expect(settings.merged.telemetry).toEqual({}); + expect(settings.merged.ui?.customThemes).toEqual({}); expect(settings.merged.mcpServers).toEqual({}); }); @@ -684,126 +1117,40 @@ describe('Settings Loading and Merging', () => { expect(settings.merged.mcpServers).toEqual({}); }); - it('should merge chatCompression settings, with workspace taking precedence', () => { - (mockFsExistsSync as Mock).mockReturnValue(true); - const userSettingsContent = { - chatCompression: { contextPercentageThreshold: 0.5 }, - }; - const workspaceSettingsContent = { - chatCompression: { contextPercentageThreshold: 0.8 }, - }; - - (fs.readFileSync as Mock).mockImplementation( - (p: fs.PathOrFileDescriptor) => { - if (p === USER_SETTINGS_PATH) - return JSON.stringify(userSettingsContent); - if (p === MOCK_WORKSPACE_SETTINGS_PATH) - return JSON.stringify(workspaceSettingsContent); - return '{}'; - }, - ); - - const settings = loadSettings(MOCK_WORKSPACE_DIR); - - expect(settings.user.settings.chatCompression).toEqual({ - contextPercentageThreshold: 0.5, - }); - expect(settings.workspace.settings.chatCompression).toEqual({ - contextPercentageThreshold: 0.8, - }); - expect(settings.merged.chatCompression).toEqual({ - contextPercentageThreshold: 0.8, - }); - }); - - it('should handle chatCompression when only in user settings', () => { - (mockFsExistsSync as Mock).mockImplementation( - (p: fs.PathLike) => p === USER_SETTINGS_PATH, - ); - const userSettingsContent = { - chatCompression: { contextPercentageThreshold: 0.5 }, - }; - (fs.readFileSync as Mock).mockImplementation( - (p: fs.PathOrFileDescriptor) => { - if (p === USER_SETTINGS_PATH) - return JSON.stringify(userSettingsContent); - return '{}'; - }, - ); - - const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.merged.chatCompression).toEqual({ - contextPercentageThreshold: 0.5, - }); - }); - - it('should have chatCompression as an empty object if not in any settings file', () => { - (mockFsExistsSync as Mock).mockReturnValue(false); // No settings files exist - (fs.readFileSync as Mock).mockReturnValue('{}'); - const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.merged.chatCompression).toEqual({}); - }); - - it('should ignore chatCompression if contextPercentageThreshold is invalid', () => { - const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {}); - (mockFsExistsSync as Mock).mockImplementation( - (p: fs.PathLike) => p === USER_SETTINGS_PATH, - ); - const userSettingsContent = { - chatCompression: { contextPercentageThreshold: 1.5 }, - }; - (fs.readFileSync as Mock).mockImplementation( - (p: fs.PathOrFileDescriptor) => { - if (p === USER_SETTINGS_PATH) - return JSON.stringify(userSettingsContent); - return '{}'; - }, - ); - - const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.merged.chatCompression).toBeUndefined(); - expect(warnSpy).toHaveBeenCalledWith( - 'Invalid value for chatCompression.contextPercentageThreshold: "1.5". Please use a value between 0 and 1. Using default compression settings.', - ); - warnSpy.mockRestore(); - }); - - it('should deep merge chatCompression settings', () => { - (mockFsExistsSync as Mock).mockReturnValue(true); - const userSettingsContent = { - chatCompression: { contextPercentageThreshold: 0.5 }, - }; - const workspaceSettingsContent = { - chatCompression: {}, - }; - - (fs.readFileSync as Mock).mockImplementation( - (p: fs.PathOrFileDescriptor) => { - if (p === USER_SETTINGS_PATH) - return JSON.stringify(userSettingsContent); - if (p === MOCK_WORKSPACE_SETTINGS_PATH) - return JSON.stringify(workspaceSettingsContent); - return '{}'; - }, - ); - - const settings = loadSettings(MOCK_WORKSPACE_DIR); - - expect(settings.merged.chatCompression).toEqual({ - contextPercentageThreshold: 0.5, - }); - }); - - it('should merge includeDirectories from all scopes', () => { + it('should merge MCP servers from system, user, and workspace with system taking precedence', () => { (mockFsExistsSync as Mock).mockReturnValue(true); const systemSettingsContent = { - includeDirectories: ['/system/dir'], + mcpServers: { + 'shared-server': { + command: 'system-command', + args: ['--system-arg'], + }, + 'system-only-server': { + command: 'system-only-command', + }, + }, }; const userSettingsContent = { - includeDirectories: ['/user/dir1', '/user/dir2'], + mcpServers: { + 'user-server': { + command: 'user-command', + }, + 'shared-server': { + command: 'user-command', + description: 'from user', + }, + }, }; const workspaceSettingsContent = { - includeDirectories: ['/workspace/dir'], + mcpServers: { + 'workspace-server': { + command: 'workspace-command', + }, + 'shared-server': { + command: 'workspace-command', + args: ['--workspace-arg'], + }, + }, }; (fs.readFileSync as Mock).mockImplementation( @@ -820,11 +1167,217 @@ describe('Settings Loading and Merging', () => { const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.merged.includeDirectories).toEqual([ - '/system/dir', + expect(settings.merged.mcpServers).toEqual({ + 'user-server': { + command: 'user-command', + }, + 'workspace-server': { + command: 'workspace-command', + }, + 'system-only-server': { + command: 'system-only-command', + }, + 'shared-server': { + command: 'system-command', + args: ['--system-arg'], + }, + }); + }); + + it('should merge mcp allowed/excluded lists with system taking precedence over workspace', () => { + (mockFsExistsSync as Mock).mockReturnValue(true); + const systemSettingsContent = { + mcp: { + allowed: ['system-allowed'], + }, + }; + const userSettingsContent = { + mcp: { + allowed: ['user-allowed'], + excluded: ['user-excluded'], + }, + }; + const workspaceSettingsContent = { + mcp: { + allowed: ['workspace-allowed'], + excluded: ['workspace-excluded'], + }, + }; + + (fs.readFileSync as Mock).mockImplementation( + (p: fs.PathOrFileDescriptor) => { + if (p === getSystemSettingsPath()) + return JSON.stringify(systemSettingsContent); + if (p === USER_SETTINGS_PATH) + return JSON.stringify(userSettingsContent); + if (p === MOCK_WORKSPACE_SETTINGS_PATH) + return JSON.stringify(workspaceSettingsContent); + return '{}'; + }, + ); + + const settings = loadSettings(MOCK_WORKSPACE_DIR); + + expect(settings.merged.mcp).toEqual({ + allowed: ['system-allowed'], + excluded: ['workspace-excluded'], + }); + }); + + it('should merge chatCompression settings, with workspace taking precedence', () => { + (mockFsExistsSync as Mock).mockReturnValue(true); + const userSettingsContent = { + general: {}, + model: { chatCompression: { contextPercentageThreshold: 0.5 } }, + }; + const workspaceSettingsContent = { + general: {}, + model: { chatCompression: { contextPercentageThreshold: 0.8 } }, + }; + + (fs.readFileSync as Mock).mockImplementation( + (p: fs.PathOrFileDescriptor) => { + if (p === USER_SETTINGS_PATH) + return JSON.stringify(userSettingsContent); + if (p === MOCK_WORKSPACE_SETTINGS_PATH) + return JSON.stringify(workspaceSettingsContent); + return '{}'; + }, + ); + + const settings = loadSettings(MOCK_WORKSPACE_DIR); + const e = settings.user.settings.model?.chatCompression; + console.log(e); + + expect(settings.user.settings.model?.chatCompression).toEqual({ + contextPercentageThreshold: 0.5, + }); + expect(settings.workspace.settings.model?.chatCompression).toEqual({ + contextPercentageThreshold: 0.8, + }); + expect(settings.merged.model?.chatCompression).toEqual({ + contextPercentageThreshold: 0.8, + }); + }); + + it('should handle chatCompression when only in user settings', () => { + (mockFsExistsSync as Mock).mockImplementation( + (p: fs.PathLike) => p === USER_SETTINGS_PATH, + ); + const userSettingsContent = { + general: {}, + model: { chatCompression: { contextPercentageThreshold: 0.5 } }, + }; + (fs.readFileSync as Mock).mockImplementation( + (p: fs.PathOrFileDescriptor) => { + if (p === USER_SETTINGS_PATH) + return JSON.stringify(userSettingsContent); + return '{}'; + }, + ); + + const settings = loadSettings(MOCK_WORKSPACE_DIR); + expect(settings.merged.model?.chatCompression).toEqual({ + contextPercentageThreshold: 0.5, + }); + }); + + it('should have chatCompression as an empty object if not in any settings file', () => { + (mockFsExistsSync as Mock).mockReturnValue(false); // No settings files exist + (fs.readFileSync as Mock).mockReturnValue('{}'); + const settings = loadSettings(MOCK_WORKSPACE_DIR); + expect(settings.merged.model?.chatCompression).toEqual({}); + }); + + it('should ignore chatCompression if contextPercentageThreshold is invalid', () => { + const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {}); + (mockFsExistsSync as Mock).mockImplementation( + (p: fs.PathLike) => p === USER_SETTINGS_PATH, + ); + const userSettingsContent = { + general: {}, + model: { chatCompression: { contextPercentageThreshold: 1.5 } }, + }; + (fs.readFileSync as Mock).mockImplementation( + (p: fs.PathOrFileDescriptor) => { + if (p === USER_SETTINGS_PATH) + return JSON.stringify(userSettingsContent); + return '{}'; + }, + ); + + const settings = loadSettings(MOCK_WORKSPACE_DIR); + expect(settings.merged.model?.chatCompression).toEqual({ + contextPercentageThreshold: 1.5, + }); + warnSpy.mockRestore(); + }); + + it('should deep merge chatCompression settings', () => { + (mockFsExistsSync as Mock).mockReturnValue(true); + const userSettingsContent = { + general: {}, + model: { chatCompression: { contextPercentageThreshold: 0.5 } }, + }; + const workspaceSettingsContent = { + general: {}, + model: { chatCompression: {} }, + }; + + (fs.readFileSync as Mock).mockImplementation( + (p: fs.PathOrFileDescriptor) => { + if (p === USER_SETTINGS_PATH) + return JSON.stringify(userSettingsContent); + if (p === MOCK_WORKSPACE_SETTINGS_PATH) + return JSON.stringify(workspaceSettingsContent); + return '{}'; + }, + ); + + const settings = loadSettings(MOCK_WORKSPACE_DIR); + + expect(settings.merged.model?.chatCompression).toEqual({ + contextPercentageThreshold: 0.5, + }); + }); + + it('should merge includeDirectories from all scopes', () => { + (mockFsExistsSync as Mock).mockReturnValue(true); + const systemSettingsContent = { + context: { includeDirectories: ['/system/dir'] }, + }; + const systemDefaultsContent = { + context: { includeDirectories: ['/system/defaults/dir'] }, + }; + const userSettingsContent = { + context: { includeDirectories: ['/user/dir1', '/user/dir2'] }, + }; + const workspaceSettingsContent = { + context: { includeDirectories: ['/workspace/dir'] }, + }; + + (fs.readFileSync as Mock).mockImplementation( + (p: fs.PathOrFileDescriptor) => { + if (p === getSystemSettingsPath()) + return JSON.stringify(systemSettingsContent); + if (p === getSystemDefaultsPath()) + return JSON.stringify(systemDefaultsContent); + if (p === USER_SETTINGS_PATH) + return JSON.stringify(userSettingsContent); + if (p === MOCK_WORKSPACE_SETTINGS_PATH) + return JSON.stringify(workspaceSettingsContent); + return '{}'; + }, + ); + + const settings = loadSettings(MOCK_WORKSPACE_DIR); + + expect(settings.merged.context?.includeDirectories).toEqual([ + '/system/defaults/dir', '/user/dir1', '/user/dir2', '/workspace/dir', + '/system/dir', ]); }); @@ -864,10 +1417,30 @@ describe('Settings Loading and Merging', () => { expect(settings.user.settings).toEqual({}); expect(settings.workspace.settings).toEqual({}); expect(settings.merged).toEqual({ - customThemes: {}, + ui: { + customThemes: {}, + }, + mcp: {}, mcpServers: {}, - includeDirectories: [], - chatCompression: {}, + context: { + includeDirectories: [], + }, + model: { + chatCompression: {}, + }, + advanced: { + excludedEnvVars: [], + }, + extensions: { + disabled: [], + workspacesWithMigrationNudge: [], + }, + security: {}, + general: {}, + privacy: {}, + tools: {}, + telemetry: {}, + ide: {}, }); // Check that error objects are populated in settings.errors @@ -893,7 +1466,7 @@ describe('Settings Loading and Merging', () => { it('should resolve environment variables in user settings', () => { process.env['TEST_API_KEY'] = 'user_api_key_from_env'; - const userSettingsContent = { + const userSettingsContent: TestSettings = { apiKey: '$TEST_API_KEY', someUrl: 'https://test.com/${TEST_API_KEY}', }; @@ -909,20 +1482,21 @@ describe('Settings Loading and Merging', () => { ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - // @ts-expect-error: dynamic property for test - expect(settings.user.settings.apiKey).toBe('user_api_key_from_env'); - // @ts-expect-error: dynamic property for test - expect(settings.user.settings.someUrl).toBe( + expect((settings.user.settings as TestSettings)['apiKey']).toBe( + 'user_api_key_from_env', + ); + expect((settings.user.settings as TestSettings)['someUrl']).toBe( 'https://test.com/user_api_key_from_env', ); - // @ts-expect-error: dynamic property for test - expect(settings.merged.apiKey).toBe('user_api_key_from_env'); + expect((settings.merged as TestSettings)['apiKey']).toBe( + 'user_api_key_from_env', + ); delete process.env['TEST_API_KEY']; }); it('should resolve environment variables in workspace settings', () => { process.env['WORKSPACE_ENDPOINT'] = 'workspace_endpoint_from_env'; - const workspaceSettingsContent = { + const workspaceSettingsContent: TestSettings = { endpoint: '${WORKSPACE_ENDPOINT}/api', nested: { value: '$WORKSPACE_ENDPOINT' }, }; @@ -938,14 +1512,15 @@ describe('Settings Loading and Merging', () => { ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.workspace.settings.endpoint).toBe( + expect((settings.workspace.settings as TestSettings)['endpoint']).toBe( 'workspace_endpoint_from_env/api', ); - expect(settings.workspace.settings.nested.value).toBe( - 'workspace_endpoint_from_env', + expect( + (settings.workspace.settings as TestSettings)['nested']['value'], + ).toBe('workspace_endpoint_from_env'); + expect((settings.merged as TestSettings)['endpoint']).toBe( + 'workspace_endpoint_from_env/api', ); - // @ts-expect-error: dynamic property for test - expect(settings.merged.endpoint).toBe('workspace_endpoint_from_env/api'); delete process.env['WORKSPACE_ENDPOINT']; }); @@ -955,19 +1530,23 @@ describe('Settings Loading and Merging', () => { process.env['WORKSPACE_VAR'] = 'workspace_value'; process.env['SHARED_VAR'] = 'final_value'; - const systemSettingsContent = { + const systemSettingsContent: TestSettings = { configValue: '$SHARED_VAR', systemOnly: '$SYSTEM_VAR', }; - const userSettingsContent = { + const userSettingsContent: TestSettings = { configValue: '$SHARED_VAR', userOnly: '$USER_VAR', - theme: 'dark', + ui: { + theme: 'dark', + }, }; - const workspaceSettingsContent = { + const workspaceSettingsContent: TestSettings = { configValue: '$SHARED_VAR', workspaceOnly: '$WORKSPACE_VAR', - theme: 'light', + ui: { + theme: 'light', + }, }; (mockFsExistsSync as Mock).mockReturnValue(true); @@ -989,29 +1568,37 @@ describe('Settings Loading and Merging', () => { const settings = loadSettings(MOCK_WORKSPACE_DIR); // Check resolved values in individual scopes - // @ts-expect-error: dynamic property for test - expect(settings.system.settings.configValue).toBe('final_value'); - // @ts-expect-error: dynamic property for test - expect(settings.system.settings.systemOnly).toBe('system_value'); - // @ts-expect-error: dynamic property for test - expect(settings.user.settings.configValue).toBe('final_value'); - // @ts-expect-error: dynamic property for test - expect(settings.user.settings.userOnly).toBe('user_value'); - // @ts-expect-error: dynamic property for test - expect(settings.workspace.settings.configValue).toBe('final_value'); - // @ts-expect-error: dynamic property for test - expect(settings.workspace.settings.workspaceOnly).toBe('workspace_value'); + expect((settings.system.settings as TestSettings)['configValue']).toBe( + 'final_value', + ); + expect((settings.system.settings as TestSettings)['systemOnly']).toBe( + 'system_value', + ); + expect((settings.user.settings as TestSettings)['configValue']).toBe( + 'final_value', + ); + expect((settings.user.settings as TestSettings)['userOnly']).toBe( + 'user_value', + ); + expect((settings.workspace.settings as TestSettings)['configValue']).toBe( + 'final_value', + ); + expect( + (settings.workspace.settings as TestSettings)['workspaceOnly'], + ).toBe('workspace_value'); // Check merged values (system > workspace > user) - // @ts-expect-error: dynamic property for test - expect(settings.merged.configValue).toBe('final_value'); - // @ts-expect-error: dynamic property for test - expect(settings.merged.systemOnly).toBe('system_value'); - // @ts-expect-error: dynamic property for test - expect(settings.merged.userOnly).toBe('user_value'); - // @ts-expect-error: dynamic property for test - expect(settings.merged.workspaceOnly).toBe('workspace_value'); - expect(settings.merged.theme).toBe('light'); // workspace overrides user + expect((settings.merged as TestSettings)['configValue']).toBe( + 'final_value', + ); + expect((settings.merged as TestSettings)['systemOnly']).toBe( + 'system_value', + ); + expect((settings.merged as TestSettings)['userOnly']).toBe('user_value'); + expect((settings.merged as TestSettings)['workspaceOnly']).toBe( + 'workspace_value', + ); + expect(settings.merged.ui?.theme).toBe('light'); // workspace overrides user delete process.env['SYSTEM_VAR']; delete process.env['USER_VAR']; @@ -1022,10 +1609,10 @@ describe('Settings Loading and Merging', () => { it('should correctly merge dnsResolutionOrder with workspace taking precedence', () => { (mockFsExistsSync as Mock).mockReturnValue(true); const userSettingsContent = { - dnsResolutionOrder: 'ipv4first', + advanced: { dnsResolutionOrder: 'ipv4first' }, }; const workspaceSettingsContent = { - dnsResolutionOrder: 'verbatim', + advanced: { dnsResolutionOrder: 'verbatim' }, }; (fs.readFileSync as Mock).mockImplementation( @@ -1039,7 +1626,7 @@ describe('Settings Loading and Merging', () => { ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.merged.dnsResolutionOrder).toBe('verbatim'); + expect(settings.merged.advanced?.dnsResolutionOrder).toBe('verbatim'); }); it('should use user dnsResolutionOrder if workspace is not defined', () => { @@ -1047,7 +1634,7 @@ describe('Settings Loading and Merging', () => { (p: fs.PathLike) => p === USER_SETTINGS_PATH, ); const userSettingsContent = { - dnsResolutionOrder: 'verbatim', + advanced: { dnsResolutionOrder: 'verbatim' }, }; (fs.readFileSync as Mock).mockImplementation( (p: fs.PathOrFileDescriptor) => { @@ -1058,11 +1645,11 @@ describe('Settings Loading and Merging', () => { ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.merged.dnsResolutionOrder).toBe('verbatim'); + expect(settings.merged.advanced?.dnsResolutionOrder).toBe('verbatim'); }); it('should leave unresolved environment variables as is', () => { - const userSettingsContent = { apiKey: '$UNDEFINED_VAR' }; + const userSettingsContent: TestSettings = { apiKey: '$UNDEFINED_VAR' }; (mockFsExistsSync as Mock).mockImplementation( (p: fs.PathLike) => p === USER_SETTINGS_PATH, ); @@ -1075,14 +1662,20 @@ describe('Settings Loading and Merging', () => { ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.user.settings.apiKey).toBe('$UNDEFINED_VAR'); - expect(settings.merged.apiKey).toBe('$UNDEFINED_VAR'); + expect((settings.user.settings as TestSettings)['apiKey']).toBe( + '$UNDEFINED_VAR', + ); + expect((settings.merged as TestSettings)['apiKey']).toBe( + '$UNDEFINED_VAR', + ); }); it('should resolve multiple environment variables in a single string', () => { process.env['VAR_A'] = 'valueA'; process.env['VAR_B'] = 'valueB'; - const userSettingsContent = { path: '/path/$VAR_A/${VAR_B}/end' }; + const userSettingsContent: TestSettings = { + path: '/path/$VAR_A/${VAR_B}/end', + }; (mockFsExistsSync as Mock).mockImplementation( (p: fs.PathLike) => p === USER_SETTINGS_PATH, ); @@ -1094,7 +1687,9 @@ describe('Settings Loading and Merging', () => { }, ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.user.settings.path).toBe('/path/valueA/valueB/end'); + expect((settings.user.settings as TestSettings)['path']).toBe( + '/path/valueA/valueB/end', + ); delete process.env['VAR_A']; delete process.env['VAR_B']; }); @@ -1102,7 +1697,9 @@ describe('Settings Loading and Merging', () => { it('should resolve environment variables in arrays', () => { process.env['ITEM_1'] = 'item1_env'; process.env['ITEM_2'] = 'item2_env'; - const userSettingsContent = { list: ['$ITEM_1', '${ITEM_2}', 'literal'] }; + const userSettingsContent: TestSettings = { + list: ['$ITEM_1', '${ITEM_2}', 'literal'], + }; (mockFsExistsSync as Mock).mockImplementation( (p: fs.PathLike) => p === USER_SETTINGS_PATH, ); @@ -1114,7 +1711,7 @@ describe('Settings Loading and Merging', () => { }, ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.user.settings.list).toEqual([ + expect((settings.user.settings as TestSettings)['list']).toEqual([ 'item1_env', 'item2_env', 'literal', @@ -1127,7 +1724,7 @@ describe('Settings Loading and Merging', () => { process.env['MY_ENV_STRING'] = 'env_string_value'; process.env['MY_ENV_STRING_NESTED'] = 'env_string_nested_value'; - const userSettingsContent = { + const userSettingsContent: TestSettings = { nullVal: null, trueVal: true, falseVal: false, @@ -1155,20 +1752,34 @@ describe('Settings Loading and Merging', () => { const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.user.settings.nullVal).toBeNull(); - expect(settings.user.settings.trueVal).toBe(true); - expect(settings.user.settings.falseVal).toBe(false); - expect(settings.user.settings.numberVal).toBe(123.45); - expect(settings.user.settings.stringVal).toBe('env_string_value'); - expect(settings.user.settings.undefinedVal).toBeUndefined(); - - expect(settings.user.settings.nestedObj.nestedNull).toBeNull(); - expect(settings.user.settings.nestedObj.nestedBool).toBe(true); - expect(settings.user.settings.nestedObj.nestedNum).toBe(0); - expect(settings.user.settings.nestedObj.nestedString).toBe('literal'); - expect(settings.user.settings.nestedObj.anotherEnv).toBe( - 'env_string_nested_value', + expect((settings.user.settings as TestSettings)['nullVal']).toBeNull(); + expect((settings.user.settings as TestSettings)['trueVal']).toBe(true); + expect((settings.user.settings as TestSettings)['falseVal']).toBe(false); + expect((settings.user.settings as TestSettings)['numberVal']).toBe( + 123.45, ); + expect((settings.user.settings as TestSettings)['stringVal']).toBe( + 'env_string_value', + ); + expect( + (settings.user.settings as TestSettings)['undefinedVal'], + ).toBeUndefined(); + + expect( + (settings.user.settings as TestSettings)['nestedObj']['nestedNull'], + ).toBeNull(); + expect( + (settings.user.settings as TestSettings)['nestedObj']['nestedBool'], + ).toBe(true); + expect( + (settings.user.settings as TestSettings)['nestedObj']['nestedNum'], + ).toBe(0); + expect( + (settings.user.settings as TestSettings)['nestedObj']['nestedString'], + ).toBe('literal'); + expect( + (settings.user.settings as TestSettings)['nestedObj']['anotherEnv'], + ).toBe('env_string_nested_value'); delete process.env['MY_ENV_STRING']; delete process.env['MY_ENV_STRING_NESTED']; @@ -1177,7 +1788,7 @@ describe('Settings Loading and Merging', () => { it('should resolve multiple concatenated environment variables in a single string value', () => { process.env['TEST_HOST'] = 'myhost'; process.env['TEST_PORT'] = '9090'; - const userSettingsContent = { + const userSettingsContent: TestSettings = { serverAddress: '${TEST_HOST}:${TEST_PORT}/api', }; (mockFsExistsSync as Mock).mockImplementation( @@ -1192,7 +1803,9 @@ describe('Settings Loading and Merging', () => { ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.user.settings.serverAddress).toBe('myhost:9090/api'); + expect((settings.user.settings as TestSettings)['serverAddress']).toBe( + 'myhost:9090/api', + ); delete process.env['TEST_HOST']; delete process.env['TEST_PORT']; @@ -1215,8 +1828,8 @@ describe('Settings Loading and Merging', () => { (p: fs.PathLike) => p === MOCK_ENV_SYSTEM_SETTINGS_PATH, ); const systemSettingsContent = { - theme: 'env-var-theme', - sandbox: true, + ui: { theme: 'env-var-theme' }, + tools: { sandbox: true }, }; (fs.readFileSync as Mock).mockImplementation( (p: fs.PathOrFileDescriptor) => { @@ -1236,56 +1849,35 @@ describe('Settings Loading and Merging', () => { expect(settings.system.settings).toEqual(systemSettingsContent); expect(settings.merged).toEqual({ ...systemSettingsContent, - customThemes: {}, + ui: { + ...systemSettingsContent.ui, + customThemes: {}, + }, + mcp: {}, mcpServers: {}, - includeDirectories: [], - chatCompression: {}, + context: { + includeDirectories: [], + }, + model: { + chatCompression: {}, + }, + advanced: { + excludedEnvVars: [], + }, + extensions: { + disabled: [], + workspacesWithMigrationNudge: [], + }, + security: {}, + general: {}, + privacy: {}, + telemetry: {}, + ide: {}, }); }); }); }); - describe('LoadedSettings class', () => { - it('setValue should update the correct scope and recompute merged settings', () => { - (mockFsExistsSync as Mock).mockReturnValue(false); - const loadedSettings = loadSettings(MOCK_WORKSPACE_DIR); - - vi.mocked(fs.writeFileSync).mockImplementation(() => {}); - // mkdirSync is mocked in beforeEach to return undefined, which is fine for void usage - - loadedSettings.setValue(SettingScope.User, 'theme', 'matrix'); - expect(loadedSettings.user.settings.theme).toBe('matrix'); - expect(loadedSettings.merged.theme).toBe('matrix'); - expect(fs.writeFileSync).toHaveBeenCalledWith( - USER_SETTINGS_PATH, - JSON.stringify({ theme: 'matrix' }, null, 2), - 'utf-8', - ); - - loadedSettings.setValue( - SettingScope.Workspace, - 'contextFileName', - 'MY_AGENTS.md', - ); - expect(loadedSettings.workspace.settings.contextFileName).toBe( - 'MY_AGENTS.md', - ); - expect(loadedSettings.merged.contextFileName).toBe('MY_AGENTS.md'); - expect(loadedSettings.merged.theme).toBe('matrix'); // User setting should still be there - expect(fs.writeFileSync).toHaveBeenCalledWith( - MOCK_WORKSPACE_SETTINGS_PATH, - JSON.stringify({ contextFileName: 'MY_AGENTS.md' }, null, 2), - 'utf-8', - ); - - // System theme overrides user and workspace themes - loadedSettings.setValue(SettingScope.System, 'theme', 'ocean'); - - expect(loadedSettings.system.settings.theme).toBe('ocean'); - expect(loadedSettings.merged.theme).toBe('ocean'); - }); - }); - describe('excludedProjectEnvVars integration', () => { const originalEnv = { ...process.env }; @@ -1300,7 +1892,8 @@ describe('Settings Loading and Merging', () => { it('should exclude DEBUG and DEBUG_MODE from project .env files by default', () => { // Create a workspace settings file with excludedProjectEnvVars const workspaceSettingsContent = { - excludedProjectEnvVars: ['DEBUG', 'DEBUG_MODE'], + general: {}, + advanced: { excludedEnvVars: ['DEBUG', 'DEBUG_MODE'] }, }; (mockFsExistsSync as Mock).mockImplementation( @@ -1341,7 +1934,7 @@ describe('Settings Loading and Merging', () => { const settings = loadSettings(MOCK_WORKSPACE_DIR); // Verify the settings were loaded correctly - expect(settings.merged.excludedProjectEnvVars).toEqual([ + expect(settings.merged.advanced?.excludedEnvVars).toEqual([ 'DEBUG', 'DEBUG_MODE', ]); @@ -1358,7 +1951,8 @@ describe('Settings Loading and Merging', () => { it('should respect custom excludedProjectEnvVars from user settings', () => { const userSettingsContent = { - excludedProjectEnvVars: ['NODE_ENV', 'DEBUG'], + general: {}, + advanced: { excludedEnvVars: ['NODE_ENV', 'DEBUG'] }, }; (mockFsExistsSync as Mock).mockImplementation( @@ -1374,11 +1968,11 @@ describe('Settings Loading and Merging', () => { ); const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.user.settings.excludedProjectEnvVars).toEqual([ + expect(settings.user.settings.advanced?.excludedEnvVars).toEqual([ 'NODE_ENV', 'DEBUG', ]); - expect(settings.merged.excludedProjectEnvVars).toEqual([ + expect(settings.merged.advanced?.excludedEnvVars).toEqual([ 'NODE_ENV', 'DEBUG', ]); @@ -1386,10 +1980,12 @@ describe('Settings Loading and Merging', () => { it('should merge excludedProjectEnvVars with workspace taking precedence', () => { const userSettingsContent = { - excludedProjectEnvVars: ['DEBUG', 'NODE_ENV', 'USER_VAR'], + general: {}, + advanced: { excludedEnvVars: ['DEBUG', 'NODE_ENV', 'USER_VAR'] }, }; const workspaceSettingsContent = { - excludedProjectEnvVars: ['WORKSPACE_DEBUG', 'WORKSPACE_VAR'], + general: {}, + advanced: { excludedEnvVars: ['WORKSPACE_DEBUG', 'WORKSPACE_VAR'] }, }; (mockFsExistsSync as Mock).mockReturnValue(true); @@ -1406,19 +2002,410 @@ describe('Settings Loading and Merging', () => { const settings = loadSettings(MOCK_WORKSPACE_DIR); - expect(settings.user.settings.excludedProjectEnvVars).toEqual([ + expect(settings.user.settings.advanced?.excludedEnvVars).toEqual([ 'DEBUG', 'NODE_ENV', 'USER_VAR', ]); - expect(settings.workspace.settings.excludedProjectEnvVars).toEqual([ + expect(settings.workspace.settings.advanced?.excludedEnvVars).toEqual([ 'WORKSPACE_DEBUG', 'WORKSPACE_VAR', ]); - expect(settings.merged.excludedProjectEnvVars).toEqual([ + expect(settings.merged.advanced?.excludedEnvVars).toEqual([ + 'DEBUG', + 'NODE_ENV', + 'USER_VAR', 'WORKSPACE_DEBUG', 'WORKSPACE_VAR', ]); }); }); + + describe('with workspace trust', () => { + it('should merge workspace settings when workspace is trusted', () => { + (mockFsExistsSync as Mock).mockReturnValue(true); + const userSettingsContent = { + ui: { theme: 'dark' }, + tools: { sandbox: false }, + }; + const workspaceSettingsContent = { + tools: { sandbox: true }, + context: { fileName: 'WORKSPACE.md' }, + }; + + (fs.readFileSync as Mock).mockImplementation( + (p: fs.PathOrFileDescriptor) => { + if (p === USER_SETTINGS_PATH) + return JSON.stringify(userSettingsContent); + if (p === MOCK_WORKSPACE_SETTINGS_PATH) + return JSON.stringify(workspaceSettingsContent); + return '{}'; + }, + ); + + const settings = loadSettings(MOCK_WORKSPACE_DIR); + expect(settings.merged.tools?.sandbox).toBe(true); + expect(settings.merged.context?.fileName).toBe('WORKSPACE.md'); + expect(settings.merged.ui?.theme).toBe('dark'); + }); + + it('should NOT merge workspace settings when workspace is not trusted', () => { + vi.mocked(isWorkspaceTrusted).mockReturnValue(false); + (mockFsExistsSync as Mock).mockReturnValue(true); + const userSettingsContent = { + ui: { theme: 'dark' }, + tools: { sandbox: false }, + context: { fileName: 'USER.md' }, + }; + const workspaceSettingsContent = { + tools: { sandbox: true }, + context: { fileName: 'WORKSPACE.md' }, + }; + + (fs.readFileSync as Mock).mockImplementation( + (p: fs.PathOrFileDescriptor) => { + if (p === USER_SETTINGS_PATH) + return JSON.stringify(userSettingsContent); + if (p === MOCK_WORKSPACE_SETTINGS_PATH) + return JSON.stringify(workspaceSettingsContent); + return '{}'; + }, + ); + + const settings = loadSettings(MOCK_WORKSPACE_DIR); + + expect(settings.merged.tools?.sandbox).toBe(false); // User setting + expect(settings.merged.context?.fileName).toBe('USER.md'); // User setting + expect(settings.merged.ui?.theme).toBe('dark'); // User setting + }); + }); + + describe('migrateSettingsToV1', () => { + it('should handle an empty object', () => { + const v2Settings = {}; + const v1Settings = migrateSettingsToV1(v2Settings); + expect(v1Settings).toEqual({}); + }); + + it('should migrate a simple v2 settings object to v1', () => { + const v2Settings = { + general: { + preferredEditor: 'vscode', + vimMode: true, + }, + ui: { + theme: 'dark', + }, + }; + const v1Settings = migrateSettingsToV1(v2Settings); + expect(v1Settings).toEqual({ + preferredEditor: 'vscode', + vimMode: true, + theme: 'dark', + }); + }); + + it('should handle nested properties correctly', () => { + const v2Settings = { + security: { + folderTrust: { + enabled: true, + }, + auth: { + selectedType: 'oauth', + }, + }, + advanced: { + autoConfigureMemory: true, + }, + }; + const v1Settings = migrateSettingsToV1(v2Settings); + expect(v1Settings).toEqual({ + folderTrust: true, + selectedAuthType: 'oauth', + autoConfigureMaxOldSpaceSize: true, + }); + }); + + it('should preserve mcpServers at the top level', () => { + const v2Settings = { + general: { + preferredEditor: 'vscode', + }, + mcpServers: { + 'my-server': { + command: 'npm start', + }, + }, + }; + const v1Settings = migrateSettingsToV1(v2Settings); + expect(v1Settings).toEqual({ + preferredEditor: 'vscode', + mcpServers: { + 'my-server': { + command: 'npm start', + }, + }, + }); + }); + + it('should carry over unrecognized top-level properties', () => { + const v2Settings = { + general: { + vimMode: false, + }, + unrecognized: 'value', + another: { + nested: true, + }, + }; + const v1Settings = migrateSettingsToV1(v2Settings); + expect(v1Settings).toEqual({ + vimMode: false, + unrecognized: 'value', + another: { + nested: true, + }, + }); + }); + + it('should handle a complex object with mixed properties', () => { + const v2Settings = { + general: { + disableAutoUpdate: true, + }, + ui: { + hideBanner: true, + customThemes: { + myTheme: {}, + }, + }, + model: { + name: 'gemini-pro', + chatCompression: { + contextPercentageThreshold: 0.5, + }, + }, + mcpServers: { + 'server-1': { + command: 'node server.js', + }, + }, + unrecognized: { + should: 'be-preserved', + }, + }; + const v1Settings = migrateSettingsToV1(v2Settings); + expect(v1Settings).toEqual({ + disableAutoUpdate: true, + hideBanner: true, + customThemes: { + myTheme: {}, + }, + model: 'gemini-pro', + chatCompression: { + contextPercentageThreshold: 0.5, + }, + mcpServers: { + 'server-1': { + command: 'node server.js', + }, + }, + unrecognized: { + should: 'be-preserved', + }, + }); + }); + + it('should not migrate a v1 settings object', () => { + const v1Settings = { + preferredEditor: 'vscode', + vimMode: true, + theme: 'dark', + }; + const migratedSettings = migrateSettingsToV1(v1Settings); + expect(migratedSettings).toEqual({ + preferredEditor: 'vscode', + vimMode: true, + theme: 'dark', + }); + }); + + it('should migrate a full v2 settings object to v1', () => { + const v2Settings: TestSettings = { + general: { + preferredEditor: 'code', + vimMode: true, + }, + ui: { + theme: 'dark', + }, + privacy: { + usageStatisticsEnabled: false, + }, + model: { + name: 'gemini-pro', + chatCompression: { + contextPercentageThreshold: 0.8, + }, + }, + context: { + fileName: 'CONTEXT.md', + includeDirectories: ['/src'], + }, + tools: { + sandbox: true, + exclude: ['toolA'], + }, + mcp: { + allowed: ['server1'], + }, + security: { + folderTrust: { + enabled: true, + }, + }, + advanced: { + dnsResolutionOrder: 'ipv4first', + excludedEnvVars: ['SECRET'], + }, + mcpServers: { + 'my-server': { + command: 'npm start', + }, + }, + unrecognizedTopLevel: { + value: 'should be preserved', + }, + }; + + const v1Settings = migrateSettingsToV1(v2Settings); + + expect(v1Settings).toEqual({ + preferredEditor: 'code', + vimMode: true, + theme: 'dark', + usageStatisticsEnabled: false, + model: 'gemini-pro', + chatCompression: { + contextPercentageThreshold: 0.8, + }, + contextFileName: 'CONTEXT.md', + includeDirectories: ['/src'], + sandbox: true, + excludeTools: ['toolA'], + allowMCPServers: ['server1'], + folderTrust: true, + dnsResolutionOrder: 'ipv4first', + excludedProjectEnvVars: ['SECRET'], + mcpServers: { + 'my-server': { + command: 'npm start', + }, + }, + unrecognizedTopLevel: { + value: 'should be preserved', + }, + }); + }); + + it('should handle partial v2 settings', () => { + const v2Settings: TestSettings = { + general: { + vimMode: false, + }, + ui: {}, + model: { + name: 'gemini-1.5-pro', + }, + unrecognized: 'value', + }; + + const v1Settings = migrateSettingsToV1(v2Settings); + + expect(v1Settings).toEqual({ + vimMode: false, + model: 'gemini-1.5-pro', + unrecognized: 'value', + }); + }); + + it('should handle settings with different data types', () => { + const v2Settings: TestSettings = { + general: { + vimMode: false, + }, + model: { + maxSessionTurns: 0, + }, + context: { + includeDirectories: [], + }, + security: { + folderTrust: { + enabled: null, + }, + }, + }; + + const v1Settings = migrateSettingsToV1(v2Settings); + + expect(v1Settings).toEqual({ + vimMode: false, + maxSessionTurns: 0, + includeDirectories: [], + folderTrust: null, + }); + }); + + it('should preserve unrecognized top-level keys', () => { + const v2Settings: TestSettings = { + general: { + vimMode: true, + }, + customTopLevel: { + a: 1, + b: [2], + }, + anotherOne: 'hello', + }; + + const v1Settings = migrateSettingsToV1(v2Settings); + + expect(v1Settings).toEqual({ + vimMode: true, + customTopLevel: { + a: 1, + b: [2], + }, + anotherOne: 'hello', + }); + }); + + it('should handle an empty v2 settings object', () => { + const v2Settings = {}; + const v1Settings = migrateSettingsToV1(v2Settings); + expect(v1Settings).toEqual({}); + }); + + it('should correctly handle mcpServers at the top level', () => { + const v2Settings: TestSettings = { + mcpServers: { + serverA: { command: 'a' }, + }, + mcp: { + allowed: ['serverA'], + }, + }; + + const v1Settings = migrateSettingsToV1(v2Settings); + + expect(v1Settings).toEqual({ + mcpServers: { + serverA: { command: 'a' }, + }, + allowMCPServers: ['serverA'], + }); + }); + }); }); diff --git a/packages/cli/src/config/settings.ts b/packages/cli/src/config/settings.ts index 8f64d6e1..f3c5a2d6 100644 --- a/packages/cli/src/config/settings.ts +++ b/packages/cli/src/config/settings.ts @@ -4,26 +4,81 @@ * SPDX-License-Identifier: Apache-2.0 */ -import * as fs from 'fs'; -import * as path from 'path'; -import { homedir, platform } from 'os'; +import * as fs from 'node:fs'; +import * as path from 'node:path'; +import { homedir, platform } from 'node:os'; import * as dotenv from 'dotenv'; import { GEMINI_CONFIG_DIR as GEMINI_DIR, getErrorMessage, + Storage, } from '@qwen-code/qwen-code-core'; import stripJsonComments from 'strip-json-comments'; import { DefaultLight } from '../ui/themes/default-light.js'; import { DefaultDark } from '../ui/themes/default.js'; -import { Settings, MemoryImportFormat } from './settingsSchema.js'; +import { isWorkspaceTrusted } from './trustedFolders.js'; +import type { Settings, MemoryImportFormat } from './settingsSchema.js'; +import { mergeWith } from 'lodash-es'; export type { Settings, MemoryImportFormat }; export const SETTINGS_DIRECTORY_NAME = '.qwen'; -export const USER_SETTINGS_DIR = path.join(homedir(), SETTINGS_DIRECTORY_NAME); -export const USER_SETTINGS_PATH = path.join(USER_SETTINGS_DIR, 'settings.json'); +export const USER_SETTINGS_PATH = Storage.getGlobalSettingsPath(); +export const USER_SETTINGS_DIR = path.dirname(USER_SETTINGS_PATH); export const DEFAULT_EXCLUDED_ENV_VARS = ['DEBUG', 'DEBUG_MODE']; +const MIGRATE_V2_OVERWRITE = false; + +const MIGRATION_MAP: Record = { + preferredEditor: 'general.preferredEditor', + vimMode: 'general.vimMode', + disableAutoUpdate: 'general.disableAutoUpdate', + disableUpdateNag: 'general.disableUpdateNag', + checkpointing: 'general.checkpointing', + theme: 'ui.theme', + customThemes: 'ui.customThemes', + hideWindowTitle: 'ui.hideWindowTitle', + hideTips: 'ui.hideTips', + hideBanner: 'ui.hideBanner', + hideFooter: 'ui.hideFooter', + showMemoryUsage: 'ui.showMemoryUsage', + showLineNumbers: 'ui.showLineNumbers', + accessibility: 'ui.accessibility', + ideMode: 'ide.enabled', + hasSeenIdeIntegrationNudge: 'ide.hasSeenNudge', + usageStatisticsEnabled: 'privacy.usageStatisticsEnabled', + telemetry: 'telemetry', + model: 'model.name', + maxSessionTurns: 'model.maxSessionTurns', + summarizeToolOutput: 'model.summarizeToolOutput', + chatCompression: 'model.chatCompression', + skipNextSpeakerCheck: 'model.skipNextSpeakerCheck', + contextFileName: 'context.fileName', + memoryImportFormat: 'context.importFormat', + memoryDiscoveryMaxDirs: 'context.discoveryMaxDirs', + includeDirectories: 'context.includeDirectories', + loadMemoryFromIncludeDirectories: 'context.loadFromIncludeDirectories', + fileFiltering: 'context.fileFiltering', + sandbox: 'tools.sandbox', + shouldUseNodePtyShell: 'tools.usePty', + allowedTools: 'tools.allowed', + coreTools: 'tools.core', + excludeTools: 'tools.exclude', + toolDiscoveryCommand: 'tools.discoveryCommand', + toolCallCommand: 'tools.callCommand', + mcpServerCommand: 'mcp.serverCommand', + allowMCPServers: 'mcp.allowed', + excludeMCPServers: 'mcp.excluded', + folderTrustFeature: 'security.folderTrust.featureEnabled', + folderTrust: 'security.folderTrust.enabled', + selectedAuthType: 'security.auth.selectedType', + useExternalAuth: 'security.auth.useExternal', + autoConfigureMaxOldSpaceSize: 'advanced.autoConfigureMemory', + dnsResolutionOrder: 'advanced.dnsResolutionOrder', + excludedProjectEnvVars: 'advanced.excludedEnvVars', + bugCommand: 'advanced.bugCommand', +}; + export function getSystemSettingsPath(): string { if (process.env['QWEN_CODE_SYSTEM_SETTINGS_PATH']) { return process.env['QWEN_CODE_SYSTEM_SETTINGS_PATH']; @@ -37,8 +92,14 @@ export function getSystemSettingsPath(): string { } } -export function getWorkspaceSettingsPath(workspaceDir: string): string { - return path.join(workspaceDir, SETTINGS_DIRECTORY_NAME, 'settings.json'); +export function getSystemDefaultsPath(): string { + if (process.env['QWEN_CODE_SYSTEM_DEFAULTS_PATH']) { + return process.env['QWEN_CODE_SYSTEM_DEFAULTS_PATH']; + } + return path.join( + path.dirname(getSystemSettingsPath()), + 'system-defaults.json', + ); } export type { DnsResolutionOrder } from './settingsSchema.js'; @@ -47,6 +108,7 @@ export enum SettingScope { User = 'User', Workspace = 'Workspace', System = 'System', + SystemDefaults = 'SystemDefaults', } export interface CheckpointingSettings { @@ -59,6 +121,7 @@ export interface SummarizeToolOutputSettings { export interface AccessibilitySettings { disableLoadingPhrases?: boolean; + screenReader?: boolean; } export interface SettingsError { @@ -71,38 +134,290 @@ export interface SettingsFile { path: string; } +function setNestedProperty( + obj: Record, + path: string, + value: unknown, +) { + const keys = path.split('.'); + const lastKey = keys.pop(); + if (!lastKey) return; + + let current: Record = obj; + for (const key of keys) { + if (current[key] === undefined) { + current[key] = {}; + } + const next = current[key]; + if (typeof next === 'object' && next !== null) { + current = next as Record; + } else { + // This path is invalid, so we stop. + return; + } + } + current[lastKey] = value; +} + +function needsMigration(settings: Record): boolean { + return !('general' in settings); +} + +function migrateSettingsToV2( + flatSettings: Record, +): Record | null { + if (!needsMigration(flatSettings)) { + return null; + } + + const v2Settings: Record = {}; + const flatKeys = new Set(Object.keys(flatSettings)); + + for (const [oldKey, newPath] of Object.entries(MIGRATION_MAP)) { + if (flatKeys.has(oldKey)) { + setNestedProperty(v2Settings, newPath, flatSettings[oldKey]); + flatKeys.delete(oldKey); + } + } + + // Preserve mcpServers at the top level + if (flatSettings['mcpServers']) { + v2Settings['mcpServers'] = flatSettings['mcpServers']; + flatKeys.delete('mcpServers'); + } + + // Carry over any unrecognized keys + for (const remainingKey of flatKeys) { + v2Settings[remainingKey] = flatSettings[remainingKey]; + } + + return v2Settings; +} + +function getNestedProperty( + obj: Record, + path: string, +): unknown { + const keys = path.split('.'); + let current: unknown = obj; + for (const key of keys) { + if (typeof current !== 'object' || current === null || !(key in current)) { + return undefined; + } + current = (current as Record)[key]; + } + return current; +} + +const REVERSE_MIGRATION_MAP: Record = Object.fromEntries( + Object.entries(MIGRATION_MAP).map(([key, value]) => [value, key]), +); + +// Dynamically determine the top-level keys from the V2 settings structure. +const KNOWN_V2_CONTAINERS = new Set( + Object.values(MIGRATION_MAP).map((path) => path.split('.')[0]), +); + +export function migrateSettingsToV1( + v2Settings: Record, +): Record { + const v1Settings: Record = {}; + const v2Keys = new Set(Object.keys(v2Settings)); + + for (const [newPath, oldKey] of Object.entries(REVERSE_MIGRATION_MAP)) { + const value = getNestedProperty(v2Settings, newPath); + if (value !== undefined) { + v1Settings[oldKey] = value; + v2Keys.delete(newPath.split('.')[0]); + } + } + + // Preserve mcpServers at the top level + if (v2Settings['mcpServers']) { + v1Settings['mcpServers'] = v2Settings['mcpServers']; + v2Keys.delete('mcpServers'); + } + + // Carry over any unrecognized keys + for (const remainingKey of v2Keys) { + const value = v2Settings[remainingKey]; + if (value === undefined) { + continue; + } + + // Don't carry over empty objects that were just containers for migrated settings. + if ( + KNOWN_V2_CONTAINERS.has(remainingKey) && + typeof value === 'object' && + value !== null && + !Array.isArray(value) && + Object.keys(value).length === 0 + ) { + continue; + } + + v1Settings[remainingKey] = value; + } + + return v1Settings; +} + function mergeSettings( system: Settings, + systemDefaults: Settings, user: Settings, workspace: Settings, + isTrusted: boolean, ): Settings { - // folderTrust is not supported at workspace level. - // eslint-disable-next-line @typescript-eslint/no-unused-vars - const { folderTrust, ...workspaceWithoutFolderTrust } = workspace; + const safeWorkspace = isTrusted ? workspace : ({} as Settings); + // folderTrust is not supported at workspace level. + const { security, ...restOfWorkspace } = safeWorkspace; + const safeWorkspaceWithoutFolderTrust = security + ? { + ...restOfWorkspace, + // eslint-disable-next-line @typescript-eslint/no-unused-vars + security: (({ folderTrust, ...rest }) => rest)(security), + } + : { + ...restOfWorkspace, + security: {}, + }; + + // Settings are merged with the following precedence (last one wins for + // single values): + // 1. System Defaults + // 2. User Settings + // 3. Workspace Settings + // 4. System Settings (as overrides) + // + // For properties that are arrays (e.g., includeDirectories), the arrays + // are concatenated. For objects (e.g., customThemes), they are merged. return { + ...systemDefaults, ...user, - ...workspaceWithoutFolderTrust, + ...safeWorkspaceWithoutFolderTrust, ...system, - customThemes: { - ...(user.customThemes || {}), - ...(workspace.customThemes || {}), - ...(system.customThemes || {}), + general: { + ...(systemDefaults.general || {}), + ...(user.general || {}), + ...(safeWorkspaceWithoutFolderTrust.general || {}), + ...(system.general || {}), + }, + ui: { + ...(systemDefaults.ui || {}), + ...(user.ui || {}), + ...(safeWorkspaceWithoutFolderTrust.ui || {}), + ...(system.ui || {}), + customThemes: { + ...(systemDefaults.ui?.customThemes || {}), + ...(user.ui?.customThemes || {}), + ...(safeWorkspaceWithoutFolderTrust.ui?.customThemes || {}), + ...(system.ui?.customThemes || {}), + }, + }, + ide: { + ...(systemDefaults.ide || {}), + ...(user.ide || {}), + ...(safeWorkspaceWithoutFolderTrust.ide || {}), + ...(system.ide || {}), + }, + privacy: { + ...(systemDefaults.privacy || {}), + ...(user.privacy || {}), + ...(safeWorkspaceWithoutFolderTrust.privacy || {}), + ...(system.privacy || {}), + }, + telemetry: { + ...(systemDefaults.telemetry || {}), + ...(user.telemetry || {}), + ...(safeWorkspaceWithoutFolderTrust.telemetry || {}), + ...(system.telemetry || {}), + }, + security: { + ...(systemDefaults.security || {}), + ...(user.security || {}), + ...(safeWorkspaceWithoutFolderTrust.security || {}), + ...(system.security || {}), + }, + mcp: { + ...(systemDefaults.mcp || {}), + ...(user.mcp || {}), + ...(safeWorkspaceWithoutFolderTrust.mcp || {}), + ...(system.mcp || {}), }, mcpServers: { + ...(systemDefaults.mcpServers || {}), ...(user.mcpServers || {}), - ...(workspace.mcpServers || {}), + ...(safeWorkspaceWithoutFolderTrust.mcpServers || {}), ...(system.mcpServers || {}), }, - includeDirectories: [ - ...(system.includeDirectories || []), - ...(user.includeDirectories || []), - ...(workspace.includeDirectories || []), - ], - chatCompression: { - ...(system.chatCompression || {}), - ...(user.chatCompression || {}), - ...(workspace.chatCompression || {}), + tools: { + ...(systemDefaults.tools || {}), + ...(user.tools || {}), + ...(safeWorkspaceWithoutFolderTrust.tools || {}), + ...(system.tools || {}), + }, + context: { + ...(systemDefaults.context || {}), + ...(user.context || {}), + ...(safeWorkspaceWithoutFolderTrust.context || {}), + ...(system.context || {}), + includeDirectories: [ + ...(systemDefaults.context?.includeDirectories || []), + ...(user.context?.includeDirectories || []), + ...(safeWorkspaceWithoutFolderTrust.context?.includeDirectories || []), + ...(system.context?.includeDirectories || []), + ], + }, + model: { + ...(systemDefaults.model || {}), + ...(user.model || {}), + ...(safeWorkspaceWithoutFolderTrust.model || {}), + ...(system.model || {}), + chatCompression: { + ...(systemDefaults.model?.chatCompression || {}), + ...(user.model?.chatCompression || {}), + ...(safeWorkspaceWithoutFolderTrust.model?.chatCompression || {}), + ...(system.model?.chatCompression || {}), + }, + }, + advanced: { + ...(systemDefaults.advanced || {}), + ...(user.advanced || {}), + ...(safeWorkspaceWithoutFolderTrust.advanced || {}), + ...(system.advanced || {}), + excludedEnvVars: [ + ...new Set([ + ...(systemDefaults.advanced?.excludedEnvVars || []), + ...(user.advanced?.excludedEnvVars || []), + ...(safeWorkspaceWithoutFolderTrust.advanced?.excludedEnvVars || []), + ...(system.advanced?.excludedEnvVars || []), + ]), + ], + }, + extensions: { + ...(systemDefaults.extensions || {}), + ...(user.extensions || {}), + ...(safeWorkspaceWithoutFolderTrust.extensions || {}), + ...(system.extensions || {}), + disabled: [ + ...new Set([ + ...(systemDefaults.extensions?.disabled || []), + ...(user.extensions?.disabled || []), + ...(safeWorkspaceWithoutFolderTrust.extensions?.disabled || []), + ...(system.extensions?.disabled || []), + ]), + ], + workspacesWithMigrationNudge: [ + ...new Set([ + ...(systemDefaults.extensions?.workspacesWithMigrationNudge || []), + ...(user.extensions?.workspacesWithMigrationNudge || []), + ...(safeWorkspaceWithoutFolderTrust.extensions + ?.workspacesWithMigrationNudge || []), + ...(system.extensions?.workspacesWithMigrationNudge || []), + ]), + ], }, }; } @@ -110,21 +425,30 @@ function mergeSettings( export class LoadedSettings { constructor( system: SettingsFile, + systemDefaults: SettingsFile, user: SettingsFile, workspace: SettingsFile, errors: SettingsError[], + isTrusted: boolean, + migratedInMemorScopes: Set, ) { this.system = system; + this.systemDefaults = systemDefaults; this.user = user; this.workspace = workspace; this.errors = errors; + this.isTrusted = isTrusted; + this.migratedInMemorScopes = migratedInMemorScopes; this._merged = this.computeMergedSettings(); } readonly system: SettingsFile; + readonly systemDefaults: SettingsFile; readonly user: SettingsFile; readonly workspace: SettingsFile; readonly errors: SettingsError[]; + readonly isTrusted: boolean; + readonly migratedInMemorScopes: Set; private _merged: Settings; @@ -135,8 +459,10 @@ export class LoadedSettings { private computeMergedSettings(): Settings { return mergeSettings( this.system.settings, + this.systemDefaults.settings, this.user.settings, this.workspace.settings, + this.isTrusted, ); } @@ -148,18 +474,16 @@ export class LoadedSettings { return this.workspace; case SettingScope.System: return this.system; + case SettingScope.SystemDefaults: + return this.systemDefaults; default: throw new Error(`Invalid scope: ${scope}`); } } - setValue( - scope: SettingScope, - key: K, - value: Settings[K], - ): void { + setValue(scope: SettingScope, key: string, value: unknown): void { const settingsFile = this.forScope(scope); - settingsFile.settings[key] = value; + setNestedProperty(settingsFile.settings, key, value); this._merged = this.computeMergedSettings(); saveSettings(settingsFile); } @@ -269,7 +593,9 @@ export function loadEnvironment(settings?: Settings): void { // If no settings provided, try to load workspace settings for exclusions let resolvedSettings = settings; if (!resolvedSettings) { - const workspaceSettingsPath = getWorkspaceSettingsPath(process.cwd()); + const workspaceSettingsPath = new Storage( + process.cwd(), + ).getWorkspaceSettingsPath(); try { if (fs.existsSync(workspaceSettingsPath)) { const workspaceContent = fs.readFileSync( @@ -294,7 +620,8 @@ export function loadEnvironment(settings?: Settings): void { const parsedEnv = dotenv.parse(envFileContent); const excludedVars = - resolvedSettings?.excludedProjectEnvVars || DEFAULT_EXCLUDED_ENV_VARS; + resolvedSettings?.advanced?.excludedEnvVars || + DEFAULT_EXCLUDED_ENV_VARS; const isProjectEnvFile = !envFilePath.includes(GEMINI_DIR); for (const key in parsedEnv) { @@ -322,10 +649,13 @@ export function loadEnvironment(settings?: Settings): void { */ export function loadSettings(workspaceDir: string): LoadedSettings { let systemSettings: Settings = {}; + let systemDefaultSettings: Settings = {}; let userSettings: Settings = {}; let workspaceSettings: Settings = {}; const settingsErrors: SettingsError[] = []; const systemSettingsPath = getSystemSettingsPath(); + const systemDefaultsPath = getSystemDefaultsPath(); + const migratedInMemorScopes = new Set(); // Resolve paths to their canonical representation to handle symlinks const resolvedWorkspaceDir = path.resolve(workspaceDir); @@ -342,70 +672,102 @@ export function loadSettings(workspaceDir: string): LoadedSettings { // We expect homedir to always exist and be resolvable. const realHomeDir = fs.realpathSync(resolvedHomeDir); - const workspaceSettingsPath = getWorkspaceSettingsPath(workspaceDir); + const workspaceSettingsPath = new Storage( + workspaceDir, + ).getWorkspaceSettingsPath(); - // Load system settings - try { - if (fs.existsSync(systemSettingsPath)) { - const systemContent = fs.readFileSync(systemSettingsPath, 'utf-8'); - systemSettings = JSON.parse(stripJsonComments(systemContent)) as Settings; - } - } catch (error: unknown) { - settingsErrors.push({ - message: getErrorMessage(error), - path: systemSettingsPath, - }); - } - - // Load user settings - try { - if (fs.existsSync(USER_SETTINGS_PATH)) { - const userContent = fs.readFileSync(USER_SETTINGS_PATH, 'utf-8'); - userSettings = JSON.parse(stripJsonComments(userContent)) as Settings; - // Support legacy theme names - if (userSettings.theme && userSettings.theme === 'VS') { - userSettings.theme = DefaultLight.name; - } else if (userSettings.theme && userSettings.theme === 'VS2015') { - userSettings.theme = DefaultDark.name; - } - } - } catch (error: unknown) { - settingsErrors.push({ - message: getErrorMessage(error), - path: USER_SETTINGS_PATH, - }); - } - - if (realWorkspaceDir !== realHomeDir) { - // Load workspace settings + const loadAndMigrate = (filePath: string, scope: SettingScope): Settings => { try { - if (fs.existsSync(workspaceSettingsPath)) { - const projectContent = fs.readFileSync(workspaceSettingsPath, 'utf-8'); - workspaceSettings = JSON.parse( - stripJsonComments(projectContent), - ) as Settings; - if (workspaceSettings.theme && workspaceSettings.theme === 'VS') { - workspaceSettings.theme = DefaultLight.name; - } else if ( - workspaceSettings.theme && - workspaceSettings.theme === 'VS2015' + if (fs.existsSync(filePath)) { + const content = fs.readFileSync(filePath, 'utf-8'); + const rawSettings: unknown = JSON.parse(stripJsonComments(content)); + + if ( + typeof rawSettings !== 'object' || + rawSettings === null || + Array.isArray(rawSettings) ) { - workspaceSettings.theme = DefaultDark.name; + settingsErrors.push({ + message: 'Settings file is not a valid JSON object.', + path: filePath, + }); + return {}; } + + let settingsObject = rawSettings as Record; + if (needsMigration(settingsObject)) { + const migratedSettings = migrateSettingsToV2(settingsObject); + if (migratedSettings) { + if (MIGRATE_V2_OVERWRITE) { + try { + fs.renameSync(filePath, `${filePath}.orig`); + fs.writeFileSync( + filePath, + JSON.stringify(migratedSettings, null, 2), + 'utf-8', + ); + } catch (e) { + console.error( + `Error migrating settings file on disk: ${getErrorMessage( + e, + )}`, + ); + } + } else { + migratedInMemorScopes.add(scope); + } + settingsObject = migratedSettings; + } + } + return settingsObject as Settings; } } catch (error: unknown) { settingsErrors.push({ message: getErrorMessage(error), - path: workspaceSettingsPath, + path: filePath, }); } + return {}; + }; + + systemSettings = loadAndMigrate(systemSettingsPath, SettingScope.System); + systemDefaultSettings = loadAndMigrate( + systemDefaultsPath, + SettingScope.SystemDefaults, + ); + userSettings = loadAndMigrate(USER_SETTINGS_PATH, SettingScope.User); + + if (realWorkspaceDir !== realHomeDir) { + workspaceSettings = loadAndMigrate( + workspaceSettingsPath, + SettingScope.Workspace, + ); } + // Support legacy theme names + if (userSettings.ui?.theme === 'VS') { + userSettings.ui.theme = DefaultLight.name; + } else if (userSettings.ui?.theme === 'VS2015') { + userSettings.ui.theme = DefaultDark.name; + } + if (workspaceSettings.ui?.theme === 'VS') { + workspaceSettings.ui.theme = DefaultLight.name; + } else if (workspaceSettings.ui?.theme === 'VS2015') { + workspaceSettings.ui.theme = DefaultDark.name; + } + + // For the initial trust check, we can only use user and system settings. + const initialTrustCheckSettings = mergeWith({}, systemSettings, userSettings); + const isTrusted = + isWorkspaceTrusted(initialTrustCheckSettings as Settings) ?? true; + // Create a temporary merged settings object to pass to loadEnvironment. const tempMergedSettings = mergeSettings( systemSettings, + systemDefaultSettings, userSettings, workspaceSettings, + isTrusted, ); // loadEnviroment depends on settings so we have to create a temp version of @@ -423,6 +785,10 @@ export function loadSettings(workspaceDir: string): LoadedSettings { path: systemSettingsPath, settings: systemSettings, }, + { + path: systemDefaultsPath, + settings: systemDefaultSettings, + }, { path: USER_SETTINGS_PATH, settings: userSettings, @@ -432,21 +798,10 @@ export function loadSettings(workspaceDir: string): LoadedSettings { settings: workspaceSettings, }, settingsErrors, + isTrusted, + migratedInMemorScopes, ); - // Validate chatCompression settings - const chatCompression = loadedSettings.merged.chatCompression; - const threshold = chatCompression?.contextPercentageThreshold; - if ( - threshold != null && - (typeof threshold !== 'number' || threshold < 0 || threshold > 1) - ) { - console.warn( - `Invalid value for chatCompression.contextPercentageThreshold: "${threshold}". Please use a value between 0 and 1. Using default compression settings.`, - ); - delete loadedSettings.merged.chatCompression; - } - return loadedSettings; } @@ -458,9 +813,16 @@ export function saveSettings(settingsFile: SettingsFile): void { fs.mkdirSync(dirPath, { recursive: true }); } + let settingsToSave = settingsFile.settings; + if (!MIGRATE_V2_OVERWRITE) { + settingsToSave = migrateSettingsToV1( + settingsToSave as Record, + ) as Settings; + } + fs.writeFileSync( settingsFile.path, - JSON.stringify(settingsFile.settings, null, 2), + JSON.stringify(settingsToSave, null, 2), 'utf-8', ); } catch (error) { diff --git a/packages/cli/src/config/settingsSchema.test.ts b/packages/cli/src/config/settingsSchema.test.ts index 572bf12a..e78f35c8 100644 --- a/packages/cli/src/config/settingsSchema.test.ts +++ b/packages/cli/src/config/settingsSchema.test.ts @@ -5,53 +5,25 @@ */ import { describe, it, expect } from 'vitest'; -import { SETTINGS_SCHEMA, Settings } from './settingsSchema.js'; +import type { Settings } from './settingsSchema.js'; +import { SETTINGS_SCHEMA } from './settingsSchema.js'; describe('SettingsSchema', () => { describe('SETTINGS_SCHEMA', () => { it('should contain all expected top-level settings', () => { const expectedSettings = [ - 'theme', - 'customThemes', - 'showMemoryUsage', - 'usageStatisticsEnabled', - 'autoConfigureMaxOldSpaceSize', - 'preferredEditor', - 'maxSessionTurns', - 'memoryImportFormat', - 'memoryDiscoveryMaxDirs', - 'contextFileName', - 'vimMode', - 'ideMode', - 'accessibility', - 'checkpointing', - 'fileFiltering', - 'disableAutoUpdate', - 'hideWindowTitle', - 'hideTips', - 'hideBanner', - 'selectedAuthType', - 'useExternalAuth', - 'sandbox', - 'coreTools', - 'excludeTools', - 'toolDiscoveryCommand', - 'toolCallCommand', - 'mcpServerCommand', 'mcpServers', - 'allowMCPServers', - 'excludeMCPServers', + 'general', + 'ui', + 'ide', + 'privacy', 'telemetry', - 'bugCommand', - 'summarizeToolOutput', - 'dnsResolutionOrder', - 'excludedProjectEnvVars', - 'disableUpdateNag', - 'includeDirectories', - 'loadMemoryFromIncludeDirectories', 'model', - 'hasSeenIdeIntegrationNudge', - 'folderTrustFeature', + 'context', + 'tools', + 'mcp', + 'security', + 'advanced', 'enableWelcomeBack', ]; @@ -78,9 +50,16 @@ describe('SettingsSchema', () => { it('should have correct nested setting structure', () => { const nestedSettings = [ - 'accessibility', - 'checkpointing', - 'fileFiltering', + 'general', + 'ui', + 'ide', + 'privacy', + 'model', + 'context', + 'tools', + 'mcp', + 'security', + 'advanced', ]; nestedSettings.forEach((setting) => { @@ -97,29 +76,36 @@ describe('SettingsSchema', () => { it('should have accessibility nested properties', () => { expect( - SETTINGS_SCHEMA.accessibility.properties?.disableLoadingPhrases, + SETTINGS_SCHEMA.ui?.properties?.accessibility?.properties, ).toBeDefined(); expect( - SETTINGS_SCHEMA.accessibility.properties?.disableLoadingPhrases.type, + SETTINGS_SCHEMA.ui?.properties?.accessibility.properties + ?.disableLoadingPhrases.type, ).toBe('boolean'); }); it('should have checkpointing nested properties', () => { - expect(SETTINGS_SCHEMA.checkpointing.properties?.enabled).toBeDefined(); - expect(SETTINGS_SCHEMA.checkpointing.properties?.enabled.type).toBe( - 'boolean', - ); + expect( + SETTINGS_SCHEMA.general?.properties?.checkpointing.properties?.enabled, + ).toBeDefined(); + expect( + SETTINGS_SCHEMA.general?.properties?.checkpointing.properties?.enabled + .type, + ).toBe('boolean'); }); it('should have fileFiltering nested properties', () => { expect( - SETTINGS_SCHEMA.fileFiltering.properties?.respectGitIgnore, + SETTINGS_SCHEMA.context.properties.fileFiltering.properties + ?.respectGitIgnore, ).toBeDefined(); expect( - SETTINGS_SCHEMA.fileFiltering.properties?.respectGeminiIgnore, + SETTINGS_SCHEMA.context.properties.fileFiltering.properties + ?.respectGeminiIgnore, ).toBeDefined(); expect( - SETTINGS_SCHEMA.fileFiltering.properties?.enableRecursiveFileSearch, + SETTINGS_SCHEMA.context.properties.fileFiltering.properties + ?.enableRecursiveFileSearch, ).toBeDefined(); }); @@ -148,11 +134,6 @@ describe('SettingsSchema', () => { expect(categories.size).toBeGreaterThan(0); expect(categories).toContain('General'); expect(categories).toContain('UI'); - expect(categories).toContain('Mode'); - expect(categories).toContain('Updates'); - expect(categories).toContain('Accessibility'); - expect(categories).toContain('Checkpointing'); - expect(categories).toContain('File Filtering'); expect(categories).toContain('Advanced'); }); @@ -181,73 +162,148 @@ describe('SettingsSchema', () => { it('should have showInDialog property configured', () => { // Check that user-facing settings are marked for dialog display - expect(SETTINGS_SCHEMA.showMemoryUsage.showInDialog).toBe(true); - expect(SETTINGS_SCHEMA.vimMode.showInDialog).toBe(true); - expect(SETTINGS_SCHEMA.ideMode.showInDialog).toBe(true); - expect(SETTINGS_SCHEMA.disableAutoUpdate.showInDialog).toBe(true); - expect(SETTINGS_SCHEMA.hideWindowTitle.showInDialog).toBe(true); - expect(SETTINGS_SCHEMA.hideTips.showInDialog).toBe(true); - expect(SETTINGS_SCHEMA.hideBanner.showInDialog).toBe(true); - expect(SETTINGS_SCHEMA.usageStatisticsEnabled.showInDialog).toBe(false); + expect(SETTINGS_SCHEMA.ui.properties.showMemoryUsage.showInDialog).toBe( + true, + ); + expect(SETTINGS_SCHEMA.general.properties.vimMode.showInDialog).toBe( + true, + ); + expect(SETTINGS_SCHEMA.ide.properties.enabled.showInDialog).toBe(true); + expect( + SETTINGS_SCHEMA.general.properties.disableAutoUpdate.showInDialog, + ).toBe(true); + expect(SETTINGS_SCHEMA.ui.properties.hideWindowTitle.showInDialog).toBe( + true, + ); + expect(SETTINGS_SCHEMA.ui.properties.hideTips.showInDialog).toBe(true); + expect(SETTINGS_SCHEMA.ui.properties.hideBanner.showInDialog).toBe(true); + expect( + SETTINGS_SCHEMA.privacy.properties.usageStatisticsEnabled.showInDialog, + ).toBe(false); // Check that advanced settings are hidden from dialog - expect(SETTINGS_SCHEMA.selectedAuthType.showInDialog).toBe(false); - expect(SETTINGS_SCHEMA.coreTools.showInDialog).toBe(false); + expect(SETTINGS_SCHEMA.security.properties.auth.showInDialog).toBe(false); + expect(SETTINGS_SCHEMA.tools.properties.core.showInDialog).toBe(false); expect(SETTINGS_SCHEMA.mcpServers.showInDialog).toBe(false); expect(SETTINGS_SCHEMA.telemetry.showInDialog).toBe(false); // Check that some settings are appropriately hidden - expect(SETTINGS_SCHEMA.theme.showInDialog).toBe(false); // Changed to false - expect(SETTINGS_SCHEMA.customThemes.showInDialog).toBe(false); // Managed via theme editor - expect(SETTINGS_SCHEMA.checkpointing.showInDialog).toBe(false); // Experimental feature - expect(SETTINGS_SCHEMA.accessibility.showInDialog).toBe(false); // Changed to false - expect(SETTINGS_SCHEMA.fileFiltering.showInDialog).toBe(false); // Changed to false - expect(SETTINGS_SCHEMA.preferredEditor.showInDialog).toBe(false); // Changed to false - expect(SETTINGS_SCHEMA.autoConfigureMaxOldSpaceSize.showInDialog).toBe( - true, - ); + expect(SETTINGS_SCHEMA.ui.properties.theme.showInDialog).toBe(false); // Changed to false + expect(SETTINGS_SCHEMA.ui.properties.customThemes.showInDialog).toBe( + false, + ); // Managed via theme editor + expect( + SETTINGS_SCHEMA.general.properties.checkpointing.showInDialog, + ).toBe(false); // Experimental feature + expect(SETTINGS_SCHEMA.ui.properties.accessibility.showInDialog).toBe( + false, + ); // Changed to false + expect( + SETTINGS_SCHEMA.context.properties.fileFiltering.showInDialog, + ).toBe(false); // Changed to false + expect( + SETTINGS_SCHEMA.general.properties.preferredEditor.showInDialog, + ).toBe(false); // Changed to false + expect( + SETTINGS_SCHEMA.advanced.properties.autoConfigureMemory.showInDialog, + ).toBe(false); }); it('should infer Settings type correctly', () => { // This test ensures that the Settings type is properly inferred from the schema const settings: Settings = { - theme: 'dark', - includeDirectories: ['/path/to/dir'], - loadMemoryFromIncludeDirectories: true, + ui: { + theme: 'dark', + }, + context: { + includeDirectories: ['/path/to/dir'], + loadMemoryFromIncludeDirectories: true, + }, }; // TypeScript should not complain about these properties - expect(settings.theme).toBe('dark'); - expect(settings.includeDirectories).toEqual(['/path/to/dir']); - expect(settings.loadMemoryFromIncludeDirectories).toBe(true); + expect(settings.ui?.theme).toBe('dark'); + expect(settings.context?.includeDirectories).toEqual(['/path/to/dir']); + expect(settings.context?.loadMemoryFromIncludeDirectories).toBe(true); }); it('should have includeDirectories setting in schema', () => { - expect(SETTINGS_SCHEMA.includeDirectories).toBeDefined(); - expect(SETTINGS_SCHEMA.includeDirectories.type).toBe('array'); - expect(SETTINGS_SCHEMA.includeDirectories.category).toBe('General'); - expect(SETTINGS_SCHEMA.includeDirectories.default).toEqual([]); + expect( + SETTINGS_SCHEMA.context?.properties.includeDirectories, + ).toBeDefined(); + expect(SETTINGS_SCHEMA.context?.properties.includeDirectories.type).toBe( + 'array', + ); + expect( + SETTINGS_SCHEMA.context?.properties.includeDirectories.category, + ).toBe('Context'); + expect( + SETTINGS_SCHEMA.context?.properties.includeDirectories.default, + ).toEqual([]); }); it('should have loadMemoryFromIncludeDirectories setting in schema', () => { - expect(SETTINGS_SCHEMA.loadMemoryFromIncludeDirectories).toBeDefined(); - expect(SETTINGS_SCHEMA.loadMemoryFromIncludeDirectories.type).toBe( - 'boolean', - ); - expect(SETTINGS_SCHEMA.loadMemoryFromIncludeDirectories.category).toBe( - 'General', - ); - expect(SETTINGS_SCHEMA.loadMemoryFromIncludeDirectories.default).toBe( - false, - ); + expect( + SETTINGS_SCHEMA.context?.properties.loadMemoryFromIncludeDirectories, + ).toBeDefined(); + expect( + SETTINGS_SCHEMA.context?.properties.loadMemoryFromIncludeDirectories + .type, + ).toBe('boolean'); + expect( + SETTINGS_SCHEMA.context?.properties.loadMemoryFromIncludeDirectories + .category, + ).toBe('Context'); + expect( + SETTINGS_SCHEMA.context?.properties.loadMemoryFromIncludeDirectories + .default, + ).toBe(false); }); it('should have folderTrustFeature setting in schema', () => { - expect(SETTINGS_SCHEMA.folderTrustFeature).toBeDefined(); - expect(SETTINGS_SCHEMA.folderTrustFeature.type).toBe('boolean'); - expect(SETTINGS_SCHEMA.folderTrustFeature.category).toBe('General'); - expect(SETTINGS_SCHEMA.folderTrustFeature.default).toBe(false); - expect(SETTINGS_SCHEMA.folderTrustFeature.showInDialog).toBe(true); + expect( + SETTINGS_SCHEMA.security.properties.folderTrust.properties.enabled, + ).toBeDefined(); + expect( + SETTINGS_SCHEMA.security.properties.folderTrust.properties.enabled.type, + ).toBe('boolean'); + expect( + SETTINGS_SCHEMA.security.properties.folderTrust.properties.enabled + .category, + ).toBe('Security'); + expect( + SETTINGS_SCHEMA.security.properties.folderTrust.properties.enabled + .default, + ).toBe(false); + expect( + SETTINGS_SCHEMA.security.properties.folderTrust.properties.enabled + .showInDialog, + ).toBe(true); + }); + + it('should have debugKeystrokeLogging setting in schema', () => { + expect( + SETTINGS_SCHEMA.general.properties.debugKeystrokeLogging, + ).toBeDefined(); + expect( + SETTINGS_SCHEMA.general.properties.debugKeystrokeLogging.type, + ).toBe('boolean'); + expect( + SETTINGS_SCHEMA.general.properties.debugKeystrokeLogging.category, + ).toBe('General'); + expect( + SETTINGS_SCHEMA.general.properties.debugKeystrokeLogging.default, + ).toBe(false); + expect( + SETTINGS_SCHEMA.general.properties.debugKeystrokeLogging + .requiresRestart, + ).toBe(false); + expect( + SETTINGS_SCHEMA.general.properties.debugKeystrokeLogging.showInDialog, + ).toBe(true); + expect( + SETTINGS_SCHEMA.general.properties.debugKeystrokeLogging.description, + ).toBe('Enable debug logging of keystrokes to the console.'); }); }); }); diff --git a/packages/cli/src/config/settingsSchema.ts b/packages/cli/src/config/settingsSchema.ts index 664820bd..1cbd63e0 100644 --- a/packages/cli/src/config/settingsSchema.ts +++ b/packages/cli/src/config/settingsSchema.ts @@ -4,14 +4,14 @@ * SPDX-License-Identifier: Apache-2.0 */ -import { +import type { MCPServerConfig, BugCommandSettings, TelemetrySettings, AuthType, ChatCompressionSettings, } from '@qwen-code/qwen-code-core'; -import { CustomTheme } from '../ui/themes/theme.js'; +import type { CustomTheme } from '../ui/themes/theme.js'; export interface SettingDefinition { type: 'boolean' | 'string' | 'number' | 'array' | 'object'; @@ -40,327 +40,7 @@ export type DnsResolutionOrder = 'ipv4first' | 'verbatim'; * `as const` is crucial for TypeScript to infer the most specific types possible. */ export const SETTINGS_SCHEMA = { - // UI Settings - theme: { - type: 'string', - label: 'Theme', - category: 'UI', - requiresRestart: false, - default: undefined as string | undefined, - description: 'The color theme for the UI.', - showInDialog: false, - }, - customThemes: { - type: 'object', - label: 'Custom Themes', - category: 'UI', - requiresRestart: false, - default: {} as Record, - description: 'Custom theme definitions.', - showInDialog: false, - }, - hideWindowTitle: { - type: 'boolean', - label: 'Hide Window Title', - category: 'UI', - requiresRestart: true, - default: false, - description: 'Hide the window title bar', - showInDialog: true, - }, - hideTips: { - type: 'boolean', - label: 'Hide Tips', - category: 'UI', - requiresRestart: false, - default: false, - description: 'Hide helpful tips in the UI', - showInDialog: true, - }, - hideBanner: { - type: 'boolean', - label: 'Hide Banner', - category: 'UI', - requiresRestart: false, - default: false, - description: 'Hide the application banner', - showInDialog: true, - }, - hideFooter: { - type: 'boolean', - label: 'Hide Footer', - category: 'UI', - requiresRestart: false, - default: false, - description: 'Hide the footer from the UI', - showInDialog: true, - }, - showMemoryUsage: { - type: 'boolean', - label: 'Show Memory Usage', - category: 'UI', - requiresRestart: false, - default: false, - description: 'Display memory usage information in the UI', - showInDialog: true, - }, - - usageStatisticsEnabled: { - type: 'boolean', - label: 'Enable Usage Statistics', - category: 'General', - requiresRestart: true, - default: true, - description: 'Enable collection of usage statistics', - showInDialog: false, // All details are shown in /privacy and dependent on auth type - }, - autoConfigureMaxOldSpaceSize: { - type: 'boolean', - label: 'Auto Configure Max Old Space Size', - category: 'General', - requiresRestart: true, - default: false, - description: 'Automatically configure Node.js memory limits', - showInDialog: true, - }, - preferredEditor: { - type: 'string', - label: 'Preferred Editor', - category: 'General', - requiresRestart: false, - default: undefined as string | undefined, - description: 'The preferred editor to open files in.', - showInDialog: false, - }, - maxSessionTurns: { - type: 'number', - label: 'Max Session Turns', - category: 'General', - requiresRestart: false, - default: -1, - description: - 'Maximum number of user/model/tool turns to keep in a session. -1 means unlimited.', - showInDialog: true, - }, - memoryImportFormat: { - type: 'string', - label: 'Memory Import Format', - category: 'General', - requiresRestart: false, - default: undefined as MemoryImportFormat | undefined, - description: 'The format to use when importing memory.', - showInDialog: false, - }, - memoryDiscoveryMaxDirs: { - type: 'number', - label: 'Memory Discovery Max Dirs', - category: 'General', - requiresRestart: false, - default: 200, - description: 'Maximum number of directories to search for memory.', - showInDialog: true, - }, - contextFileName: { - type: 'object', - label: 'Context File Name', - category: 'General', - requiresRestart: false, - default: undefined as string | string[] | undefined, - description: 'The name of the context file.', - showInDialog: false, - }, - vimMode: { - type: 'boolean', - label: 'Vim Mode', - category: 'Mode', - requiresRestart: false, - default: false, - description: 'Enable Vim keybindings', - showInDialog: true, - }, - ideMode: { - type: 'boolean', - label: 'IDE Mode', - category: 'Mode', - requiresRestart: true, - default: false, - description: 'Enable IDE integration mode', - showInDialog: true, - }, - - accessibility: { - type: 'object', - label: 'Accessibility', - category: 'Accessibility', - requiresRestart: true, - default: {}, - description: 'Accessibility settings.', - showInDialog: false, - properties: { - disableLoadingPhrases: { - type: 'boolean', - label: 'Disable Loading Phrases', - category: 'Accessibility', - requiresRestart: true, - default: false, - description: 'Disable loading phrases for accessibility', - showInDialog: true, - }, - }, - }, - checkpointing: { - type: 'object', - label: 'Checkpointing', - category: 'Checkpointing', - requiresRestart: true, - default: {}, - description: 'Session checkpointing settings.', - showInDialog: false, - properties: { - enabled: { - type: 'boolean', - label: 'Enable Checkpointing', - category: 'Checkpointing', - requiresRestart: true, - default: false, - description: 'Enable session checkpointing for recovery', - showInDialog: false, - }, - }, - }, - fileFiltering: { - type: 'object', - label: 'File Filtering', - category: 'File Filtering', - requiresRestart: true, - default: {}, - description: 'Settings for git-aware file filtering.', - showInDialog: false, - properties: { - respectGitIgnore: { - type: 'boolean', - label: 'Respect .gitignore', - category: 'File Filtering', - requiresRestart: true, - default: true, - description: 'Respect .gitignore files when searching', - showInDialog: true, - }, - respectGeminiIgnore: { - type: 'boolean', - label: 'Respect .geminiignore', - category: 'File Filtering', - requiresRestart: true, - default: true, - description: 'Respect .geminiignore files when searching', - showInDialog: true, - }, - enableRecursiveFileSearch: { - type: 'boolean', - label: 'Enable Recursive File Search', - category: 'File Filtering', - requiresRestart: true, - default: true, - description: 'Enable recursive file search functionality', - showInDialog: true, - }, - }, - }, - - disableAutoUpdate: { - type: 'boolean', - label: 'Disable Auto Update', - category: 'Updates', - requiresRestart: false, - default: false, - description: 'Disable automatic updates', - showInDialog: true, - }, - - shouldUseNodePtyShell: { - type: 'boolean', - label: 'Use node-pty for Shell Execution', - category: 'Shell', - requiresRestart: true, - default: false, - description: - 'Use node-pty for shell command execution. Fallback to child_process still applies.', - showInDialog: true, - }, - - selectedAuthType: { - type: 'string', - label: 'Selected Auth Type', - category: 'Advanced', - requiresRestart: true, - default: undefined as AuthType | undefined, - description: 'The currently selected authentication type.', - showInDialog: false, - }, - useExternalAuth: { - type: 'boolean', - label: 'Use External Auth', - category: 'Advanced', - requiresRestart: true, - default: undefined as boolean | undefined, - description: 'Whether to use an external authentication flow.', - showInDialog: false, - }, - sandbox: { - type: 'object', - label: 'Sandbox', - category: 'Advanced', - requiresRestart: true, - default: undefined as boolean | string | undefined, - description: - 'Sandbox execution environment (can be a boolean or a path string).', - showInDialog: false, - }, - coreTools: { - type: 'array', - label: 'Core Tools', - category: 'Advanced', - requiresRestart: true, - default: undefined as string[] | undefined, - description: 'Paths to core tool definitions.', - showInDialog: false, - }, - excludeTools: { - type: 'array', - label: 'Exclude Tools', - category: 'Advanced', - requiresRestart: true, - default: undefined as string[] | undefined, - description: 'Tool names to exclude from discovery.', - showInDialog: false, - }, - toolDiscoveryCommand: { - type: 'string', - label: 'Tool Discovery Command', - category: 'Advanced', - requiresRestart: true, - default: undefined as string | undefined, - description: 'Command to run for tool discovery.', - showInDialog: false, - }, - toolCallCommand: { - type: 'string', - label: 'Tool Call Command', - category: 'Advanced', - requiresRestart: true, - default: undefined as string | undefined, - description: 'Command to run for tool calls.', - showInDialog: false, - }, - mcpServerCommand: { - type: 'string', - label: 'MCP Server Command', - category: 'Advanced', - requiresRestart: true, - default: undefined as string | undefined, - description: 'Command to start an MCP server.', - showInDialog: false, - }, + // Maintained for compatibility/criticality mcpServers: { type: 'object', label: 'MCP Servers', @@ -370,24 +50,259 @@ export const SETTINGS_SCHEMA = { description: 'Configuration for MCP servers.', showInDialog: false, }, - allowMCPServers: { - type: 'array', - label: 'Allow MCP Servers', - category: 'Advanced', - requiresRestart: true, - default: undefined as string[] | undefined, - description: 'A whitelist of MCP servers to allow.', + + general: { + type: 'object', + label: 'General', + category: 'General', + requiresRestart: false, + default: {}, + description: 'General application settings.', showInDialog: false, + properties: { + preferredEditor: { + type: 'string', + label: 'Preferred Editor', + category: 'General', + requiresRestart: false, + default: undefined as string | undefined, + description: 'The preferred editor to open files in.', + showInDialog: false, + }, + vimMode: { + type: 'boolean', + label: 'Vim Mode', + category: 'General', + requiresRestart: false, + default: false, + description: 'Enable Vim keybindings', + showInDialog: true, + }, + disableAutoUpdate: { + type: 'boolean', + label: 'Disable Auto Update', + category: 'General', + requiresRestart: false, + default: false, + description: 'Disable automatic updates', + showInDialog: true, + }, + disableUpdateNag: { + type: 'boolean', + label: 'Disable Update Nag', + category: 'General', + requiresRestart: false, + default: false, + description: 'Disable update notification prompts.', + showInDialog: false, + }, + checkpointing: { + type: 'object', + label: 'Checkpointing', + category: 'General', + requiresRestart: true, + default: {}, + description: 'Session checkpointing settings.', + showInDialog: false, + properties: { + enabled: { + type: 'boolean', + label: 'Enable Checkpointing', + category: 'General', + requiresRestart: true, + default: false, + description: 'Enable session checkpointing for recovery', + showInDialog: false, + }, + }, + }, + enablePromptCompletion: { + type: 'boolean', + label: 'Enable Prompt Completion', + category: 'General', + requiresRestart: true, + default: false, + description: + 'Enable AI-powered prompt completion suggestions while typing.', + showInDialog: true, + }, + debugKeystrokeLogging: { + type: 'boolean', + label: 'Debug Keystroke Logging', + category: 'General', + requiresRestart: false, + default: false, + description: 'Enable debug logging of keystrokes to the console.', + showInDialog: true, + }, + }, }, - excludeMCPServers: { - type: 'array', - label: 'Exclude MCP Servers', - category: 'Advanced', - requiresRestart: true, - default: undefined as string[] | undefined, - description: 'A blacklist of MCP servers to exclude.', + + ui: { + type: 'object', + label: 'UI', + category: 'UI', + requiresRestart: false, + default: {}, + description: 'User interface settings.', showInDialog: false, + properties: { + theme: { + type: 'string', + label: 'Theme', + category: 'UI', + requiresRestart: false, + default: undefined as string | undefined, + description: 'The color theme for the UI.', + showInDialog: false, + }, + customThemes: { + type: 'object', + label: 'Custom Themes', + category: 'UI', + requiresRestart: false, + default: {} as Record, + description: 'Custom theme definitions.', + showInDialog: false, + }, + hideWindowTitle: { + type: 'boolean', + label: 'Hide Window Title', + category: 'UI', + requiresRestart: true, + default: false, + description: 'Hide the window title bar', + showInDialog: true, + }, + hideTips: { + type: 'boolean', + label: 'Hide Tips', + category: 'UI', + requiresRestart: false, + default: false, + description: 'Hide helpful tips in the UI', + showInDialog: true, + }, + hideBanner: { + type: 'boolean', + label: 'Hide Banner', + category: 'UI', + requiresRestart: false, + default: false, + description: 'Hide the application banner', + showInDialog: true, + }, + hideFooter: { + type: 'boolean', + label: 'Hide Footer', + category: 'UI', + requiresRestart: false, + default: false, + description: 'Hide the footer from the UI', + showInDialog: true, + }, + showMemoryUsage: { + type: 'boolean', + label: 'Show Memory Usage', + category: 'UI', + requiresRestart: false, + default: false, + description: 'Display memory usage information in the UI', + showInDialog: true, + }, + showLineNumbers: { + type: 'boolean', + label: 'Show Line Numbers', + category: 'UI', + requiresRestart: false, + default: false, + description: 'Show line numbers in the chat.', + showInDialog: true, + }, + accessibility: { + type: 'object', + label: 'Accessibility', + category: 'UI', + requiresRestart: true, + default: {}, + description: 'Accessibility settings.', + showInDialog: false, + properties: { + disableLoadingPhrases: { + type: 'boolean', + label: 'Disable Loading Phrases', + category: 'UI', + requiresRestart: true, + default: false, + description: 'Disable loading phrases for accessibility', + showInDialog: true, + }, + screenReader: { + type: 'boolean', + label: 'Screen Reader Mode', + category: 'UI', + requiresRestart: true, + default: undefined as boolean | undefined, + description: + 'Render output in plain-text to be more screen reader accessible', + showInDialog: true, + }, + }, + }, + }, }, + + ide: { + type: 'object', + label: 'IDE', + category: 'IDE', + requiresRestart: true, + default: {}, + description: 'IDE integration settings.', + showInDialog: false, + properties: { + enabled: { + type: 'boolean', + label: 'IDE Mode', + category: 'IDE', + requiresRestart: true, + default: false, + description: 'Enable IDE integration mode', + showInDialog: true, + }, + hasSeenNudge: { + type: 'boolean', + label: 'Has Seen IDE Integration Nudge', + category: 'IDE', + requiresRestart: false, + default: false, + description: 'Whether the user has seen the IDE integration nudge.', + showInDialog: false, + }, + }, + }, + + privacy: { + type: 'object', + label: 'Privacy', + category: 'Privacy', + requiresRestart: true, + default: {}, + description: 'Privacy-related settings.', + showInDialog: false, + properties: { + usageStatisticsEnabled: { + type: 'boolean', + label: 'Enable Usage Statistics', + category: 'Privacy', + requiresRestart: true, + default: true, + description: 'Enable collection of usage statistics', + showInDialog: false, + }, + }, + }, + telemetry: { type: 'object', label: 'Telemetry', @@ -397,123 +312,467 @@ export const SETTINGS_SCHEMA = { description: 'Telemetry configuration.', showInDialog: false, }, - bugCommand: { + + model: { type: 'object', - label: 'Bug Command', - category: 'Advanced', + label: 'Model', + category: 'Model', requiresRestart: false, - default: undefined as BugCommandSettings | undefined, - description: 'Configuration for the bug report command.', - showInDialog: false, - }, - summarizeToolOutput: { - type: 'object', - label: 'Summarize Tool Output', - category: 'Advanced', - requiresRestart: false, - default: undefined as Record | undefined, - description: 'Settings for summarizing tool output.', + default: {}, + description: 'Settings related to the generative model.', showInDialog: false, + properties: { + name: { + type: 'string', + label: 'Model', + category: 'Model', + requiresRestart: false, + default: undefined as string | undefined, + description: 'The Gemini model to use for conversations.', + showInDialog: false, + }, + maxSessionTurns: { + type: 'number', + label: 'Max Session Turns', + category: 'Model', + requiresRestart: false, + default: -1, + description: + 'Maximum number of user/model/tool turns to keep in a session. -1 means unlimited.', + showInDialog: true, + }, + summarizeToolOutput: { + type: 'object', + label: 'Summarize Tool Output', + category: 'Model', + requiresRestart: false, + default: undefined as + | Record + | undefined, + description: 'Settings for summarizing tool output.', + showInDialog: false, + }, + chatCompression: { + type: 'object', + label: 'Chat Compression', + category: 'Model', + requiresRestart: false, + default: undefined as ChatCompressionSettings | undefined, + description: 'Chat compression settings.', + showInDialog: false, + }, + skipNextSpeakerCheck: { + type: 'boolean', + label: 'Skip Next Speaker Check', + category: 'Model', + requiresRestart: false, + default: false, + description: 'Skip the next speaker check.', + showInDialog: true, + }, + }, }, - dnsResolutionOrder: { - type: 'string', - label: 'DNS Resolution Order', + context: { + type: 'object', + label: 'Context', + category: 'Context', + requiresRestart: false, + default: {}, + description: 'Settings for managing context provided to the model.', + showInDialog: false, + properties: { + fileName: { + type: 'object', + label: 'Context File Name', + category: 'Context', + requiresRestart: false, + default: undefined as string | string[] | undefined, + description: 'The name of the context file.', + showInDialog: false, + }, + importFormat: { + type: 'string', + label: 'Memory Import Format', + category: 'Context', + requiresRestart: false, + default: undefined as MemoryImportFormat | undefined, + description: 'The format to use when importing memory.', + showInDialog: false, + }, + discoveryMaxDirs: { + type: 'number', + label: 'Memory Discovery Max Dirs', + category: 'Context', + requiresRestart: false, + default: 200, + description: 'Maximum number of directories to search for memory.', + showInDialog: true, + }, + includeDirectories: { + type: 'array', + label: 'Include Directories', + category: 'Context', + requiresRestart: false, + default: [] as string[], + description: + 'Additional directories to include in the workspace context. Missing directories will be skipped with a warning.', + showInDialog: false, + }, + loadMemoryFromIncludeDirectories: { + type: 'boolean', + label: 'Load Memory From Include Directories', + category: 'Context', + requiresRestart: false, + default: false, + description: 'Whether to load memory files from include directories.', + showInDialog: true, + }, + fileFiltering: { + type: 'object', + label: 'File Filtering', + category: 'Context', + requiresRestart: true, + default: {}, + description: 'Settings for git-aware file filtering.', + showInDialog: false, + properties: { + respectGitIgnore: { + type: 'boolean', + label: 'Respect .gitignore', + category: 'Context', + requiresRestart: true, + default: true, + description: 'Respect .gitignore files when searching', + showInDialog: true, + }, + respectGeminiIgnore: { + type: 'boolean', + label: 'Respect .qwenignore', + category: 'Context', + requiresRestart: true, + default: true, + description: 'Respect .qwenignore files when searching', + showInDialog: true, + }, + enableRecursiveFileSearch: { + type: 'boolean', + label: 'Enable Recursive File Search', + category: 'Context', + requiresRestart: true, + default: true, + description: 'Enable recursive file search functionality', + showInDialog: true, + }, + disableFuzzySearch: { + type: 'boolean', + label: 'Disable Fuzzy Search', + category: 'Context', + requiresRestart: true, + default: false, + description: 'Disable fuzzy search when searching for files.', + showInDialog: true, + }, + }, + }, + }, + }, + + tools: { + type: 'object', + label: 'Tools', + category: 'Tools', + requiresRestart: true, + default: {}, + description: 'Settings for built-in and custom tools.', + showInDialog: false, + properties: { + sandbox: { + type: 'object', + label: 'Sandbox', + category: 'Tools', + requiresRestart: true, + default: undefined as boolean | string | undefined, + description: + 'Sandbox execution environment (can be a boolean or a path string).', + showInDialog: false, + }, + usePty: { + type: 'boolean', + label: 'Use node-pty for Shell Execution', + category: 'Tools', + requiresRestart: true, + default: false, + description: + 'Use node-pty for shell command execution. Fallback to child_process still applies.', + showInDialog: true, + }, + core: { + type: 'array', + label: 'Core Tools', + category: 'Tools', + requiresRestart: true, + default: undefined as string[] | undefined, + description: 'Paths to core tool definitions.', + showInDialog: false, + }, + allowed: { + type: 'array', + label: 'Allowed Tools', + category: 'Advanced', + requiresRestart: true, + default: undefined as string[] | undefined, + description: + 'A list of tool names that will bypass the confirmation dialog.', + showInDialog: false, + }, + exclude: { + type: 'array', + label: 'Exclude Tools', + category: 'Tools', + requiresRestart: true, + default: undefined as string[] | undefined, + description: 'Tool names to exclude from discovery.', + showInDialog: false, + }, + discoveryCommand: { + type: 'string', + label: 'Tool Discovery Command', + category: 'Tools', + requiresRestart: true, + default: undefined as string | undefined, + description: 'Command to run for tool discovery.', + showInDialog: false, + }, + callCommand: { + type: 'string', + label: 'Tool Call Command', + category: 'Tools', + requiresRestart: true, + default: undefined as string | undefined, + description: 'Command to run for tool calls.', + showInDialog: false, + }, + useRipgrep: { + type: 'boolean', + label: 'Use Ripgrep', + category: 'Tools', + requiresRestart: false, + default: false, + description: + 'Use ripgrep for file content search instead of the fallback implementation. Provides faster search performance.', + showInDialog: true, + }, + }, + }, + + mcp: { + type: 'object', + label: 'MCP', + category: 'MCP', + requiresRestart: true, + default: {}, + description: 'Settings for Model Context Protocol (MCP) servers.', + showInDialog: false, + properties: { + serverCommand: { + type: 'string', + label: 'MCP Server Command', + category: 'MCP', + requiresRestart: true, + default: undefined as string | undefined, + description: 'Command to start an MCP server.', + showInDialog: false, + }, + allowed: { + type: 'array', + label: 'Allow MCP Servers', + category: 'MCP', + requiresRestart: true, + default: undefined as string[] | undefined, + description: 'A whitelist of MCP servers to allow.', + showInDialog: false, + }, + excluded: { + type: 'array', + label: 'Exclude MCP Servers', + category: 'MCP', + requiresRestart: true, + default: undefined as string[] | undefined, + description: 'A blacklist of MCP servers to exclude.', + showInDialog: false, + }, + }, + }, + + security: { + type: 'object', + label: 'Security', + category: 'Security', + requiresRestart: true, + default: {}, + description: 'Security-related settings.', + showInDialog: false, + properties: { + folderTrust: { + type: 'object', + label: 'Folder Trust', + category: 'Security', + requiresRestart: false, + default: {}, + description: 'Settings for folder trust.', + showInDialog: false, + properties: { + featureEnabled: { + type: 'boolean', + label: 'Folder Trust Feature', + category: 'Security', + requiresRestart: false, + default: false, + description: 'Enable folder trust feature for enhanced security.', + showInDialog: true, + }, + enabled: { + type: 'boolean', + label: 'Folder Trust', + category: 'Security', + requiresRestart: false, + default: false, + description: 'Setting to track whether Folder trust is enabled.', + showInDialog: true, + }, + }, + }, + auth: { + type: 'object', + label: 'Authentication', + category: 'Security', + requiresRestart: true, + default: {}, + description: 'Authentication settings.', + showInDialog: false, + properties: { + selectedType: { + type: 'string', + label: 'Selected Auth Type', + category: 'Security', + requiresRestart: true, + default: undefined as AuthType | undefined, + description: 'The currently selected authentication type.', + showInDialog: false, + }, + useExternal: { + type: 'boolean', + label: 'Use External Auth', + category: 'Security', + requiresRestart: true, + default: undefined as boolean | undefined, + description: 'Whether to use an external authentication flow.', + showInDialog: false, + }, + }, + }, + }, + }, + + advanced: { + type: 'object', + label: 'Advanced', category: 'Advanced', requiresRestart: true, - default: undefined as DnsResolutionOrder | undefined, - description: 'The DNS resolution order.', + default: {}, + description: 'Advanced settings for power users.', showInDialog: false, + properties: { + autoConfigureMemory: { + type: 'boolean', + label: 'Auto Configure Max Old Space Size', + category: 'Advanced', + requiresRestart: true, + default: false, + description: 'Automatically configure Node.js memory limits', + showInDialog: false, + }, + dnsResolutionOrder: { + type: 'string', + label: 'DNS Resolution Order', + category: 'Advanced', + requiresRestart: true, + default: undefined as DnsResolutionOrder | undefined, + description: 'The DNS resolution order.', + showInDialog: false, + }, + excludedEnvVars: { + type: 'array', + label: 'Excluded Project Environment Variables', + category: 'Advanced', + requiresRestart: false, + default: ['DEBUG', 'DEBUG_MODE'] as string[], + description: 'Environment variables to exclude from project context.', + showInDialog: false, + }, + bugCommand: { + type: 'object', + label: 'Bug Command', + category: 'Advanced', + requiresRestart: false, + default: undefined as BugCommandSettings | undefined, + description: 'Configuration for the bug report command.', + showInDialog: false, + }, + }, }, - excludedProjectEnvVars: { - type: 'array', - label: 'Excluded Project Environment Variables', - category: 'Advanced', - requiresRestart: false, - default: ['DEBUG', 'DEBUG_MODE'] as string[], - description: 'Environment variables to exclude from project context.', - showInDialog: false, - }, - disableUpdateNag: { - type: 'boolean', - label: 'Disable Update Nag', - category: 'Updates', - requiresRestart: false, - default: false, - description: 'Disable update notification prompts.', - showInDialog: false, - }, - includeDirectories: { - type: 'array', - label: 'Include Directories', - category: 'General', - requiresRestart: false, - default: [] as string[], - description: 'Additional directories to include in the workspace context.', - showInDialog: false, - }, - loadMemoryFromIncludeDirectories: { - type: 'boolean', - label: 'Load Memory From Include Directories', - category: 'General', - requiresRestart: false, - default: false, - description: 'Whether to load memory files from include directories.', - showInDialog: true, - }, - model: { - type: 'string', - label: 'Model', - category: 'General', - requiresRestart: false, - default: undefined as string | undefined, - description: 'The Gemini model to use for conversations.', - showInDialog: false, - }, - hasSeenIdeIntegrationNudge: { - type: 'boolean', - label: 'Has Seen IDE Integration Nudge', - category: 'General', - requiresRestart: false, - default: false, - description: 'Whether the user has seen the IDE integration nudge.', - showInDialog: false, - }, - folderTrustFeature: { - type: 'boolean', - label: 'Folder Trust Feature', - category: 'General', - requiresRestart: false, - default: false, - description: 'Enable folder trust feature for enhanced security.', - showInDialog: true, - }, - folderTrust: { - type: 'boolean', - label: 'Folder Trust', - category: 'General', - requiresRestart: false, - default: false, - description: 'Setting to track whether Folder trust is enabled.', - showInDialog: true, - }, - chatCompression: { + + experimental: { type: 'object', - label: 'Chat Compression', - category: 'General', - requiresRestart: false, - default: undefined as ChatCompressionSettings | undefined, - description: 'Chat compression settings.', + label: 'Experimental', + category: 'Experimental', + requiresRestart: true, + default: {}, + description: 'Setting to enable experimental features', showInDialog: false, + properties: { + extensionManagement: { + type: 'boolean', + label: 'Extension Management', + category: 'Experimental', + requiresRestart: true, + default: false, + description: 'Enable extension management features.', + showInDialog: false, + }, + }, }, - showLineNumbers: { - type: 'boolean', - label: 'Show Line Numbers', - category: 'General', - requiresRestart: false, - default: false, - description: 'Show line numbers in the chat.', - showInDialog: true, + + extensions: { + type: 'object', + label: 'Extensions', + category: 'Extensions', + requiresRestart: true, + default: {}, + description: 'Settings for extensions.', + showInDialog: false, + properties: { + disabled: { + type: 'array', + label: 'Disabled Extensions', + category: 'Extensions', + requiresRestart: true, + default: [] as string[], + description: 'List of disabled extensions.', + showInDialog: false, + }, + workspacesWithMigrationNudge: { + type: 'array', + label: 'Workspaces with Migration Nudge', + category: 'Extensions', + requiresRestart: false, + default: [] as string[], + description: + 'List of workspaces for which the migration nudge has been shown.', + showInDialog: false, + }, + }, }, contentGenerator: { type: 'object', @@ -604,6 +863,15 @@ export const SETTINGS_SCHEMA = { description: 'Skip the next speaker check.', showInDialog: true, }, + skipLoopDetection: { + type: 'boolean', + label: 'Skip Loop Detection', + category: 'General', + requiresRestart: false, + default: false, + description: 'Disable all loop detection checks (streaming and LLM).', + showInDialog: true, + }, enableWelcomeBack: { type: 'boolean', label: 'Enable Welcome Back', diff --git a/packages/cli/src/config/trustedFolders.test.ts b/packages/cli/src/config/trustedFolders.test.ts index 5f613e63..b6583a83 100644 --- a/packages/cli/src/config/trustedFolders.test.ts +++ b/packages/cli/src/config/trustedFolders.test.ts @@ -5,7 +5,7 @@ */ // Mock 'os' first. -import * as osActual from 'os'; +import * as osActual from 'node:os'; vi.mock('os', async (importOriginal) => { const actualOs = await importOriginal(); return { @@ -25,9 +25,9 @@ import { type Mocked, type Mock, } from 'vitest'; -import * as fs from 'fs'; +import * as fs from 'node:fs'; import stripJsonComments from 'strip-json-comments'; -import * as path from 'path'; +import * as path from 'node:path'; import { loadTrustedFolders, @@ -35,7 +35,7 @@ import { TrustLevel, isWorkspaceTrusted, } from './trustedFolders.js'; -import { Settings } from './settings.js'; +import type { Settings } from './settings.js'; vi.mock('fs', async (importOriginal) => { const actualFs = await importOriginal(); @@ -132,8 +132,12 @@ describe('isWorkspaceTrusted', () => { let mockCwd: string; const mockRules: Record = {}; const mockSettings: Settings = { - folderTrustFeature: true, - folderTrust: true, + security: { + folderTrust: { + featureEnabled: true, + enabled: true, + }, + }, }; beforeEach(() => { diff --git a/packages/cli/src/config/trustedFolders.ts b/packages/cli/src/config/trustedFolders.ts index 2f105984..fe394d39 100644 --- a/packages/cli/src/config/trustedFolders.ts +++ b/packages/cli/src/config/trustedFolders.ts @@ -4,11 +4,11 @@ * SPDX-License-Identifier: Apache-2.0 */ -import * as fs from 'fs'; -import * as path from 'path'; -import { homedir } from 'os'; +import * as fs from 'node:fs'; +import * as path from 'node:path'; +import { homedir } from 'node:os'; import { getErrorMessage, isWithinRoot } from '@qwen-code/qwen-code-core'; -import { Settings } from './settings.js'; +import type { Settings } from './settings.js'; import stripJsonComments from 'strip-json-comments'; export const TRUSTED_FOLDERS_FILENAME = 'trustedFolders.json'; @@ -111,8 +111,9 @@ export function saveTrustedFolders( } export function isWorkspaceTrusted(settings: Settings): boolean | undefined { - const folderTrustFeature = settings.folderTrustFeature ?? false; - const folderTrustSetting = settings.folderTrust ?? true; + const folderTrustFeature = + settings.security?.folderTrust?.featureEnabled ?? false; + const folderTrustSetting = settings.security?.folderTrust?.enabled ?? true; const folderTrustEnabled = folderTrustFeature && folderTrustSetting; if (!folderTrustEnabled) { diff --git a/packages/cli/src/gemini.test.tsx b/packages/cli/src/gemini.test.tsx index c4de8308..979a367f 100644 --- a/packages/cli/src/gemini.test.tsx +++ b/packages/cli/src/gemini.test.tsx @@ -4,19 +4,18 @@ * SPDX-License-Identifier: Apache-2.0 */ -import stripAnsi from 'strip-ansi'; import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'; import { main, setupUnhandledRejectionHandler, validateDnsResolutionOrder, + startInteractiveUI, } from './gemini.js'; -import { - LoadedSettings, - SettingsFile, - loadSettings, -} from './config/settings.js'; +import type { SettingsFile } from './config/settings.js'; +import { LoadedSettings, loadSettings } from './config/settings.js'; import { appEvents, AppEvent } from './utils/events.js'; +import type { Config } from '@qwen-code/qwen-code-core'; +import { FatalConfigError } from '@qwen-code/qwen-code-core'; // Custom error to identify mock process.exit calls class MockProcessExitError extends Error { @@ -76,7 +75,6 @@ vi.mock('./utils/sandbox.js', () => ({ })); describe('gemini.tsx main function', () => { - let consoleErrorSpy: ReturnType; let loadSettingsMock: ReturnType>; let originalEnvGeminiSandbox: string | undefined; let originalEnvSandbox: string | undefined; @@ -98,7 +96,6 @@ describe('gemini.tsx main function', () => { delete process.env['GEMINI_SANDBOX']; delete process.env['SANDBOX']; - consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(() => {}); initialUnhandledRejectionListeners = process.listeners('unhandledRejection'); }); @@ -127,7 +124,7 @@ describe('gemini.tsx main function', () => { vi.restoreAllMocks(); }); - it('should call process.exit(1) if settings have errors', async () => { + it('should throw InvalidConfigurationError if settings have errors', async () => { const settingsError = { message: 'Test settings error', path: '/test/settings.json', @@ -144,37 +141,23 @@ describe('gemini.tsx main function', () => { path: '/system/settings.json', settings: {}, }; + const systemDefaultsFile: SettingsFile = { + path: '/system/system-defaults.json', + settings: {}, + }; const mockLoadedSettings = new LoadedSettings( systemSettingsFile, + systemDefaultsFile, userSettingsFile, workspaceSettingsFile, [settingsError], + true, + new Set(), ); loadSettingsMock.mockReturnValue(mockLoadedSettings); - try { - await main(); - // If main completes without throwing, the test should fail because process.exit was expected - expect.fail('main function did not exit as expected'); - } catch (error) { - expect(error).toBeInstanceOf(MockProcessExitError); - if (error instanceof MockProcessExitError) { - expect(error.code).toBe(1); - } - } - - // Verify console.error was called with the error message - expect(consoleErrorSpy).toHaveBeenCalledTimes(2); - expect(stripAnsi(String(consoleErrorSpy.mock.calls[0][0]))).toBe( - 'Error in /test/settings.json: Test settings error', - ); - expect(stripAnsi(String(consoleErrorSpy.mock.calls[1][0]))).toBe( - 'Please fix /test/settings.json and try again.', - ); - - // Verify process.exit was called. - expect(processExitSpy).toHaveBeenCalledWith(1); + await expect(main()).rejects.toThrow(FatalConfigError); }); it('should log unhandled promise rejections and open debug console on first error', async () => { @@ -250,3 +233,100 @@ describe('validateDnsResolutionOrder', () => { ); }); }); + +describe('startInteractiveUI', () => { + // Mock dependencies + const mockConfig = { + getProjectRoot: () => '/root', + getScreenReader: () => false, + } as Config; + const mockSettings = { + merged: { + ui: { + hideWindowTitle: false, + }, + }, + } as LoadedSettings; + const mockStartupWarnings = ['warning1']; + const mockWorkspaceRoot = '/root'; + + vi.mock('./utils/version.js', () => ({ + getCliVersion: vi.fn(() => Promise.resolve('1.0.0')), + })); + + vi.mock('./ui/utils/kittyProtocolDetector.js', () => ({ + detectAndEnableKittyProtocol: vi.fn(() => Promise.resolve()), + })); + + vi.mock('./ui/utils/updateCheck.js', () => ({ + checkForUpdates: vi.fn(() => Promise.resolve(null)), + })); + + vi.mock('./utils/cleanup.js', () => ({ + cleanupCheckpoints: vi.fn(() => Promise.resolve()), + registerCleanup: vi.fn(), + })); + + vi.mock('ink', () => ({ + render: vi.fn().mockReturnValue({ unmount: vi.fn() }), + })); + + beforeEach(() => { + vi.clearAllMocks(); + }); + + it('should render the UI with proper React context and exitOnCtrlC disabled', async () => { + const { render } = await import('ink'); + const renderSpy = vi.mocked(render); + + await startInteractiveUI( + mockConfig, + mockSettings, + mockStartupWarnings, + mockWorkspaceRoot, + ); + + // Verify render was called with correct options + expect(renderSpy).toHaveBeenCalledTimes(1); + const [reactElement, options] = renderSpy.mock.calls[0]; + + // Verify render options + expect(options).toEqual({ + exitOnCtrlC: false, + isScreenReaderEnabled: false, + }); + + // Verify React element structure is valid (but don't deep dive into JSX internals) + expect(reactElement).toBeDefined(); + }); + + it('should perform all startup tasks in correct order', async () => { + const { getCliVersion } = await import('./utils/version.js'); + const { detectAndEnableKittyProtocol } = await import( + './ui/utils/kittyProtocolDetector.js' + ); + const { checkForUpdates } = await import('./ui/utils/updateCheck.js'); + const { registerCleanup } = await import('./utils/cleanup.js'); + + await startInteractiveUI( + mockConfig, + mockSettings, + mockStartupWarnings, + mockWorkspaceRoot, + ); + + // Verify all startup tasks were called + expect(getCliVersion).toHaveBeenCalledTimes(1); + expect(detectAndEnableKittyProtocol).toHaveBeenCalledTimes(1); + expect(registerCleanup).toHaveBeenCalledTimes(1); + + // Verify cleanup handler is registered with unmount function + const cleanupFn = vi.mocked(registerCleanup).mock.calls[0][0]; + expect(typeof cleanupFn).toBe('function'); + + // checkForUpdates should be called asynchronously (not waited for) + // We need a small delay to let it execute + await new Promise((resolve) => setTimeout(resolve, 0)); + expect(checkForUpdates).toHaveBeenCalledTimes(1); + }); +}); diff --git a/packages/cli/src/gemini.tsx b/packages/cli/src/gemini.tsx index c4680c3f..361bd5b7 100644 --- a/packages/cli/src/gemini.tsx +++ b/packages/cli/src/gemini.tsx @@ -4,49 +4,47 @@ * SPDX-License-Identifier: Apache-2.0 */ -import React from 'react'; -import { render } from 'ink'; -import { AppWrapper } from './ui/App.js'; -import { loadCliConfig, parseArguments } from './config/config.js'; -import { readStdin } from './utils/readStdin.js'; -import { basename } from 'node:path'; -import v8 from 'node:v8'; -import os from 'node:os'; -import dns from 'node:dns'; -import { spawn } from 'node:child_process'; -import { start_sandbox } from './utils/sandbox.js'; +import type { Config } from '@qwen-code/qwen-code-core'; import { - DnsResolutionOrder, - LoadedSettings, - loadSettings, - SettingScope, -} from './config/settings.js'; -import { themeManager } from './ui/themes/theme-manager.js'; -import { getStartupWarnings } from './utils/startupWarnings.js'; -import { getUserStartupWarnings } from './utils/userStartupWarnings.js'; -import { ConsolePatcher } from './ui/utils/ConsolePatcher.js'; -import { runNonInteractive } from './nonInteractiveCli.js'; -import { loadExtensions } from './config/extension.js'; -import { cleanupCheckpoints, registerCleanup } from './utils/cleanup.js'; -import { getCliVersion } from './utils/version.js'; -import { - Config, - sessionId, - logUserPrompt, AuthType, + FatalConfigError, getOauthClient, - logIdeConnection, IdeConnectionEvent, IdeConnectionType, + logIdeConnection, + logUserPrompt, + sessionId, } from '@qwen-code/qwen-code-core'; +import { render } from 'ink'; +import { spawn } from 'node:child_process'; +import dns from 'node:dns'; +import os from 'node:os'; +import { basename } from 'node:path'; +import v8 from 'node:v8'; +import React from 'react'; import { validateAuthMethod } from './config/auth.js'; +import { loadCliConfig, parseArguments } from './config/config.js'; +import { loadExtensions } from './config/extension.js'; +import type { DnsResolutionOrder, LoadedSettings } from './config/settings.js'; +import { loadSettings, SettingScope } from './config/settings.js'; +import { runNonInteractive } from './nonInteractiveCli.js'; +import { AppWrapper } from './ui/App.js'; import { setMaxSizedBoxDebugging } from './ui/components/shared/MaxSizedBox.js'; -import { validateNonInteractiveAuth } from './validateNonInterActiveAuth.js'; +import { SettingsContext } from './ui/contexts/SettingsContext.js'; +import { themeManager } from './ui/themes/theme-manager.js'; +import { ConsolePatcher } from './ui/utils/ConsolePatcher.js'; import { detectAndEnableKittyProtocol } from './ui/utils/kittyProtocolDetector.js'; import { checkForUpdates } from './ui/utils/updateCheck.js'; +import { cleanupCheckpoints, registerCleanup } from './utils/cleanup.js'; +import { AppEvent, appEvents } from './utils/events.js'; import { handleAutoUpdate } from './utils/handleAutoUpdate.js'; -import { appEvents, AppEvent } from './utils/events.js'; -import { SettingsContext } from './ui/contexts/SettingsContext.js'; +import { readStdin } from './utils/readStdin.js'; +import { start_sandbox } from './utils/sandbox.js'; +import { getStartupWarnings } from './utils/startupWarnings.js'; +import { getUserStartupWarnings } from './utils/userStartupWarnings.js'; +import { getCliVersion } from './utils/version.js'; +import { validateNonInteractiveAuth } from './validateNonInterActiveAuth.js'; +import { runZedIntegration } from './zed-integration/zedIntegration.js'; export function validateDnsResolutionOrder( order: string | undefined, @@ -108,7 +106,6 @@ async function relaunchWithAdditionalArgs(additionalArgs: string[]) { await new Promise((resolve) => child.on('close', resolve)); process.exit(0); } -import { runZedIntegration } from './zed-integration/zedIntegration.js'; export function setupUnhandledRejectionHandler() { let unhandledRejectionOccurred = false; @@ -132,6 +129,44 @@ ${reason.stack}` }); } +export async function startInteractiveUI( + config: Config, + settings: LoadedSettings, + startupWarnings: string[], + workspaceRoot: string, +) { + const version = await getCliVersion(); + // Detect and enable Kitty keyboard protocol once at startup + await detectAndEnableKittyProtocol(); + setWindowTitle(basename(workspaceRoot), settings); + const instance = render( + + + + + , + { exitOnCtrlC: false, isScreenReaderEnabled: config.getScreenReader() }, + ); + + checkForUpdates() + .then((info) => { + handleAutoUpdate(info, settings, config.getProjectRoot()); + }) + .catch((err) => { + // Silently ignore update check errors. + if (config.getDebugMode()) { + console.error('Update check failed:', err); + } + }); + + registerCleanup(() => instance.unmount()); +} + export async function main() { setupUnhandledRejectionHandler(); const workspaceRoot = process.cwd(); @@ -139,18 +174,15 @@ export async function main() { await cleanupCheckpoints(); if (settings.errors.length > 0) { - for (const error of settings.errors) { - let errorMessage = `Error in ${error.path}: ${error.message}`; - if (!process.env['NO_COLOR']) { - errorMessage = `\x1b[31m${errorMessage}\x1b[0m`; - } - console.error(errorMessage); - console.error(`Please fix ${error.path} and try again.`); - } - process.exit(1); + const errorMessages = settings.errors.map( + (error) => `Error in ${error.path}: ${error.message}`, + ); + throw new FatalConfigError( + `${errorMessages.join('\n')}\nPlease fix the configuration file(s) and try again.`, + ); } - const argv = await parseArguments(); + const argv = await parseArguments(settings.merged); const extensions = loadExtensions(workspaceRoot); const config = await loadCliConfig( settings.merged, @@ -167,7 +199,7 @@ export async function main() { registerCleanup(consolePatcher.cleanup); dns.setDefaultResultOrder( - validateDnsResolutionOrder(settings.merged.dnsResolutionOrder), + validateDnsResolutionOrder(settings.merged.advanced?.dnsResolutionOrder), ); if (argv.promptInteractive && !process.stdin.isTTY) { @@ -186,7 +218,7 @@ export async function main() { } // Set a default auth type if one isn't set. - if (!settings.merged.selectedAuthType) { + if (!settings.merged.security?.auth?.selectedType) { if (process.env['CLOUD_SHELL'] === 'true') { settings.setValue( SettingScope.User, @@ -195,6 +227,14 @@ export async function main() { ); } } + // Empty key causes issues with the GoogleGenAI package. + if (process.env['GEMINI_API_KEY']?.trim() === '') { + delete process.env['GEMINI_API_KEY']; + } + + if (process.env['GOOGLE_API_KEY']?.trim() === '') { + delete process.env['GOOGLE_API_KEY']; + } setMaxSizedBoxDebugging(config.getDebugMode()); @@ -206,40 +246,72 @@ export async function main() { } // Load custom themes from settings - themeManager.loadCustomThemes(settings.merged.customThemes); + themeManager.loadCustomThemes(settings.merged.ui?.customThemes); - if (settings.merged.theme) { - if (!themeManager.setActiveTheme(settings.merged.theme)) { + if (settings.merged.ui?.theme) { + if (!themeManager.setActiveTheme(settings.merged.ui?.theme)) { // If the theme is not found during initial load, log a warning and continue. // The useThemeCommand hook in App.tsx will handle opening the dialog. - console.warn(`Warning: Theme "${settings.merged.theme}" not found.`); + console.warn(`Warning: Theme "${settings.merged.ui?.theme}" not found.`); } } // hop into sandbox if we are outside and sandboxing is enabled if (!process.env['SANDBOX']) { - const memoryArgs = settings.merged.autoConfigureMaxOldSpaceSize + const memoryArgs = settings.merged.advanced?.autoConfigureMemory ? getNodeMemoryArgs(config) : []; const sandboxConfig = config.getSandbox(); if (sandboxConfig) { if ( - settings.merged.selectedAuthType && - !settings.merged.useExternalAuth + settings.merged.security?.auth?.selectedType && + !settings.merged.security?.auth?.useExternal ) { // Validate authentication here because the sandbox will interfere with the Oauth2 web redirect. try { - const err = validateAuthMethod(settings.merged.selectedAuthType); + const err = validateAuthMethod( + settings.merged.security.auth.selectedType, + ); if (err) { throw new Error(err); } - await config.refreshAuth(settings.merged.selectedAuthType); + await config.refreshAuth(settings.merged.security.auth.selectedType); } catch (err) { console.error('Error authenticating:', err); process.exit(1); } } - await start_sandbox(sandboxConfig, memoryArgs, config); + let stdinData = ''; + if (!process.stdin.isTTY) { + stdinData = await readStdin(); + } + + // This function is a copy of the one from sandbox.ts + // It is moved here to decouple sandbox.ts from the CLI's argument structure. + const injectStdinIntoArgs = ( + args: string[], + stdinData?: string, + ): string[] => { + const finalArgs = [...args]; + if (stdinData) { + const promptIndex = finalArgs.findIndex( + (arg) => arg === '--prompt' || arg === '-p', + ); + if (promptIndex > -1 && finalArgs.length > promptIndex + 1) { + // If there's a prompt argument, prepend stdin to it + finalArgs[promptIndex + 1] = + `${stdinData}\n\n${finalArgs[promptIndex + 1]}`; + } else { + // If there's no prompt argument, add stdin as the prompt + finalArgs.push('--prompt', stdinData); + } + } + return finalArgs; + }; + + const sandboxArgs = injectStdinIntoArgs(process.argv, stdinData); + + await start_sandbox(sandboxConfig, memoryArgs, config, sandboxArgs); process.exit(0); } else { // Not in a sandbox and not entering one, so relaunch with additional @@ -252,11 +324,12 @@ export async function main() { } if ( - settings.merged.selectedAuthType === AuthType.LOGIN_WITH_GOOGLE && + settings.merged.security?.auth?.selectedType === + AuthType.LOGIN_WITH_GOOGLE && config.isBrowserLaunchSuppressed() ) { // Do oauth before app renders to make copying the link possible. - await getOauthClient(settings.merged.selectedAuthType, config); + await getOauthClient(settings.merged.security.auth.selectedType, config); } if (config.getExperimentalZedIntegration()) { @@ -271,36 +344,7 @@ export async function main() { // Render UI, passing necessary config values. Check that there is no command line question. if (config.isInteractive()) { - const version = await getCliVersion(); - // Detect and enable Kitty keyboard protocol once at startup - await detectAndEnableKittyProtocol(); - setWindowTitle(basename(workspaceRoot), settings); - const instance = render( - - - - - , - { exitOnCtrlC: false }, - ); - - checkForUpdates() - .then((info) => { - handleAutoUpdate(info, settings, config.getProjectRoot()); - }) - .catch((err) => { - // Silently ignore update check errors. - if (config.getDebugMode()) { - console.error('Update check failed:', err); - } - }); - - registerCleanup(() => instance.unmount()); + await startInteractiveUI(config, settings, startupWarnings, workspaceRoot); return; } // If not a TTY, read from stdin @@ -312,7 +356,9 @@ export async function main() { } } if (!input) { - console.error('No input provided via stdin.'); + console.error( + `No input provided via stdin. Input can be provided by piping data into gemini or using the --prompt option.`, + ); process.exit(1); } @@ -327,17 +373,21 @@ export async function main() { }); const nonInteractiveConfig = await validateNonInteractiveAuth( - settings.merged.selectedAuthType, - settings.merged.useExternalAuth, + settings.merged.security?.auth?.selectedType, + settings.merged.security?.auth?.useExternal, config, ); + if (config.getDebugMode()) { + console.log('Session ID: %s', sessionId); + } + await runNonInteractive(nonInteractiveConfig, input, prompt_id); process.exit(0); } function setWindowTitle(title: string, settings: LoadedSettings) { - if (!settings.merged.hideWindowTitle) { + if (!settings.merged.ui?.hideWindowTitle) { const windowTitle = (process.env['CLI_TITLE'] || `Qwen - ${title}`).replace( // eslint-disable-next-line no-control-regex /[\x00-\x1F\x7F]/g, diff --git a/packages/cli/src/nonInteractiveCli.test.ts b/packages/cli/src/nonInteractiveCli.test.ts index 229dbe8c..7d5727c2 100644 --- a/packages/cli/src/nonInteractiveCli.test.ts +++ b/packages/cli/src/nonInteractiveCli.test.ts @@ -5,19 +5,20 @@ */ import { - Config, + type Config, + type ToolRegistry, executeToolCall, - ToolRegistry, ToolErrorType, shutdownTelemetry, GeminiEventType, - ServerGeminiStreamEvent, + type ServerGeminiStreamEvent, } from '@qwen-code/qwen-code-core'; -import { Part } from '@google/genai'; +import { type Part } from '@google/genai'; import { runNonInteractive } from './nonInteractiveCli.js'; import { vi } from 'vitest'; // Mock core modules +vi.mock('./ui/hooks/atCommandProcessor.js'); vi.mock('@qwen-code/qwen-code-core', async (importOriginal) => { const original = await importOriginal(); @@ -35,20 +36,16 @@ describe('runNonInteractive', () => { let mockCoreExecuteToolCall: vi.Mock; let mockShutdownTelemetry: vi.Mock; let consoleErrorSpy: vi.SpyInstance; - let processExitSpy: vi.SpyInstance; let processStdoutSpy: vi.SpyInstance; let mockGeminiClient: { sendMessageStream: vi.Mock; }; - beforeEach(() => { + beforeEach(async () => { mockCoreExecuteToolCall = vi.mocked(executeToolCall); mockShutdownTelemetry = vi.mocked(shutdownTelemetry); consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(() => {}); - processExitSpy = vi - .spyOn(process, 'exit') - .mockImplementation((() => {}) as (code?: number) => never); processStdoutSpy = vi .spyOn(process.stdout, 'write') .mockImplementation(() => true); @@ -72,6 +69,14 @@ describe('runNonInteractive', () => { getContentGeneratorConfig: vi.fn().mockReturnValue({}), getDebugMode: vi.fn().mockReturnValue(false), } as unknown as Config; + + const { handleAtCommand } = await import( + './ui/hooks/atCommandProcessor.js' + ); + vi.mocked(handleAtCommand).mockImplementation(async ({ query }) => ({ + processedQuery: [{ text: query }], + shouldProceed: true, + })); }); afterEach(() => { @@ -163,14 +168,16 @@ describe('runNonInteractive', () => { mockCoreExecuteToolCall.mockResolvedValue({ error: new Error('Execution failed'), errorType: ToolErrorType.EXECUTION_FAILED, - responseParts: { - functionResponse: { - name: 'errorTool', - response: { - output: 'Error: Execution failed', + responseParts: [ + { + functionResponse: { + name: 'errorTool', + response: { + output: 'Error: Execution failed', + }, }, }, - }, + ], resultDisplay: 'Execution failed', }); const finalResponse: ServerGeminiStreamEvent[] = [ @@ -189,7 +196,6 @@ describe('runNonInteractive', () => { expect(consoleErrorSpy).toHaveBeenCalledWith( 'Error executing tool errorTool: Execution failed', ); - expect(processExitSpy).not.toHaveBeenCalled(); expect(mockGeminiClient.sendMessageStream).toHaveBeenCalledTimes(2); expect(mockGeminiClient.sendMessageStream).toHaveBeenNthCalledWith( 2, @@ -215,12 +221,9 @@ describe('runNonInteractive', () => { throw apiError; }); - await runNonInteractive(mockConfig, 'Initial fail', 'prompt-id-4'); - - expect(consoleErrorSpy).toHaveBeenCalledWith( - '[API Error: API connection failed]', - ); - expect(processExitSpy).toHaveBeenCalledWith(1); + await expect( + runNonInteractive(mockConfig, 'Initial fail', 'prompt-id-4'), + ).rejects.toThrow(apiError); }); it('should not exit if a tool is not found, and should send error back to model', async () => { @@ -259,7 +262,6 @@ describe('runNonInteractive', () => { expect(consoleErrorSpy).toHaveBeenCalledWith( 'Error executing tool nonexistentTool: Tool "nonexistentTool" not found in registry.', ); - expect(processExitSpy).not.toHaveBeenCalled(); expect(mockGeminiClient.sendMessageStream).toHaveBeenCalledTimes(2); expect(processStdoutSpy).toHaveBeenCalledWith( "Sorry, I can't find that tool.", @@ -268,9 +270,54 @@ describe('runNonInteractive', () => { it('should exit when max session turns are exceeded', async () => { vi.mocked(mockConfig.getMaxSessionTurns).mockReturnValue(0); - await runNonInteractive(mockConfig, 'Trigger loop', 'prompt-id-6'); - expect(consoleErrorSpy).toHaveBeenCalledWith( - '\n Reached max session turns for this session. Increase the number of turns by specifying maxSessionTurns in settings.json.', + await expect( + runNonInteractive(mockConfig, 'Trigger loop', 'prompt-id-6'), + ).rejects.toThrow( + 'Reached max session turns for this session. Increase the number of turns by specifying maxSessionTurns in settings.json.', ); }); + + it('should preprocess @include commands before sending to the model', async () => { + // 1. Mock the imported atCommandProcessor + const { handleAtCommand } = await import( + './ui/hooks/atCommandProcessor.js' + ); + const mockHandleAtCommand = vi.mocked(handleAtCommand); + + // 2. Define the raw input and the expected processed output + const rawInput = 'Summarize @file.txt'; + const processedParts: Part[] = [ + { text: 'Summarize @file.txt' }, + { text: '\n--- Content from referenced files ---\n' }, + { text: 'This is the content of the file.' }, + { text: '\n--- End of content ---' }, + ]; + + // 3. Setup the mock to return the processed parts + mockHandleAtCommand.mockResolvedValue({ + processedQuery: processedParts, + shouldProceed: true, + }); + + // Mock a simple stream response from the Gemini client + const events: ServerGeminiStreamEvent[] = [ + { type: GeminiEventType.Content, value: 'Summary complete.' }, + ]; + mockGeminiClient.sendMessageStream.mockReturnValue( + createStreamFromEvents(events), + ); + + // 4. Run the non-interactive mode with the raw input + await runNonInteractive(mockConfig, rawInput, 'prompt-id-7'); + + // 5. Assert that sendMessageStream was called with the PROCESSED parts, not the raw input + expect(mockGeminiClient.sendMessageStream).toHaveBeenCalledWith( + processedParts, + expect.any(AbortSignal), + 'prompt-id-7', + ); + + // 6. Assert the final output is correct + expect(processStdoutSpy).toHaveBeenCalledWith('Summary complete.'); + }); }); diff --git a/packages/cli/src/nonInteractiveCli.ts b/packages/cli/src/nonInteractiveCli.ts index 4b6fe6bb..bdc42f46 100644 --- a/packages/cli/src/nonInteractiveCli.ts +++ b/packages/cli/src/nonInteractiveCli.ts @@ -4,18 +4,20 @@ * SPDX-License-Identifier: Apache-2.0 */ +import type { Config, ToolCallRequestInfo } from '@qwen-code/qwen-code-core'; import { - Config, - ToolCallRequestInfo, executeToolCall, shutdownTelemetry, isTelemetrySdkInitialized, GeminiEventType, parseAndFormatApiError, + FatalInputError, + FatalTurnLimitedError, } from '@qwen-code/qwen-code-core'; -import { Content, Part, FunctionCall } from '@google/genai'; +import type { Content, Part } from '@google/genai'; import { ConsolePatcher } from './ui/utils/ConsolePatcher.js'; +import { handleAtCommand } from './ui/hooks/atCommandProcessor.js'; export async function runNonInteractive( config: Config, @@ -40,9 +42,28 @@ export async function runNonInteractive( const geminiClient = config.getGeminiClient(); const abortController = new AbortController(); + + const { processedQuery, shouldProceed } = await handleAtCommand({ + query: input, + config, + addItem: (_item, _timestamp) => 0, + onDebugMessage: () => {}, + messageId: Date.now(), + signal: abortController.signal, + }); + + if (!shouldProceed || !processedQuery) { + // An error occurred during @include processing (e.g., file not found). + // The error message is already logged by handleAtCommand. + throw new FatalInputError( + 'Exiting due to an error processing the @ command.', + ); + } + let currentMessages: Content[] = [ - { role: 'user', parts: [{ text: input }] }, + { role: 'user', parts: processedQuery as Part[] }, ]; + let turnCount = 0; while (true) { turnCount++; @@ -50,12 +71,11 @@ export async function runNonInteractive( config.getMaxSessionTurns() >= 0 && turnCount > config.getMaxSessionTurns() ) { - console.error( - '\n Reached max session turns for this session. Increase the number of turns by specifying maxSessionTurns in settings.json.', + throw new FatalTurnLimitedError( + 'Reached max session turns for this session. Increase the number of turns by specifying maxSessionTurns in settings.json.', ); - return; } - const functionCalls: FunctionCall[] = []; + const toolCallRequests: ToolCallRequestInfo[] = []; const responseStream = geminiClient.sendMessageStream( currentMessages[0]?.parts || [], @@ -72,29 +92,13 @@ export async function runNonInteractive( if (event.type === GeminiEventType.Content) { process.stdout.write(event.value); } else if (event.type === GeminiEventType.ToolCallRequest) { - const toolCallRequest = event.value; - const fc: FunctionCall = { - name: toolCallRequest.name, - args: toolCallRequest.args, - id: toolCallRequest.callId, - }; - functionCalls.push(fc); + toolCallRequests.push(event.value); } } - if (functionCalls.length > 0) { + if (toolCallRequests.length > 0) { const toolResponseParts: Part[] = []; - - for (const fc of functionCalls) { - const callId = fc.id ?? `${fc.name}-${Date.now()}`; - const requestInfo: ToolCallRequestInfo = { - callId, - name: fc.name as string, - args: (fc.args ?? {}) as Record, - isClientInitiated: false, - prompt_id, - }; - + for (const requestInfo of toolCallRequests) { const toolResponse = await executeToolCall( config, requestInfo, @@ -103,21 +107,12 @@ export async function runNonInteractive( if (toolResponse.error) { console.error( - `Error executing tool ${fc.name}: ${toolResponse.resultDisplay || toolResponse.error.message}`, + `Error executing tool ${requestInfo.name}: ${toolResponse.resultDisplay || toolResponse.error.message}`, ); } if (toolResponse.responseParts) { - const parts = Array.isArray(toolResponse.responseParts) - ? toolResponse.responseParts - : [toolResponse.responseParts]; - for (const part of parts) { - if (typeof part === 'string') { - toolResponseParts.push({ text: part }); - } else if (part) { - toolResponseParts.push(part); - } - } + toolResponseParts.push(...toolResponse.responseParts); } } currentMessages = [{ role: 'user', parts: toolResponseParts }]; @@ -133,7 +128,7 @@ export async function runNonInteractive( config.getContentGeneratorConfig()?.authType, ), ); - process.exit(1); + throw error; } finally { consolePatcher.cleanup(); if (isTelemetrySdkInitialized()) { diff --git a/packages/cli/src/services/BuiltinCommandLoader.test.ts b/packages/cli/src/services/BuiltinCommandLoader.test.ts index 8760f64b..dcede5a3 100644 --- a/packages/cli/src/services/BuiltinCommandLoader.test.ts +++ b/packages/cli/src/services/BuiltinCommandLoader.test.ts @@ -22,7 +22,7 @@ vi.mock('../ui/commands/restoreCommand.js', () => ({ import { describe, it, expect, vi, beforeEach, type Mock } from 'vitest'; import { BuiltinCommandLoader } from './BuiltinCommandLoader.js'; -import { Config } from '@qwen-code/qwen-code-core'; +import type { Config } from '@qwen-code/qwen-code-core'; import { CommandKind } from '../ui/commands/types.js'; import { ideCommand } from '../ui/commands/ideCommand.js'; diff --git a/packages/cli/src/services/BuiltinCommandLoader.ts b/packages/cli/src/services/BuiltinCommandLoader.ts index f1446880..74de2a3c 100644 --- a/packages/cli/src/services/BuiltinCommandLoader.ts +++ b/packages/cli/src/services/BuiltinCommandLoader.ts @@ -4,9 +4,9 @@ * SPDX-License-Identifier: Apache-2.0 */ -import { ICommandLoader } from './types.js'; -import { SlashCommand } from '../ui/commands/types.js'; -import { Config } from '@qwen-code/qwen-code-core'; +import type { ICommandLoader } from './types.js'; +import type { SlashCommand } from '../ui/commands/types.js'; +import type { Config } from '@qwen-code/qwen-code-core'; import { aboutCommand } from '../ui/commands/aboutCommand.js'; import { authCommand } from '../ui/commands/authCommand.js'; import { bugCommand } from '../ui/commands/bugCommand.js'; diff --git a/packages/cli/src/services/CommandService.ts b/packages/cli/src/services/CommandService.ts index 78e4817b..5f1e09d5 100644 --- a/packages/cli/src/services/CommandService.ts +++ b/packages/cli/src/services/CommandService.ts @@ -4,8 +4,8 @@ * SPDX-License-Identifier: Apache-2.0 */ -import { SlashCommand } from '../ui/commands/types.js'; -import { ICommandLoader } from './types.js'; +import type { SlashCommand } from '../ui/commands/types.js'; +import type { ICommandLoader } from './types.js'; /** * Orchestrates the discovery and loading of all slash commands for the CLI. diff --git a/packages/cli/src/services/FileCommandLoader.test.ts b/packages/cli/src/services/FileCommandLoader.test.ts index 8ec8c1e9..aef6c408 100644 --- a/packages/cli/src/services/FileCommandLoader.test.ts +++ b/packages/cli/src/services/FileCommandLoader.test.ts @@ -5,11 +5,8 @@ */ import * as path from 'node:path'; -import { - Config, - getProjectCommandsDir, - getUserCommandsDir, -} from '@qwen-code/qwen-code-core'; +import type { Config } from '@qwen-code/qwen-code-core'; +import { Storage } from '@qwen-code/qwen-code-core'; import mock from 'mock-fs'; import { FileCommandLoader } from './FileCommandLoader.js'; import { assert, vi } from 'vitest'; @@ -17,15 +14,23 @@ import { createMockCommandContext } from '../test-utils/mockCommandContext.js'; import { SHELL_INJECTION_TRIGGER, SHORTHAND_ARGS_PLACEHOLDER, + type PromptPipelineContent, } from './prompt-processors/types.js'; import { ConfirmationRequiredError, ShellProcessor, } from './prompt-processors/shellProcessor.js'; import { DefaultArgumentProcessor } from './prompt-processors/argumentProcessor.js'; -import { CommandContext } from '../ui/commands/types.js'; +import type { CommandContext } from '../ui/commands/types.js'; +import { AtFileProcessor } from './prompt-processors/atFileProcessor.js'; const mockShellProcess = vi.hoisted(() => vi.fn()); +const mockAtFileProcess = vi.hoisted(() => vi.fn()); +vi.mock('./prompt-processors/atFileProcessor.js', () => ({ + AtFileProcessor: vi.fn().mockImplementation(() => ({ + process: mockAtFileProcess, + })), +})); vi.mock('./prompt-processors/shellProcessor.js', () => ({ ShellProcessor: vi.fn().mockImplementation(() => ({ process: mockShellProcess, @@ -57,6 +62,7 @@ vi.mock('@qwen-code/qwen-code-core', async (importOriginal) => { await importOriginal(); return { ...original, + Storage: original.Storage, isCommandAllowed: vi.fn(), ShellExecutionService: { execute: vi.fn(), @@ -70,15 +76,28 @@ describe('FileCommandLoader', () => { beforeEach(() => { vi.clearAllMocks(); mockShellProcess.mockImplementation( - (prompt: string, context: CommandContext) => { + (prompt: PromptPipelineContent, context: CommandContext) => { const userArgsRaw = context?.invocation?.args || ''; - const processedPrompt = prompt.replaceAll( + // This is a simplified mock. A real implementation would need to iterate + // through all parts and process only the text parts. + const firstTextPart = prompt.find( + (p) => typeof p === 'string' || 'text' in p, + ); + let textContent = ''; + if (typeof firstTextPart === 'string') { + textContent = firstTextPart; + } else if (firstTextPart && 'text' in firstTextPart) { + textContent = firstTextPart.text ?? ''; + } + + const processedText = textContent.replaceAll( SHORTHAND_ARGS_PLACEHOLDER, userArgsRaw, ); - return Promise.resolve(processedPrompt); + return Promise.resolve([{ text: processedText }]); }, ); + mockAtFileProcess.mockImplementation(async (prompt: string) => prompt); }); afterEach(() => { @@ -86,7 +105,7 @@ describe('FileCommandLoader', () => { }); it('loads a single command from a file', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'test.toml': 'prompt = "This is a test prompt"', @@ -112,7 +131,7 @@ describe('FileCommandLoader', () => { '', ); if (result?.type === 'submit_prompt') { - expect(result.content).toBe('This is a test prompt'); + expect(result.content).toEqual([{ text: 'This is a test prompt' }]); } else { assert.fail('Incorrect action type'); } @@ -127,7 +146,7 @@ describe('FileCommandLoader', () => { itif(process.platform !== 'win32')( 'loads commands from a symlinked directory', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); const realCommandsDir = '/real/commands'; mock({ [realCommandsDir]: { @@ -152,7 +171,7 @@ describe('FileCommandLoader', () => { itif(process.platform !== 'win32')( 'loads commands from a symlinked subdirectory', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); const realNamespacedDir = '/real/namespaced-commands'; mock({ [userCommandsDir]: { @@ -176,7 +195,7 @@ describe('FileCommandLoader', () => { ); it('loads multiple commands', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'test1.toml': 'prompt = "Prompt 1"', @@ -191,7 +210,7 @@ describe('FileCommandLoader', () => { }); it('creates deeply nested namespaces correctly', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { @@ -213,7 +232,7 @@ describe('FileCommandLoader', () => { }); it('creates namespaces from nested directories', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { git: { @@ -232,8 +251,10 @@ describe('FileCommandLoader', () => { }); it('returns both user and project commands in order', async () => { - const userCommandsDir = getUserCommandsDir(); - const projectCommandsDir = getProjectCommandsDir(process.cwd()); + const userCommandsDir = Storage.getUserCommandsDir(); + const projectCommandsDir = new Storage( + process.cwd(), + ).getProjectCommandsDir(); mock({ [userCommandsDir]: { 'test.toml': 'prompt = "User prompt"', @@ -262,7 +283,7 @@ describe('FileCommandLoader', () => { '', ); if (userResult?.type === 'submit_prompt') { - expect(userResult.content).toBe('User prompt'); + expect(userResult.content).toEqual([{ text: 'User prompt' }]); } else { assert.fail('Incorrect action type for user command'); } @@ -277,14 +298,14 @@ describe('FileCommandLoader', () => { '', ); if (projectResult?.type === 'submit_prompt') { - expect(projectResult.content).toBe('Project prompt'); + expect(projectResult.content).toEqual([{ text: 'Project prompt' }]); } else { assert.fail('Incorrect action type for project command'); } }); it('ignores files with TOML syntax errors', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'invalid.toml': 'this is not valid toml', @@ -300,7 +321,7 @@ describe('FileCommandLoader', () => { }); it('ignores files that are semantically invalid (missing prompt)', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'no_prompt.toml': 'description = "This file is missing a prompt"', @@ -316,7 +337,7 @@ describe('FileCommandLoader', () => { }); it('handles filename edge cases correctly', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'test.v1.toml': 'prompt = "Test prompt"', @@ -338,7 +359,7 @@ describe('FileCommandLoader', () => { }); it('uses a default description if not provided', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'test.toml': 'prompt = "Test prompt"', @@ -353,7 +374,7 @@ describe('FileCommandLoader', () => { }); it('uses the provided description', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'test.toml': 'prompt = "Test prompt"\ndescription = "My test command"', @@ -368,7 +389,7 @@ describe('FileCommandLoader', () => { }); it('should sanitize colons in filenames to prevent namespace conflicts', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'legacy:command.toml': 'prompt = "This is a legacy command"', @@ -388,7 +409,7 @@ describe('FileCommandLoader', () => { describe('Processor Instantiation Logic', () => { it('instantiates only DefaultArgumentProcessor if no {{args}} or !{} are present', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'simple.toml': `prompt = "Just a regular prompt"`, @@ -403,7 +424,7 @@ describe('FileCommandLoader', () => { }); it('instantiates only ShellProcessor if {{args}} is present (but not !{})', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'args.toml': `prompt = "Prompt with {{args}}"`, @@ -418,7 +439,7 @@ describe('FileCommandLoader', () => { }); it('instantiates ShellProcessor and DefaultArgumentProcessor if !{} is present (but not {{args}})', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'shell.toml': `prompt = "Prompt with !{cmd}"`, @@ -433,7 +454,7 @@ describe('FileCommandLoader', () => { }); it('instantiates only ShellProcessor if both {{args}} and !{} are present', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'both.toml': `prompt = "Prompt with {{args}} and !{cmd}"`, @@ -446,15 +467,65 @@ describe('FileCommandLoader', () => { expect(ShellProcessor).toHaveBeenCalledTimes(1); expect(DefaultArgumentProcessor).not.toHaveBeenCalled(); }); + + it('instantiates AtFileProcessor and DefaultArgumentProcessor if @{} is present', async () => { + const userCommandsDir = Storage.getUserCommandsDir(); + mock({ + [userCommandsDir]: { + 'at-file.toml': `prompt = "Context: @{./my-file.txt}"`, + }, + }); + + const loader = new FileCommandLoader(null as unknown as Config); + await loader.loadCommands(signal); + + expect(AtFileProcessor).toHaveBeenCalledTimes(1); + expect(ShellProcessor).not.toHaveBeenCalled(); + expect(DefaultArgumentProcessor).toHaveBeenCalledTimes(1); + }); + + it('instantiates ShellProcessor and AtFileProcessor if !{} and @{} are present', async () => { + const userCommandsDir = Storage.getUserCommandsDir(); + mock({ + [userCommandsDir]: { + 'shell-and-at.toml': `prompt = "Run !{cmd} with @{file.txt}"`, + }, + }); + + const loader = new FileCommandLoader(null as unknown as Config); + await loader.loadCommands(signal); + + expect(ShellProcessor).toHaveBeenCalledTimes(1); + expect(AtFileProcessor).toHaveBeenCalledTimes(1); + expect(DefaultArgumentProcessor).toHaveBeenCalledTimes(1); // because no {{args}} + }); + + it('instantiates only ShellProcessor and AtFileProcessor if {{args}} and @{} are present', async () => { + const userCommandsDir = Storage.getUserCommandsDir(); + mock({ + [userCommandsDir]: { + 'args-and-at.toml': `prompt = "Run {{args}} with @{file.txt}"`, + }, + }); + + const loader = new FileCommandLoader(null as unknown as Config); + await loader.loadCommands(signal); + + expect(ShellProcessor).toHaveBeenCalledTimes(1); + expect(AtFileProcessor).toHaveBeenCalledTimes(1); + expect(DefaultArgumentProcessor).not.toHaveBeenCalled(); + }); }); describe('Extension Command Loading', () => { it('loads commands from active extensions', async () => { - const userCommandsDir = getUserCommandsDir(); - const projectCommandsDir = getProjectCommandsDir(process.cwd()); + const userCommandsDir = Storage.getUserCommandsDir(); + const projectCommandsDir = new Storage( + process.cwd(), + ).getProjectCommandsDir(); const extensionDir = path.join( process.cwd(), - '.gemini/extensions/test-ext', + '.qwen/extensions/test-ext', ); mock({ @@ -465,7 +536,7 @@ describe('FileCommandLoader', () => { 'project.toml': 'prompt = "Project command"', }, [extensionDir]: { - 'gemini-extension.json': JSON.stringify({ + 'qwen-extension.json': JSON.stringify({ name: 'test-ext', version: '1.0.0', }), @@ -499,16 +570,18 @@ describe('FileCommandLoader', () => { }); it('extension commands have extensionName metadata for conflict resolution', async () => { - const userCommandsDir = getUserCommandsDir(); - const projectCommandsDir = getProjectCommandsDir(process.cwd()); + const userCommandsDir = Storage.getUserCommandsDir(); + const projectCommandsDir = new Storage( + process.cwd(), + ).getProjectCommandsDir(); const extensionDir = path.join( process.cwd(), - '.gemini/extensions/test-ext', + '.qwen/extensions/test-ext', ); mock({ [extensionDir]: { - 'gemini-extension.json': JSON.stringify({ + 'qwen-extension.json': JSON.stringify({ name: 'test-ext', version: '1.0.0', }), @@ -555,7 +628,7 @@ describe('FileCommandLoader', () => { ); expect(result0?.type).toBe('submit_prompt'); if (result0?.type === 'submit_prompt') { - expect(result0.content).toBe('User deploy command'); + expect(result0.content).toEqual([{ text: 'User deploy command' }]); } expect(commands[1].name).toBe('deploy'); @@ -572,7 +645,7 @@ describe('FileCommandLoader', () => { ); expect(result1?.type).toBe('submit_prompt'); if (result1?.type === 'submit_prompt') { - expect(result1.content).toBe('Project deploy command'); + expect(result1.content).toEqual([{ text: 'Project deploy command' }]); } expect(commands[2].name).toBe('deploy'); @@ -590,23 +663,23 @@ describe('FileCommandLoader', () => { ); expect(result2?.type).toBe('submit_prompt'); if (result2?.type === 'submit_prompt') { - expect(result2.content).toBe('Extension deploy command'); + expect(result2.content).toEqual([{ text: 'Extension deploy command' }]); } }); it('only loads commands from active extensions', async () => { const extensionDir1 = path.join( process.cwd(), - '.gemini/extensions/active-ext', + '.qwen/extensions/active-ext', ); const extensionDir2 = path.join( process.cwd(), - '.gemini/extensions/inactive-ext', + '.qwen/extensions/inactive-ext', ); mock({ [extensionDir1]: { - 'gemini-extension.json': JSON.stringify({ + 'qwen-extension.json': JSON.stringify({ name: 'active-ext', version: '1.0.0', }), @@ -615,7 +688,7 @@ describe('FileCommandLoader', () => { }, }, [extensionDir2]: { - 'gemini-extension.json': JSON.stringify({ + 'qwen-extension.json': JSON.stringify({ name: 'inactive-ext', version: '1.0.0', }), @@ -654,12 +727,12 @@ describe('FileCommandLoader', () => { it('handles missing extension commands directory gracefully', async () => { const extensionDir = path.join( process.cwd(), - '.gemini/extensions/no-commands', + '.qwen/extensions/no-commands', ); mock({ [extensionDir]: { - 'gemini-extension.json': JSON.stringify({ + 'qwen-extension.json': JSON.stringify({ name: 'no-commands', version: '1.0.0', }), @@ -684,11 +757,11 @@ describe('FileCommandLoader', () => { }); it('handles nested command structure in extensions', async () => { - const extensionDir = path.join(process.cwd(), '.gemini/extensions/a'); + const extensionDir = path.join(process.cwd(), '.qwen/extensions/a'); mock({ [extensionDir]: { - 'gemini-extension.json': JSON.stringify({ + 'qwen-extension.json': JSON.stringify({ name: 'a', version: '1.0.0', }), @@ -733,7 +806,9 @@ describe('FileCommandLoader', () => { '', ); if (result?.type === 'submit_prompt') { - expect(result.content).toBe('Nested command from extension a'); + expect(result.content).toEqual([ + { text: 'Nested command from extension a' }, + ]); } else { assert.fail('Incorrect action type'); } @@ -742,7 +817,7 @@ describe('FileCommandLoader', () => { describe('Argument Handling Integration (via ShellProcessor)', () => { it('correctly processes a command with {{args}}', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'shorthand.toml': @@ -767,14 +842,16 @@ describe('FileCommandLoader', () => { ); expect(result?.type).toBe('submit_prompt'); if (result?.type === 'submit_prompt') { - expect(result.content).toBe('The user wants to: do something cool'); + expect(result.content).toEqual([ + { text: 'The user wants to: do something cool' }, + ]); } }); }); describe('Default Argument Processor Integration', () => { it('correctly processes a command without {{args}}', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'model_led.toml': @@ -801,14 +878,14 @@ describe('FileCommandLoader', () => { if (result?.type === 'submit_prompt') { const expectedContent = 'This is the instruction.\n\n/model_led 1.2.0 added "a feature"'; - expect(result.content).toBe(expectedContent); + expect(result.content).toEqual([{ text: expectedContent }]); } }); }); describe('Shell Processor Integration', () => { it('instantiates ShellProcessor if {{args}} is present (even without shell trigger)', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'args_only.toml': `prompt = "Hello {{args}}"`, @@ -821,7 +898,7 @@ describe('FileCommandLoader', () => { expect(ShellProcessor).toHaveBeenCalledWith('args_only'); }); it('instantiates ShellProcessor if the trigger is present', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'shell.toml': `prompt = "Run this: ${SHELL_INJECTION_TRIGGER}echo hello}"`, @@ -835,7 +912,7 @@ describe('FileCommandLoader', () => { }); it('does not instantiate ShellProcessor if no triggers ({{args}} or !{}) are present', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'regular.toml': `prompt = "Just a regular prompt"`, @@ -849,13 +926,13 @@ describe('FileCommandLoader', () => { }); it('returns a "submit_prompt" action if shell processing succeeds', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'shell.toml': `prompt = "Run !{echo 'hello'}"`, }, }); - mockShellProcess.mockResolvedValue('Run hello'); + mockShellProcess.mockResolvedValue([{ text: 'Run hello' }]); const loader = new FileCommandLoader(null as unknown as Config); const commands = await loader.loadCommands(signal); @@ -871,12 +948,12 @@ describe('FileCommandLoader', () => { expect(result?.type).toBe('submit_prompt'); if (result?.type === 'submit_prompt') { - expect(result.content).toBe('Run hello'); + expect(result.content).toEqual([{ text: 'Run hello' }]); } }); it('returns a "confirm_shell_commands" action if shell processing requires it', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); const rawInvocation = '/shell rm -rf /'; mock({ [userCommandsDir]: { @@ -910,7 +987,7 @@ describe('FileCommandLoader', () => { }); it('re-throws other errors from the processor', async () => { - const userCommandsDir = getUserCommandsDir(); + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { 'shell.toml': `prompt = "Run !{something}"`, @@ -934,23 +1011,36 @@ describe('FileCommandLoader', () => { ), ).rejects.toThrow('Something else went wrong'); }); - it('assembles the processor pipeline in the correct order (Shell -> Default)', async () => { - const userCommandsDir = getUserCommandsDir(); + it('assembles the processor pipeline in the correct order (AtFile -> Shell -> Default)', async () => { + const userCommandsDir = Storage.getUserCommandsDir(); mock({ [userCommandsDir]: { - // This prompt uses !{} but NOT {{args}}, so both processors should be active. + // This prompt uses !{}, @{}, but NOT {{args}}, so all processors should be active. 'pipeline.toml': ` - prompt = "Shell says: ${SHELL_INJECTION_TRIGGER}echo foo}." + prompt = "Shell says: !{echo foo}. File says: @{./bar.txt}" `, }, + './bar.txt': 'bar content', }); const defaultProcessMock = vi .fn() - .mockImplementation((p) => Promise.resolve(`${p}-default-processed`)); + .mockImplementation((p: PromptPipelineContent) => + Promise.resolve([ + { text: `${(p[0] as { text: string }).text}-default-processed` }, + ]), + ); - mockShellProcess.mockImplementation((p) => - Promise.resolve(`${p}-shell-processed`), + mockShellProcess.mockImplementation((p: PromptPipelineContent) => + Promise.resolve([ + { text: `${(p[0] as { text: string }).text}-shell-processed` }, + ]), + ); + + mockAtFileProcess.mockImplementation((p: PromptPipelineContent) => + Promise.resolve([ + { text: `${(p[0] as { text: string }).text}-at-file-processed` }, + ]), ); vi.mocked(DefaultArgumentProcessor).mockImplementation( @@ -968,35 +1058,115 @@ describe('FileCommandLoader', () => { const result = await command!.action!( createMockCommandContext({ invocation: { - raw: '/pipeline bar', + raw: '/pipeline baz', name: 'pipeline', - args: 'bar', + args: 'baz', }, }), - 'bar', + 'baz', ); + expect(mockAtFileProcess.mock.invocationCallOrder[0]).toBeLessThan( + mockShellProcess.mock.invocationCallOrder[0], + ); expect(mockShellProcess.mock.invocationCallOrder[0]).toBeLessThan( defaultProcessMock.mock.invocationCallOrder[0], ); // Verify the flow of the prompt through the processors - // 1. Shell processor runs first - expect(mockShellProcess).toHaveBeenCalledWith( - expect.stringContaining(SHELL_INJECTION_TRIGGER), + // 1. AtFile processor runs first + expect(mockAtFileProcess).toHaveBeenCalledWith( + [{ text: expect.stringContaining('@{./bar.txt}') }], expect.any(Object), ); - // 2. Default processor runs second + // 2. Shell processor runs second + expect(mockShellProcess).toHaveBeenCalledWith( + [{ text: expect.stringContaining('-at-file-processed') }], + expect.any(Object), + ); + // 3. Default processor runs third expect(defaultProcessMock).toHaveBeenCalledWith( - expect.stringContaining('-shell-processed'), + [{ text: expect.stringContaining('-shell-processed') }], expect.any(Object), ); if (result?.type === 'submit_prompt') { - expect(result.content).toContain('-shell-processed-default-processed'); + const contentAsArray = Array.isArray(result.content) + ? result.content + : [result.content]; + expect(contentAsArray.length).toBeGreaterThan(0); + const firstPart = contentAsArray[0]; + + if (typeof firstPart === 'object' && firstPart && 'text' in firstPart) { + expect(firstPart.text).toContain( + '-at-file-processed-shell-processed-default-processed', + ); + } else { + assert.fail( + 'First part of content is not a text part or is a string', + ); + } } else { assert.fail('Incorrect action type'); } }); }); + + describe('@-file Processor Integration', () => { + it('correctly processes a command with @{file}', async () => { + const userCommandsDir = Storage.getUserCommandsDir(); + mock({ + [userCommandsDir]: { + 'at-file.toml': + 'prompt = "Context from file: @{./test.txt}"\ndescription = "@-file test"', + }, + './test.txt': 'file content', + }); + + mockAtFileProcess.mockImplementation( + async (prompt: PromptPipelineContent) => { + // A simplified mock of AtFileProcessor's behavior + const textContent = (prompt[0] as { text: string }).text; + if (textContent.includes('@{./test.txt}')) { + return [ + { + text: textContent.replace('@{./test.txt}', 'file content'), + }, + ]; + } + return prompt; + }, + ); + + // Prevent default processor from interfering + vi.mocked(DefaultArgumentProcessor).mockImplementation( + () => + ({ + process: (p: PromptPipelineContent) => Promise.resolve(p), + }) as unknown as DefaultArgumentProcessor, + ); + + const loader = new FileCommandLoader(null as unknown as Config); + const commands = await loader.loadCommands(signal); + const command = commands.find((c) => c.name === 'at-file'); + expect(command).toBeDefined(); + + const result = await command!.action?.( + createMockCommandContext({ + invocation: { + raw: '/at-file', + name: 'at-file', + args: '', + }, + }), + '', + ); + expect(result?.type).toBe('submit_prompt'); + if (result?.type === 'submit_prompt') { + expect(result.content).toEqual([ + { text: 'Context from file: file content' }, + ]); + } + }); + }); }); diff --git a/packages/cli/src/services/FileCommandLoader.ts b/packages/cli/src/services/FileCommandLoader.ts index 16acf9b3..38365b96 100644 --- a/packages/cli/src/services/FileCommandLoader.ts +++ b/packages/cli/src/services/FileCommandLoader.ts @@ -4,33 +4,35 @@ * SPDX-License-Identifier: Apache-2.0 */ -import { promises as fs } from 'fs'; -import path from 'path'; +import { promises as fs } from 'node:fs'; +import path from 'node:path'; import toml from '@iarna/toml'; import { glob } from 'glob'; import { z } from 'zod'; -import { - Config, - getProjectCommandsDir, - getUserCommandsDir, -} from '@qwen-code/qwen-code-core'; -import { ICommandLoader } from './types.js'; -import { +import type { Config } from '@qwen-code/qwen-code-core'; +import { Storage } from '@qwen-code/qwen-code-core'; +import type { ICommandLoader } from './types.js'; +import type { CommandContext, - CommandKind, SlashCommand, SlashCommandActionReturn, } from '../ui/commands/types.js'; +import { CommandKind } from '../ui/commands/types.js'; import { DefaultArgumentProcessor } from './prompt-processors/argumentProcessor.js'; -import { +import type { IPromptProcessor, + PromptPipelineContent, +} from './prompt-processors/types.js'; +import { SHORTHAND_ARGS_PLACEHOLDER, SHELL_INJECTION_TRIGGER, + AT_FILE_INJECTION_TRIGGER, } from './prompt-processors/types.js'; import { ConfirmationRequiredError, ShellProcessor, } from './prompt-processors/shellProcessor.js'; +import { AtFileProcessor } from './prompt-processors/atFileProcessor.js'; interface CommandDirectory { path: string; @@ -130,11 +132,13 @@ export class FileCommandLoader implements ICommandLoader { private getCommandDirectories(): CommandDirectory[] { const dirs: CommandDirectory[] = []; + const storage = this.config?.storage ?? new Storage(this.projectRoot); + // 1. User commands - dirs.push({ path: getUserCommandsDir() }); + dirs.push({ path: Storage.getUserCommandsDir() }); // 2. Project commands (override user commands) - dirs.push({ path: getProjectCommandsDir(this.projectRoot) }); + dirs.push({ path: storage.getProjectCommandsDir() }); // 3. Extension commands (processed last to detect all conflicts) if (this.config) { @@ -225,16 +229,25 @@ export class FileCommandLoader implements ICommandLoader { const usesShellInjection = validDef.prompt.includes( SHELL_INJECTION_TRIGGER, ); + const usesAtFileInjection = validDef.prompt.includes( + AT_FILE_INJECTION_TRIGGER, + ); - // Interpolation (Shell Execution and Argument Injection) - // If the prompt uses either shell injection OR argument placeholders, - // we must use the ShellProcessor. + // 1. @-File Injection (Security First). + // This runs first to ensure we're not executing shell commands that + // could dynamically generate malicious @-paths. + if (usesAtFileInjection) { + processors.push(new AtFileProcessor(baseCommandName)); + } + + // 2. Argument and Shell Injection. + // This runs after file content has been safely injected. if (usesShellInjection || usesArgs) { processors.push(new ShellProcessor(baseCommandName)); } - // Default Argument Handling - // If NO explicit argument injection ({{args}}) was used, we append the raw invocation. + // 3. Default Argument Handling. + // Appends the raw invocation if no explicit {{args}} are used. if (!usesArgs) { processors.push(new DefaultArgumentProcessor()); } @@ -254,19 +267,24 @@ export class FileCommandLoader implements ICommandLoader { ); return { type: 'submit_prompt', - content: validDef.prompt, // Fallback to unprocessed prompt + content: [{ text: validDef.prompt }], // Fallback to unprocessed prompt }; } try { - let processedPrompt = validDef.prompt; + let processedContent: PromptPipelineContent = [ + { text: validDef.prompt }, + ]; for (const processor of processors) { - processedPrompt = await processor.process(processedPrompt, context); + processedContent = await processor.process( + processedContent, + context, + ); } return { type: 'submit_prompt', - content: processedPrompt, + content: processedContent, }; } catch (e) { // Check if it's our specific error type diff --git a/packages/cli/src/services/McpPromptLoader.test.ts b/packages/cli/src/services/McpPromptLoader.test.ts new file mode 100644 index 00000000..27a6256b --- /dev/null +++ b/packages/cli/src/services/McpPromptLoader.test.ts @@ -0,0 +1,128 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import { McpPromptLoader } from './McpPromptLoader.js'; +import type { Config } from '@qwen-code/qwen-code-core'; +import type { PromptArgument } from '@modelcontextprotocol/sdk/types.js'; +import { describe, it, expect } from 'vitest'; + +describe('McpPromptLoader', () => { + const mockConfig = {} as Config; + + describe('parseArgs', () => { + it('should handle multi-word positional arguments', () => { + const loader = new McpPromptLoader(mockConfig); + const promptArgs: PromptArgument[] = [ + { name: 'arg1', required: true }, + { name: 'arg2', required: true }, + ]; + const userArgs = 'hello world'; + const result = loader.parseArgs(userArgs, promptArgs); + expect(result).toEqual({ arg1: 'hello', arg2: 'world' }); + }); + + it('should handle quoted multi-word positional arguments', () => { + const loader = new McpPromptLoader(mockConfig); + const promptArgs: PromptArgument[] = [ + { name: 'arg1', required: true }, + { name: 'arg2', required: true }, + ]; + const userArgs = '"hello world" foo'; + const result = loader.parseArgs(userArgs, promptArgs); + expect(result).toEqual({ arg1: 'hello world', arg2: 'foo' }); + }); + + it('should handle a single positional argument with multiple words', () => { + const loader = new McpPromptLoader(mockConfig); + const promptArgs: PromptArgument[] = [{ name: 'arg1', required: true }]; + const userArgs = 'hello world'; + const result = loader.parseArgs(userArgs, promptArgs); + expect(result).toEqual({ arg1: 'hello world' }); + }); + + it('should handle escaped quotes in positional arguments', () => { + const loader = new McpPromptLoader(mockConfig); + const promptArgs: PromptArgument[] = [{ name: 'arg1', required: true }]; + const userArgs = '"hello \\"world\\""'; + const result = loader.parseArgs(userArgs, promptArgs); + expect(result).toEqual({ arg1: 'hello "world"' }); + }); + + it('should handle escaped backslashes in positional arguments', () => { + const loader = new McpPromptLoader(mockConfig); + const promptArgs: PromptArgument[] = [{ name: 'arg1', required: true }]; + const userArgs = '"hello\\\\world"'; + const result = loader.parseArgs(userArgs, promptArgs); + expect(result).toEqual({ arg1: 'hello\\world' }); + }); + + it('should handle named args followed by positional args', () => { + const loader = new McpPromptLoader(mockConfig); + const promptArgs: PromptArgument[] = [ + { name: 'named', required: true }, + { name: 'pos', required: true }, + ]; + const userArgs = '--named="value" positional'; + const result = loader.parseArgs(userArgs, promptArgs); + expect(result).toEqual({ named: 'value', pos: 'positional' }); + }); + + it('should handle positional args followed by named args', () => { + const loader = new McpPromptLoader(mockConfig); + const promptArgs: PromptArgument[] = [ + { name: 'pos', required: true }, + { name: 'named', required: true }, + ]; + const userArgs = 'positional --named="value"'; + const result = loader.parseArgs(userArgs, promptArgs); + expect(result).toEqual({ pos: 'positional', named: 'value' }); + }); + + it('should handle positional args interspersed with named args', () => { + const loader = new McpPromptLoader(mockConfig); + const promptArgs: PromptArgument[] = [ + { name: 'pos1', required: true }, + { name: 'named', required: true }, + { name: 'pos2', required: true }, + ]; + const userArgs = 'p1 --named="value" p2'; + const result = loader.parseArgs(userArgs, promptArgs); + expect(result).toEqual({ pos1: 'p1', named: 'value', pos2: 'p2' }); + }); + + it('should treat an escaped quote at the start as a literal', () => { + const loader = new McpPromptLoader(mockConfig); + const promptArgs: PromptArgument[] = [ + { name: 'arg1', required: true }, + { name: 'arg2', required: true }, + ]; + const userArgs = '\\"hello world'; + const result = loader.parseArgs(userArgs, promptArgs); + expect(result).toEqual({ arg1: '"hello', arg2: 'world' }); + }); + + it('should handle a complex mix of args', () => { + const loader = new McpPromptLoader(mockConfig); + const promptArgs: PromptArgument[] = [ + { name: 'pos1', required: true }, + { name: 'named1', required: true }, + { name: 'pos2', required: true }, + { name: 'named2', required: true }, + { name: 'pos3', required: true }, + ]; + const userArgs = + 'p1 --named1="value 1" "p2 has spaces" --named2=value2 "p3 \\"with quotes\\""'; + const result = loader.parseArgs(userArgs, promptArgs); + expect(result).toEqual({ + pos1: 'p1', + named1: 'value 1', + pos2: 'p2 has spaces', + named2: 'value2', + pos3: 'p3 "with quotes"', + }); + }); + }); +}); diff --git a/packages/cli/src/services/McpPromptLoader.ts b/packages/cli/src/services/McpPromptLoader.ts index 65fcd714..349145f0 100644 --- a/packages/cli/src/services/McpPromptLoader.ts +++ b/packages/cli/src/services/McpPromptLoader.ts @@ -4,19 +4,19 @@ * SPDX-License-Identifier: Apache-2.0 */ +import type { Config } from '@qwen-code/qwen-code-core'; import { - Config, getErrorMessage, getMCPServerPrompts, } from '@qwen-code/qwen-code-core'; -import { +import type { CommandContext, - CommandKind, SlashCommand, SlashCommandActionReturn, } from '../ui/commands/types.js'; -import { ICommandLoader } from './types.js'; -import { PromptArgument } from '@modelcontextprotocol/sdk/types.js'; +import { CommandKind } from '../ui/commands/types.js'; +import type { ICommandLoader } from './types.js'; +import type { PromptArgument } from '@modelcontextprotocol/sdk/types.js'; /** * Discovers and loads executable slash commands from prompts exposed by @@ -169,7 +169,16 @@ export class McpPromptLoader implements ICommandLoader { return Promise.resolve(promptCommands); } - private parseArgs( + /** + * Parses the `userArgs` string representing the prompt arguments (all the text + * after the command) into a record matching the shape of the `promptArgs`. + * + * @param userArgs + * @param promptArgs + * @returns A record of the parsed arguments + * @visibleForTesting + */ + parseArgs( userArgs: string, promptArgs: PromptArgument[] | undefined, ): Record | Error { @@ -177,28 +186,36 @@ export class McpPromptLoader implements ICommandLoader { const promptInputs: Record = {}; // arg parsing: --key="value" or --key=value - const namedArgRegex = /--([^=]+)=(?:"((?:\\.|[^"\\])*)"|([^ ]*))/g; + const namedArgRegex = /--([^=]+)=(?:"((?:\\.|[^"\\])*)"|([^ ]+))/g; let match; - const remainingArgs: string[] = []; let lastIndex = 0; + const positionalParts: string[] = []; while ((match = namedArgRegex.exec(userArgs)) !== null) { const key = match[1]; - const value = match[2] ?? match[3]; // Quoted or unquoted value + // Extract the quoted or unquoted argument and remove escape chars. + const value = (match[2] ?? match[3]).replace(/\\(.)/g, '$1'); argValues[key] = value; // Capture text between matches as potential positional args if (match.index > lastIndex) { - remainingArgs.push(userArgs.substring(lastIndex, match.index).trim()); + positionalParts.push(userArgs.substring(lastIndex, match.index)); } lastIndex = namedArgRegex.lastIndex; } // Capture any remaining text after the last named arg if (lastIndex < userArgs.length) { - remainingArgs.push(userArgs.substring(lastIndex).trim()); + positionalParts.push(userArgs.substring(lastIndex)); } - const positionalArgs = remainingArgs.join(' ').split(/ +/); + const positionalArgsString = positionalParts.join('').trim(); + // extracts either quoted strings or non-quoted sequences of non-space characters. + const positionalArgRegex = /(?:"((?:\\.|[^"\\])*)"|([^ ]+))/g; + const positionalArgs: string[] = []; + while ((match = positionalArgRegex.exec(positionalArgsString)) !== null) { + // Extract the quoted or unquoted argument and remove escape chars. + positionalArgs.push((match[1] ?? match[2]).replace(/\\(.)/g, '$1')); + } if (!promptArgs) { return promptInputs; @@ -213,19 +230,27 @@ export class McpPromptLoader implements ICommandLoader { (arg) => arg.required && !promptInputs[arg.name], ); - const missingArgs: string[] = []; - for (let i = 0; i < unfilledArgs.length; i++) { - if (positionalArgs.length > i && positionalArgs[i]) { - promptInputs[unfilledArgs[i].name] = positionalArgs[i]; - } else { - missingArgs.push(unfilledArgs[i].name); + if (unfilledArgs.length === 1) { + // If we have only one unfilled arg, we don't require quotes we just + // join all the given arguments together as if they were quoted. + promptInputs[unfilledArgs[0].name] = positionalArgs.join(' '); + } else { + const missingArgs: string[] = []; + for (let i = 0; i < unfilledArgs.length; i++) { + if (positionalArgs.length > i) { + promptInputs[unfilledArgs[i].name] = positionalArgs[i]; + } else { + missingArgs.push(unfilledArgs[i].name); + } + } + if (missingArgs.length > 0) { + const missingArgNames = missingArgs + .map((name) => `--${name}`) + .join(', '); + return new Error(`Missing required argument(s): ${missingArgNames}`); } } - if (missingArgs.length > 0) { - const missingArgNames = missingArgs.map((name) => `--${name}`).join(', '); - return new Error(`Missing required argument(s): ${missingArgNames}`); - } return promptInputs; } } diff --git a/packages/cli/src/services/prompt-processors/argumentProcessor.test.ts b/packages/cli/src/services/prompt-processors/argumentProcessor.test.ts index 1a4c0c6b..80bde128 100644 --- a/packages/cli/src/services/prompt-processors/argumentProcessor.test.ts +++ b/packages/cli/src/services/prompt-processors/argumentProcessor.test.ts @@ -13,7 +13,7 @@ describe('Argument Processors', () => { const processor = new DefaultArgumentProcessor(); it('should append the full command if args are provided', async () => { - const prompt = 'Parse the command.'; + const prompt = [{ text: 'Parse the command.' }]; const context = createMockCommandContext({ invocation: { raw: '/mycommand arg1 "arg two"', @@ -22,11 +22,13 @@ describe('Argument Processors', () => { }, }); const result = await processor.process(prompt, context); - expect(result).toBe('Parse the command.\n\n/mycommand arg1 "arg two"'); + expect(result).toEqual([ + { text: 'Parse the command.\n\n/mycommand arg1 "arg two"' }, + ]); }); it('should NOT append the full command if no args are provided', async () => { - const prompt = 'Parse the command.'; + const prompt = [{ text: 'Parse the command.' }]; const context = createMockCommandContext({ invocation: { raw: '/mycommand', @@ -35,7 +37,7 @@ describe('Argument Processors', () => { }, }); const result = await processor.process(prompt, context); - expect(result).toBe('Parse the command.'); + expect(result).toEqual([{ text: 'Parse the command.' }]); }); }); }); diff --git a/packages/cli/src/services/prompt-processors/argumentProcessor.ts b/packages/cli/src/services/prompt-processors/argumentProcessor.ts index 9d5fc369..5265eaeb 100644 --- a/packages/cli/src/services/prompt-processors/argumentProcessor.ts +++ b/packages/cli/src/services/prompt-processors/argumentProcessor.ts @@ -4,8 +4,9 @@ * SPDX-License-Identifier: Apache-2.0 */ -import { IPromptProcessor } from './types.js'; -import { CommandContext } from '../../ui/commands/types.js'; +import { appendToLastTextPart } from '@qwen-code/qwen-code-core'; +import type { IPromptProcessor, PromptPipelineContent } from './types.js'; +import type { CommandContext } from '../../ui/commands/types.js'; /** * Appends the user's full command invocation to the prompt if arguments are @@ -14,9 +15,12 @@ import { CommandContext } from '../../ui/commands/types.js'; * This processor is only used if the prompt does NOT contain {{args}}. */ export class DefaultArgumentProcessor implements IPromptProcessor { - async process(prompt: string, context: CommandContext): Promise { - if (context.invocation!.args) { - return `${prompt}\n\n${context.invocation!.raw}`; + async process( + prompt: PromptPipelineContent, + context: CommandContext, + ): Promise { + if (context.invocation?.args) { + return appendToLastTextPart(prompt, context.invocation.raw); } return prompt; } diff --git a/packages/cli/src/services/prompt-processors/atFileProcessor.test.ts b/packages/cli/src/services/prompt-processors/atFileProcessor.test.ts new file mode 100644 index 00000000..0a50308c --- /dev/null +++ b/packages/cli/src/services/prompt-processors/atFileProcessor.test.ts @@ -0,0 +1,221 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import { describe, it, expect, beforeEach, vi } from 'vitest'; +import { createMockCommandContext } from '../../test-utils/mockCommandContext.js'; +import { type CommandContext } from '../../ui/commands/types.js'; +import { AtFileProcessor } from './atFileProcessor.js'; +import { MessageType } from '../../ui/types.js'; +import type { Config } from '@qwen-code/qwen-code-core'; +import type { PartUnion } from '@google/genai'; + +// Mock the core dependency +const mockReadPathFromWorkspace = vi.hoisted(() => vi.fn()); +vi.mock('@qwen-code/qwen-code-core', async (importOriginal) => { + const original = await importOriginal(); + return { + ...original, + readPathFromWorkspace: mockReadPathFromWorkspace, + }; +}); + +describe('AtFileProcessor', () => { + let context: CommandContext; + let mockConfig: Config; + + beforeEach(() => { + vi.clearAllMocks(); + + mockConfig = { + // The processor only passes the config through, so we don't need a full mock. + } as unknown as Config; + + context = createMockCommandContext({ + services: { + config: mockConfig, + }, + }); + + // Default mock success behavior: return content wrapped in a text part. + mockReadPathFromWorkspace.mockImplementation( + async (path: string): Promise => [ + { text: `content of ${path}` }, + ], + ); + }); + + it('should not change the prompt if no @{ trigger is present', async () => { + const processor = new AtFileProcessor(); + const prompt: PartUnion[] = [{ text: 'This is a simple prompt.' }]; + const result = await processor.process(prompt, context); + expect(result).toEqual(prompt); + expect(mockReadPathFromWorkspace).not.toHaveBeenCalled(); + }); + + it('should not change the prompt if config service is missing', async () => { + const processor = new AtFileProcessor(); + const prompt: PartUnion[] = [{ text: 'Analyze @{file.txt}' }]; + const contextWithoutConfig = createMockCommandContext({ + services: { + config: null, + }, + }); + const result = await processor.process(prompt, contextWithoutConfig); + expect(result).toEqual(prompt); + expect(mockReadPathFromWorkspace).not.toHaveBeenCalled(); + }); + + describe('Parsing Logic', () => { + it('should replace a single valid @{path/to/file.txt} placeholder', async () => { + const processor = new AtFileProcessor(); + const prompt: PartUnion[] = [ + { text: 'Analyze this file: @{path/to/file.txt}' }, + ]; + const result = await processor.process(prompt, context); + expect(mockReadPathFromWorkspace).toHaveBeenCalledWith( + 'path/to/file.txt', + mockConfig, + ); + expect(result).toEqual([ + { text: 'Analyze this file: ' }, + { text: 'content of path/to/file.txt' }, + ]); + }); + + it('should replace multiple different @{...} placeholders', async () => { + const processor = new AtFileProcessor(); + const prompt: PartUnion[] = [ + { text: 'Compare @{file1.js} with @{file2.js}' }, + ]; + const result = await processor.process(prompt, context); + expect(mockReadPathFromWorkspace).toHaveBeenCalledTimes(2); + expect(mockReadPathFromWorkspace).toHaveBeenCalledWith( + 'file1.js', + mockConfig, + ); + expect(mockReadPathFromWorkspace).toHaveBeenCalledWith( + 'file2.js', + mockConfig, + ); + expect(result).toEqual([ + { text: 'Compare ' }, + { text: 'content of file1.js' }, + { text: ' with ' }, + { text: 'content of file2.js' }, + ]); + }); + + it('should handle placeholders at the beginning, middle, and end', async () => { + const processor = new AtFileProcessor(); + const prompt: PartUnion[] = [ + { text: '@{start.txt} in the @{middle.txt} and @{end.txt}' }, + ]; + const result = await processor.process(prompt, context); + expect(result).toEqual([ + { text: 'content of start.txt' }, + { text: ' in the ' }, + { text: 'content of middle.txt' }, + { text: ' and ' }, + { text: 'content of end.txt' }, + ]); + }); + + it('should correctly parse paths that contain balanced braces', async () => { + const processor = new AtFileProcessor(); + const prompt: PartUnion[] = [ + { text: 'Analyze @{path/with/{braces}/file.txt}' }, + ]; + const result = await processor.process(prompt, context); + expect(mockReadPathFromWorkspace).toHaveBeenCalledWith( + 'path/with/{braces}/file.txt', + mockConfig, + ); + expect(result).toEqual([ + { text: 'Analyze ' }, + { text: 'content of path/with/{braces}/file.txt' }, + ]); + }); + + it('should throw an error if the prompt contains an unclosed trigger', async () => { + const processor = new AtFileProcessor(); + const prompt: PartUnion[] = [{ text: 'Hello @{world' }]; + // The new parser throws an error for unclosed injections. + await expect(processor.process(prompt, context)).rejects.toThrow( + /Unclosed injection/, + ); + }); + }); + + describe('Integration and Error Handling', () => { + it('should leave the placeholder unmodified if readPathFromWorkspace throws', async () => { + const processor = new AtFileProcessor(); + const prompt: PartUnion[] = [ + { text: 'Analyze @{not-found.txt} and @{good-file.txt}' }, + ]; + mockReadPathFromWorkspace.mockImplementation(async (path: string) => { + if (path === 'not-found.txt') { + throw new Error('File not found'); + } + return [{ text: `content of ${path}` }]; + }); + + const result = await processor.process(prompt, context); + expect(result).toEqual([ + { text: 'Analyze ' }, + { text: '@{not-found.txt}' }, // Placeholder is preserved as a text part + { text: ' and ' }, + { text: 'content of good-file.txt' }, + ]); + }); + }); + + describe('UI Feedback', () => { + it('should call ui.addItem with an ERROR on failure', async () => { + const processor = new AtFileProcessor(); + const prompt: PartUnion[] = [{ text: 'Analyze @{bad-file.txt}' }]; + mockReadPathFromWorkspace.mockRejectedValue(new Error('Access denied')); + + await processor.process(prompt, context); + + expect(context.ui.addItem).toHaveBeenCalledTimes(1); + expect(context.ui.addItem).toHaveBeenCalledWith( + { + type: MessageType.ERROR, + text: "Failed to inject content for '@{bad-file.txt}': Access denied", + }, + expect.any(Number), + ); + }); + + it('should call ui.addItem with a WARNING if the file was ignored', async () => { + const processor = new AtFileProcessor(); + const prompt: PartUnion[] = [{ text: 'Analyze @{ignored.txt}' }]; + // Simulate an ignored file by returning an empty array. + mockReadPathFromWorkspace.mockResolvedValue([]); + + const result = await processor.process(prompt, context); + + // The placeholder should be removed, resulting in only the prefix. + expect(result).toEqual([{ text: 'Analyze ' }]); + + expect(context.ui.addItem).toHaveBeenCalledTimes(1); + expect(context.ui.addItem).toHaveBeenCalledWith( + { + type: MessageType.INFO, + text: "File '@{ignored.txt}' was ignored by .gitignore or .qwenignore and was not included in the prompt.", + }, + expect.any(Number), + ); + }); + + it('should NOT call ui.addItem on success', async () => { + const processor = new AtFileProcessor(); + const prompt: PartUnion[] = [{ text: 'Analyze @{good-file.txt}' }]; + await processor.process(prompt, context); + expect(context.ui.addItem).not.toHaveBeenCalled(); + }); + }); +}); diff --git a/packages/cli/src/services/prompt-processors/atFileProcessor.ts b/packages/cli/src/services/prompt-processors/atFileProcessor.ts new file mode 100644 index 00000000..3d8737b1 --- /dev/null +++ b/packages/cli/src/services/prompt-processors/atFileProcessor.ts @@ -0,0 +1,96 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import { + flatMapTextParts, + readPathFromWorkspace, +} from '@qwen-code/qwen-code-core'; +import type { CommandContext } from '../../ui/commands/types.js'; +import { MessageType } from '../../ui/types.js'; +import { + AT_FILE_INJECTION_TRIGGER, + type IPromptProcessor, + type PromptPipelineContent, +} from './types.js'; +import { extractInjections } from './injectionParser.js'; + +export class AtFileProcessor implements IPromptProcessor { + constructor(private readonly commandName?: string) {} + + async process( + input: PromptPipelineContent, + context: CommandContext, + ): Promise { + const config = context.services.config; + if (!config) { + return input; + } + + return flatMapTextParts(input, async (text) => { + if (!text.includes(AT_FILE_INJECTION_TRIGGER)) { + return [{ text }]; + } + + const injections = extractInjections( + text, + AT_FILE_INJECTION_TRIGGER, + this.commandName, + ); + if (injections.length === 0) { + return [{ text }]; + } + + const output: PromptPipelineContent = []; + let lastIndex = 0; + + for (const injection of injections) { + const prefix = text.substring(lastIndex, injection.startIndex); + if (prefix) { + output.push({ text: prefix }); + } + + const pathStr = injection.content; + try { + const fileContentParts = await readPathFromWorkspace(pathStr, config); + if (fileContentParts.length === 0) { + const uiMessage = `File '@{${pathStr}}' was ignored by .gitignore or .qwenignore and was not included in the prompt.`; + context.ui.addItem( + { type: MessageType.INFO, text: uiMessage }, + Date.now(), + ); + } + output.push(...fileContentParts); + } catch (error) { + const message = + error instanceof Error ? error.message : String(error); + const uiMessage = `Failed to inject content for '@{${pathStr}}': ${message}`; + + console.error( + `[AtFileProcessor] ${uiMessage}. Leaving placeholder in prompt.`, + ); + context.ui.addItem( + { type: MessageType.ERROR, text: uiMessage }, + Date.now(), + ); + + const placeholder = text.substring( + injection.startIndex, + injection.endIndex, + ); + output.push({ text: placeholder }); + } + lastIndex = injection.endIndex; + } + + const suffix = text.substring(lastIndex); + if (suffix) { + output.push({ text: suffix }); + } + + return output; + }); + } +} diff --git a/packages/cli/src/services/prompt-processors/injectionParser.test.ts b/packages/cli/src/services/prompt-processors/injectionParser.test.ts new file mode 100644 index 00000000..5ce0f8f7 --- /dev/null +++ b/packages/cli/src/services/prompt-processors/injectionParser.test.ts @@ -0,0 +1,223 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import { describe, it, expect } from 'vitest'; +import { extractInjections } from './injectionParser.js'; + +describe('extractInjections', () => { + const SHELL_TRIGGER = '!{'; + const AT_FILE_TRIGGER = '@{'; + + describe('Basic Functionality', () => { + it('should return an empty array if no trigger is present', () => { + const prompt = 'This is a simple prompt without injections.'; + const result = extractInjections(prompt, SHELL_TRIGGER); + expect(result).toEqual([]); + }); + + it('should extract a single, simple injection', () => { + const prompt = 'Run this command: !{ls -la}'; + const result = extractInjections(prompt, SHELL_TRIGGER); + expect(result).toEqual([ + { + content: 'ls -la', + startIndex: 18, + endIndex: 27, + }, + ]); + }); + + it('should extract multiple injections', () => { + const prompt = 'First: !{cmd1}, Second: !{cmd2}'; + const result = extractInjections(prompt, SHELL_TRIGGER); + expect(result).toHaveLength(2); + expect(result[0]).toEqual({ + content: 'cmd1', + startIndex: 7, + endIndex: 14, + }); + expect(result[1]).toEqual({ + content: 'cmd2', + startIndex: 24, + endIndex: 31, + }); + }); + + it('should handle different triggers (e.g., @{)', () => { + const prompt = 'Read this file: @{path/to/file.txt}'; + const result = extractInjections(prompt, AT_FILE_TRIGGER); + expect(result).toEqual([ + { + content: 'path/to/file.txt', + startIndex: 16, + endIndex: 35, + }, + ]); + }); + }); + + describe('Positioning and Edge Cases', () => { + it('should handle injections at the start and end of the prompt', () => { + const prompt = '!{start} middle text !{end}'; + const result = extractInjections(prompt, SHELL_TRIGGER); + expect(result).toHaveLength(2); + expect(result[0]).toEqual({ + content: 'start', + startIndex: 0, + endIndex: 8, + }); + expect(result[1]).toEqual({ + content: 'end', + startIndex: 21, + endIndex: 27, + }); + }); + + it('should handle adjacent injections', () => { + const prompt = '!{A}!{B}'; + const result = extractInjections(prompt, SHELL_TRIGGER); + expect(result).toHaveLength(2); + expect(result[0]).toEqual({ content: 'A', startIndex: 0, endIndex: 4 }); + expect(result[1]).toEqual({ content: 'B', startIndex: 4, endIndex: 8 }); + }); + + it('should handle empty injections', () => { + const prompt = 'Empty: !{}'; + const result = extractInjections(prompt, SHELL_TRIGGER); + expect(result).toEqual([ + { + content: '', + startIndex: 7, + endIndex: 10, + }, + ]); + }); + + it('should trim whitespace within the content', () => { + const prompt = '!{ \n command with space \t }'; + const result = extractInjections(prompt, SHELL_TRIGGER); + expect(result).toEqual([ + { + content: 'command with space', + startIndex: 0, + endIndex: 29, + }, + ]); + }); + + it('should ignore similar patterns that are not the exact trigger', () => { + const prompt = 'Not a trigger: !(cmd) or {cmd} or ! {cmd}'; + const result = extractInjections(prompt, SHELL_TRIGGER); + expect(result).toEqual([]); + }); + + it('should ignore extra closing braces before the trigger', () => { + const prompt = 'Ignore this } then !{run}'; + const result = extractInjections(prompt, SHELL_TRIGGER); + expect(result).toEqual([ + { + content: 'run', + startIndex: 19, + endIndex: 25, + }, + ]); + }); + + it('should stop parsing at the first balanced closing brace (non-greedy)', () => { + // This tests that the parser doesn't greedily consume extra closing braces + const prompt = 'Run !{ls -l}} extra braces'; + const result = extractInjections(prompt, SHELL_TRIGGER); + expect(result).toEqual([ + { + content: 'ls -l', + startIndex: 4, + endIndex: 12, + }, + ]); + }); + }); + + describe('Nested Braces (Balanced)', () => { + it('should correctly parse content with simple nested braces (e.g., JSON)', () => { + const prompt = `Send JSON: !{curl -d '{"key": "value"}'}`; + const result = extractInjections(prompt, SHELL_TRIGGER); + expect(result).toHaveLength(1); + expect(result[0].content).toBe(`curl -d '{"key": "value"}'`); + }); + + it('should correctly parse content with shell constructs (e.g., awk)', () => { + const prompt = `Process text: !{awk '{print $1}' file.txt}`; + const result = extractInjections(prompt, SHELL_TRIGGER); + expect(result).toHaveLength(1); + expect(result[0].content).toBe(`awk '{print $1}' file.txt`); + }); + + it('should correctly parse multiple levels of nesting', () => { + const prompt = `!{level1 {level2 {level3}} suffix}`; + const result = extractInjections(prompt, SHELL_TRIGGER); + expect(result).toHaveLength(1); + expect(result[0].content).toBe(`level1 {level2 {level3}} suffix`); + expect(result[0].endIndex).toBe(prompt.length); + }); + + it('should correctly parse paths containing balanced braces', () => { + const prompt = 'Analyze @{path/with/{braces}/file.txt}'; + const result = extractInjections(prompt, AT_FILE_TRIGGER); + expect(result).toHaveLength(1); + expect(result[0].content).toBe('path/with/{braces}/file.txt'); + }); + + it('should correctly handle an injection containing the trigger itself', () => { + // This works because the parser counts braces, it doesn't look for the trigger again until the current one is closed. + const prompt = '!{echo "The trigger is !{ confusing }"}'; + const expectedContent = 'echo "The trigger is !{ confusing }"'; + const result = extractInjections(prompt, SHELL_TRIGGER); + expect(result).toHaveLength(1); + expect(result[0].content).toBe(expectedContent); + }); + }); + + describe('Error Handling (Unbalanced/Unclosed)', () => { + it('should throw an error for a simple unclosed injection', () => { + const prompt = 'This prompt has !{an unclosed trigger'; + expect(() => extractInjections(prompt, SHELL_TRIGGER)).toThrow( + /Invalid syntax: Unclosed injection starting at index 16 \('!{'\)/, + ); + }); + + it('should throw an error if the prompt ends inside a nested block', () => { + const prompt = 'This fails: !{outer {inner'; + expect(() => extractInjections(prompt, SHELL_TRIGGER)).toThrow( + /Invalid syntax: Unclosed injection starting at index 12 \('!{'\)/, + ); + }); + + it('should include the context name in the error message if provided', () => { + const prompt = 'Failing !{command'; + const contextName = 'test-command'; + expect(() => + extractInjections(prompt, SHELL_TRIGGER, contextName), + ).toThrow( + /Invalid syntax in command 'test-command': Unclosed injection starting at index 8/, + ); + }); + + it('should throw if content contains unbalanced braces (e.g., missing closing)', () => { + // This is functionally the same as an unclosed injection from the parser's perspective. + const prompt = 'Analyze @{path/with/braces{example.txt}'; + expect(() => extractInjections(prompt, AT_FILE_TRIGGER)).toThrow( + /Invalid syntax: Unclosed injection starting at index 8 \('@{'\)/, + ); + }); + + it('should clearly state that unbalanced braces in content are not supported in the error', () => { + const prompt = 'Analyze @{path/with/braces{example.txt}'; + expect(() => extractInjections(prompt, AT_FILE_TRIGGER)).toThrow( + /Paths or commands with unbalanced braces are not supported directly/, + ); + }); + }); +}); diff --git a/packages/cli/src/services/prompt-processors/injectionParser.ts b/packages/cli/src/services/prompt-processors/injectionParser.ts new file mode 100644 index 00000000..52d3226d --- /dev/null +++ b/packages/cli/src/services/prompt-processors/injectionParser.ts @@ -0,0 +1,89 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +/** + * Represents a single detected injection site in a prompt string. + */ +export interface Injection { + /** The content extracted from within the braces (e.g., the command or path), trimmed. */ + content: string; + /** The starting index of the injection (inclusive, points to the start of the trigger). */ + startIndex: number; + /** The ending index of the injection (exclusive, points after the closing '}'). */ + endIndex: number; +} + +/** + * Iteratively parses a prompt string to extract injections (e.g., !{...} or @{...}), + * correctly handling nested braces within the content. + * + * This parser relies on simple brace counting and does not support escaping. + * + * @param prompt The prompt string to parse. + * @param trigger The opening trigger sequence (e.g., '!{', '@{'). + * @param contextName Optional context name (e.g., command name) for error messages. + * @returns An array of extracted Injection objects. + * @throws Error if an unclosed injection is found. + */ +export function extractInjections( + prompt: string, + trigger: string, + contextName?: string, +): Injection[] { + const injections: Injection[] = []; + let index = 0; + + while (index < prompt.length) { + const startIndex = prompt.indexOf(trigger, index); + + if (startIndex === -1) { + break; + } + + let currentIndex = startIndex + trigger.length; + let braceCount = 1; + let foundEnd = false; + + while (currentIndex < prompt.length) { + const char = prompt[currentIndex]; + + if (char === '{') { + braceCount++; + } else if (char === '}') { + braceCount--; + if (braceCount === 0) { + const injectionContent = prompt.substring( + startIndex + trigger.length, + currentIndex, + ); + const endIndex = currentIndex + 1; + + injections.push({ + content: injectionContent.trim(), + startIndex, + endIndex, + }); + + index = endIndex; + foundEnd = true; + break; + } + } + currentIndex++; + } + + // Check if the inner loop finished without finding the closing brace. + if (!foundEnd) { + const contextInfo = contextName ? ` in command '${contextName}'` : ''; + // Enforce strict parsing (Comment 1) and clarify limitations (Comment 2). + throw new Error( + `Invalid syntax${contextInfo}: Unclosed injection starting at index ${startIndex} ('${trigger}'). Ensure braces are balanced. Paths or commands with unbalanced braces are not supported directly.`, + ); + } + } + + return injections; +} diff --git a/packages/cli/src/services/prompt-processors/shellProcessor.test.ts b/packages/cli/src/services/prompt-processors/shellProcessor.test.ts index f557c795..54b1830f 100644 --- a/packages/cli/src/services/prompt-processors/shellProcessor.test.ts +++ b/packages/cli/src/services/prompt-processors/shellProcessor.test.ts @@ -7,14 +7,16 @@ import { describe, it, expect, beforeEach, vi, type Mock } from 'vitest'; import { ConfirmationRequiredError, ShellProcessor } from './shellProcessor.js'; import { createMockCommandContext } from '../../test-utils/mockCommandContext.js'; -import { CommandContext } from '../../ui/commands/types.js'; -import { ApprovalMode, Config } from '@qwen-code/qwen-code-core'; -import os from 'os'; +import type { CommandContext } from '../../ui/commands/types.js'; +import type { Config } from '@qwen-code/qwen-code-core'; +import { ApprovalMode } from '@qwen-code/qwen-code-core'; +import os from 'node:os'; import { quote } from 'shell-quote'; +import { createPartFromText } from '@google/genai'; +import type { PromptPipelineContent } from './types.js'; // Helper function to determine the expected escaped string based on the current OS, -// mirroring the logic in the actual `escapeShellArg` implementation. This makes -// our tests robust and platform-agnostic. +// mirroring the logic in the actual `escapeShellArg` implementation. function getExpectedEscapedArgForPlatform(arg: string): string { if (os.platform() === 'win32') { const comSpec = (process.env['ComSpec'] || 'cmd.exe').toLowerCase(); @@ -31,6 +33,11 @@ function getExpectedEscapedArgForPlatform(arg: string): string { } } +// Helper to create PromptPipelineContent +function createPromptPipelineContent(text: string): PromptPipelineContent { + return [createPartFromText(text)]; +} + const mockCheckCommandPermissions = vi.hoisted(() => vi.fn()); const mockShellExecute = vi.hoisted(() => vi.fn()); @@ -92,7 +99,7 @@ describe('ShellProcessor', () => { it('should throw an error if config is missing', async () => { const processor = new ShellProcessor('test-command'); - const prompt = '!{ls}'; + const prompt: PromptPipelineContent = createPromptPipelineContent('!{ls}'); const contextWithoutConfig = createMockCommandContext({ services: { config: null, @@ -106,15 +113,19 @@ describe('ShellProcessor', () => { it('should not change the prompt if no shell injections are present', async () => { const processor = new ShellProcessor('test-command'); - const prompt = 'This is a simple prompt with no injections.'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + 'This is a simple prompt with no injections.', + ); const result = await processor.process(prompt, context); - expect(result).toBe(prompt); + expect(result).toEqual(prompt); expect(mockShellExecute).not.toHaveBeenCalled(); }); it('should process a single valid shell injection if allowed', async () => { const processor = new ShellProcessor('test-command'); - const prompt = 'The current status is: !{git status}'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + 'The current status is: !{git status}', + ); mockCheckCommandPermissions.mockReturnValue({ allAllowed: true, disallowedCommands: [], @@ -137,12 +148,14 @@ describe('ShellProcessor', () => { expect.any(Object), false, ); - expect(result).toBe('The current status is: On branch main'); + expect(result).toEqual([{ text: 'The current status is: On branch main' }]); }); it('should process multiple valid shell injections if all are allowed', async () => { const processor = new ShellProcessor('test-command'); - const prompt = '!{git status} in !{pwd}'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + '!{git status} in !{pwd}', + ); mockCheckCommandPermissions.mockReturnValue({ allAllowed: true, disallowedCommands: [], @@ -163,12 +176,14 @@ describe('ShellProcessor', () => { expect(mockCheckCommandPermissions).toHaveBeenCalledTimes(2); expect(mockShellExecute).toHaveBeenCalledTimes(2); - expect(result).toBe('On branch main in /usr/home'); + expect(result).toEqual([{ text: 'On branch main in /usr/home' }]); }); it('should throw ConfirmationRequiredError if a command is not allowed in default mode', async () => { const processor = new ShellProcessor('test-command'); - const prompt = 'Do something dangerous: !{rm -rf /}'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + 'Do something dangerous: !{rm -rf /}', + ); mockCheckCommandPermissions.mockReturnValue({ allAllowed: false, disallowedCommands: ['rm -rf /'], @@ -181,7 +196,9 @@ describe('ShellProcessor', () => { it('should NOT throw ConfirmationRequiredError if a command is not allowed but approval mode is YOLO', async () => { const processor = new ShellProcessor('test-command'); - const prompt = 'Do something dangerous: !{rm -rf /}'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + 'Do something dangerous: !{rm -rf /}', + ); mockCheckCommandPermissions.mockReturnValue({ allAllowed: false, disallowedCommands: ['rm -rf /'], @@ -202,12 +219,14 @@ describe('ShellProcessor', () => { expect.any(Object), false, ); - expect(result).toBe('Do something dangerous: deleted'); + expect(result).toEqual([{ text: 'Do something dangerous: deleted' }]); }); it('should still throw an error for a hard-denied command even in YOLO mode', async () => { const processor = new ShellProcessor('test-command'); - const prompt = 'Do something forbidden: !{reboot}'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + 'Do something forbidden: !{reboot}', + ); mockCheckCommandPermissions.mockReturnValue({ allAllowed: false, disallowedCommands: ['reboot'], @@ -227,7 +246,9 @@ describe('ShellProcessor', () => { it('should throw ConfirmationRequiredError with the correct command', async () => { const processor = new ShellProcessor('test-command'); - const prompt = 'Do something dangerous: !{rm -rf /}'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + 'Do something dangerous: !{rm -rf /}', + ); mockCheckCommandPermissions.mockReturnValue({ allAllowed: false, disallowedCommands: ['rm -rf /'], @@ -249,7 +270,9 @@ describe('ShellProcessor', () => { it('should throw ConfirmationRequiredError with multiple commands if multiple are disallowed', async () => { const processor = new ShellProcessor('test-command'); - const prompt = '!{cmd1} and !{cmd2}'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + '!{cmd1} and !{cmd2}', + ); mockCheckCommandPermissions.mockImplementation((cmd) => { if (cmd === 'cmd1') { return { allAllowed: false, disallowedCommands: ['cmd1'] }; @@ -274,7 +297,9 @@ describe('ShellProcessor', () => { it('should not execute any commands if at least one requires confirmation', async () => { const processor = new ShellProcessor('test-command'); - const prompt = 'First: !{echo "hello"}, Second: !{rm -rf /}'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + 'First: !{echo "hello"}, Second: !{rm -rf /}', + ); mockCheckCommandPermissions.mockImplementation((cmd) => { if (cmd.includes('rm')) { @@ -293,7 +318,9 @@ describe('ShellProcessor', () => { it('should only request confirmation for disallowed commands in a mixed prompt', async () => { const processor = new ShellProcessor('test-command'); - const prompt = 'Allowed: !{ls -l}, Disallowed: !{rm -rf /}'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + 'Allowed: !{ls -l}, Disallowed: !{rm -rf /}', + ); mockCheckCommandPermissions.mockImplementation((cmd) => ({ allAllowed: !cmd.includes('rm'), @@ -313,7 +340,9 @@ describe('ShellProcessor', () => { it('should execute all commands if they are on the session allowlist', async () => { const processor = new ShellProcessor('test-command'); - const prompt = 'Run !{cmd1} and !{cmd2}'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + 'Run !{cmd1} and !{cmd2}', + ); // Add commands to the session allowlist context.session.sessionShellAllowlist = new Set(['cmd1', 'cmd2']); @@ -345,12 +374,14 @@ describe('ShellProcessor', () => { context.session.sessionShellAllowlist, ); expect(mockShellExecute).toHaveBeenCalledTimes(2); - expect(result).toBe('Run output1 and output2'); + expect(result).toEqual([{ text: 'Run output1 and output2' }]); }); it('should trim whitespace from the command inside the injection before interpolation', async () => { const processor = new ShellProcessor('test-command'); - const prompt = 'Files: !{ ls {{args}} -l }'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + 'Files: !{ ls {{args}} -l }', + ); const rawArgs = context.invocation!.args; @@ -384,7 +415,8 @@ describe('ShellProcessor', () => { it('should handle an empty command inside the injection gracefully (skips execution)', async () => { const processor = new ShellProcessor('test-command'); - const prompt = 'This is weird: !{}'; + const prompt: PromptPipelineContent = + createPromptPipelineContent('This is weird: !{}'); const result = await processor.process(prompt, context); @@ -392,77 +424,14 @@ describe('ShellProcessor', () => { expect(mockShellExecute).not.toHaveBeenCalled(); // It replaces !{} with an empty string. - expect(result).toBe('This is weird: '); - }); - - describe('Robust Parsing (Balanced Braces)', () => { - it('should correctly parse commands containing nested braces (e.g., awk)', async () => { - const processor = new ShellProcessor('test-command'); - const command = "awk '{print $1}' file.txt"; - const prompt = `Output: !{${command}}`; - mockShellExecute.mockReturnValue({ - result: Promise.resolve({ ...SUCCESS_RESULT, output: 'result' }), - }); - - const result = await processor.process(prompt, context); - - expect(mockCheckCommandPermissions).toHaveBeenCalledWith( - command, - expect.any(Object), - context.session.sessionShellAllowlist, - ); - expect(mockShellExecute).toHaveBeenCalledWith( - command, - expect.any(String), - expect.any(Function), - expect.any(Object), - false, - ); - expect(result).toBe('Output: result'); - }); - - it('should handle deeply nested braces correctly', async () => { - const processor = new ShellProcessor('test-command'); - const command = "echo '{{a},{b}}'"; - const prompt = `!{${command}}`; - mockShellExecute.mockReturnValue({ - result: Promise.resolve({ ...SUCCESS_RESULT, output: '{{a},{b}}' }), - }); - - const result = await processor.process(prompt, context); - expect(mockShellExecute).toHaveBeenCalledWith( - command, - expect.any(String), - expect.any(Function), - expect.any(Object), - false, - ); - expect(result).toBe('{{a},{b}}'); - }); - - it('should throw an error for unclosed shell injections', async () => { - const processor = new ShellProcessor('test-command'); - const prompt = 'This prompt is broken: !{ls -l'; - - await expect(processor.process(prompt, context)).rejects.toThrow( - /Unclosed shell injection/, - ); - }); - - it('should throw an error for unclosed nested braces', async () => { - const processor = new ShellProcessor('test-command'); - const prompt = 'Broken: !{echo {a}'; - - await expect(processor.process(prompt, context)).rejects.toThrow( - /Unclosed shell injection/, - ); - }); + expect(result).toEqual([{ text: 'This is weird: ' }]); }); describe('Error Reporting', () => { it('should append exit code and command name on failure', async () => { const processor = new ShellProcessor('test-command'); - const prompt = '!{cmd}'; + const prompt: PromptPipelineContent = + createPromptPipelineContent('!{cmd}'); mockShellExecute.mockReturnValue({ result: Promise.resolve({ ...SUCCESS_RESULT, @@ -474,14 +443,17 @@ describe('ShellProcessor', () => { const result = await processor.process(prompt, context); - expect(result).toBe( - "some error output\n[Shell command 'cmd' exited with code 1]", - ); + expect(result).toEqual([ + { + text: "some error output\n[Shell command 'cmd' exited with code 1]", + }, + ]); }); it('should append signal info and command name if terminated by signal', async () => { const processor = new ShellProcessor('test-command'); - const prompt = '!{cmd}'; + const prompt: PromptPipelineContent = + createPromptPipelineContent('!{cmd}'); mockShellExecute.mockReturnValue({ result: Promise.resolve({ ...SUCCESS_RESULT, @@ -494,14 +466,17 @@ describe('ShellProcessor', () => { const result = await processor.process(prompt, context); - expect(result).toBe( - "output\n[Shell command 'cmd' terminated by signal SIGTERM]", - ); + expect(result).toEqual([ + { + text: "output\n[Shell command 'cmd' terminated by signal SIGTERM]", + }, + ]); }); it('should throw a detailed error if the shell fails to spawn', async () => { const processor = new ShellProcessor('test-command'); - const prompt = '!{bad-command}'; + const prompt: PromptPipelineContent = + createPromptPipelineContent('!{bad-command}'); const spawnError = new Error('spawn EACCES'); mockShellExecute.mockReturnValue({ result: Promise.resolve({ @@ -521,7 +496,9 @@ describe('ShellProcessor', () => { it('should report abort status with command name if aborted', async () => { const processor = new ShellProcessor('test-command'); - const prompt = '!{long-running-command}'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + '!{long-running-command}', + ); const spawnError = new Error('Aborted'); mockShellExecute.mockReturnValue({ result: Promise.resolve({ @@ -535,9 +512,11 @@ describe('ShellProcessor', () => { }); const result = await processor.process(prompt, context); - expect(result).toBe( - "partial output\n[Shell command 'long-running-command' aborted]", - ); + expect(result).toEqual([ + { + text: "partial output\n[Shell command 'long-running-command' aborted]", + }, + ]); }); }); @@ -551,29 +530,35 @@ describe('ShellProcessor', () => { it('should perform raw replacement if no shell injections are present (optimization path)', async () => { const processor = new ShellProcessor('test-command'); - const prompt = 'The user said: {{args}}'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + 'The user said: {{args}}', + ); const result = await processor.process(prompt, context); - expect(result).toBe(`The user said: ${rawArgs}`); + expect(result).toEqual([{ text: `The user said: ${rawArgs}` }]); expect(mockShellExecute).not.toHaveBeenCalled(); }); it('should perform raw replacement outside !{} blocks', async () => { const processor = new ShellProcessor('test-command'); - const prompt = 'Outside: {{args}}. Inside: !{echo "hello"}'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + 'Outside: {{args}}. Inside: !{echo "hello"}', + ); mockShellExecute.mockReturnValue({ result: Promise.resolve({ ...SUCCESS_RESULT, output: 'hello' }), }); const result = await processor.process(prompt, context); - expect(result).toBe(`Outside: ${rawArgs}. Inside: hello`); + expect(result).toEqual([{ text: `Outside: ${rawArgs}. Inside: hello` }]); }); it('should perform escaped replacement inside !{} blocks', async () => { const processor = new ShellProcessor('test-command'); - const prompt = 'Command: !{grep {{args}} file.txt}'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + 'Command: !{grep {{args}} file.txt}', + ); mockShellExecute.mockReturnValue({ result: Promise.resolve({ ...SUCCESS_RESULT, output: 'match found' }), }); @@ -591,12 +576,14 @@ describe('ShellProcessor', () => { false, ); - expect(result).toBe('Command: match found'); + expect(result).toEqual([{ text: 'Command: match found' }]); }); it('should handle both raw (outside) and escaped (inside) injection simultaneously', async () => { const processor = new ShellProcessor('test-command'); - const prompt = 'User "({{args}})" requested search: !{search {{args}}}'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + 'User "({{args}})" requested search: !{search {{args}}}', + ); mockShellExecute.mockReturnValue({ result: Promise.resolve({ ...SUCCESS_RESULT, output: 'results' }), }); @@ -613,12 +600,15 @@ describe('ShellProcessor', () => { false, ); - expect(result).toBe(`User "(${rawArgs})" requested search: results`); + expect(result).toEqual([ + { text: `User "(${rawArgs})" requested search: results` }, + ]); }); it('should perform security checks on the final, resolved (escaped) command', async () => { const processor = new ShellProcessor('test-command'); - const prompt = '!{rm {{args}}}'; + const prompt: PromptPipelineContent = + createPromptPipelineContent('!{rm {{args}}}'); const expectedEscapedArgs = getExpectedEscapedArgForPlatform(rawArgs); const expectedResolvedCommand = `rm ${expectedEscapedArgs}`; @@ -641,7 +631,8 @@ describe('ShellProcessor', () => { it('should report the resolved command if a hard denial occurs', async () => { const processor = new ShellProcessor('test-command'); - const prompt = '!{rm {{args}}}'; + const prompt: PromptPipelineContent = + createPromptPipelineContent('!{rm {{args}}}'); const expectedEscapedArgs = getExpectedEscapedArgForPlatform(rawArgs); const expectedResolvedCommand = `rm ${expectedEscapedArgs}`; mockCheckCommandPermissions.mockReturnValue({ @@ -661,7 +652,9 @@ describe('ShellProcessor', () => { const processor = new ShellProcessor('test-command'); const multilineArgs = 'first line\nsecond line'; context.invocation!.args = multilineArgs; - const prompt = 'Commit message: !{git commit -m {{args}}}'; + const prompt: PromptPipelineContent = createPromptPipelineContent( + 'Commit message: !{git commit -m {{args}}}', + ); const expectedEscapedArgs = getExpectedEscapedArgForPlatform(multilineArgs); @@ -690,7 +683,8 @@ describe('ShellProcessor', () => { ])('should safely escape args containing $name', async ({ input }) => { const processor = new ShellProcessor('test-command'); context.invocation!.args = input; - const prompt = '!{echo {{args}}}'; + const prompt: PromptPipelineContent = + createPromptPipelineContent('!{echo {{args}}}'); const expectedEscapedArgs = getExpectedEscapedArgForPlatform(input); const expectedCommand = `echo ${expectedEscapedArgs}`; diff --git a/packages/cli/src/services/prompt-processors/shellProcessor.ts b/packages/cli/src/services/prompt-processors/shellProcessor.ts index 039fd284..3aec590f 100644 --- a/packages/cli/src/services/prompt-processors/shellProcessor.ts +++ b/packages/cli/src/services/prompt-processors/shellProcessor.ts @@ -10,14 +10,16 @@ import { escapeShellArg, getShellConfiguration, ShellExecutionService, + flatMapTextParts, } from '@qwen-code/qwen-code-core'; -import { CommandContext } from '../../ui/commands/types.js'; +import type { CommandContext } from '../../ui/commands/types.js'; +import type { IPromptProcessor, PromptPipelineContent } from './types.js'; import { - IPromptProcessor, SHELL_INJECTION_TRIGGER, SHORTHAND_ARGS_PLACEHOLDER, } from './types.js'; +import { extractInjections, type Injection } from './injectionParser.js'; export class ConfirmationRequiredError extends Error { constructor( @@ -30,15 +32,10 @@ export class ConfirmationRequiredError extends Error { } /** - * Represents a single detected shell injection site in the prompt. + * Represents a single detected shell injection site in the prompt, + * after resolution of arguments. Extends the base Injection interface. */ -interface ShellInjection { - /** The shell command extracted from within !{...}, trimmed. */ - command: string; - /** The starting index of the injection (inclusive, points to '!'). */ - startIndex: number; - /** The ending index of the injection (exclusive, points after '}'). */ - endIndex: number; +interface ResolvedShellInjection extends Injection { /** The command after {{args}} has been escaped and substituted. */ resolvedCommand?: string; } @@ -56,11 +53,25 @@ interface ShellInjection { export class ShellProcessor implements IPromptProcessor { constructor(private readonly commandName: string) {} - async process(prompt: string, context: CommandContext): Promise { + async process( + prompt: PromptPipelineContent, + context: CommandContext, + ): Promise { + return flatMapTextParts(prompt, (text) => + this.processString(text, context), + ); + } + + private async processString( + prompt: string, + context: CommandContext, + ): Promise { const userArgsRaw = context.invocation?.args || ''; if (!prompt.includes(SHELL_INJECTION_TRIGGER)) { - return prompt.replaceAll(SHORTHAND_ARGS_PLACEHOLDER, userArgsRaw); + return [ + { text: prompt.replaceAll(SHORTHAND_ARGS_PLACEHOLDER, userArgsRaw) }, + ]; } const config = context.services.config; @@ -71,26 +82,37 @@ export class ShellProcessor implements IPromptProcessor { } const { sessionShellAllowlist } = context.session; - const injections = this.extractInjections(prompt); + const injections = extractInjections( + prompt, + SHELL_INJECTION_TRIGGER, + this.commandName, + ); + // If extractInjections found no closed blocks (and didn't throw), treat as raw. if (injections.length === 0) { - return prompt.replaceAll(SHORTHAND_ARGS_PLACEHOLDER, userArgsRaw); + return [ + { text: prompt.replaceAll(SHORTHAND_ARGS_PLACEHOLDER, userArgsRaw) }, + ]; } const { shell } = getShellConfiguration(); const userArgsEscaped = escapeShellArg(userArgsRaw, shell); - const resolvedInjections = injections.map((injection) => { - if (injection.command === '') { - return injection; - } - // Replace {{args}} inside the command string with the escaped version. - const resolvedCommand = injection.command.replaceAll( - SHORTHAND_ARGS_PLACEHOLDER, - userArgsEscaped, - ); - return { ...injection, resolvedCommand }; - }); + const resolvedInjections: ResolvedShellInjection[] = injections.map( + (injection) => { + const command = injection.content; + + if (command === '') { + return { ...injection, resolvedCommand: undefined }; + } + + const resolvedCommand = command.replaceAll( + SHORTHAND_ARGS_PLACEHOLDER, + userArgsEscaped, + ); + return { ...injection, resolvedCommand }; + }, + ); const commandsToConfirm = new Set(); for (const injection of resolvedInjections) { @@ -180,69 +202,6 @@ export class ShellProcessor implements IPromptProcessor { userArgsRaw, ); - return processedPrompt; - } - - /** - * Iteratively parses the prompt string to extract shell injections (!{...}), - * correctly handling nested braces within the command. - * - * @param prompt The prompt string to parse. - * @returns An array of extracted ShellInjection objects. - * @throws Error if an unclosed injection (`!{`) is found. - */ - private extractInjections(prompt: string): ShellInjection[] { - const injections: ShellInjection[] = []; - let index = 0; - - while (index < prompt.length) { - const startIndex = prompt.indexOf(SHELL_INJECTION_TRIGGER, index); - - if (startIndex === -1) { - break; - } - - let currentIndex = startIndex + SHELL_INJECTION_TRIGGER.length; - let braceCount = 1; - let foundEnd = false; - - while (currentIndex < prompt.length) { - const char = prompt[currentIndex]; - - // We count literal braces. This parser does not interpret shell quoting/escaping. - if (char === '{') { - braceCount++; - } else if (char === '}') { - braceCount--; - if (braceCount === 0) { - const commandContent = prompt.substring( - startIndex + SHELL_INJECTION_TRIGGER.length, - currentIndex, - ); - const endIndex = currentIndex + 1; - - injections.push({ - command: commandContent.trim(), - startIndex, - endIndex, - }); - - index = endIndex; - foundEnd = true; - break; - } - } - currentIndex++; - } - - // Check if the inner loop finished without finding the closing brace. - if (!foundEnd) { - throw new Error( - `Invalid syntax in command '${this.commandName}': Unclosed shell injection starting at index ${startIndex} ('!{'). Ensure braces are balanced.`, - ); - } - } - - return injections; + return [{ text: processedPrompt }]; } } diff --git a/packages/cli/src/services/prompt-processors/types.ts b/packages/cli/src/services/prompt-processors/types.ts index 956bb432..c6876574 100644 --- a/packages/cli/src/services/prompt-processors/types.ts +++ b/packages/cli/src/services/prompt-processors/types.ts @@ -4,7 +4,13 @@ * SPDX-License-Identifier: Apache-2.0 */ -import { CommandContext } from '../../ui/commands/types.js'; +import type { CommandContext } from '../../ui/commands/types.js'; +import type { PartUnion } from '@google/genai'; + +/** + * Defines the input/output type for prompt processors. + */ +export type PromptPipelineContent = PartUnion[]; /** * Defines the interface for a prompt processor, a module that can transform @@ -13,12 +19,8 @@ import { CommandContext } from '../../ui/commands/types.js'; */ export interface IPromptProcessor { /** - * Processes a prompt string, applying a specific transformation as part of a pipeline. - * - * Each processor in a command's pipeline receives the output of the previous - * processor. This method provides the full command context, allowing for - * complex transformations that may require access to invocation details, - * application services, or UI state. + * Processes a prompt input (which may contain text and multi-modal parts), + * applying a specific transformation as part of a pipeline. * * @param prompt The current state of the prompt string. This may have been * modified by previous processors in the pipeline. @@ -28,7 +30,10 @@ export interface IPromptProcessor { * @returns A promise that resolves to the transformed prompt string, which * will be passed to the next processor or, if it's the last one, sent to the model. */ - process(prompt: string, context: CommandContext): Promise; + process( + prompt: PromptPipelineContent, + context: CommandContext, + ): Promise; } /** @@ -42,3 +47,8 @@ export const SHORTHAND_ARGS_PLACEHOLDER = '{{args}}'; * The trigger string for shell command injection in custom commands. */ export const SHELL_INJECTION_TRIGGER = '!{'; + +/** + * The trigger string for at file injection in custom commands. + */ +export const AT_FILE_INJECTION_TRIGGER = '@{'; diff --git a/packages/cli/src/services/types.ts b/packages/cli/src/services/types.ts index 9d30e791..13a87687 100644 --- a/packages/cli/src/services/types.ts +++ b/packages/cli/src/services/types.ts @@ -4,7 +4,7 @@ * SPDX-License-Identifier: Apache-2.0 */ -import { SlashCommand } from '../ui/commands/types.js'; +import type { SlashCommand } from '../ui/commands/types.js'; /** * Defines the contract for any class that can load and provide slash commands. diff --git a/packages/cli/src/test-utils/customMatchers.ts b/packages/cli/src/test-utils/customMatchers.ts index 26eac07b..2a1b275a 100644 --- a/packages/cli/src/test-utils/customMatchers.ts +++ b/packages/cli/src/test-utils/customMatchers.ts @@ -12,7 +12,8 @@ * SPDX-License-Identifier: Apache-2.0 */ -import { Assertion, expect } from 'vitest'; +import type { Assertion } from 'vitest'; +import { expect } from 'vitest'; import type { TextBuffer } from '../ui/components/shared/text-buffer.js'; // RegExp to detect invalid characters: backspace, and ANSI escape codes diff --git a/packages/cli/src/test-utils/mockCommandContext.ts b/packages/cli/src/test-utils/mockCommandContext.ts index 45a041e4..377fc6a3 100644 --- a/packages/cli/src/test-utils/mockCommandContext.ts +++ b/packages/cli/src/test-utils/mockCommandContext.ts @@ -5,10 +5,10 @@ */ import { vi } from 'vitest'; -import { CommandContext } from '../ui/commands/types.js'; -import { LoadedSettings } from '../config/settings.js'; -import { GitService } from '@qwen-code/qwen-code-core'; -import { SessionStatsState } from '../ui/contexts/SessionContext.js'; +import type { CommandContext } from '../ui/commands/types.js'; +import type { LoadedSettings } from '../config/settings.js'; +import type { GitService } from '@qwen-code/qwen-code-core'; +import type { SessionStatsState } from '../ui/contexts/SessionContext.js'; // A utility type to make all properties of an object, and its nested objects, partial. type DeepPartial = T extends object diff --git a/packages/cli/src/test-utils/render.tsx b/packages/cli/src/test-utils/render.tsx index 05b92532..0aff7c74 100644 --- a/packages/cli/src/test-utils/render.tsx +++ b/packages/cli/src/test-utils/render.tsx @@ -5,7 +5,7 @@ */ import { render } from 'ink-testing-library'; -import React from 'react'; +import type React from 'react'; import { KeypressProvider } from '../ui/contexts/KeypressContext.js'; export const renderWithProviders = ( diff --git a/packages/cli/src/ui/App.test.tsx b/packages/cli/src/ui/App.test.tsx index 6688640c..e29aee24 100644 --- a/packages/cli/src/ui/App.test.tsx +++ b/packages/cli/src/ui/App.test.tsx @@ -4,31 +4,41 @@ * SPDX-License-Identifier: Apache-2.0 */ -import { describe, it, expect, vi, beforeEach, afterEach, Mock } from 'vitest'; -import { renderWithProviders } from '../test-utils/render.js'; -import { AppWrapper as App } from './App.js'; -import { - Config as ServerConfig, - MCPServerConfig, - ApprovalMode, - ToolRegistry, +import type { AccessibilitySettings, - SandboxConfig, + AuthType, GeminiClient, - ideContext, - type AuthType, + MCPServerConfig, + SandboxConfig, + ToolRegistry, } from '@qwen-code/qwen-code-core'; -import { LoadedSettings, SettingsFile, Settings } from '../config/settings.js'; +import { + ApprovalMode, + Config as ServerConfig, + ideContext, +} from '@qwen-code/qwen-code-core'; +import { waitFor } from '@testing-library/react'; +import { EventEmitter } from 'node:events'; import process from 'node:process'; -import { useGeminiStream } from './hooks/useGeminiStream.js'; -import { useConsoleMessages } from './hooks/useConsoleMessages.js'; -import { StreamingState, ConsoleMessageItem } from './types.js'; -import { Tips } from './components/Tips.js'; -import { checkForUpdates, UpdateObject } from './utils/updateCheck.js'; -import { EventEmitter } from 'events'; -import { updateEventEmitter } from '../utils/updateEventEmitter.js'; +import type { Mock } from 'vitest'; +import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'; import * as auth from '../config/auth.js'; +import { + LoadedSettings, + type Settings, + type SettingsFile, +} from '../config/settings.js'; +import { renderWithProviders } from '../test-utils/render.js'; +import { updateEventEmitter } from '../utils/updateEventEmitter.js'; +import { AppWrapper as App } from './App.js'; +import { Tips } from './components/Tips.js'; +import { useConsoleMessages } from './hooks/useConsoleMessages.js'; +import { useGeminiStream } from './hooks/useGeminiStream.js'; import * as useTerminalSize from './hooks/useTerminalSize.js'; +import type { ConsoleMessageItem } from './types.js'; +import { StreamingState, ToolCallStatus } from './types.js'; +import type { UpdateObject } from './utils/updateCheck.js'; +import { checkForUpdates } from './utils/updateCheck.js'; // Define a more complete mock server config based on actual Config interface MockServerConfig { @@ -52,6 +62,7 @@ interface MockServerConfig { showMemoryUsage?: boolean; accessibility?: AccessibilitySettings; embeddingModel: string; + checkpointing?: boolean; getApiKey: Mock<() => string>; getModel: Mock<() => string>; @@ -66,6 +77,7 @@ interface MockServerConfig { getToolCallCommand: Mock<() => string | undefined>; getMcpServerCommand: Mock<() => string | undefined>; getMcpServers: Mock<() => Record | undefined>; + getPromptRegistry: Mock<() => Record>; getExtensions: Mock< () => Array<{ name: string; version: string; isActive: boolean }> >; @@ -83,10 +95,34 @@ interface MockServerConfig { getShowMemoryUsage: Mock<() => boolean>; getAccessibility: Mock<() => AccessibilitySettings>; getProjectRoot: Mock<() => string | undefined>; - getAllGeminiMdFilenames: Mock<() => string[]>; + getEnablePromptCompletion: Mock<() => boolean>; getGeminiClient: Mock<() => GeminiClient | undefined>; + getCheckpointingEnabled: Mock<() => boolean>; + getAllGeminiMdFilenames: Mock<() => string[]>; + setFlashFallbackHandler: Mock<(handler: (fallback: boolean) => void) => void>; + getSessionId: Mock<() => string>; getUserTier: Mock<() => Promise>; - getIdeClient: Mock<() => { getCurrentIde: Mock<() => string | undefined> }>; + getIdeMode: Mock<() => boolean>; + getWorkspaceContext: Mock< + () => { + getDirectories: Mock<() => string[]>; + } + >; + getIdeClient: Mock< + () => { + getCurrentIde: Mock<() => string | undefined>; + getDetectedIdeDisplayName: Mock<() => string>; + addStatusChangeListener: Mock< + (listener: (status: string) => void) => void + >; + removeStatusChangeListener: Mock< + (listener: (status: string) => void) => void + >; + getConnectionStatus: Mock<() => string>; + } + >; + isTrustedFolder: Mock<() => boolean>; + getScreenReader: Mock<() => boolean>; } // Mock @qwen-code/qwen-code-core and its Config class @@ -147,6 +183,7 @@ vi.mock('@qwen-code/qwen-code-core', async (importOriginal) => { getShowMemoryUsage: vi.fn(() => opts.showMemoryUsage ?? false), getAccessibility: vi.fn(() => opts.accessibility ?? {}), getProjectRoot: vi.fn(() => opts.targetDir), + getEnablePromptCompletion: vi.fn(() => false), getGeminiClient: vi.fn(() => ({ getUserTier: vi.fn(), })), @@ -167,6 +204,7 @@ vi.mock('@qwen-code/qwen-code-core', async (importOriginal) => { getConnectionStatus: vi.fn(() => 'connected'), })), isTrustedFolder: vi.fn(() => true), + getScreenReader: vi.fn(() => false), }; }); @@ -193,6 +231,7 @@ vi.mock('./hooks/useGeminiStream', () => ({ initError: null, pendingHistoryItems: [], thought: null, + cancelOngoingRequest: vi.fn(), })), })); @@ -209,8 +248,10 @@ vi.mock('./hooks/useAuthCommand', () => ({ vi.mock('./hooks/useFolderTrust', () => ({ useFolderTrust: vi.fn(() => ({ + isTrusted: undefined, isFolderTrustDialogOpen: false, handleFolderTrustSelect: vi.fn(), + isRestarting: false, })), })); @@ -283,6 +324,10 @@ describe('App UI', () => { path: '/system/settings.json', settings: settings.system || {}, }; + const systemDefaultsFile: SettingsFile = { + path: '/system/system-defaults.json', + settings: {}, + }; const userSettingsFile: SettingsFile = { path: '/user/settings.json', settings: settings.user || {}, @@ -293,9 +338,12 @@ describe('App UI', () => { }; return new LoadedSettings( systemSettingsFile, + systemDefaultsFile, userSettingsFile, workspaceSettingsFile, [], + true, + new Set(), ); }; @@ -327,7 +375,9 @@ describe('App UI', () => { mockConfig.getShowMemoryUsage.mockReturnValue(false); // Default for most tests // Ensure a theme is set so the theme dialog does not appear. - mockSettings = createMockSettings({ workspace: { theme: 'Default' } }); + mockSettings = createMockSettings({ + workspace: { ui: { theme: 'Default' } }, + }); // Ensure getWorkspaceContext is available if not added by the constructor if (!mockConfig.getWorkspaceContext) { @@ -352,9 +402,19 @@ describe('App UI', () => { beforeEach(async () => { const { spawn } = await import('node:child_process'); spawnEmitter = new EventEmitter(); - spawnEmitter.stdout = new EventEmitter(); - spawnEmitter.stderr = new EventEmitter(); - (spawn as vi.Mock).mockReturnValue(spawnEmitter); + ( + spawnEmitter as EventEmitter & { + stdout: EventEmitter; + stderr: EventEmitter; + } + ).stdout = new EventEmitter(); + ( + spawnEmitter as EventEmitter & { + stdout: EventEmitter; + stderr: EventEmitter; + } + ).stderr = new EventEmitter(); + (spawn as Mock).mockReturnValue(spawnEmitter); }); afterEach(() => { @@ -368,6 +428,7 @@ describe('App UI', () => { name: '@qwen-code/qwen-code', latest: '1.1.0', current: '1.0.0', + type: 'major' as const, }, message: 'Qwen Code update available!', }; @@ -383,9 +444,10 @@ describe('App UI', () => { ); currentUnmount = unmount; - await new Promise((resolve) => setTimeout(resolve, 10)); - - expect(spawn).not.toHaveBeenCalled(); + // Wait for any potential async operations to complete + await waitFor(() => { + expect(spawn).not.toHaveBeenCalled(); + }); }); it('should show a success message when update succeeds', async () => { @@ -395,6 +457,7 @@ describe('App UI', () => { name: '@qwen-code/qwen-code', latest: '1.1.0', current: '1.0.0', + type: 'major' as const, }, message: 'Update available', }; @@ -411,11 +474,12 @@ describe('App UI', () => { updateEventEmitter.emit('update-success', info); - await new Promise((resolve) => setTimeout(resolve, 10)); - - expect(lastFrame()).toContain( - 'Update successful! The new version will be used on your next run.', - ); + // Wait for the success message to appear + await waitFor(() => { + expect(lastFrame()).toContain( + 'Update successful! The new version will be used on your next run.', + ); + }); }); it('should show an error message when update fails', async () => { @@ -425,6 +489,7 @@ describe('App UI', () => { name: '@qwen-code/qwen-code', latest: '1.1.0', current: '1.0.0', + type: 'major' as const, }, message: 'Update available', }; @@ -441,11 +506,12 @@ describe('App UI', () => { updateEventEmitter.emit('update-failed', info); - await new Promise((resolve) => setTimeout(resolve, 10)); - - expect(lastFrame()).toContain( - 'Automatic update failed. Please try updating manually', - ); + // Wait for the error message to appear + await waitFor(() => { + expect(lastFrame()).toContain( + 'Automatic update failed. Please try updating manually', + ); + }); }); it('should show an error message when spawn fails', async () => { @@ -455,6 +521,7 @@ describe('App UI', () => { name: '@qwen-code/qwen-code', latest: '1.1.0', current: '1.0.0', + type: 'major' as const, }, message: 'Update available', }; @@ -473,11 +540,12 @@ describe('App UI', () => { // which is what should be emitted when a spawn error occurs elsewhere. updateEventEmitter.emit('update-failed', info); - await new Promise((resolve) => setTimeout(resolve, 10)); - - expect(lastFrame()).toContain( - 'Automatic update failed. Please try updating manually', - ); + // Wait for the error message to appear + await waitFor(() => { + expect(lastFrame()).toContain( + 'Automatic update failed. Please try updating manually', + ); + }); }); it('should not auto-update if GEMINI_CLI_DISABLE_AUTOUPDATER is true', async () => { @@ -488,6 +556,7 @@ describe('App UI', () => { name: '@qwen-code/qwen-code', latest: '1.1.0', current: '1.0.0', + type: 'major' as const, }, message: 'Update available', }; @@ -503,9 +572,10 @@ describe('App UI', () => { ); currentUnmount = unmount; - await new Promise((resolve) => setTimeout(resolve, 10)); - - expect(spawn).not.toHaveBeenCalled(); + // Wait for any potential async operations to complete + await waitFor(() => { + expect(spawn).not.toHaveBeenCalled(); + }); }); }); @@ -659,7 +729,10 @@ describe('App UI', () => { it('should display custom contextFileName in footer when set and count is 1', async () => { mockSettings = createMockSettings({ - workspace: { contextFileName: 'AGENTS.md', theme: 'Default' }, + workspace: { + context: { fileName: 'AGENTS.md' }, + ui: { theme: 'Default' }, + }, }); mockConfig.getGeminiMdFileCount.mockReturnValue(1); mockConfig.getAllGeminiMdFilenames.mockReturnValue(['AGENTS.md']); @@ -681,8 +754,8 @@ describe('App UI', () => { it('should display a generic message when multiple context files with different names are provided', async () => { mockSettings = createMockSettings({ workspace: { - contextFileName: ['AGENTS.md', 'CONTEXT.md'], - theme: 'Default', + context: { fileName: ['AGENTS.md', 'CONTEXT.md'] }, + ui: { theme: 'Default' }, }, }); mockConfig.getGeminiMdFileCount.mockReturnValue(2); @@ -707,7 +780,10 @@ describe('App UI', () => { it('should display custom contextFileName with plural when set and count is > 1', async () => { mockSettings = createMockSettings({ - workspace: { contextFileName: 'MY_NOTES.TXT', theme: 'Default' }, + workspace: { + context: { fileName: 'MY_NOTES.TXT' }, + ui: { theme: 'Default' }, + }, }); mockConfig.getGeminiMdFileCount.mockReturnValue(3); mockConfig.getAllGeminiMdFilenames.mockReturnValue([ @@ -732,7 +808,10 @@ describe('App UI', () => { it('should not display context file message if count is 0, even if contextFileName is set', async () => { mockSettings = createMockSettings({ - workspace: { contextFileName: 'ANY_FILE.MD', theme: 'Default' }, + workspace: { + context: { fileName: 'ANY_FILE.MD' }, + ui: { theme: 'Default' }, + }, }); mockConfig.getGeminiMdFileCount.mockReturnValue(0); mockConfig.getAllGeminiMdFilenames.mockReturnValue([]); @@ -810,7 +889,7 @@ describe('App UI', () => { it('should not display Tips component when hideTips is true', async () => { mockSettings = createMockSettings({ workspace: { - hideTips: true, + ui: { hideTips: true }, }, }); @@ -843,7 +922,7 @@ describe('App UI', () => { it('should not display Header component when hideBanner is true', async () => { const { Header } = await import('./components/Header.js'); mockSettings = createMockSettings({ - user: { hideBanner: true }, + user: { ui: { hideBanner: true } }, }); const { unmount } = renderWithProviders( @@ -874,7 +953,7 @@ describe('App UI', () => { it('should not display Footer component when hideFooter is true', async () => { mockSettings = createMockSettings({ - user: { hideFooter: true }, + user: { ui: { hideFooter: true } }, }); const { lastFrame, unmount } = renderWithProviders( @@ -892,9 +971,9 @@ describe('App UI', () => { it('should show footer if system says show, but workspace and user settings say hide', async () => { mockSettings = createMockSettings({ - system: { hideFooter: false }, - user: { hideFooter: true }, - workspace: { hideFooter: true }, + system: { ui: { hideFooter: false } }, + user: { ui: { hideFooter: true } }, + workspace: { ui: { hideFooter: true } }, }); const { lastFrame, unmount } = renderWithProviders( @@ -912,9 +991,9 @@ describe('App UI', () => { it('should show tips if system says show, but workspace and user settings say hide', async () => { mockSettings = createMockSettings({ - system: { hideTips: false }, - user: { hideTips: true }, - workspace: { hideTips: true }, + system: { ui: { hideTips: false } }, + user: { ui: { hideTips: true } }, + workspace: { ui: { hideTips: true } }, }); const { unmount } = renderWithProviders( @@ -995,6 +1074,7 @@ describe('App UI', () => { initError: null, pendingHistoryItems: [], thought: null, + cancelOngoingRequest: vi.fn(), }); const { lastFrame, unmount } = renderWithProviders( @@ -1020,6 +1100,7 @@ describe('App UI', () => { initError: null, pendingHistoryItems: [], thought: null, + cancelOngoingRequest: vi.fn(), }); mockConfig.getGeminiClient.mockReturnValue({ @@ -1089,9 +1170,13 @@ describe('App UI', () => { const validateAuthMethodSpy = vi.spyOn(auth, 'validateAuthMethod'); mockSettings = createMockSettings({ workspace: { - selectedAuthType: 'USE_GEMINI' as AuthType, - useExternalAuth: false, - theme: 'Default', + security: { + auth: { + selectedType: 'USE_GEMINI' as AuthType, + useExternal: false, + }, + }, + ui: { theme: 'Default' }, }, }); @@ -1111,9 +1196,13 @@ describe('App UI', () => { const validateAuthMethodSpy = vi.spyOn(auth, 'validateAuthMethod'); mockSettings = createMockSettings({ workspace: { - selectedAuthType: 'USE_GEMINI' as AuthType, - useExternalAuth: true, - theme: 'Default', + security: { + auth: { + selectedType: 'USE_GEMINI' as AuthType, + useExternal: true, + }, + }, + ui: { theme: 'Default' }, }, }); @@ -1181,8 +1270,10 @@ describe('App UI', () => { it('should display the folder trust dialog when isFolderTrustDialogOpen is true', async () => { const { useFolderTrust } = await import('./hooks/useFolderTrust.js'); vi.mocked(useFolderTrust).mockReturnValue({ + isTrusted: undefined, isFolderTrustDialogOpen: true, handleFolderTrustSelect: vi.fn(), + isRestarting: false, }); const { lastFrame, unmount } = renderWithProviders( @@ -1200,8 +1291,10 @@ describe('App UI', () => { it('should display the folder trust dialog when the feature is enabled but the folder is not trusted', async () => { const { useFolderTrust } = await import('./hooks/useFolderTrust.js'); vi.mocked(useFolderTrust).mockReturnValue({ + isTrusted: false, isFolderTrustDialogOpen: true, handleFolderTrustSelect: vi.fn(), + isRestarting: false, }); mockConfig.isTrustedFolder.mockReturnValue(false); @@ -1220,8 +1313,10 @@ describe('App UI', () => { it('should not display the folder trust dialog when the feature is disabled', async () => { const { useFolderTrust } = await import('./hooks/useFolderTrust.js'); vi.mocked(useFolderTrust).mockReturnValue({ + isTrusted: false, isFolderTrustDialogOpen: false, handleFolderTrustSelect: vi.fn(), + isRestarting: false, }); mockConfig.isTrustedFolder.mockReturnValue(false); @@ -1239,7 +1334,7 @@ describe('App UI', () => { }); describe('Message Queuing', () => { - let mockSubmitQuery: typeof vi.fn; + let mockSubmitQuery: Mock; beforeEach(() => { mockSubmitQuery = vi.fn(); @@ -1257,6 +1352,7 @@ describe('App UI', () => { initError: null, pendingHistoryItems: [], thought: null, + cancelOngoingRequest: vi.fn(), }); const { unmount } = renderWithProviders( @@ -1282,6 +1378,7 @@ describe('App UI', () => { initError: null, pendingHistoryItems: [], thought: null, + cancelOngoingRequest: vi.fn(), }); const { unmount, rerender } = renderWithProviders( @@ -1300,6 +1397,7 @@ describe('App UI', () => { initError: null, pendingHistoryItems: [], thought: null, + cancelOngoingRequest: vi.fn(), }); // Rerender to trigger the useEffect with new state @@ -1328,7 +1426,8 @@ describe('App UI', () => { submitQuery: mockSubmitQuery, initError: null, pendingHistoryItems: [], - thought: 'Processing...', + thought: { subject: 'Processing', description: 'Processing...' }, + cancelOngoingRequest: vi.fn(), }); const { unmount, lastFrame } = renderWithProviders( @@ -1356,6 +1455,7 @@ describe('App UI', () => { initError: null, pendingHistoryItems: [], thought: null, + cancelOngoingRequest: vi.fn(), }); const { unmount, lastFrame } = renderWithProviders( @@ -1385,6 +1485,7 @@ describe('App UI', () => { initError: null, pendingHistoryItems: [], thought: null, + cancelOngoingRequest: vi.fn(), }); const { unmount } = renderWithProviders( @@ -1413,6 +1514,7 @@ describe('App UI', () => { initError: null, pendingHistoryItems: [], thought: null, + cancelOngoingRequest: vi.fn(), }); const { unmount, lastFrame } = renderWithProviders( @@ -1440,7 +1542,8 @@ describe('App UI', () => { submitQuery: mockSubmitQuery, initError: null, pendingHistoryItems: [], - thought: 'Processing...', + thought: { subject: 'Processing', description: 'Processing...' }, + cancelOngoingRequest: vi.fn(), }); const { lastFrame, unmount } = renderWithProviders( @@ -1471,7 +1574,8 @@ describe('App UI', () => { submitQuery: mockSubmitQuery, initError: null, pendingHistoryItems: [], - thought: 'Processing...', + thought: { subject: 'Processing', description: 'Processing...' }, + cancelOngoingRequest: vi.fn(), }); const { lastFrame, unmount } = renderWithProviders( @@ -1493,4 +1597,142 @@ describe('App UI', () => { expect(output).toContain('esc to cancel'); }); }); + + describe('debug keystroke logging', () => { + let consoleLogSpy: ReturnType; + + beforeEach(() => { + consoleLogSpy = vi.spyOn(console, 'log').mockImplementation(() => {}); + }); + + afterEach(() => { + consoleLogSpy.mockRestore(); + }); + + it('should pass debugKeystrokeLogging setting to KeypressProvider', () => { + const mockSettingsWithDebug = createMockSettings({ + workspace: { + ui: { theme: 'Default' }, + general: { debugKeystrokeLogging: true }, + }, + }); + + const { lastFrame, unmount } = renderWithProviders( + , + ); + currentUnmount = unmount; + + const output = lastFrame(); + + expect(output).toBeDefined(); + expect(mockSettingsWithDebug.merged.general?.debugKeystrokeLogging).toBe( + true, + ); + }); + + it('should use default false value when debugKeystrokeLogging is not set', () => { + const { lastFrame, unmount } = renderWithProviders( + , + ); + currentUnmount = unmount; + + const output = lastFrame(); + + expect(output).toBeDefined(); + expect( + mockSettings.merged.general?.debugKeystrokeLogging, + ).toBeUndefined(); + }); + }); + + describe('Ctrl+C behavior', () => { + it('should call cancel but only clear the prompt when a tool is executing', async () => { + const mockCancel = vi.fn(); + let onCancelSubmitCallback = () => {}; + + // Simulate a tool in the "Executing" state. + vi.mocked(useGeminiStream).mockImplementation( + ( + _client, + _history, + _addItem, + _config, + _onDebugMessage, + _handleSlashCommand, + _shellModeActive, + _getPreferredEditor, + _onAuthError, + _performMemoryRefresh, + _modelSwitchedFromQuotaError, + _setModelSwitchedFromQuotaError, + _onEditorClose, + onCancelSubmit, // Capture the cancel callback from App.tsx + ) => { + onCancelSubmitCallback = onCancelSubmit; + return { + streamingState: StreamingState.Responding, + submitQuery: vi.fn(), + initError: null, + pendingHistoryItems: [ + { + type: 'tool_group', + tools: [ + { + name: 'test_tool', + status: ToolCallStatus.Executing, + callId: 'test-call-id', + description: 'Test tool description', + resultDisplay: 'Test result', + confirmationDetails: undefined, + }, + ], + }, + ], + thought: null, + cancelOngoingRequest: () => { + mockCancel(); + onCancelSubmitCallback(); // <--- This is the key change + }, + }; + }, + ); + + const { stdin, lastFrame, unmount } = renderWithProviders( + , + ); + currentUnmount = unmount; + + // Simulate user typing something into the prompt while a tool is running. + stdin.write('some text'); + await new Promise((resolve) => setTimeout(resolve, 100)); + + // Verify the text is in the prompt. + expect(lastFrame()).toContain('some text'); + + // Simulate Ctrl+C. + stdin.write('\x03'); + await new Promise((resolve) => setTimeout(resolve, 100)); + + // The main cancellation handler SHOULD be called. + expect(mockCancel).toHaveBeenCalled(); + + // The prompt should now be empty as a result of the cancellation handler's logic. + // We can't directly test the buffer's state, but we can see the rendered output. + await waitFor(() => { + expect(lastFrame()).not.toContain('some text'); + }); + }); + }); }); diff --git a/packages/cli/src/ui/App.tsx b/packages/cli/src/ui/App.tsx index 3494f3ce..9ec15650 100644 --- a/packages/cli/src/ui/App.tsx +++ b/packages/cli/src/ui/App.tsx @@ -7,14 +7,20 @@ import { useCallback, useEffect, useMemo, useState, useRef } from 'react'; import { Box, - DOMElement, + type DOMElement, measureElement, Static, Text, useStdin, useStdout, } from 'ink'; -import { StreamingState, type HistoryItem, MessageType } from './types.js'; +import { + StreamingState, + type HistoryItem, + MessageType, + ToolCallStatus, + type HistoryItemWithoutId, +} from './types.js'; import { useTerminalSize } from './hooks/useTerminalSize.js'; import { useGeminiStream } from './hooks/useGeminiStream.js'; import { useLoadingIndicator } from './hooks/useLoadingIndicator.js'; @@ -53,7 +59,8 @@ import { } from './components/subagents/index.js'; import { Colors } from './colors.js'; import { loadHierarchicalGeminiMemory } from '../config/config.js'; -import { LoadedSettings, SettingScope } from '../config/settings.js'; +import type { LoadedSettings } from '../config/settings.js'; +import { SettingScope } from '../config/settings.js'; import { Tips } from './components/Tips.js'; import { ConsolePatcher } from './utils/ConsolePatcher.js'; import { registerCleanup } from '../utils/cleanup.js'; @@ -62,23 +69,22 @@ import { HistoryItemDisplay } from './components/HistoryItemDisplay.js'; import { ContextSummaryDisplay } from './components/ContextSummaryDisplay.js'; import { useHistory } from './hooks/useHistoryManager.js'; import process from 'node:process'; +import type { EditorType, Config, IdeContext } from '@qwen-code/qwen-code-core'; import { - getErrorMessage, - type Config, - getAllGeminiMdFilenames, ApprovalMode, + getAllGeminiMdFilenames, isEditorAvailable, - EditorType, - FlashFallbackEvent, - logFlashFallback, + getErrorMessage, AuthType, - type IdeContext, + logFlashFallback, + FlashFallbackEvent, ideContext, + isProQuotaExceededError, + isGenericQuotaExceededError, + UserTierId, } from '@qwen-code/qwen-code-core'; -import { - IdeIntegrationNudge, - IdeIntegrationNudgeResult, -} from './IdeIntegrationNudge.js'; +import type { IdeIntegrationNudgeResult } from './IdeIntegrationNudge.js'; +import { IdeIntegrationNudge } from './IdeIntegrationNudge.js'; import { validateAuthMethod } from '../config/auth.js'; import { useLogger } from './hooks/useLogger.js'; import { StreamingContext } from './contexts/StreamingContext.js'; @@ -92,18 +98,14 @@ import { useBracketedPaste } from './hooks/useBracketedPaste.js'; import { useTextBuffer } from './components/shared/text-buffer.js'; import { useVimMode, VimModeProvider } from './contexts/VimModeContext.js'; import { useVim } from './hooks/vim.js'; -import { useKeypress, Key } from './hooks/useKeypress.js'; +import type { Key } from './hooks/useKeypress.js'; +import { useKeypress } from './hooks/useKeypress.js'; import { KeypressProvider } from './contexts/KeypressContext.js'; import { useKittyKeyboardProtocol } from './hooks/useKittyKeyboardProtocol.js'; import { keyMatchers, Command } from './keyMatchers.js'; -import * as fs from 'fs'; +import * as fs from 'node:fs'; import { UpdateNotification } from './components/UpdateNotification.js'; -import { - isProQuotaExceededError, - isGenericQuotaExceededError, - UserTierId, -} from '@qwen-code/qwen-code-core'; -import { UpdateObject } from './utils/updateCheck.js'; +import type { UpdateObject } from './utils/updateCheck.js'; import ansiEscapes from 'ansi-escapes'; import { OverflowProvider } from './contexts/OverflowContext.js'; import { ShowMoreLines } from './components/ShowMoreLines.js'; @@ -113,6 +115,8 @@ import { SettingsDialog } from './components/SettingsDialog.js'; import { setUpdateHandler } from '../utils/handleAutoUpdate.js'; import { appEvents, AppEvent } from '../utils/events.js'; import { isNarrowWidth } from './utils/isNarrowWidth.js'; +import { useWorkspaceMigration } from './hooks/useWorkspaceMigration.js'; +import { WorkspaceMigrationDialog } from './components/WorkspaceMigrationDialog.js'; import { WelcomeBackDialog } from './components/WelcomeBackDialog.js'; // Maximum number of queued messages to display in UI to prevent performance issues @@ -125,12 +129,28 @@ interface AppProps { version: string; } +function isToolExecuting(pendingHistoryItems: HistoryItemWithoutId[]) { + return pendingHistoryItems.some((item) => { + if (item && item.type === 'tool_group') { + return item.tools.some( + (tool) => ToolCallStatus.Executing === tool.status, + ); + } + return false; + }); +} + export const AppWrapper = (props: AppProps) => { const kittyProtocolStatus = useKittyKeyboardProtocol(); + const nodeMajorVersion = parseInt(process.versions.node.split('.')[0], 10); return ( @@ -157,7 +177,7 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { const shouldShowIdePrompt = currentIDE && !config.getIdeMode() && - !settings.merged.hasSeenIdeIntegrationNudge && + !settings.merged.ide?.hasSeenNudge && !idePromptAnswered; useEffect(() => { @@ -221,6 +241,12 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { >(); const [showEscapePrompt, setShowEscapePrompt] = useState(false); const [isProcessing, setIsProcessing] = useState(false); + const { + showWorkspaceMigrationDialog, + workspaceExtensions, + onWorkspaceMigrationDialogOpen, + onWorkspaceMigrationDialogClose, + } = useWorkspaceMigration(settings); useEffect(() => { const unsubscribe = ideContext.subscribeToIdeContext(setIdeContextState); @@ -291,10 +317,8 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { closeAgentsManagerDialog, } = useAgentsManagerDialog(); - const { isFolderTrustDialogOpen, handleFolderTrustSelect } = useFolderTrust( - settings, - setIsTrustedFolder, - ); + const { isFolderTrustDialogOpen, handleFolderTrustSelect, isRestarting } = + useFolderTrust(settings, setIsTrustedFolder); const { showQuitConfirmation, handleQuitConfirmationSelect } = useQuitConfirmation(); @@ -317,16 +341,21 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { } = useQwenAuth(settings, isAuthenticating); useEffect(() => { - if (settings.merged.selectedAuthType && !settings.merged.useExternalAuth) { - const error = validateAuthMethod(settings.merged.selectedAuthType); + if ( + settings.merged.security?.auth?.selectedType && + !settings.merged.security?.auth?.useExternal + ) { + const error = validateAuthMethod( + settings.merged.security.auth.selectedType, + ); if (error) { setAuthError(error); openAuthDialog(); } } }, [ - settings.merged.selectedAuthType, - settings.merged.useExternalAuth, + settings.merged.security?.auth?.selectedType, + settings.merged.security?.auth?.useExternal, openAuthDialog, setAuthError, ]); @@ -382,14 +411,14 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { try { const { memoryContent, fileCount } = await loadHierarchicalGeminiMemory( process.cwd(), - settings.merged.loadMemoryFromIncludeDirectories + settings.merged.context?.loadMemoryFromIncludeDirectories ? config.getWorkspaceContext().getDirectories() : [], config.getDebugMode(), config.getFileService(), settings.merged, config.getExtensionContextFilePaths(), - settings.merged.memoryImportFormat || 'tree', // Use setting or default to 'tree' + settings.merged.context?.importFormat || 'tree', // Use setting or default to 'tree' config.getFileFilteringOptions(), ); @@ -547,7 +576,7 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { }, []); const getPreferredEditor = useCallback(() => { - const editorType = settings.merged.preferredEditor; + const editorType = settings.merged.general?.preferredEditor; const isValidEditor = isEditorAvailable(editorType); if (!isValidEditor) { openEditorDialog(); @@ -637,6 +666,17 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { () => cancelHandlerRef.current(), ); + const pendingHistoryItems = useMemo( + () => + [...pendingSlashCommandHistoryItems, ...pendingGeminiHistoryItems].map( + (item, index) => ({ + ...item, + id: index, + }), + ), + [pendingSlashCommandHistoryItems, pendingGeminiHistoryItems], + ); + // Welcome back functionality const { welcomeBackInfo, @@ -652,7 +692,7 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { handleThemeSelect, isAuthDialogOpen, handleAuthSelect, - selectedAuthType: settings.merged.selectedAuthType, + selectedAuthType: settings.merged.security?.auth?.selectedType, isEditorDialogOpen, exitEditorDialog, isSettingsDialogOpen, @@ -674,6 +714,11 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { // Update the cancel handler with message queue support cancelHandlerRef.current = useCallback(() => { + if (isToolExecuting(pendingHistoryItems)) { + buffer.setText(''); // Just clear the prompt + return; + } + const lastUserMessage = userMessages.at(-1); let textToSet = lastUserMessage || ''; @@ -687,7 +732,13 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { if (textToSet) { buffer.setText(textToSet); } - }, [buffer, userMessages, getQueuedMessagesText, clearQueue]); + }, [ + buffer, + userMessages, + getQueuedMessagesText, + clearQueue, + pendingHistoryItems, + ]); // Input handling - queue messages for processing const handleFinalSubmit = useCallback( @@ -723,15 +774,10 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { ); const { handleInput: vimHandleInput } = useVim(buffer, handleFinalSubmit); - const pendingHistoryItems = useMemo(() => { - const items = [...pendingSlashCommandHistoryItems]; - items.push(...pendingGeminiHistoryItems); - return items.map((item, i) => ({ ...item, id: i })); - }, [pendingSlashCommandHistoryItems, pendingGeminiHistoryItems]); const { elapsedTime, currentLoadingPhrase } = useLoadingIndicator(streamingState); - const showAutoAcceptIndicator = useAutoAcceptIndicator({ config }); + const showAutoAcceptIndicator = useAutoAcceptIndicator({ config, addItem }); const handleExit = useCallback( ( @@ -789,6 +835,11 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { const handleGlobalKeypress = useCallback( (key: Key) => { + // Debug log keystrokes if enabled + if (settings.merged.general?.debugKeystrokeLogging) { + console.log('[DEBUG] Keystroke:', JSON.stringify(key)); + } + let enteringConstrainHeightMode = false; if (!constrainHeight) { enteringConstrainHeightMode = true; @@ -848,6 +899,7 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { ctrlDTimerRef, handleSlashCommand, isAuthenticating, + settings.merged.general?.debugKeystrokeLogging, ], ); @@ -861,7 +913,7 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { } }, [config, config.getGeminiMdFileCount]); - const logger = useLogger(); + const logger = useLogger(config.storage); useEffect(() => { const fetchUserMessages = async () => { @@ -964,12 +1016,12 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { const branchName = useGitBranchName(config.getTargetDir()); const contextFileNames = useMemo(() => { - const fromSettings = settings.merged.contextFileName; + const fromSettings = settings.merged.context?.fileName; if (fromSettings) { return Array.isArray(fromSettings) ? fromSettings : [fromSettings]; } return getAllGeminiMdFilenames(); - }, [settings.merged.contextFileName]); + }, [settings.merged.context?.fileName]); const initialPrompt = useMemo(() => config.getQuestion(), [config]); const geminiClient = config.getGeminiClient(); @@ -1051,10 +1103,12 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { key={staticKey} items={[ - {!settings.merged.hideBanner && ( -
+ {!( + settings.merged.ui?.hideBanner || config.getScreenReader() + ) &&
} + {!(settings.merged.ui?.hideTips || config.getScreenReader()) && ( + )} - {!settings.merged.hideTips && } , ...history.map((h) => ( { onClose={handleWelcomeBackClose} /> )} - - {shouldShowIdePrompt && currentIDE ? ( + {showWorkspaceMigrationDialog ? ( + + ) : shouldShowIdePrompt && currentIDE ? ( ) : isFolderTrustDialogOpen ? ( - + ) : quitConfirmationRequest ? ( { @@ -1270,12 +1332,14 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { { ... (+ - {messageQueue.length - - MAX_DISPLAYED_QUEUED_MESSAGES}{' '} + {messageQueue.length - MAX_DISPLAYED_QUEUED_MESSAGES} more) @@ -1427,7 +1490,7 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => { )} )} - {!settings.merged.hideFooter && ( + {!settings.merged.ui?.hideFooter && (