layerlens 1.0.1 layerlens: ^1.0.1 copied to clipboard
Generate a dependency diagram in every folder of your source code.
LayerLens #
Generate a dependency diagram in every folder of your source code.
flowchart TD;
generator.dart-->model.dart;
analyzer.dart-->layering.dart;
analyzer.dart-->model.dart;
analyzer.dart-->primitives.dart;
code_parser.dart-->model.dart;
code_parser.dart-->surveyor;
layering.dart-->model.dart;
model.dart-->primitives.dart;
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 #
Install Markdown Preview Mermaid Support
extension to VSCode,
to see the diagrams in VSCode preview.
Generate diagrams for your project #
- Add dependency to https://pub.dev/packages/layerlens
- Run
dart run layerlens
in the root of your project - Find the file DEPENDENCIES.md in each source folder
- In VSCode right click the file and select 'Open Preview'
Refresh on every GitHub push #
To make GitHub auto-generating the diagrams after every push,
copy refresh-dependencies.yaml
to .github/workflows
.
Contributing #
See CONTRIBUTING.md
for details.
License #
Apache 2.0; see LICENSE
for details.