{"id":27689694,"url":"https://github.com/almin/almin-usecase-map-generator","last_synced_at":"2025-04-25T10:39:39.750Z","repository":{"id":23290825,"uuid":"98639363","full_name":"almin/almin-usecase-map-generator","owner":"almin","description":"Command line tool that generate UseCase map from almin's UseCases.","archived":false,"fork":false,"pushed_at":"2024-12-21T09:29:52.000Z","size":588,"stargazers_count":3,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-24T01:36:50.852Z","etag":null,"topics":["generator","svg","tool","uml","usecase"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/almin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-28T10:33:38.000Z","updated_at":"2022-05-16T01:12:35.000Z","dependencies_parsed_at":"2022-09-13T19:51:31.713Z","dependency_job_id":"3fc35ec0-45d9-4567-bb34-008c50cc9fe3","html_url":"https://github.com/almin/almin-usecase-map-generator","commit_stats":{"total_commits":309,"total_committers":4,"mean_commits":77.25,"dds":0.08737864077669899,"last_synced_commit":"a0585db7e3eae2a9ae3e61bb97385311e0daf7dd"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/almin%2Falmin-usecase-map-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/almin%2Falmin-usecase-map-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/almin%2Falmin-usecase-map-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/almin%2Falmin-usecase-map-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/almin","download_url":"https://codeload.github.com/almin/almin-usecase-map-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250799633,"owners_count":21489326,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["generator","svg","tool","uml","usecase"],"created_at":"2025-04-25T10:39:39.245Z","updated_at":"2025-04-25T10:39:39.737Z","avatar_url":"https://github.com/almin.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# almin-usecase-map-generator [![Build Status](https://travis-ci.org/azu/almin-usecase-map-generator.svg?branch=master)](https://travis-ci.org/azu/almin-usecase-map-generator)\n\n\nCommand line tool that generate UseCase map from almin's UseCases.\n\n```\n└── use-case\n    ├── group-a\n    │   ├── AUseCase.ts\n    │   └── BUseCase.ts\n    └── group-b\n        ├── CUseCase.ts\n        └── DUseCase.ts\n```\n\n\n[![Example of output](./out.png)](./out.svg)\n\nThis tool generate UML from your UseCase codes.\nThe UML is based on [nomnoml](http://www.nomnoml.com/ \"nomnoml\").\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n    npm install almin-usecase-map-generator\n\n## Usage\n\n    Usage\n      $ almin-usecase-map-generator \"[glob*]\"\n      # the glob pattern match your usecase files\n\n\n    Options\n      --output  output path\n      --format  \"nomnoml\" | \"svg\" | \"url\" (default: \"svg\")\n    \n    Examples\n      $ almin-usecase-map-generator \"src/use-case/**/*.js\"\n\n\n## Structure of UseCase\n\nFor example, [Faao](https://github.com/azu/faao \"Faao\").\n\n- UseCase\n    - Group/\n        - UseCase files\n\n\n**Coommand**:\n\n```sh\nalmin-usecase-map-generator \"./UseCase/**/*UseCase.ts\"\n```\n\n**Result**:\n\n- \u003chttps://azu.github.io/faao/meta/use-case.html\u003e\n\n\n**File Tree**:\n\n```\n✈ tree\nUseCase\n├── App\n│   ├── AppUserOpenGitHubUserCase.ts\n│   ├── AppUserOpenGitHubUserEventUseCase.ts\n│   ├── AppUserOpenItemUseCase.ts\n│   ├── AppUserOpenStreamUseCase.ts\n│   ├── AppUserSelectFirstItemUseCase.ts\n│   ├── AppUserSelectItemUseCase.ts\n│   ├── AppUserSelectNextItemUseCase.ts\n│   ├── AppUserSelectPrevItemUseCase.ts\n│   ├── OpenItemInNewTabUseCase.ts\n│   ├── UpdateAppNetworkStatusUseCase.ts\n│   └── UpdateQueryToSearchListUseCase.ts\n├── DomainConnection\n│   ├── GItHubSettingToGitHubUser.ts\n│   └── README.md\n├── GitHubSearchList\n│   ├── AddSearchListUseCase.ts\n│   ├── DeleteQueryUseCase.ts\n│   ├── SaveQueryToSearchListUseCase.ts\n│   ├── SearchQueriesAndOpenStreamUseCase.ts\n│   ├── SearchQueriesAndUpdateStreamUseCase.ts\n│   ├── SearchQueryAndOpenStreamUseCase.ts\n│   ├── SearchQueryToUpdateStreamUseCase.ts\n│   ├── ToggleQueryPanelUseCase.ts\n│   └── ToggleSearchListPanelUseCase.ts\n├── GitHubSearchStream\n│   ├── ApplyFilterToCurrentStreamUseCase.ts\n│   ├── ReloadActiveStreamUseCase.ts\n│   └── ReloadAllStreamUseCase.ts\n├── GitHubSetting\n│   ├── CheckGrantGitHubAPIUseCase.ts\n│   ├── DeleteSettingUseCase.ts\n│   ├── SaveGitHubSettingUseCase.ts\n│   ├── ToggleSettingPanelUseCase.ts\n│   └── __tests__\n│       └── ToggleSettingPanelUseCase-test.ts\n├── GitHubUser\n│   ├── ApplyFilterToCurrentUserActivityUseCase.ts\n│   ├── FetchGitHubUserActivityUseCase.ts\n│   ├── FetchGitHubUserDataUserCase.ts\n│   └── ReloadCurrentUserActivityUseCase.ts\n├── Mobile\n│   └── ToggleMobileMenuUseCase.ts\n├── Notice\n│   ├── DismissErrorNoticeUseCase.ts\n│   ├── ShowErrorNoticeUseCase.ts\n│   ├── ShowGenericErrorUseCase.ts\n│   └── __tests__\n│       ├── DismissErrorNoticeUseCase-test.ts\n│       └── ShowErrorNoticeUseCase-test.ts\n├── Profile\n│   ├── ExportProfileUseCase.ts\n│   ├── ImportProfileJSONUseCase.ts\n│   ├── ToggleProfileWindowUseCase.ts\n│   └── __tests__\n│       ├── ExportProfileUseCase-test.ts\n│       └── ImportProfileJSONUseCase-test.ts\n├── QuickIssue\n│   ├── CloseQuickIssueUseCase.ts\n│   ├── OpenGitHubIssueUseCase.ts\n│   └── OpenQuickIssueUseCase.ts\n└── System\n    ├── ClearAllStorageUseCase.ts\n    ├── ClearCacheDataUseCase.ts\n    └── SystemReadyToLaunchAppUseCase.ts\n\n```\n\n## Usage of module\n\n- [ ] Need more info\n\n## Changelog\n\nSee [Releases page](https://github.com/almin/almin-usecase-map-generator/releases).\n\n## Running tests\n\nInstall devDependencies and Run `npm test`:\n\n    npm i -d \u0026\u0026 npm test\n\n## Contributing\n\nPull requests and stars are always welcome.\n\nFor bugs and feature requests, [please create an issue](https://github.com/almin/almin-usecase-map-generator/issues).\n\n1. Fork it!\n2. Create your feature branch: `git checkout -b my-new-feature`\n3. Commit your changes: `git commit -am 'Add some feature'`\n4. Push to the branch: `git push origin my-new-feature`\n5. Submit a pull request :D\n\n## Author\n\n- [github/azu](https://github.com/azu)\n- [twitter/azu_re](https://twitter.com/azu_re)\n\n## License\n\nMIT © azu\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falmin%2Falmin-usecase-map-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falmin%2Falmin-usecase-map-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falmin%2Falmin-usecase-map-generator/lists"}