Skip to content

Commit 0fc047c

Browse files
committed
Add note about JS / TS runtimes
1 parent b29843d commit 0fc047c

2 files changed

Lines changed: 16 additions & 1 deletion

File tree

.github/data/language-readme-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To update, modify .github/data/databases.json or .github/data/languages.json
2323
# {language_name} ADBC Quickstarts
2424

2525
Simple {language_name} examples showing how to use ADBC to connect, run a query, and return the results.
26-
26+
{language_notes}
2727
## Source systems covered
2828

2929
{databases_list}

.github/scripts/generate_readmes.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,15 @@
2929
# GitHub repository URL
3030
GITHUB_REPO_URL = "https://github.com/columnar-tech/adbc-quickstarts"
3131

32+
# Per-language notes inserted into language README files
33+
LANGUAGE_NOTES = {
34+
"javascript": (
35+
"> [!NOTE]\n"
36+
"> These examples require a server-side JS/TS runtime"
37+
" (like Node.js or Bun) and do not run in the browser."
38+
),
39+
}
40+
3241

3342
def load_mappings() -> tuple[dict[str, str], dict[str, dict]]:
3443
"""
@@ -233,13 +242,19 @@ def generate_language_readme(
233242
# Get language display name
234243
language_name = language_names.get(language, language.upper())
235244

245+
# Per-language notes
246+
language_notes = LANGUAGE_NOTES.get(language, "")
247+
if language_notes:
248+
language_notes = f"\n{language_notes}\n"
249+
236250
# Discover databases for this language
237251
language_dir = repo_root / language
238252
databases = discover_databases_for_language(language_dir, database_info)
239253
databases_list = format_databases_list(databases, database_info, link_mode="relative")
240254

241255
return template.format(
242256
language_name=language_name,
257+
language_notes=language_notes,
243258
databases_list=databases_list,
244259
)
245260

0 commit comments

Comments
 (0)