FilesExpand file tree

main

/

generate-model-tables.js

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

169 lines (144 loc) · 5.65 KB

main

/

generate-model-tables.js

Copy path

Top

File metadata and controls

• Code
• Blame

169 lines (144 loc) · 5.65 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

#!/usr/bin/env node

/**

* Model Tables Documentation Generator

*

* Reads the built-in model alias map from JSON data files and generates an

* intuitively readable reference page with markdown tables.

*

* Usage:

* node scripts/generate-model-tables.js

*

* Inputs:

* pkg/cli/data/model_aliases.json – Built-in alias → pattern mappings

*

* Output:

* docs/src/content/docs/reference/model-tables.md

*/

import fs from "fs";

import path from "path";

import { fileURLToPath } from "url";

const __filename = fileURLToPath(import.meta.url);

const __dirname = path.dirname(__filename);

const ROOT = path.resolve(__dirname, "..");

const ALIASES_PATH = path.join(ROOT, "pkg/workflow/data/model_aliases.json");

const OUTPUT_PATH = path.join(ROOT, "docs/src/content/docs/reference/model-tables.md");

// ---------------------------------------------------------------------------

// Load data

// ---------------------------------------------------------------------------

/**

* Read and parse a JSON file, with a clear error message on failure.

* @param {string} filePath

* @returns {any}

*/

function readJSON(filePath) {

let raw;

try {

raw = fs.readFileSync(filePath, "utf-8");

} catch (err) {

console.error(`Error: could not read ${filePath}: ${err.message}`);

process.exit(1);

}

try {

return JSON.parse(raw);

} catch (err) {

console.error(`Error: invalid JSON in ${filePath}: ${err.message}`);

process.exit(1);

}

}

const aliasesData = readJSON(ALIASES_PATH);

const aliases = aliasesData.aliases;

// ---------------------------------------------------------------------------

// Helpers

// ---------------------------------------------------------------------------

/**

* Group aliases into "vendor" aliases (patterns using glob wildcards) and

* "meta" aliases (patterns that reference other aliases by name, with no slash).

*/

function classifyAliases(aliasMap) {

const vendor = [];

const meta = [];

for (const [alias, patterns] of Object.entries(aliasMap)) {

const isMetaOnly = patterns.every(p => !p.includes("/"));

if (isMetaOnly) {

meta.push({ alias, resolves: patterns });

} else {

vendor.push({ alias, patterns });

}

}

return { vendor, meta };

}

// ---------------------------------------------------------------------------

// Markdown generators

// ---------------------------------------------------------------------------

function generateAliasTable(vendorAliases) {

const lines = [];

lines.push("| Alias | Fallback patterns (tried in order) |");

lines.push("|-------|-------------------------------------|");

for (const { alias, patterns } of vendorAliases) {

const formattedPatterns = patterns.map(p => `\`${p}\``).join(", ");

lines.push(`| \`${alias}\` | ${formattedPatterns} |`);

}

return lines.join("\n");

}

function generateMetaAliasTable(metaAliases) {

const lines = [];

lines.push("| Meta-alias | Expands to |");

lines.push("|------------|------------|");

for (const { alias, resolves } of metaAliases) {

const formattedResolves = resolves.map(r => `\`${r}\``).join(" → ");

lines.push(`| \`${alias}\` | ${formattedResolves} |`);

}

return lines.join("\n");

}

// ---------------------------------------------------------------------------

// Build the full document

// ---------------------------------------------------------------------------

function generateMarkdown() {

const { vendor, meta } = classifyAliases(aliases);

const lines = [];

// Frontmatter

lines.push("---");

lines.push("title: Model Aliases");

lines.push("description: Reference tables for the built-in model alias map used by GitHub Agentic Workflows.");

lines.push("sidebar:");

lines.push(" order: 297");

lines.push("---");

lines.push("");

lines.push("This page lists the built-in model aliases used by GitHub Agentic Workflows.");

lines.push("");

// -------------------------------------------------------------------------

// Model Aliases

// -------------------------------------------------------------------------

lines.push("## Model Aliases");

lines.push("");

lines.push(

"Model aliases let you write `engine: copilot` with a human-friendly model name such as `sonnet` or `mini`, and gh-aw resolves it to the best available concrete model at compile time. Each alias holds an ordered list of patterns; the first pattern that matches an available model wins."

);

lines.push("");

lines.push("For details on the alias syntax, fallback resolution algorithm, and how to define your own aliases in workflow frontmatter, see the [Model Alias Format Specification](/gh-aw/specs/model-alias-specification/).");

lines.push("");

lines.push("### Vendor Aliases");

lines.push("");

lines.push("Vendor aliases map a short name to one or more provider-scoped glob patterns. The Copilot gateway is always tried first.");

lines.push("");

lines.push(generateAliasTable(vendor));

lines.push("");

lines.push("### Meta-Aliases");

lines.push("");

lines.push("Meta-aliases reference other aliases by name. They are resolved recursively until a concrete pattern is reached.");

lines.push("");

lines.push(generateMetaAliasTable(meta));

lines.push("");

return lines.join("\n");

}

// ---------------------------------------------------------------------------

// Write output

// ---------------------------------------------------------------------------

console.log("Generating model tables documentation...");

const markdown = generateMarkdown();

const outputDir = path.dirname(OUTPUT_PATH);

if (!fs.existsSync(outputDir)) {

fs.mkdirSync(outputDir, { recursive: true });

}

fs.writeFileSync(OUTPUT_PATH, markdown, "utf-8");

console.log(`✓ Generated: ${OUTPUT_PATH}`);