Skip to content
This repository was archived by the owner on Feb 6, 2024. It is now read-only.

Commit 92dac89

Browse files
authored
docs: update directive docs
1 parent 7607dad commit 92dac89

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/directive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# The dependency-tree's directive
22

3-
In most cases, statical source code analysis works quite well for purposes that the dependency-tree tool aims to target. However, this approach doesn't work for some rare, yet important cases. Since most of the application's code depends on the configuration files indirectly an ability to link these files with the application's source code became crucial. For example, the tool is currently unable to build a correct dependency graph between a file with available agent queues in it (e.g. `production/buildkite/queues.json`) and the application's source code. Another example where there is no full (AST processing) support for a particular language (e.g. `*.ejs`, `*.sh`, etc) in the dependency-tree tool but since we use this language in critical paths of the system it's important to build dependency graph correctly for such cases.
3+
In most cases, statical source code analysis works quite well for purposes that the dependency-tree tool aims to target. However, this approach doesn't work for some rare, yet important cases. Since most of the application's code depends on the configuration files indirectly an ability to link these files with the application's source code became crucial. For example, the tool is currently unable to build a correct dependency graph between some configuration files and the application's source code. Another example where there is no full (AST processing) support for a particular language (e.g. `*.ejs`, `*.sh`, etc) in the dependency-tree tool but since we use this language in critical paths of the system it's important to build dependency graph correctly for such cases.
44

55
The approach to address this problem could look like to annotate some of the files with pieces of metadata that let the tool know how to build a dependency graph.
66

0 commit comments

Comments
 (0)