Below is an updated version of your README, incorporating the commands you provided, reflecting the current functionality, and addressing the style map issue you described earlier. I've also refined the content for clarity and professionalism while keeping the structure intact.
vsc-hosanna-ui README
IMPORTANT!!!!!!
- Ensure you have increased the open file limit on your machine.
on mac - add this to your ~/.zprofile file and ~/.zhrc file:
ulimit -n 262144
NOTE - there is something more permanent to do, with launchtl; but I don't remember what it is right now.
This is to avoid too many open files errors.
- In the find window of the debug console, put some random text to filter out, the output as too many log lines will show and grind your machine to a halt. We will fix this shortly
Overview
The vsc-hosanna-ui extension enhances your Visual Studio Code experience by providing advanced navigation and synchronization tools for JSON and TypeScript development. Key features include:
- JSON Navigation: Navigate style links and style key references within JSON files.
- TypeScript Navigation: Locate style links and style key references in TypeScript files.
- Source Synchronization: Keep transpiled Roku sources in sync with their TypeScript counterparts.
These tools are designed to streamline your workflow, improve code navigation, and maintain consistency across your project.
Features
JSON File Navigation
- Navigate to style links and style key references in JSON files (e.g.,
style.config.json).
- Quickly jump to style definitions to edit or review them.
TypeScript File Navigation
- Find and navigate to style links and style key references within TypeScript files.
- Seamlessly connect style usage with their definitions for faster development.
Source Synchronization
- Synchronize transpiled Roku code with its original TypeScript sources.
- Toggle synchronization on or off as needed to match your workflow.
Commands
This extension contributes the following commands, accessible via the Command Palette (Cmd+Shift+P or Ctrl+Shift+P):
vsc-hosanna-ui.navigateToRokuCode: Navigate to Roku Code
Jumps to the corresponding Roku code from your current context.vsc-hosanna-ui.navigateToSourceCode: Navigate to Source Code
Locates the original TypeScript source for transpiled code.vsc-hosanna-ui.toggleTranspiledCodeSync: Toggle Transpiled Code Sync
Enables or disables synchronization between Roku and TypeScript sources.transpiledCodeNavigator.toggleIgnoreWhiteSpaceInSelections: Toggle Ignore White Space In Selections
Adjusts selection behavior to ignore whitespace during navigation or syncing.extension.processJsonStyleFiles: Process JSON Style Files
Manually processes or reloads JSON style files (e.g., style.config.json) to update style maps.
Running the Extension
To get started:
- Install dependencies:
npm install
- Open the project in Visual Studio Code.
- Press the "Run" button in the VS Code debugger or launch the extension.
Note: If style navigation doesn't work initially, run the Process JSON Style Files command after launching the extension to ensure style maps are loaded correctly.
Known Issues
- Style Map Loading: Style maps may not populate unless
style.config.json is processed manually or the file is open during extension launch. A fix is in progress to load files directly from the filesystem.
- Completions: Autocompletion can be inconsistent and may not always trigger as expected.
- TypeScript Navigation: Style navigation in TypeScript files occasionally fails to resolve correctly.
- Broken Completions in TypeScript: Completions are currently non-functional in TypeScript files.
The underlying code for these features exists but may require minor adjustments for full reliability. Contributions or AI-assisted tweaks are welcome!
Extension Settings
This extension provides the following settings:
vscHosannaUI.enable: Enable or disable the extension (default: true).vscHosannaUI.processJSONStyles: Trigger the extension.processJsonStyleFiles command to process JSON style files manually.
Release Notes
1.0.0
- Initial release with JSON and TypeScript navigation and source synchronization features.
1.0.1
- Fixed minor bugs and improved overall stability.
1.1.0
- Added new commands and enhancements for better navigation and synchronization.
Following Extension Guidelines
Ensure your development adheres to VS Code's best practices:
Working with Markdown
Author this README in Visual Studio Code with these handy shortcuts:
- Split editor:
Cmd+\ (macOS) or Ctrl+\ (Windows/Linux).
- Toggle preview:
Shift+Cmd+V (macOS) or Shift+Ctrl+V (Windows/Linux).
- Markdown snippets:
Ctrl+Space (all platforms).
Enjoy!
