FilesExpand file tree

main

/

frontmatter.js

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

260 lines (251 loc) · 6.17 KB

main

/

frontmatter.js

Copy path

Top

File metadata and controls

• Code
• Blame

260 lines (251 loc) · 6.17 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

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

import fs from 'fs'

import path from 'path'

import parse from './read-frontmatter.js'

import semver from 'semver'

import { allVersions } from './all-versions.js'

const layoutNames = [

'default',

'dev-toc',

'graphql-explorer',

'product-landing',

'product-sublanding',

'release-notes',

false,

]

const semverValidRange = semver.validRange

const semverRange = {

type: 'string',

conform: semverValidRange,

message: 'Must be a valid SemVer range',

}

const versionObjs = Object.values(allVersions)

const guideTypes = ['overview', 'quick_start', 'tutorial', 'how_to', 'reference']

const featureVersions = fs

.readdirSync(path.posix.join(process.cwd(), 'data/features'))

.map((file) => path.basename(file, '.yml'))

export const schema = {

properties: {

title: {

type: 'string',

required: true,

translatable: true,

},

shortTitle: {

type: 'string',

translatable: true,

},

intro: {

type: 'string',

translatable: true,

},

product: {

type: 'string',

translatable: true,

},

permissions: {

type: 'string',

},

// true by default on articles, false on all other content

showMiniToc: {

type: 'boolean',

},

miniTocMaxHeadingLevel: {

type: 'number',

default: 2,

minimum: 2,

maximum: 4,

},

mapTopic: {

type: 'boolean',

},

// allow hidden articles under `early-access`

hidden: {

type: 'boolean',

},

layout: {

type: ['string', 'boolean'],

enum: layoutNames,

message: 'must be the filename of an existing layout file, or `false` for no layout',

},

redirect_from: {

type: ['array', 'string'],

},

allowTitleToDifferFromFilename: {

type: 'boolean',

},

introLinks: {

type: 'object',

properties: {

quickstart: { type: 'string' },

reference: { type: 'string' },

overview: { type: 'string' },

},

},

authors: {

type: 'array',

items: {

type: 'string',

},

},

examples_source: {

type: 'string',

},

effectiveDate: {

type: 'string',

},

featuredLinks: {

type: 'object',

properties: {

gettingStarted: {

type: 'array',

items: { type: 'string' },

},

guides: {

type: 'array',

items: { type: 'string' },

},

guideCards: {

type: 'array',

items: { type: 'string' },

},

popular: {

type: 'array',

items: { type: 'string' },

},

// allows you to use an alternate heading for the popular column

popularHeading: {

type: 'string',

},

},

},

// Shown in `product-landing.html` "What's new" section

changelog: {

type: 'object',

properties: {

label: { type: 'string' },

prefix: { type: 'string' },

},

},

type: {

type: 'string',

enum: guideTypes,

},

topics: {

type: 'array',

},

includeGuides: {

type: 'array',

},

learningTracks: {

type: 'array',

},

// Used in `product-landing.html`

beta_product: {

type: 'boolean',

},

// Show in `product-landing.html`

product_video: {

type: 'string',

},

interactive: {

type: 'boolean',

},

communityRedirect: {

type: 'object',

properties: {

name: 'string',

href: 'string',

},

},

// Platform-specific content preference

defaultPlatform: {

type: 'string',

enum: ['mac', 'windows', 'linux'],

},

// Tool-specific content preference

defaultTool: {

type: 'string',

enum: ['webui', 'cli', 'desktop', 'curl', 'codespaces', 'vscode'],

},

// Documentation contributed by a third party, such as a GitHub Partner

contributor: {

type: 'object',

properties: {

name: { type: 'string' },

URL: { type: 'string' },

},

},

// Child groups specified on top-level TOC

childGroups: {

type: 'array',

},

// Child links specified on any TOC page

children: {

type: 'array',

},

// External products specified on the homepage

externalProducts: {

type: 'object',

properties: {

atom: {

type: 'object',

required: true,

properties: {

id: { type: 'string', required: true },

name: { type: 'string', required: true },

href: { type: 'string', format: 'url', required: true },

external: { type: 'boolean', required: true },

},

},

electron: {

type: 'object',

required: true,

properties: {

id: { type: 'string', required: true },

name: { type: 'string', required: true },

href: { type: 'string', format: 'url', required: true },

external: { type: 'boolean', required: true },

},

},

},

},

// whether or not the page is mirrored by an experimental page

hasExperimentalAlternative: {

type: 'boolean',

},

},

}

const featureVersionsProp = {

feature: {

type: ['string', 'array'],

enum: featureVersions,

items: {

type: 'string',

},

message:

'must be the name (or names) of a feature that matches "filename" in data/features/_filename_.yml',

},

}

schema.properties.versions = {

type: ['object', 'string'], // allow a '*' string to indicate all versions

required: true,

properties: versionObjs.reduce((acc, versionObj) => {

acc[versionObj.plan] = semverRange

acc[versionObj.shortName] = semverRange

return acc

}, featureVersionsProp),

}

// Support 'github-ae': next

schema.properties.versions.properties['github-ae'] = 'next'

schema.properties.versions.properties.ghae = 'next'

function frontmatter(markdown, opts = {}) {

const defaults = {

schema,

validateKeyNames: true,

validateKeyOrder: false, // TODO: enable this once we've sorted all the keys. See issue 9658

}

return parse(markdown, Object.assign({}, defaults, opts))

}

// attach the schema object so it can be `require`d elsewhere.

frontmatter.schema = schema

export default frontmatter