huncholaneA Regex file extension that makes it way easier to edit large regex.
| 1 | # Regex File Extension |
| 2 | |
| 3 | The Regex File extension adds support for `.re` files in Visual Studio Code, providing enhanced functionality for working with regular expressions. This extension enables you to associate `.re` files with regex syntax, highlights matching patterns in other editor windows, and conveniently displays your regex flags at the bottom of the screen. |
| 4 | |
| 5 | ## Features |
| 6 | |
| 7 | - **File Type Association**: Associate `.re` files with regex syntax for better syntax highlighting and language-specific features. |
| 8 | - **Highlight Matching Patterns**: Automatically highlight matching patterns from the `.re` file in other editor windows for improved visibility and context. |
| 9 | - **Regex Flags Display**: Display your active regex flags (e.g., `/gm`) at the bottom of the screen, so you can easily track and manage them without manually typing them each time. |
| 10 | |
| 11 | ## Requirements |
| 12 | |
| 13 | - Visual Studio Code (version 1.60.0 or higher) |
| 14 | |
| 15 | ## Installation |
| 16 | |
| 17 | 1. Launch Visual Studio Code. |
| 18 | 2. Go to the Extensions view by clicking on the square icon on the left sidebar or pressing `Ctrl+Shift+X`. |
| 19 | 3. Search for "regex-file" in the Extensions Marketplace. |
| 20 | 4. Click on the "Install" button next to the "Regex File" extension. |
| 21 | 5. After installation, the extension will be activated automatically. |
| 22 | |
| 23 | ## Usage |
| 24 | |
| 25 | 1. Open a `.re` file in Visual Studio Code, or create a new file with the `.re` extension. |
| 26 | 2. The extension will associate the file with regex syntax, enabling syntax highlighting and language-specific features. |
| 27 | 3. Any other open editor windows will automatically highlight matching patterns from the `.re` file for better visibility and context. |
| 28 | 4. The active regex flags will be displayed at the bottom of the screen, allowing you to track and manage them easily. |
| 29 | |
| 30 | ## Configuration |
| 31 | |
| 32 | The Regex File extension does not require any additional configuration. However, you can customize the extension's behavior by modifying your user or workspace settings. |
| 33 | |
| 34 | To access the extension's settings: |
| 35 | |
| 36 | 1. Go to the File menu in Visual Studio Code. |
| 37 | 2. Select Preferences, then click on "Settings" (or press `Ctrl+,`). |
| 38 | |
| 39 | Inside the settings, you can adjust options related to the extension, such as color schemes, regex file associations, or display preferences. |
| 40 | |
| 41 | ## Known Issues |
| 42 | |
| 43 | - No known issues at the moment. Please report any problems or bugs on the extension's GitHub repository. |
| 44 | |
| 45 | ## Feedback and Contributions |
| 46 | |
| 47 | - Feedback, suggestions, and contributions are welcome! Please feel free to submit issues or pull requests on the extension's GitHub repository. |
| 48 | |
| 49 | ## License |
| 50 | |
| 51 | This extension is licensed under the [MIT License](https://opensource.org/licenses/MIT). |
| 52 | |
| 53 | --- |
| 54 | |
| 55 | Thank you for using the Regex File extension! We hope it enhances your experience when working with regex files in Visual Studio Code. If you have any questions or need further assistance, please don't hesitate to reach out. |
| 56 | |
| 57 | Happy regexing! |