{"id":27998590,"url":"https://github.com/pjaerr/code-flow-extension","last_synced_at":"2026-03-01T12:31:58.729Z","repository":{"id":37717767,"uuid":"172728621","full_name":"Pjaerr/Code-Flow-Extension","owner":"Pjaerr","description":"VS Code Extension to map code flow output as a diagram","archived":false,"fork":false,"pushed_at":"2023-07-08T05:45:03.000Z","size":460,"stargazers_count":24,"open_issues_count":9,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-08T22:54:20.522Z","etag":null,"topics":["diagram","diagramming","typescript","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":"","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/Pjaerr.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,"zenodo":null}},"created_at":"2019-02-26T14:34:45.000Z","updated_at":"2025-05-01T05:15:00.000Z","dependencies_parsed_at":"2025-05-08T22:54:21.577Z","dependency_job_id":"202218c9-5d69-4c41-8eac-7c9da9fb2abf","html_url":"https://github.com/Pjaerr/Code-Flow-Extension","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Pjaerr/Code-Flow-Extension","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pjaerr%2FCode-Flow-Extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pjaerr%2FCode-Flow-Extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pjaerr%2FCode-Flow-Extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pjaerr%2FCode-Flow-Extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Pjaerr","download_url":"https://codeload.github.com/Pjaerr/Code-Flow-Extension/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pjaerr%2FCode-Flow-Extension/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29969243,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T11:43:06.159Z","status":"ssl_error","status_checked_at":"2026-03-01T11:43:03.887Z","response_time":124,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["diagram","diagramming","typescript","vscode","vscode-extension"],"created_at":"2025-05-08T22:54:17.533Z","updated_at":"2026-03-01T12:31:58.711Z","avatar_url":"https://github.com/Pjaerr.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Code Flow - VS Code Extension\n\n**Code Flow** is a Visual Studio Code extension that generates a diagram showing annotated flow between different points within your codebase.\n\nI created this extension as a way to help map out my thoughts around how a codebase, or particular part of a codebase, is structured without having to leave the context of the code to write up a diagram.\n\n![](https://media.giphy.com/media/THlJRdtu8OkSAhybNj/source.gif)\n\nExtension Installation Link: https://marketplace.visualstudio.com/items?itemName=JoshJackson.code-flow-extension\n\n## How To Use\n\nThe way this extension works is you select a line within a file in your codebase, give that line a **name** and some extra **detail** about what the line does. Once you have a line, also called a Data Point, you can then select the next Data Point, this is the one that the previously selected Data Point/line connects to in the resulting diagram.\n\n1. Navigate to the line of code you want to create a Data Point from\n1. Press `CTRL + SHIFT + P` to open the command picker\n1. Type in _CodeFlow_ and press enter\n1. Select the **Add Data Point** option which will prompt you for a name, give it a name and then press enter. You will then be prompted for some detail about your Data Point.\n1. Repeat the above process as if you were drawing a diagram and each Data Point is a connection in the diagram.\n1. Once you have all of your points, you can press `CTRL + SHIFT + P` to open the command picker and open _CodeFlow_ to then select **Generate Diagram**.\n1. Once you are happy with your diagram, you can save your selected Data Points as a .json file so you can reopen them at a later date if required.\n\n## Contributing\n\nI am happy for any sort of contributions to this project as I believe it is a very useful _idea_ and can undoubtedly be improved via open source contributions. Please feel free to work on whatever you feel can be improved and I will happily go through the pull request!\n\nIf you are unsure what to work on, I have added any bugs as well as future features as Github [Issues](https://github.com/Pjaerr/Code-Flow-Extension/issues).\n\nIf you wish to contribute, you can follow the getting setup guide below:\n\n### Getting Setup\n\n1. Clone this repository and run `npm install`\n\n2. Run `npm run test` to ensure everything is working as expected (optional)\n\n3. Open the root folder in VS Code\n\n4. Press F5 to debug the extension, this will open a development version of vs code.\n\n**To use the extension:** Press `CTRL + SHIFT + P` to open the command picker, type in `CodeFlow` and press enter.\n\n### Important features that are missing\n\n- Saving a diagram as an image (see: https://github.com/Pjaerr/Code-Flow-Extension/issues/12)\n\n- Exporting the diagram as XML to be used in stuff like Lucid Charts or Draw.io (see: https://github.com/Pjaerr/Code-Flow-Extension/issues/14)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpjaerr%2Fcode-flow-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpjaerr%2Fcode-flow-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpjaerr%2Fcode-flow-extension/lists"}