Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ozovalihasan/navigate-rails-files

A VS Code extension to navigate Rails files
https://github.com/ozovalihasan/navigate-rails-files

rails7 ruby-on-rails-7 vscode-extension

Last synced: 13 days ago
JSON representation

A VS Code extension to navigate Rails files

Host: GitHub
URL: https://github.com/ozovalihasan/navigate-rails-files
Owner: ozovalihasan
License: mit
Created: 2023-07-08T11:45:31.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-08-23T08:54:21.000Z (4 months ago)
Last Synced: 2024-12-17T11:04:57.770Z (17 days ago)
Topics: rails7, ruby-on-rails-7, vscode-extension
Language: TypeScript
Homepage: https://marketplace.visualstudio.com/items?itemName=ozovalihasan.navigate-rails-files
Size: 1.05 MB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

Navigate Rails Files

The purpose of this extension is to navigate Rails files with the help of shortcuts.

- Template engines `.erb`, `.slim`, and `haml` are already supported for view files. They can be customized by changing `navigateRailsFiles.templateEngines` in the VSCode settings.

- RSpec is used for test files, but Minitest has not been supported yet.

- [ViewComponent](https://viewcomponent.org/) is supported out of the box. If [sidecar directories](https://viewcomponent.org/guide/generators.html#place-the-view-in-a-sidecar-directory) are being used, set `navigateRailsFiles.useViewComponentsSidecar` to `true`.
### Navigate to ruby files
Shortcut: Alt + I
![Alt text](./img/navigate-to-ruby-file.png)

### Navigate to files ending with `.html`
Shortcut: Alt + O
![Alt text](./img/navigate-to-html-file.png)

- Files ending with template engines (`erb`, `slim`, and `haml` as default or custom ones) are checked one-by-one.

- If there is no html file, a turbo_stream file is opened if it exists.

- So the order of checked files is as follows: `html.erb`, `html.slim`, `html.haml`, `turbo_stream.erb`, `turbo_stream.slim`, and `turbo_stream.haml`.

### Navigate to files ending with `.turbo_stream`
Shortcut: Alt + U
![Alt text](./img/navigate-to-turbo-stream-file.png)

### Navigate to test files
Shortcut: Alt + P
![Alt text](./img/navigate-to-test-file.png)

## Extension Settings

This extension contributes the following settings:

* `navigateRailsFiles.allowToOpenRbFile`: Allows using the shortcut to open Ruby files ("true" by default).
* `navigateRailsFiles.allowToOpenAppHtmlFile`: Allows using the shortcut to open view (.html) files ("true" by default).
* `navigateRailsFiles.allowToOpenAppTurboStreamFile`: Allows using the shortcut to open view (.turbo_stream) files ("true" by default).
* `navigateRailsFiles.allowToOpenRspecFile`: Allows using the shortcut to open test (RSpec) files ("true" by default).

## How to Test the Extension Locally

- Press "F1" and select "Debug: Select and Start Debugging." Then select "Extension Tests."

## How to Use a Custom Version of the Extension

The extension can be customized by any developer easily. Please follow the steps below to use your custom version.

- Clone the repository.
- Run `npm install -g @vscode/vsce` to install [vsce](https://github.com/microsoft/vscode-vsce) if necessary.
- Customize any part of the project.
- Run `vsce package`.
- Open your VSCode.
- Press "F1" and select "Extensions: Install from VSIX." Then, select the generated file ending with `.vsix`.

## Authors

Reach out to us at one of the following places!

👤 **Hasan Özovalı**

- LinkedIn: [Hasan Ozovali](https://www.linkedin.com/in/hasan-ozovali/)
- Github: [@ozovalihasan](https://github.com/ozovalihasan)
- Twitter: [@ozovalihasan](https://twitter.com/ozovalihasan)

## Contributing 🤝

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/ozovalihasan/navigateRailsFiles/issues).

## Show Your Support

Give a ⭐️ if you like the extension!

## License

[![License](https://img.shields.io/:license-mit-blue.svg?style=flat-square)](https://badges.mit-license.org/)

- **[MIT license](https://opensource.org/license/mit/)**