Documentation Error: Incorrect nesting of `includeDirectories` in `settings.json` examples
Describe the documentation error
The documentation in docs/cli/configuration.md provides an example settings.json that uses the deprecated top-level includeDirectories key. The codebase (packages/cli/src/config/settings.ts) confirms that includeDirectories is migrated to context.includeDirectories. This migration was introduced in PR #7244 ("refactor: refactor settings to a nested structure").
Contradictory Example
In docs/cli/configuration.md, the "Example settings.json" snippet shows:
{
...
"includeDirectories": ["path/to/dir1", "~/path/to/dir2", "../path/to/dir3"],
...
}
Expected Behavior
The documentation should reflect the current V2 schema structure:
{
"context": {
"includeDirectories": ["path/to/dir1", "~/path/to/dir2", "../path/to/dir3"]
}
}
Additional Context
-
packages/cli/src/config/settings.tscontainsincludeDirectories: 'context.includeDirectories'inMIGRATION_MAP. - PR #7244 explicitly refactored settings to a nested structure.
- Using the deprecated key triggers an internal migration or potential confusion for users expecting the modern schema.
/assign
👋 @maru0804, you've been assigned to this issue! Thank you for taking the time to contribute. Make sure to check out our contributing guidelines.
I've created a PR to fix this issue: #15067
This updates the documentation to use the correct V2 nested schema structure for includeDirectories settings.