Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fnando/enroute
Generates a TypeScript file that defines all named routes from Rails as helper functions.
https://github.com/fnando/enroute
rails rails-routes routes typescript
Last synced: 28 days ago
JSON representation
Generates a TypeScript file that defines all named routes from Rails as helper functions.
- Host: GitHub
- URL: https://github.com/fnando/enroute
- Owner: fnando
- License: mit
- Created: 2020-02-14T01:36:49.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-08T22:55:56.000Z (9 months ago)
- Last Synced: 2024-10-06T04:27:27.818Z (about 1 month ago)
- Topics: rails, rails-routes, routes, typescript
- Language: Ruby
- Homepage:
- Size: 118 KB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Enroute
Generates a TypeScript file that defines all named routes from Rails as helper
functions.
[](https://github.com/fnando/enroute)
[](https://rubygems.org/gems/enroute)
[](https://rubygems.org/gems/enroute)
## Installation
Add this line to your application's Gemfile:
```ruby
gem "enroute"
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install enroute
## Usage
All you have to do is call the `enroute` binary with the main file you want to
load and a output path.
```console
$ bundle exec enroute export --output ./app/frontend/scripts/config/routes.ts
```
By default, `/config/environment.rb` will be loaded. If you want to use a
different file, use the `--require` switch.
```console
$ bundle exec enroute export --require ./different-file.rb --output ./routes.ts
```
You can also ignore routes by using a config file.
```console
$ bundle exec enroute export --output ./app/frontend/scripts/config/routes.ts --config ./config/enroute.yml
```
The config file must look like this:
```yaml
---
ignore:
- route_name
```
There's also a `:only` option that will include only the matching named routes.
```yaml
---
only:
- route_name
```
By default, route params will be typed as `any`. To add a custom typing
annotation, you can use the `typings` key on the configuration file. Imagine you
have the route `get "settings/edit(/:section)" => "", as: "edit_settings"`; you
can have a config file like this:
```yaml
---
typings:
_default:
format: '"html" | "json"'
edit_settings:
section: string
```
### Importing helpers on TypeScript
You can then import any route that's been exported. Parameters are positional.
```typescript
import { userUrl } from "./routes";
userUrl({ id: 1234 });
//=> "/users/1234"
userUrl({ id: 1234, format: "json" });
//=> "/users/1234.json"
```
You can also have routes with optional segments. For instance, imagine you have
define the route `get "settings/edit(/:section)" => "", as: "edit_settings"`.
You could then use the helper `editSettingsUrl()` like this:
```typescript
import { editSettingsUrl } from "./routes";
editSettingsUrl();
//=> "/settings/edit"
editSettingsUrl({ section: "security" });
//=> "/settings/edit/security"
```
All helpers are typed accordingly to the route definition. For convenience, you
may pass any primitives as a url parameter, which will then be converted into
string.
An exception will be raised if you forget to provide a required parameter; empty
strings, `null` and `undefined` will be rejected, but `false` is accepted.
```typescript
import { userUrl } from "./routes";
userUrl();
//=> raises `id is required, but received undefined`
```
## Maintainer
- [Nando Vieira](https://github.com/fnando)
## Contributors
- https://github.com/fnando/enroute/contributors
## Contributing
For more details about how to contribute, please read
https://github.com/fnando/enroute/blob/main/CONTRIBUTING.md.
## License
The gem is available as open source under the terms of the
[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
found at https://github.com/fnando/enroute/blob/main/LICENSE.md.
## Code of Conduct
Everyone interacting in the enroute project's codebases, issue trackers, chat
rooms and mailing lists is expected to follow the
[code of conduct](https://github.com/fnando/enroute/blob/main/CODE_OF_CONDUCT.md).