layerlens 1.0.4

Generate a dependency diagram in every folder of your source code.

LayerLens

Generate dependency diagram in every folder of your source code.

Disclaimer

This project is not an official Google project. It is not supported by Google and Google specifically disclaims all warranties as to its quality, merchantability, or fitness for a particular purpose.

Use layerlens

Prerequisites

Install Markdown Preview Mermaid Support extension to VSCode, to see the diagrams locally, in preview.

Generate diagrams for your project

1. Add dependency to https://pub.dev/packages/layerlens
2. Run dart run layerlens in the root of your project
3. Find the generated file DEPENDENCIES.md in a source folder
4. In VSCode, right click the file and select 'Open Preview'

Re-generate on every GitHub push

To make GitHub re-generating the diagrams after every push, copy regenerate-dependencies.yaml to .github/workflows.

Alert on circular references

If you want presubmit alerting for circular references, upvote the issue and explain why you want it.

Supported languages

While lauerlens diagramming is language agnistic, for now only dart is supported. Please submit an issue if you want other language to be added.

Contribute to layerlens

See CONTRIBUTING.md for details.

License

Apache 2.0; see LICENSE for details.