forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor sync-search-indices (github#29152)
* refactor sync-search-indices * tidying
- Loading branch information
Showing
7 changed files
with
121 additions
and
84 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| #!/usr/bin/env node | ||
|
|
||
| // [start-readme] | ||
| // | ||
| // This script is run automatically via GitHub Actions on every push to `main` to generate searchable data. | ||
| // It can also be run manually. For more info see [contributing/search.md](contributing/search.md) | ||
| // | ||
| // [end-readme] | ||
|
|
||
| import path from 'path' | ||
|
|
||
| import { program, Option } from 'commander' | ||
|
|
||
| import { languageKeys } from '../../lib/languages.js' | ||
| import { allVersionKeys } from '../../lib/all-versions.js' | ||
| import searchSync from './sync.js' | ||
|
|
||
| const DEFAULT_OUT_DIRECTORY = path.join('lib', 'search', 'indexes') | ||
|
|
||
| program | ||
| .description('Creates search records (and Lunr indexes) by scraping') | ||
| .option('-v, --verbose', 'Verbose outputs') | ||
| .addOption(new Option('-V, --version <VERSION>', 'Specific versions').choices(allVersionKeys)) | ||
| .addOption( | ||
| new Option('-l, --language <LANGUAGE>', 'Which languages to focus on').choices(languageKeys) | ||
| ) | ||
| .addOption( | ||
| new Option('--not-language <LANGUAGE>', 'Specific language to omit').choices(languageKeys) | ||
| ) | ||
| .option('-d, --dry-run', 'Does not write to disk') | ||
| .option( | ||
| '-o, --out-directory <DIRECTORY>', | ||
| `Where to dump the created files (default ${DEFAULT_OUT_DIRECTORY}` | ||
| ) | ||
| .parse(process.argv) | ||
|
|
||
| main(program.opts()) | ||
|
|
||
| async function main(opts) { | ||
| let language | ||
| if ('language' in opts) { | ||
| language = opts.language | ||
| if (process.env.LANGUAGE) { | ||
| console.warn( | ||
| `'language' specified as argument ('${language}') AND environment variable ('${process.env.LANGUAGE}')` | ||
| ) | ||
| } | ||
| } else { | ||
| if (process.env.LANGUAGE && process.env.LANGUAGE !== 'all') { | ||
| language = process.env.LANGUAGE | ||
| if (!languageKeys.includes(language)) { | ||
| throw new Error( | ||
| `Environment variable 'VERSION' (${language}) is not recognized. Must be one of ${languageKeys}` | ||
| ) | ||
| } | ||
| } | ||
| } | ||
| const notLanguage = opts.notLanguage | ||
| if (notLanguage && language) { | ||
| throw new Error("Can't specify --language *and* --not-language") | ||
| } | ||
|
|
||
| let version | ||
| if ('version' in opts) { | ||
| version = opts.version | ||
| if (process.env.VERSION) { | ||
| console.warn( | ||
| `'version' specified as argument ('${version}') AND environment variable ('${process.env.VERSION}')` | ||
| ) | ||
| } | ||
| } else { | ||
| if (process.env.VERSION && process.env.VERSION !== 'all') { | ||
| version = process.env.VERSION | ||
| if (!allVersionKeys.includes(version)) { | ||
| throw new Error( | ||
| `Environment variable 'VERSION' (${version}) is not recognized. Must be one of ${allVersionKeys}` | ||
| ) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| let dryRun = false | ||
| if ('dryRun' in opts) { | ||
| dryRun = opts.dryRun | ||
| } else { | ||
| dryRun = Boolean(JSON.parse(process.env.DRY_RUN || 'false')) | ||
| } | ||
|
|
||
| const outDirectory = opts.outDirectory || DEFAULT_OUT_DIRECTORY | ||
|
|
||
| const options = { | ||
| dryRun, | ||
| language, | ||
| notLanguage, | ||
| version, | ||
| outDirectory, | ||
| } | ||
| await searchSync(options) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.