MirroredRepos/bat
1
0
Fork 0
mirror of https://github.com/sharkdp/bat.git synced 2025-09-29 00:22:26 +01:00
Code Issues Releases Wiki Activity

build_assets.rs: Enable dump of syntax dependencies to Graphviz dot file

Browse Source
This commit is contained in:
Martin Nordholts
2021-09-22 09:30:42 +02:00
parent b9d01c1a61
commit 9d9b266f54
2 changed files with 68 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
src/assets/build_assets.rs
View File

@@ -8,6 +8,8 @@ use syntect::parsing::{Scope, SyntaxSet, SyntaxSetBuilder};
use crate::assets::*;
mod graphviz_utils;
type SyntaxName = String;
/// Used to look up which [SyntaxDefinition] corresponds to a given [OtherSyntax]
@@ -221,6 +223,11 @@ fn build_minimal_syntax_sets(
let (other_syntax_lookup, syntax_to_dependencies, syntax_to_dependents) =
generate_maps(syntaxes);
maybe_write_syntax_dependencies_to_graphviz_dot_file(
&other_syntax_lookup,
&syntax_to_dependencies,
);
// Create one minimal SyntaxSet from each (non-hidden) SyntaxDefinition
syntaxes.iter().filter_map(move |syntax| {
if syntax.hidden {
@@ -329,6 +336,26 @@ fn dependencies_from_pattern(pattern: &Pattern) -> Vec<OtherSyntax> {
.collect()
}
/// To generate a Graphviz dot file of syntax dependencies, do this:
/// ```bash
/// sudo apt install graphviz
/// BAT_SYNTAX_DEPENDENCIES_TO_GRAPHVIZ_DOT_FILE=/tmp/bat-syntax-dependencies.dot cargo run -- cache --build --source assets --blank --target /tmp
/// dot /tmp/bat-syntax-dependencies.dot -Tpng -o /tmp/bat-syntax-dependencies.png
/// open /tmp/bat-syntax-dependencies.png
/// ```
fn maybe_write_syntax_dependencies_to_graphviz_dot_file(
other_syntax_lookup: &OtherSyntaxLookup,
syntax_to_dependencies: &SyntaxToDependencies,
) {
if let Ok(dot_file_path) = std::env::var("BAT_SYNTAX_DEPENDENCIES_TO_GRAPHVIZ_DOT_FILE") {
graphviz_utils::try_syntax_dependencies_to_graphviz_dot_file(
other_syntax_lookup,
syntax_to_dependencies,
&dot_file_path,
);
}
}
/// Removes any context name from the syntax reference.
///
/// When we track dependencies between syntaxes, we are not interested in