Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,14 @@ Run: `cargo run -p plotnik-cli -- <command>`

Inputs: `-q/--query <Q>`, `--query-file <F>`, `--source <S>`, `-s/--source-file <F>`, `-l/--lang <L>`

Output: `--show-query`, `--show-source`, `--only-symbols`, `--cst`, `--raw`, `--spans`, `--cardinalities`
Output (inferred from input): `--only-symbols`, `--cst`, `--raw`, `--spans`, `--cardinalities`

```sh
cargo run -p plotnik-cli -- debug -q '(identifier) @id' --show-query
cargo run -p plotnik-cli -- debug -q '(identifier) @id'
cargo run -p plotnik-cli -- debug -q '(identifier) @id' --only-symbols
cargo run -p plotnik-cli -- debug -s app.ts --show-source
cargo run -p plotnik-cli -- debug -s app.ts --show-source --raw
cargo run -p plotnik-cli -- debug -q '(function_declaration) @fn' -s app.ts -l typescript --show-query
cargo run -p plotnik-cli -- debug -s app.ts
cargo run -p plotnik-cli -- debug -s app.ts --raw
cargo run -p plotnik-cli -- debug -q '(function_declaration) @fn' -s app.ts -l typescript
```

## Syntax
Expand Down
18 changes: 5 additions & 13 deletions crates/plotnik-cli/src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ pub struct Cli {
pub enum Command {
/// Debug and inspect queries and source files
#[command(after_help = r#"EXAMPLES:
plotnik debug -q '(identifier) @id' --show-query
plotnik debug -q '(identifier) @id'
plotnik debug -q '(identifier) @id' --only-symbols
plotnik debug -s app.ts --show-source
plotnik debug -s app.ts --show-source --raw
plotnik debug -q '(function_declaration) @fn' -s app.ts -l typescript --show-query"#)]
plotnik debug -s app.ts
plotnik debug -s app.ts --raw
plotnik debug -q '(function_declaration) @fn' -s app.ts -l typescript"#)]
Debug {
#[command(flatten)]
query: QueryArgs,
Expand Down Expand Up @@ -88,19 +88,11 @@ pub struct SourceArgs {

#[derive(Args)]
pub struct OutputArgs {
/// Show query syntax tree
#[arg(long = "show-query")]
pub query: bool,

/// Colorize output (auto-detected by default)
#[arg(long, default_value = "auto", value_name = "WHEN")]
pub color: ColorChoice,

/// Show source syntax tree
#[arg(long = "show-source")]
pub source: bool,

/// Show only symbol table
/// Show only symbol table (instead of query AST)
#[arg(long = "only-symbols")]
pub symbols: bool,

Expand Down
32 changes: 12 additions & 20 deletions crates/plotnik-cli/src/commands/debug/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ pub struct DebugArgs {
pub source_text: Option<String>,
pub source_file: Option<std::path::PathBuf>,
pub lang: Option<String>,
pub query: bool,
pub source: bool,
pub symbols: bool,
pub raw: bool,
pub cst: bool,
Expand Down Expand Up @@ -45,15 +43,11 @@ pub fn run(args: DebugArgs) {
})
});

let show_headers = [args.query, args.source, args.symbols]
.iter()
.filter(|&&x| x)
.count()
>= 2;
let show_query = has_query_input && !args.symbols;
let show_source = has_source_input;
let show_headers = (show_query || args.symbols) && show_source;

if args.query
&& let Some(ref q) = query
{
if show_query && let Some(ref q) = query {
if show_headers {
println!("=== QUERY ===");
}
Expand Down Expand Up @@ -83,7 +77,7 @@ pub fn run(args: DebugArgs) {
);
}

if args.source {
if show_source {
let resolved_lang = resolve_lang(&args.lang, &args.source_text, &args.source_file);
let source_code = load_source(&args.source_text, &args.source_file);
let tree = parse_tree(&source_code, resolved_lang);
Expand Down Expand Up @@ -120,20 +114,18 @@ fn load_query(args: &DebugArgs) -> String {
}

fn validate(args: &DebugArgs, has_query: bool, has_source: bool) -> Result<(), &'static str> {
if (args.query || args.symbols) && !has_query {
return Err("--query and --only-symbols require --query-text or --query-file");
if !has_query && !has_source {
return Err(
"specify at least one input: -q/--query, --query-file, -s/--source-file, or --source",
);
}

if args.source && !has_source {
return Err("--source requires --source-text or --source-file");
if args.symbols && !has_query {
return Err("--only-symbols requires -q/--query or --query-file");
}

if args.source_text.is_some() && args.lang.is_none() {
return Err("--lang is required when using --source-text");
}

if !args.query && !args.source && !args.symbols {
return Err("specify at least one output: --query, --source, or --only-symbols");
return Err("--lang is required when using --source");
}

Ok(())
Expand Down
2 changes: 0 additions & 2 deletions crates/plotnik-cli/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ fn main() {
source_text: source.source_text,
source_file: source.source_file,
lang,
query: output.query,
source: output.source,
symbols: output.symbols,
raw: output.raw,
cst: output.cst,
Expand Down