Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/s4ff0x/fsd-cruise

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/s4ff0x/fsd-cruise
Owner: s4ff0x
License: mit
Created: 2024-04-05T16:41:19.000Z (9 months ago)
Default Branch: main
Last Pushed: 2024-04-06T18:08:52.000Z (9 months ago)
Last Synced: 2024-07-08T09:59:22.689Z (6 months ago)
Language: JavaScript
Size: 31.3 KB
Stars: 13
Watchers: 1
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome - `fsd-cruise` - Sliced Design based on dependency-cruiser (DevExp / Tools)

README

        # [fsd-cruise](https://www.npmjs.com/package/fsd-cruise)

> `Currently in Beta`

[npm]: https://www.npmjs.com/package/fsd-cruise

[![npm](https://img.shields.io/npm/v/fsd-cruise?style=flat-square)][npm]

Simple dependency visualization for [Feature Sliced Design](https://feature-sliced.design/) based on [dependency-cruiser](https://www.npmjs.com/package/dependency-cruiser)

## Usage

### Install dependency-cruiser and run with npx

```shell

yarn add dependency-cruiser -D

npx fsd-cruise

```

> **requirements:** dependency-cruiser requires the `graphviz` library, which will be automatically installed using `brew`

> **limitations:** Currently, it only operates with the provided `tsconfig.json` and `src` folder paths, which are assumed by default to be in the root directory.

## Customization

1. You can provide custom paths to `src` folder and `tsconfig.json`

    ```shell

    npx fsd-cruise app/src app/tsconfig.json

    ```

## Output example