Skip to content

Commit 0c0b39d

Browse files
committed
Delete create-search-index.ts
1 parent 62aba6b commit 0c0b39d

File tree

4 files changed

+0
-117
lines changed

4 files changed

+0
-117
lines changed

packages/publisher/README.md

Lines changed: 0 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ npm run clean
3636
npm run parse
3737
npm run calculate-versions
3838
npm run generate
39-
npm run index
4039
npm run publish-packages
4140
npm run upload-blobs
4241
```
@@ -61,7 +60,6 @@ To update the types packages, the following steps must be performed:
6160
* Parse the definitions
6261
* Calculate versions
6362
* Generate packages on disk
64-
* Create a search index
6563
* Publish packages on disk
6664

6765
Importantly, each of these steps is *idempotent*.
@@ -189,48 +187,6 @@ This generates `versions.json` based on the last uploaded `versions.json` and by
189187
The `--forceUpdate` argument will cause a build version bump even if the `contentHash` of the originating types folder has not changed.
190188
This argument may be needed during development, but should not be used during routine usage.
191189

192-
# Create a search index
193-
194-
> `npm run index`
195-
196-
This script creates `data/search-index-min.json`, which (in the upload step) will be uploaded to Azure and used by [TypeSearch](https://github.com/microsoft/typesearch).
197-
This step is not necessary for other steps in the process.
198-
199-
### Arguments to `create-search-index`
200-
201-
You can generate a prettier output in `data/search-index-full.json`.
202-
This version is for human review only and is not compatible with TypeSearch.
203-
204-
By default, `create-search-index` fetches download counts from NPM for use in search result ranking.
205-
The argument `--skipDownloads` disables this behavior.
206-
207-
### Search Entries
208-
209-
Each `search-*.json` file consists of an array.
210-
An example unminified entry is:
211-
```js
212-
{
213-
"projectName": "http://backgridjs.com/",
214-
"libraryName": "Backgrid",
215-
"globals": [
216-
"Backgrid"
217-
],
218-
"typePackageName": "backgrid",
219-
"declaredExternalModules": [
220-
"backgrid"
221-
],
222-
"downloads": 532234
223-
},
224-
```
225-
These fields should hopefully be self-explanatory.
226-
`downloads` refers to the number in the past month.
227-
If `--skipDownloads` was specified, `downloads` will be -1.
228-
In the case where the type package name is different from the NPM package name, or no NPM package name exists, `downloads` will be 0.
229-
230-
In the minified files, the properties are simply renamed. See `src/lib/search-index-generator.ts` for documentation.
231-
232-
Empty arrays may be elided in future versions of the minified files.
233-
234190
# Generate packages on disk
235191

236192
> `npm run generate`

packages/publisher/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@
4444
"calculate-versions": "node -r source-map-support/register dist/calculate-versions.js",
4545
"generate": "node -r source-map-support/register dist/generate-packages.js",
4646
"validate": "node -r source-map-support/register dist/validate.js",
47-
"index": "node -r source-map-support/register dist/create-search-index.js",
4847
"publish-packages": "node -r source-map-support/register dist/publish-packages.js",
4948
"publish-packages-dry": "node -r source-map-support/register dist/publish-packages.js --dry",
5049
"publish-registry": "node -r source-map-support/register dist/publish-registry.js",

packages/publisher/src/create-search-index.ts

Lines changed: 0 additions & 70 deletions
This file was deleted.

packages/publisher/src/full.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ import * as yargs from "yargs";
33

44
import calculateVersions from "./calculate-versions";
55
import { clean } from "./clean";
6-
import createSearchIndex from "./create-search-index";
76
import generatePackages from "./generate-packages";
87
import publishPackages from "./publish-packages";
98
import publishRegistry from "./publish-registry";
@@ -49,7 +48,6 @@ export default async function full(
4948
);
5049
const changedPackages = await calculateVersions(dt, infoClient, log);
5150
await generatePackages(dt, allPackages, changedPackages);
52-
await createSearchIndex(allPackages, infoClient);
5351
await publishPackages(changedPackages, dry, githubAccessToken, fetcher);
5452
await publishRegistry(dt, allPackages, dry, infoClient);
5553
}

0 commit comments

Comments
 (0)