https://github.com/joesobo/codegraphy
VSCode force-based graph extension for displaying file connections
https://github.com/joesobo/codegraphy
connections extension graph hacktoberfest hierarchy visual-studio-code vscode vscode-extension
Last synced: about 2 months ago
JSON representation
VSCode force-based graph extension for displaying file connections
- Host: GitHub
- URL: https://github.com/joesobo/codegraphy
- Owner: joesobo
- License: mit
- Created: 2022-05-15T19:43:33.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-12T00:47:19.000Z (about 2 years ago)
- Last Synced: 2024-05-02T02:20:00.212Z (12 months ago)
- Topics: connections, extension, graph, hacktoberfest, hierarchy, visual-studio-code, vscode, vscode-extension
- Language: TypeScript
- Homepage:
- Size: 360 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# CodeGraphy
> CodeGraphy **enhances** files connections inside VSCode and allows for **birds eye views** of each repository. It helps you to **visualize code hierarchy** at a glance, **seamlessly navigate and explore** your file hierarchy, **gain valuable insights** via a force based node graph UI, and more.
CodeGraphy is an [open-source](https://github.com/joesobo/CodeGraphy "Open CodeGraphy on GitHub") extension for [Visual Studio Code](https://code.visualstudio.com).
Simply CodeGraphy helps you **better understand file connections**. With its force-based graph you can get a completely different view of the architecture of your codebase and make quick informed decisions about where your code is "knotted" in the graph.
# Note!
Development for V2 is underway. This involves some large scale changes so its been completely rewritten from the ground up and will perform much better, with many additional features. Feel free to track its progress here: https://github.com/joesobo/CodeGraphyV2
## Install CodeGraphy
Install CodeGraphy for [VSCode](https://marketplace.visualstudio.com/items?itemName=codegraphy.codegraphy)
## Features
### Node Graph
CodeGraphy's main feature is its ability to display the file hierarchy within the current directory and the connections within the files of the directory.
- Ability to open files directly from CodeGraphy
- Can change the style of the force-based graph
- Displays connections between files
### Settings
To color of nodes and selected node of the graph add these configurations to your `settings.json`. You can also `blacklist` any files or folders you want ignored. These can be manually editted from the `Config` section of the extension.
```json
"codegraphy.selectedColor": "#fff",
"codegraphy.nodeSettings": [
{
"extension": ".js",
"color": "#4985be"
},
{
"extension": ".ts",
"color": "#eac73e"
},
{
"extension": ".vue",
"color": "#74cc4b"
},
{
"extension": ".json",
"color": "#dc6844"
}
],
"codegraphy.blacklist": [
".spec.",
".vscode",
".git",
".github",
"node_modules",
"dist",
],
```
## Known Issues
This extension is still a work in progress. It is subject to major changes still.
- Does not include custom relative pathing (Ex: `@/file/to/path.js`)
## Contributing
Contributions are always welcome for CodeGraphy! Please make sure to read the [Contributing Guide](https://github.com/joesobo/CodeGraphy/blob/main/.github/CONTRIBUTING.md) before making a pull request.
## License
[MIT](https://opensource.org/licenses/MIT)
Copyright (c) 2022-present, Joe Soboleski