You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/publisher/README.md
-44Lines changed: 0 additions & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,6 @@ npm run clean
36
36
npm run parse
37
37
npm run calculate-versions
38
38
npm run generate
39
-
npm run index
40
39
npm run publish-packages
41
40
npm run upload-blobs
42
41
```
@@ -61,7 +60,6 @@ To update the types packages, the following steps must be performed:
61
60
* Parse the definitions
62
61
* Calculate versions
63
62
* Generate packages on disk
64
-
* Create a search index
65
63
* Publish packages on disk
66
64
67
65
Importantly, each of these steps is *idempotent*.
@@ -189,48 +187,6 @@ This generates `versions.json` based on the last uploaded `versions.json` and by
189
187
The `--forceUpdate` argument will cause a build version bump even if the `contentHash` of the originating types folder has not changed.
190
188
This argument may be needed during development, but should not be used during routine usage.
191
189
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.
0 commit comments