A lightweight VS Code extension to display the number of 📖reads and ✏️writes for class properties in JavaScript and TypeScript files.
Have you ever exhibited an unintended behavior, knowing it was likely linked to a value write operation somewhere?
If the answer is yes, you’ve probably already used your IDE’s regex filters to scrutinize each of the ~100< assignments across your architecture, or used VSCode’s native service that aggregates all types of merged operations.
This extension simply waits for native CodeLens to retrieve the information, then splits it into two sections so you can view assignments and reads separately for debugging your strange behavior more easily.
- Read and Write Counts: Instantly see how many times a property is read or written.
- Quick Navigation: Click on the CodeLens to view references directly.
- Full Support: Works seamlessly with JavaScript and TypeScript.
The extension works out of the box. Optional settings are available to customize the display:
- Toggle visibility of read | write counts.
- Customize emojis 📖 and ✏️ and text for CodeLens.
- Open VS Code.
- Go to the Extensions tab (Ctrl+Shift+X).
- Search for "Property Read/Write CodeLens".
- Click "Install".
- Open a JavaScript or TypeScript file.
- CodeLens will appear above class properties, showing read and write counts.
- Click on the counts to navigate to the references.
Contributions are welcome! Open an issue or submit a pull request on GitHub.
see CHANGELOG.md
- Add support for more options with regex for complex properties assignments ex:
entity.set( componentType, {property: value } )as writes references. this can prove very useful in architectures such as ECS, in game engines where coupling occurs through facades. For now, the 'property' type is considered a read operation. Users will be allowed to add a special regex to detect this type of assignment as a write operation. - Fix the self field counting when used with access modifiers such as public, private, or protected.
- add flag to show rwcodelens on literals objects.
- add flag to enable rwcodelens on interfaces.
- when using this in constructor, it should not show rwcodelens.
MIT