Skip to content

Commit ea2de35

Browse files
committed
Refactor README.md to streamline cache management section and update usage tips for improved clarity on cache handling after major changes.
1 parent 8864670 commit ea2de35

File tree

1 file changed

+2
-14
lines changed

1 file changed

+2
-14
lines changed

vscode-rescriptdep/README.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,6 @@ This extension provides several commands in the Command Palette (`Ctrl+Shift+P`
3434
- **ReScript: Show Unused Modules**: Identifies and visualizes modules that have no dependents (potentially unused code)
3535
- **ReScript: Clear Dependency Cache**: Clears the cached dependency data for improved accuracy after major changes
3636

37-
## Cache Management
38-
39-
The extension uses a caching mechanism to improve performance when analyzing module dependencies:
40-
41-
- Cache files are stored in the extension's global storage area:
42-
- macOS: `~/Library/Application Support/Code/User/globalStorage/mununki.vscode-bibimbob/cache`
43-
- Linux: `~/.config/Code/User/globalStorage/mununki.vscode-bibimbob/cache`
44-
- Each workspace gets its own cache file based on the workspace name
45-
- The cache is automatically invalidated when module files change (using digest comparison)
46-
- You can manually clear the cache using the "ReScript: Clear Dependency Cache" command
47-
4837
## Requirements
4938

5039
- A ReScript project (with either `bsconfig.json` or `rescript.json` configuration file)
@@ -59,9 +48,8 @@ The extension uses a caching mechanism to improve performance when analyzing mod
5948

6049
## Usage Tips
6150

62-
1. **First Analysis**: The first analysis might take longer as it builds the initial cache
63-
2. **After Major Changes**: Clear the cache using the command if you've made significant changes to your codebase
64-
3. **Module Navigation**: Click on any module in the visualization to focus on that module
51+
1. **After Major Changes**: When making significant changes to your codebase (including module deletion), run `rescript clean` to recompile your project for improved analysis accuracy
52+
2. **Module Navigation**: Click on any module in the visualization to focus on that module
6553

6654
## Extension Settings
6755

0 commit comments

Comments
 (0)