layerlens 1.0.9

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

LayerLens

Generate dependency diagram in every folder of your source code as Mermaid flowchart documents.

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.

Prerequisites

To see the diagrams in IDE:

• VSCode: install Markdown Preview Mermaid Support extension

• Android Studio: enable the "Mermaid" extension in the Markdown language settings

Assumptions

All internal dependencies would be referenced with relative directives.

Use prefer_relative_imports to guarantee this.

Generate diagrams

1. Add a dev_dependency to https://pub.dev/packages/layerlens
2. Run dart pub get or flutter pub get
3. Run dart run layerlens
4. Find the generated file DEPENDENCIES.md in a source folder
5. In VSCode, right click the file and select 'Open Preview'

CI: re-generate on every GitHub push

To make GitHub re-generating the diagrams after every push, copy content of run-layerlens.yaml to .github/workflows.

Alert on circular references

You may want to avoid circular references, because without circles:

1. Method contracts are easier to understand and clean up
2. Treeshaking (i.e. not includine non-used code into build) is more efficient
3. Incremental build is faster

LayerLens marks inverted dependencies (dependencies that create circles) with '!'.

If, in addition, you want presubmit alerting for circular references, upvote the issue and explain your use case.

Supported languages

While layerlens concepts are language agnostic, 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.