-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New version supporting explicit filtering of versions
- Loading branch information
Adrian Kosmaczewski
committed
Jul 17, 2023
1 parent
1fdce80
commit 97bf6fe
Showing
9 changed files
with
2,024 additions
and
200 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
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
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,42 @@ | ||
| import { expect } from 'chai' | ||
| import { FileRepository, getConfigSync, search } from '../src/engine' | ||
| import lunr from 'lunr' | ||
|
|
||
| let files: any | ||
| let lunrIndex: any | ||
|
|
||
| describe ('Search engine', () => { | ||
| before(() => { | ||
| files = getConfigSync('files.json', 'index') as FileRepository | ||
| const lunrIndexSource = getConfigSync('lunr.json', 'index') | ||
| lunrIndex = lunr.Index.load(lunrIndexSource) | ||
| }) | ||
|
|
||
| it('returns results', () => { | ||
| const results = search(lunrIndex, files, 'backup') | ||
| expect(results).not.to.be.null | ||
| }) | ||
|
|
||
| it('by default returns a maximum of 50 results', () => { | ||
| const results = search(lunrIndex, files, 'backup') | ||
| expect(results.length).to.equal(50) | ||
| }) | ||
|
|
||
| it('the "main" version works just like "master"', () => { | ||
| const results1 = search(lunrIndex, files, 'backup', undefined, 'master') | ||
| const results2 = search(lunrIndex, files, 'backup', undefined, 'main') | ||
| expect(results1.length).to.equal(50) | ||
| expect(results2.length).to.equal(50) | ||
| expect(results1).to.deep.equal(results2) | ||
| }) | ||
|
|
||
| it('can be filtered by version', () => { | ||
| const results = search(lunrIndex, files, 'backup', undefined, '0.1') | ||
| expect(results.length).to.equal(7) | ||
| }) | ||
|
|
||
| it('can be return a maximum number of results', () => { | ||
| const results = search(lunrIndex, files, 'backup', 2, '0.1') | ||
| expect(results.length).to.equal(2) | ||
| }) | ||
| }) |
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,63 @@ | ||
| import SearchResult from "./search_result" | ||
| import path from 'path' | ||
| import fs from 'fs' | ||
|
|
||
| export type FileRepository = { [ref: string]: SearchResult } | ||
|
|
||
| /** | ||
| * Performs the actual search against the Lunr index. | ||
| * This function takes a "version" parameter; if this parameter is "master" or "main", then all search | ||
| * results are included in the response. If a different value is provided, only those values are returned. | ||
| * @param lunrIndex The Lunr.js index | ||
| * @param files The repository of files | ||
| * @param query Text to search | ||
| * @param count (Optional, default 50) Number of items to return | ||
| * @param version (Optional, default "master") Version of the search results to return | ||
| */ | ||
| export function search(lunrIndex: lunr.Index, files: FileRepository, query: string, count = 50, version = 'master'): SearchResult[] { | ||
| if (isEmptyOrBlank(query)) { | ||
| return [] | ||
| } | ||
| const results: SearchResult[] = lunrIndex.search(query.trim()) | ||
| .map((result: lunr.Index.Result) => { | ||
| return files[result.ref] | ||
| }) | ||
| .filter((result: SearchResult) => { | ||
| // This "or" statement short-circuits the evaluation: if "master" or "main" are mentioned, | ||
| // the result is included; otherwise, if the version coincides, it is included. | ||
| if (version === 'master' || version === 'main' || result.version === version) { | ||
| return result | ||
| } | ||
| }) | ||
| .slice(0, count) | ||
| return results | ||
| } | ||
|
|
||
| /** | ||
| * Returns a JSON object with the contents of a configuration file. | ||
| * @param file A valid filename | ||
| */ | ||
| export function getConfigSync(file: string, folder = '/site/index'): object { | ||
| const filepath = path.join(folder, file) | ||
| return readJsonFileSync(filepath) | ||
| } | ||
|
|
||
| /** | ||
| * Returns true if a string is null, undefined, empty or blank after trimming. | ||
| * @param s The string to test | ||
| */ | ||
| function isEmptyOrBlank(s: string): boolean { | ||
| return (!s || s.length === 0 || !s.trim()) | ||
| } | ||
|
|
||
| /** | ||
| * Returns the contents of the JSON file whose name is passed as parameter. | ||
| * @param file A valid filename | ||
| */ | ||
| function readJsonFileSync(filepath: string, encoding = 'utf8'): object { | ||
| if (!fs.existsSync(filepath)) { | ||
| throw `File "${filepath}" does not exist'` | ||
| } | ||
| const file = fs.readFileSync(filepath, encoding) | ||
| return JSON.parse(file) | ||
| } |
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 |
|---|---|---|
| @@ -1,63 +1,12 @@ | ||
| { | ||
| "compilerOptions": { | ||
| /* Basic Options */ | ||
| // "incremental": true, /* Enable incremental compilation */ | ||
| "target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */ | ||
| "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */ | ||
| // "lib": [], /* Specify library files to be included in the compilation. */ | ||
| // "allowJs": true, /* Allow javascript files to be compiled. */ | ||
| // "checkJs": true, /* Report errors in .js files. */ | ||
| // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ | ||
| // "declaration": true, /* Generates corresponding '.d.ts' file. */ | ||
| // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ | ||
| // "sourceMap": true, /* Generates corresponding '.map' file. */ | ||
| // "outFile": "./", /* Concatenate and emit output to single file. */ | ||
| "outDir": "./dist", /* Redirect output structure to the directory. */ | ||
| "rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ | ||
| // "composite": true, /* Enable project compilation */ | ||
| // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ | ||
| // "removeComments": true, /* Do not emit comments to output. */ | ||
| // "noEmit": true, /* Do not emit outputs. */ | ||
| // "importHelpers": true, /* Import emit helpers from 'tslib'. */ | ||
| // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ | ||
| // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ | ||
|
|
||
| /* Strict Type-Checking Options */ | ||
| "strict": true, /* Enable all strict type-checking options. */ | ||
| // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ | ||
| "strictNullChecks": true, /* Enable strict null checks. */ | ||
| // "strictFunctionTypes": true, /* Enable strict checking of function types. */ | ||
| // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ | ||
| // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ | ||
| // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ | ||
| // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ | ||
|
|
||
| /* Additional Checks */ | ||
| // "noUnusedLocals": true, /* Report errors on unused locals. */ | ||
| // "noUnusedParameters": true, /* Report errors on unused parameters. */ | ||
| // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ | ||
| // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ | ||
|
|
||
| /* Module Resolution Options */ | ||
| // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ | ||
| // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ | ||
| // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ | ||
| // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ | ||
| // "typeRoots": [], /* List of folders to include type definitions from. */ | ||
| // "types": [], /* Type declaration files to be included in compilation. */ | ||
| // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ | ||
| "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ | ||
| // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ | ||
| // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ | ||
|
|
||
| /* Source Map Options */ | ||
| // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ | ||
| // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ | ||
| // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ | ||
| // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ | ||
|
|
||
| /* Experimental Options */ | ||
| // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ | ||
| // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ | ||
| "target": "es5", | ||
| "module": "commonjs", | ||
| "sourceMap": true, | ||
| "outDir": "./dist", | ||
| "strict": true, | ||
| "strictNullChecks": true, | ||
| "esModuleInterop": true, | ||
| "forceConsistentCasingInFileNames": true | ||
| } | ||
| } |