almin-usecase-map-generator

Command line tool that generate UseCase map from almin's UseCases.

└── use-case
    ├── group-a
    │   ├── AUseCase.ts
    │   └── BUseCase.ts
    └── group-b
        ├── CUseCase.ts
        └── DUseCase.ts

This tool generate UML from your UseCase codes. The UML is based on nomnoml.

Install

Install with npm:

npm install almin-usecase-map-generator

Usage

Usage
  $ almin-usecase-map-generator "[glob*]"
  # the glob pattern match your usecase files


Options
  --output  output path
  --format  "nomnoml" | "svg" | "url" (default: "svg")

Examples
  $ almin-usecase-map-generator "src/use-case/**/*.js"

Structure of UseCase

For example, Faao.

• UseCase
  • Group/
    • UseCase files

Coommand:

almin-usecase-map-generator "./UseCase/**/*UseCase.ts"

Result:

• https://azu.github.io/faao/meta/use-case.html

File Tree:

✈ tree
UseCase
├── App
│   ├── AppUserOpenGitHubUserCase.ts
│   ├── AppUserOpenGitHubUserEventUseCase.ts
│   ├── AppUserOpenItemUseCase.ts
│   ├── AppUserOpenStreamUseCase.ts
│   ├── AppUserSelectFirstItemUseCase.ts
│   ├── AppUserSelectItemUseCase.ts
│   ├── AppUserSelectNextItemUseCase.ts
│   ├── AppUserSelectPrevItemUseCase.ts
│   ├── OpenItemInNewTabUseCase.ts
│   ├── UpdateAppNetworkStatusUseCase.ts
│   └── UpdateQueryToSearchListUseCase.ts
├── DomainConnection
│   ├── GItHubSettingToGitHubUser.ts
│   └── README.md
├── GitHubSearchList
│   ├── AddSearchListUseCase.ts
│   ├── DeleteQueryUseCase.ts
│   ├── SaveQueryToSearchListUseCase.ts
│   ├── SearchQueriesAndOpenStreamUseCase.ts
│   ├── SearchQueriesAndUpdateStreamUseCase.ts
│   ├── SearchQueryAndOpenStreamUseCase.ts
│   ├── SearchQueryToUpdateStreamUseCase.ts
│   ├── ToggleQueryPanelUseCase.ts
│   └── ToggleSearchListPanelUseCase.ts
├── GitHubSearchStream
│   ├── ApplyFilterToCurrentStreamUseCase.ts
│   ├── ReloadActiveStreamUseCase.ts
│   └── ReloadAllStreamUseCase.ts
├── GitHubSetting
│   ├── CheckGrantGitHubAPIUseCase.ts
│   ├── DeleteSettingUseCase.ts
│   ├── SaveGitHubSettingUseCase.ts
│   ├── ToggleSettingPanelUseCase.ts
│   └── __tests__
│       └── ToggleSettingPanelUseCase-test.ts
├── GitHubUser
│   ├── ApplyFilterToCurrentUserActivityUseCase.ts
│   ├── FetchGitHubUserActivityUseCase.ts
│   ├── FetchGitHubUserDataUserCase.ts
│   └── ReloadCurrentUserActivityUseCase.ts
├── Mobile
│   └── ToggleMobileMenuUseCase.ts
├── Notice
│   ├── DismissErrorNoticeUseCase.ts
│   ├── ShowErrorNoticeUseCase.ts
│   ├── ShowGenericErrorUseCase.ts
│   └── __tests__
│       ├── DismissErrorNoticeUseCase-test.ts
│       └── ShowErrorNoticeUseCase-test.ts
├── Profile
│   ├── ExportProfileUseCase.ts
│   ├── ImportProfileJSONUseCase.ts
│   ├── ToggleProfileWindowUseCase.ts
│   └── __tests__
│       ├── ExportProfileUseCase-test.ts
│       └── ImportProfileJSONUseCase-test.ts
├── QuickIssue
│   ├── CloseQuickIssueUseCase.ts
│   ├── OpenGitHubIssueUseCase.ts
│   └── OpenQuickIssueUseCase.ts
└── System
    ├── ClearAllStorageUseCase.ts
    ├── ClearCacheDataUseCase.ts
    └── SystemReadyToLaunchAppUseCase.ts

Usage of module

• [ ] Need more info

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

Author

• github/azu
• twitter/azu_re

License

MIT © azu