18504871b9
* cache full rendering * still not working with gzip * progress progress progress * smaller * hacky progress * small fixes * wip * lock file * wip * wip * package-lock updates * wip * search DOM in lowercase * simplify * with instrument * improve test coverage * mutateCheeriobodyByRequest * fix * remove renderContentCacheByContex * disable render caching in sync-search * diables things in github/github link checker * gzip lru * tidying up * updated * correct tests * fix: move userLanguage to LanguagesContext * Revert "fix: move userLanguage to LanguagesContext" This reverts commit d7c05d958c71eaad496eb46764eb845d80b866ca. * contexts ftw * fixed rendering tests * oops for got new file * nits addressed Co-authored-by: Mike Surowiec <mikesurowiec@users.noreply.github.com>
99 lines
3.5 KiB
JavaScript
99 lines
3.5 KiB
JavaScript
#!/usr/bin/env node
|
|
import languages from '../../lib/languages.js'
|
|
import buildRecords from './build-records.js'
|
|
import findIndexablePages from './find-indexable-pages.js'
|
|
import { allVersions } from '../../lib/all-versions.js'
|
|
import { namePrefix } from '../../lib/search/config.js'
|
|
import LunrIndex from './lunr-search-index.js'
|
|
|
|
// Lunr
|
|
|
|
// Build a search data file for every combination of product version and language
|
|
// e.g. `github-docs-dotcom-en.json` and `github-docs-2.14-ja.json`
|
|
export default async function syncSearchIndexes(opts = {}) {
|
|
const t0 = new Date()
|
|
if (opts.language) {
|
|
if (!Object.keys(languages).includes(opts.language)) {
|
|
console.log(
|
|
`Error! ${opts.language} not found. You must provide a currently supported two-letter language code.`
|
|
)
|
|
process.exit(1)
|
|
}
|
|
}
|
|
|
|
if (opts.version) {
|
|
if (!Object.keys(allVersions).includes(opts.version)) {
|
|
console.log(`${opts.version} not one of ${Object.keys(allVersions)}`)
|
|
throw new Error(
|
|
`Error! ${opts.version} not found. You must provide a currently supported version in <PLAN@RELEASE> format.`
|
|
)
|
|
}
|
|
}
|
|
|
|
// build indices for a specific language if provided; otherwise build indices for all languages
|
|
const languagesToBuild = opts.language
|
|
? Object.keys(languages).filter((language) => language === opts.language)
|
|
: Object.keys(languages)
|
|
|
|
// build indices for a specific version if provided; otherwise build indices for all veersions
|
|
const versionsToBuild = opts.version
|
|
? Object.keys(allVersions).filter((version) => version === opts.version)
|
|
: Object.keys(allVersions)
|
|
|
|
console.log(
|
|
`Building indices for ${opts.language || 'all languages'} and ${
|
|
opts.version || 'all versions'
|
|
}.\n`
|
|
)
|
|
|
|
// Exclude WIP pages, hidden pages, index pages, etc
|
|
const indexablePages = await findIndexablePages()
|
|
const redirects = {}
|
|
indexablePages.forEach((page) => {
|
|
const href = page.relativePath.replace('index.md', '').replace('.md', '')
|
|
for (let redirectFrom of page.redirect_from || []) {
|
|
// Remember that each redirect_from as a prefix / and often it ends
|
|
// with a trailing /
|
|
if (redirectFrom.startsWith('/')) redirectFrom = redirectFrom.slice(1)
|
|
if (redirectFrom.endsWith('/')) redirectFrom = redirectFrom.slice(0, -1)
|
|
redirects[redirectFrom] = href
|
|
}
|
|
})
|
|
|
|
// Build and validate all indices
|
|
for (const languageCode of languagesToBuild) {
|
|
for (const pageVersion of versionsToBuild) {
|
|
// if GHES, resolves to the release number like 2.21, 2.22, etc.
|
|
// if FPT, resolves to 'dotcom'
|
|
// if GHAE, resolves to 'ghae'
|
|
const indexVersion =
|
|
allVersions[pageVersion].plan === 'enterprise-server'
|
|
? allVersions[pageVersion].currentRelease
|
|
: allVersions[pageVersion].miscBaseName
|
|
|
|
// github-docs-dotcom-en, github-docs-2.22-en
|
|
const indexName = `${namePrefix}-${indexVersion}-${languageCode}`
|
|
|
|
// The page version will be the new version, e.g., free-pro-team@latest, enterprise-server@2.22
|
|
const records = await buildRecords(
|
|
indexName,
|
|
indexablePages,
|
|
pageVersion,
|
|
languageCode,
|
|
redirects
|
|
)
|
|
const index = new LunrIndex(indexName, records)
|
|
|
|
if (!opts.dryRun) {
|
|
await index.write()
|
|
console.log('wrote index to file: ', indexName)
|
|
}
|
|
}
|
|
}
|
|
const t1 = new Date()
|
|
const tookSec = (t1.getTime() - t0.getTime()) / 1000
|
|
|
|
console.log('\nDone!')
|
|
console.log(`Took ${tookSec.toFixed(1)} seconds`)
|
|
}
|