Open source · Data & Analytics

Dashboard Source Map

Map dashboard tiles to source queries, models and freshness evidence.

v0.1.0 · Node.js 22+ · MIT

Browse the public repository · View releases

Somebody renames a model. Nothing breaks that afternoon, because the warehouse still has the old table; three weeks later a tile on a board nobody owns is quietly wrong, and finding out which tiles were affected means opening every dashboard by hand.

This walkthrough uses the tool's public README and checked-in example files. Run the command from a repository checkout with Node.js 22+; inspect the source before using it on your own files.

Run the checked-in example

# A pair of exports that resolves end to end.
node bin/dashboard-source-map.mjs --root examples/clean            # exit 0

# The same dashboards after a model was renamed, with the rename recorded.
node bin/dashboard-source-map.mjs --root examples/renamed          # exit 0, impacted tiles named

# The same rename with nothing recorded: a broken link.
node bin/dashboard-source-map.mjs --root examples/broken           # exit 1

# A dashboard exported from another tool, sitting beside a readable one.
node bin/dashboard-source-map.mjs --root examples/unsupported      # exit 2

# Write the map itself.
node bin/dashboard-source-map.mjs --root examples/clean --out /tmp/source-map.json

Read the result

stdout carries the JSON report and nothing else. stderr carries a human summary; --quiet turns it off. The source map is written only when --out is given.

Where this check stops

Every bound is enforced before the work: the directory listing is counted before a file is opened, each document's size comes from stat before its bytes are read, and every count is checked against the parsed document before the map is built. Exceeding one is an incomplete result naming the limit, never a silent truncation and never a pass.

Before adapting the command to your own workflow, review the accepted inputs, exit codes and safety boundaries in the README.

Compiled with AI assistance from checked-in public documentation and example scripts. Run the example and review the repository's current documentation before relying on its result.