https://github.com/BBVAEngineering/ember-cli-route-map

Command to generate a route map of your Ember application.
https://github.com/BBVAEngineering/ember-cli-route-map

Last synced: 3 months ago
JSON representation

Command to generate a route map of your Ember application.

• Host: GitHub
• URL: https://github.com/BBVAEngineering/ember-cli-route-map
• Owner: BBVAEngineering
• License: mit
• Created: 2018-07-27T11:22:49.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-01-28T13:17:19.000Z (almost 5 years ago)
• Last Synced: 2024-07-04T05:23:17.938Z (4 months ago)
• Language: JavaScript
• Homepage: https://bbvaengineering.github.io/ember-cli-route-map/
• Size: 2.64 MB
• Stars: 15
• Watchers: 11
• Forks: 1
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-ember - ember-cli-route-map - Command to generate a route map of your Ember.js application. (Packages / Debugging / Profiling)

README

        
# ember-cli-route-map

[![Build Status](https://travis-ci.org/BBVAEngineering/ember-cli-route-map.svg?branch=master)](https://travis-ci.org/BBVAEngineering/ember-cli-route-map)

[![GitHub version](https://badge.fury.io/gh/BBVAEngineering%2Fember-cli-route-map.svg)](https://badge.fury.io/gh/BBVAEngineering%2Fember-cli-route-map)

[![NPM version](https://badge.fury.io/js/ember-cli-route-map.svg)](https://badge.fury.io/js/ember-cli-route-map)

[![Dependency Status](https://david-dm.org/BBVAEngineering/ember-cli-route-map.svg)](https://david-dm.org/BBVAEngineering/ember-cli-route-map)

[![codecov](https://codecov.io/gh/BBVAEngineering/ember-cli-route-map/branch/master/graph/badge.svg)](https://codecov.io/gh/BBVAEngineering/ember-cli-route-map)

[![Greenkeeper badge](https://badges.greenkeeper.io/BBVAEngineering/ember-cli-route-map.svg)](https://greenkeeper.io/)

[![Ember Observer Score](https://emberobserver.com/badges/ember-cli-route-map.svg)](https://emberobserver.com/addons/ember-cli-route-map)

## Information

[![NPM](https://nodei.co/npm/ember-cli-route-map.png?downloads=true&downloadRank=true)](https://nodei.co/npm/ember-cli-route-map/)

Command to generate a route map of your Ember application.

To see what can be done [visit the example page](https://bbvaengineering.github.io/ember-cli-route-map/), it's the real route map from the [BBVA Mobile App](https://movil.bbva.es/)!

![ember-cli-route-map](https://raw.githubusercontent.com/BBVAEngineering/ember-cli-route-map/master/assets/ember-cli-route-map.jpg)

## Installation

```

ember install ember-cli-route-map

```

### Usage

#### Output result in the console

Run the next command:

```bash

ember route-map

```

![console](https://raw.githubusercontent.com/BBVAEngineering/ember-cli-route-map/master/assets/console.png)

#### Storing the report inside a directory

Use `--output` to select an output dir:

```bash

ember route-map --output="reports/route-map/"

```

#### Pretty output, save in HTML format

Use `--pretty` and `--output`:

```bash

ember route-map --output="reports/route-map/" --pretty

```

![console](https://raw.githubusercontent.com/BBVAEngineering/ember-cli-route-map/master/assets/reports.png)

#### ¿How can I add another directory to the report?

If your project have a different directory tree from the official Ember project you can use the `--globs` flag.

It accepts an Array of directories and remember to add all the paths because the default directories will be overriden.

```bash

ember route-map --globs "app/router.js" --globs "addons/*/reopens/router.js" --globs "lib/*/addon/routes/routes.js"

```

## Contribute

If you want to contribute to this addon, please read the [CONTRIBUTING.md](CONTRIBUTING.md).

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/BBVAEngineering/ember-cli-route-map/tags).

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details