Skip to content

Commit 9a1b79c

Browse files
committed
Update docs
1 parent 0977049 commit 9a1b79c

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ Documentation around configuration variables can be found in the [config.ts](htt
1616
- Simple diagnostics reporting
1717
- Documentation for symbols on hover
1818
- Workspace symbols
19+
- Rename symbol
1920

2021
To be implemented:
2122

22-
- Rename symbol
2323
- Better jump to declaration and find references based on scope
2424

2525
## Installation

server/src/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export const ConfigSchema = z.object({
1919
// Log level for the server. To set the right log level from the start please also use the environment variable 'BASH_IDE_LOG_LEVEL'.
2020
logLevel: z.enum(LOG_LEVELS).default(DEFAULT_LOG_LEVEL),
2121

22-
// Controls how symbols (e.g. variables and functions) are included and used for completion and documentation.
22+
// Controls how symbols (e.g. variables and functions) are included and used for completion, documentation, and renaming.
2323
// If false, then we only include symbols from sourced files (i.e. using non dynamic statements like 'source file.sh' or '. file.sh' or following ShellCheck directives).
2424
// If true, then all symbols from the workspace are included.
2525
includeAllWorkspaceSymbols: z.boolean().default(false),

vscode-client/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ We strongly recommend that you install [shellcheck][shellcheck] to enable lintin
1818
- [x] Simple diagnostics reporting
1919
- [x] Documentation for flags on hover
2020
- [x] Workspace symbols
21-
- [ ] Rename symbol
21+
- [x] Rename symbol
2222
- [x] Snippets
2323

2424
## Configuration

vscode-client/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
"bashIde.includeAllWorkspaceSymbols": {
5656
"type": "boolean",
5757
"default": false,
58-
"description": "Controls how symbols (e.g. variables and functions) are included and used for completion and documentation. If false (default and recommended), then we only include symbols from sourced files (i.e. using non dynamic statements like 'source file.sh' or '. file.sh' or following ShellCheck directives). If true, then all symbols from the workspace are included."
58+
"description": "Controls how symbols (e.g. variables and functions) are included and used for completion, documentation, and renaming. If false (default and recommended), then we only include symbols from sourced files (i.e. using non dynamic statements like 'source file.sh' or '. file.sh' or following ShellCheck directives). If true, then all symbols from the workspace are included."
5959
},
6060
"bashIde.logLevel": {
6161
"type": "string",

0 commit comments

Comments
 (0)