I broke both composites on main. Editing them with a pattern-match script, I replaced an import line by matching text that had already changed, so the replacement silently matched nothing and three names — RTL_LOCALES, getRuntimeLocale, detectLocale — were used and never imported. Setup threw a ReferenceError and both elements rendered nothing until a hotfix landed. ★ IT PASSED EVERY GATE, AND THAT IS THE INTERESTING PART. It compiled, because a free identifier is valid JavaScript until it RUNS. It passed my grep of the built bundle for the new code, because the code was genuinely there. It passed template-literal, sfc-parse, composite-freshness and SRI, because not one of them evaluates a setup function. The evidence I had could not distinguish a working composite from a dead one, and I called it "verified headless". So this asks the one question those gates cannot: is every name a component uses actually bound — imported, declared, a parameter, or a known global? It reads the same source the compiler reads, tracks real scopes (module, function, block, catch, class), and runs in milliseconds with no browser. Fleet-wide, over every .vue in plugin-designs/ and library/, because the mistake was a text-editing habit rather than anything about one plugin. WRITTEN BY RUNNING IT, which is the only way an allowlist gets honest. The first run reported 4,259 findings — every one a false positive from a real bug in my own walker: a helper that takes a node TYPE was being handed the NODE, so the function branch never fired and every parameter read as unbound. The second run found the globals this tree genuinely uses (d3, customElements, ShadowRoot, CSS, Function, self, the typed arrays) and vite's build-time defines. The third found a real gap in the gate: an SFC may have BOTH a plain <script> and a <script setup>, and they share a scope — LegendTools exports a function from one and uses it in the other, which I was reporting as free. Reading only one block would have taught the fleet to ignore this gate on its first run. NEGATIVE CONTROL, because a check that has never been seen to fail is not evidence: restoring the broken import makes it FAIL naming all three names and their lines; restored, it passes across 127 components. It is the cheap half of a pair — it proves a name is bound, not that the thing runs. The expensive half is a check that actually mounts a composite. |
||
|---|---|---|
| .. | ||
| all-people-groups | ||
| big-picture | ||
| cities-internet | ||
| country-posters | ||
| dashboard-plus-grid | ||
| demo-map | ||
| doxa-maps-spa | ||
| doxa-research-map | ||
| doxa-simple-map | ||
| doxa-vision-card | ||
| golden-path-check | ||
| gospel-resources | ||
| key-cities | ||
| my-upg-100-list | ||
| people-groups-grid | ||
| plugin-studio | ||
| pplr-data-maps | ||
| prayer-walk-planner | ||
| regions-dashboard | ||
| research-dashboard | ||
| research-map-plus-grid | ||
| stack-demo | ||
| template-bundle | ||
| upg-neighbor | ||
| wall-of-people-groups | ||
| .gitkeep | ||
| README.md | ||
plugin-designs/ — where YOUR maps live
The shared template lives in ../library/ (aliased @map) — you never edit it per-map.
You build your map by making a folder here, plugin-designs/<your-map>/, and composing the
template's building blocks. Your folder is yours (colors, API, i18n); the template is shared
(Apache-2.0, propagated to every map on the next build).
Shared vs. yours — the balance
library/ (@map) ── SHARED, reusable, parameterized ──► legend · map · map-controls
│ (every map reuses these)
│ imported by
▼
plugin-designs/<your-map>/ ── YOURS ──► the map's "main" class (the .vue profile = the Vue
│ instance for that map)
└── src/ ── YOURS ──► this map's OWN non-reusable components, colors, API, utils
One bundle can hold as many maps as you want — add another .vue profile and rebuild.
- Reusable →
library/. The legend, the map, the map-controls are shared, parameterized components every map reuses. Fix once, every map benefits. Never edit it to customize one map. - This map's own →
plugin-designs/<your-map>/. It holds two things: the map's "main" class (each.vueprofile is the Vue instance for that map) and that map's own non-reusable components (insrc/). Nothing here leaks to another map. - Many maps per bundle. The bundler bundles one map or many — add another flat
.vueand rebuild.
Production or experimental — every profile declares itself
Every app profile is one of two things, and experimental profiles are unlimited and encouraged — create as many as you need:
- Experimental, not built: prefix the folder with
_— the build skips it; it just sits in code. Zero cost, zero risk. - Experimental, built: builds normally, but it belongs in the Experimental section of the power app's layout (nav section) — never embedded on partner surfaces.
- Production: a real product — main sections of the power app + individually embeddable.
(The power app = the SPA layout that composes all profiles into one application.)
The pattern in one picture
plugin-designs/<your-map>/ ← one FOLDER = one BUNDLE, named after the folder
├── index.js ← entry: registers the custom element, finds the profiles
├── overview.vue ← one .vue = one PROFILE (flat in the folder — no profiles/ subfolder)
└── detail.vue ← another profile in the SAME bundle
builds to ─────────────► public/dx-maps/<your-map>/<your-map>.js (one file)
- Folder name = bundle name. Folders starting with
_or.are skipped (handy for WIP). - Each
.vue= one profile (one map screen). One bundle can hold many. - Pick the profile at embed time with the
profilefield — every profile shares one bundle:
<script src="/dx-maps/<your-map>/<your-map>.js"></script>
<your-map profile-config='{"profile":"overview","tk":"pk.eyJ..."}'></your-map>
<your-map profile-config='{"profile":"detail","tk":"pk.eyJ..."}'></your-map>
Add a map — three steps
# 1. create the folder + one profile
mkdir -p plugin-designs/<your-map>
# index.js ← copy doxa-simple-map/index.js, rename the tag
# <name>.vue ← your screen, built from @map/* blocks (flat in the folder)
# 2. build
npm run build # → public/dx-maps/<your-map>/<your-map>.js
# (just this one: BUNDLE=<your-map> npm run build:bundle)
# 3. embed the script tag + element (dev staging at `npm run dev` shows a paste-ready snippet)
Your three things (everything else is shared)
- Colors — how pins are colored. Pick one the template ships (
getColorStrategy('language-family')), or drop your own inplugin-designs/<your-map>/src/colors/(start fromtemplate-bundle/src/colors/example-mode.js). Never edit@map/colors/to recolor your map. - API — your map reads its data from the
profile-configon the page, so the same bundle points at different data with no rebuild.DataSourceManageracceptscsv(bundled file),api(one JSON URL), orrest-api(a live REST endpoint, the default). Prefer the real API over inlined JSON. - i18n — the template ships 11 base locales in
@map/i18n/locales/. UseuseI18n()for strings andRTL_LOCALESfor right-to-left; add or override strings from your own profile.
The one hosting variable
The only thing that changes between hosting modes is the <script src>: a relative path when
your own site serves the file, or an absolute CDN URL when a partner site serves it. The bundle
is identical either way. See ../documentation/CONTRIBUTING.md for the two CDN modes and partner-site embedding.
Profile patterns (mix freely)
- Individual — one
.vueper bundle (simplest). - Parameterized — one profile, behavior driven by
profile-configprops (e.g.tabs[]). - Nested — one profile that renders others (workbench-style, like
doxa-research-map).
See also
doxa-simple-map/index.js— fully commented reference bundle entrytemplate-bundle/— minimal two-profile skeleton to copy../library/colors/README.md— the color-strategy contract../README.md— repo overview & build pipeline ·../documentation/CONTRIBUTING.md— build vs dev, CDN modes