Ignore incorrect nodoc in Chrome 111+ for `world` parameter

This commit is contained in:
Oliver Dunk 2024-05-23 12:44:44 +01:00
Родитель 180c029f1b
Коммит 08cd3e762d
3 изменённых файлов: 20 добавлений и 2 удалений

Просмотреть файл

@ -14,6 +14,16 @@ test('setPanelBehavior is visible', t => {
t.assert(rc.isVisible({ nodoc: true }, 'api:sidePanel.setPanelBehavior'));
});
test('version specific API is visible in correct versions', t => {
// Correctly marked as nodoc in Chrome 110. Should not be visible.
const rcNotVisible = new RenderOverride({}, new FeatureQuery({}), null, 110);
t.assert(!rcNotVisible.isVisible({ nodoc: true }, 'api:extensionTypes.ExecutionWorld'));
// Incorrectly marked as nodoc in Chrome 111. nodoc should be ignored.
const rcVisible = new RenderOverride({}, new FeatureQuery({}), null, 111);
t.assert(rcVisible.isVisible({ nodoc: true }, 'api:extensionTypes.ExecutionWorld'));
});
test('chrome-install-location tag is added', (t) => {
const rc = new RenderOverride({}, new FeatureQuery({'api:sidePanel.setPanelBehavior': { location: 'policy' }}), {
generated: "",

Просмотреть файл

@ -76,19 +76,22 @@ export class RenderOverride extends EmptyRenderOverride {
#fq;
#api;
#history;
#majorVersion;
/**
* @param {{[name: string]: chromeTypes.NamespaceSpec}} api
* @param {FeatureQuery} fq
* @param {chromeTypes.HistoricSymbolsPayload?} history
* @param {number?} majorVersion
*/
constructor(api, fq, history = null) {
constructor(api, fq, history = null, majorVersion = null) {
super();
const allNamespaceNames = Object.keys(api);
this.#commentRewriter = buildNamespaceAwareMarkdownRewrite(allNamespaceNames);
this.#fq = fq;
this.#api = api;
this.#history = history;
this.#majorVersion = majorVersion;
}
/**
@ -114,6 +117,9 @@ export class RenderOverride extends EmptyRenderOverride {
}
switch (id) {
case 'api:extensionTypes.ExecutionWorld':
case 'api:contentScripts.ContentScript.world':
return !this.#majorVersion || this.#majorVersion >= 111;
case 'api:contextMenus.OnClickData':
case 'api:notifications.NotificationBitmap':
case 'api:sidePanel.getPanelBehavior':

Просмотреть файл

@ -58,8 +58,10 @@ This is used internally to generate historic version data for Chrome's APIs.
/** @type {chromeTypes.ProcessedAPIData} */
const o = JSON.parse(await getStdin());
const majorVersion = o.version ? Math.ceil(+o.version.version.split(".")[0]) : undefined;
const featureQuery = new FeatureQuery(o.feature);
const renderOverride = new RenderOverride(o.api, featureQuery);
const renderOverride = new RenderOverride(o.api, featureQuery, null, majorVersion);
const renderContext = new RenderContext(renderOverride);
/** @type {Map<string, boolean>} */