@theia/plugin-utils 1.77.0-next.99 → 1.78.0-next.0

package/src/common/contribution-types.ts

@@ -21,10 +21,10 @@ import type {
     JSONObject,
     PreferenceSchema,
     TaskDefinition,
-} from './protocol-shims';
-import type { PluginManifest } from './manifest-types';
+} from './protocol-shims.js';
+import type { PluginManifest } from './manifest-types.js';
 
-export type { JSONObject } from './protocol-shims';
+export type { JSONObject } from './protocol-shims.js';
 
 /**
  * Raw `contributes` section from `package.json` before normalization.
@@ -213,11 +213,17 @@ export enum PluginViewType {
     Webview = 'webview'
 }
 
+export const PLUGIN_VIEW_VISIBILITIES = ['visible', 'collapsed', 'hidden'] as const;
+export type PluginViewVisibility = typeof PLUGIN_VIEW_VISIBILITIES[number];
+
 export interface PluginPackageView {
     id: string;
     name: string;
     when?: string;
     type?: string;
+    visibility?: PluginViewVisibility;
+    /** Initial size of the view relative to the other views in its container, like the CSS `flex` property. */
+    initialSize?: number;
 }
 
 export interface PluginPackageViewWelcome {

package/src/common/manifest-types.spec.ts

@@ -15,7 +15,7 @@
 // *****************************************************************************
 
 import { expect } from 'chai';
-import { rawContributes } from './manifest-types';
+import { rawContributes } from './manifest-types.js';
 
 describe('manifest-types', () => {
 

package/src/common/manifest-types.ts

@@ -14,8 +14,8 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 // *****************************************************************************
 
-import { isObject } from './utils';
-import type { NormalizedPluginContribution, PluginManifestContribution } from './contribution-types';
+import { isObject } from './utils.js';
+import type { NormalizedPluginContribution, PluginManifestContribution } from './contribution-types.js';
 
 export const PLUGIN_HOST_BACKEND = 'main' as const;
 export const PLUGIN_HOST_FRONTEND = 'frontend' as const;

package/src/common/package-nls.spec.ts

@@ -15,11 +15,12 @@
 // *****************************************************************************
 
 import { expect } from 'chai';
-import * as fs from 'fs-extra';
+// A CommonJS module whose exports cannot be detected statically, so it is imported as a whole.
+import fs from 'fs-extra';
 import * as os from 'os';
 import * as path from 'path';
-import { coerceLocalizations, localizePackage, localizeWithResolver } from './package-nls';
-import { loadPackageTranslations } from '../node/package-nls';
+import { coerceLocalizations, localizePackage, localizeWithResolver } from './package-nls.js';
+import { loadPackageTranslations } from '../node/package-nls.js';
 
 describe('package-nls', () => {
 

package/src/common/package-nls.ts

@@ -14,7 +14,7 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 // *****************************************************************************
 
-import { isObject } from './utils';
+import { isObject } from './utils.js';
 
 export interface PackageTranslation {
     translation?: Record<string, string>;

package/src/common/plugin-activation-events.spec.ts

@@ -15,8 +15,8 @@
 // *****************************************************************************
 
 import { expect } from 'chai';
-import { updateActivationEvents } from './plugin-activation-events';
-import type { PluginManifest } from './manifest-types';
+import { updateActivationEvents } from './plugin-activation-events.js';
+import type { PluginManifest } from './manifest-types.js';
 
 function manifest(partial: Pick<PluginManifest, 'contributes' | 'activationEvents'>): Pick<PluginManifest, 'contributes' | 'activationEvents'> {
     return {

package/src/common/plugin-activation-events.ts

@@ -14,8 +14,8 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 // *****************************************************************************
 
-import { flatten, isObject, isStringArray } from './utils';
-import { rawContributes, type PluginManifest } from './manifest-types';
+import { flatten, isObject, isStringArray } from './utils.js';
+import { rawContributes, type PluginManifest } from './manifest-types.js';
 
 /**
  * Most activation events can be automatically deduced from the package manifest.

package/src/common/plugin-manifest.spec.ts

@@ -15,11 +15,12 @@
 // *****************************************************************************
 
 import { expect } from 'chai';
-import { UNPUBLISHED, VSCODE_BUILTIN_NAME_PREFIX } from './constants';
-import { prepareLoadedManifest, stripVscodeBuiltinNamePrefix } from './plugin-manifest';
-import { loadManifest } from '../node/plugin-manifest';
-import type { PluginManifest } from './manifest-types';
-import * as fs from 'fs-extra';
+import { UNPUBLISHED, VSCODE_BUILTIN_NAME_PREFIX } from './constants.js';
+import { prepareLoadedManifest, stripVscodeBuiltinNamePrefix } from './plugin-manifest.js';
+import { loadManifest } from '../node/plugin-manifest.js';
+import type { PluginManifest } from './manifest-types.js';
+// A CommonJS module whose exports cannot be detected statically, so it is imported as a whole.
+import fs from 'fs-extra';
 import * as os from 'os';
 import * as path from 'path';
 

package/src/common/plugin-manifest.ts

@@ -14,9 +14,9 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 // *****************************************************************************
 
-import { UNPUBLISHED, VSCODE_BUILTIN_NAME_PREFIX } from './constants';
-import type { PluginManifest } from './manifest-types';
-import { updateActivationEvents } from './plugin-activation-events';
+import { UNPUBLISHED, VSCODE_BUILTIN_NAME_PREFIX } from './constants.js';
+import type { PluginManifest } from './manifest-types.js';
+import { updateActivationEvents } from './plugin-activation-events.js';
 
 export interface PrepareLoadedManifestOptions {
     /** @default true */

package/src/common/plugin-model.spec.ts

@@ -26,7 +26,7 @@ import {
     VSCODE_FRONTEND_INIT,
     THEIA_PLUGIN_START_METHOD,
     THEIA_PLUGIN_STOP_METHOD
-} from './constants';
+} from './constants.js';
 import {
     applyTrustExtraction,
     buildEntryPointForTheia,
@@ -40,9 +40,9 @@ import {
     pickEngineType,
     toPluginUri,
     toPluginUrl
-} from './plugin-model';
-import { getPluginRootFileUrl } from '../node/plugin-model';
-import { manifest } from './test-helpers';
+} from './plugin-model.js';
+import { getPluginRootFileUrl } from '../node/plugin-model.js';
+import { manifest } from './test-helpers.js';
 
 describe('plugin-model', () => {
 

package/src/common/plugin-model.ts

@@ -23,14 +23,14 @@ import {
     VSCODE_EXTENSION_ACTIVATE,
     VSCODE_EXTENSION_DEACTIVATE,
     VSCODE_FRONTEND_INIT
-} from './constants';
+} from './constants.js';
 import type {
     PluginEntryPoint,
     PluginLifecycle,
     PluginModel,
     PluginManifest,
     PluginPackageCapabilities
-} from './manifest-types';
+} from './manifest-types.js';
 
 export interface PluginIdentifierSource {
     publisher?: string;

package/src/common/test-helpers.ts

@@ -14,9 +14,9 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 // *****************************************************************************
 
-import type { NormalizeContributionsContext } from './contribution-types';
-import type { PluginManifest } from './manifest-types';
-import { toPluginUrl } from './plugin-model';
+import type { NormalizeContributionsContext } from './contribution-types.js';
+import type { PluginManifest } from './manifest-types.js';
+import { toPluginUrl } from './plugin-model.js';
 
 export function manifest(partial: Partial<PluginManifest> & Pick<PluginManifest, 'name'>): PluginManifest {
     return {

package/src/common/utils.spec.ts

@@ -17,7 +17,7 @@
 import { expect } from 'chai';
 import { rejects } from 'assert';
 import { promises as fs } from 'fs';
-import { deepClone, isENOENT, isObject, isStringArray } from './utils';
+import { deepClone, isENOENT, isObject, isStringArray } from './utils.js';
 
 describe('utils', () => {
 
@@ -63,7 +63,7 @@ describe('utils', () => {
         });
 
         it('returns false for other errno codes', async () => {
-            await rejects(fs.readdir(__filename), reason => !isENOENT(reason));
+            await rejects(fs.readdir(import.meta.filename), reason => !isENOENT(reason));
         });
     });
 

package/src/node/normalize-contributions.spec.ts

@@ -15,8 +15,8 @@
 // *****************************************************************************
 
 import { expect } from 'chai';
-import { CustomEditorPriority, type GrammarsContribution, type PluginUiTheme, type WalkthroughContribution } from '../common/contribution-types';
-import { PreferenceScope } from '../common/protocol-shims';
+import { CustomEditorPriority, type GrammarsContribution, type PluginPackageView, type PluginUiTheme, type WalkthroughContribution } from '../common/contribution-types.js';
+import { PreferenceScope } from '../common/protocol-shims.js';
 import {
     deriveDefaultForType,
     extractPluginViewsIds,
@@ -47,9 +47,9 @@ import {
     readWalkthroughs,
     toSchema,
     transformIconUrl
-} from './normalize-contributions';
-import { createNormalizeCtx, manifest } from '../common/test-helpers';
-import type { PluginManifest } from '../common/manifest-types';
+} from './normalize-contributions.js';
+import { createNormalizeCtx, manifest } from '../common/test-helpers.js';
+import type { PluginManifest } from '../common/manifest-types.js';
 
 describe('normalize-contributions', () => {
 
@@ -203,7 +203,9 @@ describe('normalize-contributions', () => {
                 id: 'sample.view',
                 name: 'Sample View',
                 when: undefined,
-                type: undefined
+                type: undefined,
+                visibility: undefined,
+                initialSize: undefined
             }]);
 
             const welcome = readViewsWelcome([{
@@ -217,6 +219,16 @@ describe('normalize-contributions', () => {
             }, ['sample.view']).order).to.equal(1);
         });
 
+        it('keeps the initial visibility and size a view declares, and drops values of the wrong kind', () => {
+            const rawView: PluginPackageView = { id: 'sample.view', name: 'Sample View', visibility: 'collapsed', initialSize: 3 };
+            const malformedView = { id: 'malformed.view', name: 'Malformed View', visibility: 'shown', initialSize: Infinity } as unknown as PluginPackageView;
+
+            const [view, malformed] = readViews([rawView, malformedView]);
+
+            expect(view).to.include({ visibility: 'collapsed', initialSize: 3 });
+            expect(malformed).to.include({ visibility: undefined, initialSize: undefined });
+        });
+
         it('skips view containers without a string icon and reports an error', () => {
             const errors: unknown[] = [];
             const ctx = createNormalizeCtx({}, {
@@ -714,7 +726,7 @@ describe('normalize-contributions', () => {
                 }]
             });
             expect(contributions.views).to.deep.equal({
-                explorer: [{ id: 'sample.view', name: 'Sample View', when: undefined, type: undefined }]
+                explorer: [{ id: 'sample.view', name: 'Sample View', when: undefined, type: undefined, visibility: undefined, initialSize: undefined }]
             });
             expect(contributions.viewsWelcome).to.deep.equal([{
                 view: 'sample.view',
@@ -825,6 +837,24 @@ describe('normalize-contributions', () => {
             }]);
         });
 
+        it('keeps the initial size of a view only in a view container the same plugin contributes', async () => {
+            const ctx = createNormalizeCtx({
+                name: 'sized',
+                contributes: {
+                    viewsContainers: { activitybar: [{ id: 'own', title: 'Own', icon: '$(a)' }] },
+                    views: {
+                        own: [{ id: 'own.view', name: 'Own View', initialSize: 2 }],
+                        explorer: [{ id: 'foreign.view', name: 'Foreign View', initialSize: 3 }]
+                    }
+                }
+            });
+
+            const { views } = await normalizeContributions(ctx, {} as { views?: { [location: string]: PluginPackageView[] } });
+
+            expect(views?.own[0].initialSize).to.equal(2);
+            expect(views?.explorer[0].initialSize).to.equal(undefined);
+        });
+
         it('merges aliased view container locations and reports async reader failures', async () => {
             const errors: Array<{ kind: string; message: unknown }> = [];
             const ctx = createNormalizeCtx({

package/src/node/normalize-contributions.ts

@@ -19,7 +19,7 @@
 import { promises as fs } from 'fs';
 import * as path from 'path';
 import * as jsoncparser from 'jsonc-parser';
-import { deepClone, isColorDefaults, isENOENT, isObject, isStringArray } from '../common/utils';
+import { deepClone, isColorDefaults, isENOENT, isObject, isStringArray } from '../common/utils.js';
 import {
     ICON_NAME_SEGMENT,
     type ColorDefinition,
@@ -30,9 +30,10 @@ import {
     type PreferenceSchema,
     PreferenceScope,
     type TaskDefinition,
-} from '../common/protocol-shims';
+} from '../common/protocol-shims.js';
 import {
     CustomEditorPriority,
+    PLUGIN_VIEW_VISIBILITIES,
     type AutoClosingPair,
     type AutoClosingPairConditional,
     type CharacterPair,
@@ -77,9 +78,9 @@ import {
     type WalkthroughStepContribution,
     type WalkthroughStepMedia,
     type PluginPackageWalkthroughStepMedia,
-} from '../common/contribution-types';
-import { rawContributes, type PluginManifest } from '../common/manifest-types';
-import { UNPUBLISHED } from '../common/constants';
+} from '../common/contribution-types.js';
+import { rawContributes, type PluginManifest } from '../common/manifest-types.js';
+import { UNPUBLISHED } from '../common/constants.js';
 
 function isPluginUiTheme(value: unknown): value is PluginUiTheme {
     return value === 'vs' || value === 'vs-dark' || value === 'hc-black' || value === 'hc-light';
@@ -261,8 +262,13 @@ export async function normalizeContributions<TContrib extends object>(
     try {
         if (contributes.views) {
             const views: { [location: string]: RawView[] } = {};
+            // As in VS Code, a view may set its initial size only within a view container of its own plugin.
+            const ownViewContainerIds = new Set(Object.values(output.viewsContainers ?? {}).flat().map(container => container.id));
             for (const location of Object.keys(contributes.views)) {
-                views[location] = readViewsFn(contributes.views[location]);
+                const locationViews = readViewsFn(contributes.views[location]);
+                views[location] = ownViewContainerIds.has(location)
+                    ? locationViews
+                    : locationViews.map(view => ({ ...view, initialSize: undefined }));
             }
             output.views = views;
         }
@@ -853,7 +859,9 @@ export function readView(rawView: RawView): RawView {
         id: rawView.id,
         name: rawView.name,
         when: rawView.when,
-        type: rawView.type
+        type: rawView.type,
+        visibility: PLUGIN_VIEW_VISIBILITIES.find(visibility => visibility === rawView.visibility),
+        initialSize: Number.isFinite(rawView.initialSize) && rawView.initialSize! > 0 ? rawView.initialSize : undefined
     };
 }
 

package/src/node/package-nls.ts

@@ -15,12 +15,13 @@
 // *****************************************************************************
 
 import * as path from 'path';
-import * as fs from 'fs-extra';
-import { isENOENT } from '../common/utils';
+// A CommonJS module whose exports cannot be detected statically, so it is imported as a whole.
+import fs from 'fs-extra';
+import { isENOENT } from '../common/utils.js';
 import {
     coerceLocalizations,
     type PackageTranslation,
-} from '../common/package-nls';
+} from '../common/package-nls.js';
 
 export async function loadPackageTranslations(pluginPath: string, locale?: string): Promise<PackageTranslation> {
     const defaultPath = path.join(pluginPath, 'package.nls.json');

package/src/node/plugin-manifest.ts

@@ -15,9 +15,10 @@
 // *****************************************************************************
 
 import * as path from 'path';
-import * as fs from 'fs-extra';
-import type { PluginManifest } from '../common/manifest-types';
-import { prepareLoadedManifest, type PrepareLoadedManifestOptions } from '../common/plugin-manifest';
+// A CommonJS module whose exports cannot be detected statically, so it is imported as a whole.
+import fs from 'fs-extra';
+import type { PluginManifest } from '../common/manifest-types.js';
+import { prepareLoadedManifest, type PrepareLoadedManifestOptions } from '../common/plugin-manifest.js';
 
 type LoadedManifest = Pick<PluginManifest, 'name' | 'publisher' | 'contributes' | 'activationEvents'>;
 

package/src/node/plugin-model.ts

@@ -15,7 +15,7 @@
 // *****************************************************************************
 
 import { readdirSync } from 'fs';
-import { toPluginUrl, type PluginIdentifierSource } from '../common/plugin-model';
+import { toPluginUrl, type PluginIdentifierSource } from '../common/plugin-model.js';
 
 export function getPluginRootFileUrl(manifest: PluginIdentifierSource & { packagePath: string }, names: string[]): string | undefined {
     const nameSet = new Set(names.map(n => n.toLowerCase()));

package/src/node/read-grammars.spec.ts

@@ -15,10 +15,11 @@
 // *****************************************************************************
 
 import { expect } from 'chai';
-import * as fs from 'fs-extra';
+// A CommonJS module whose exports cannot be detected statically, so it is imported as a whole.
+import fs from 'fs-extra';
 import * as os from 'os';
 import * as path from 'path';
-import { readGrammarFromDisk, getGrammarContributionValidationError } from './read-grammars';
+import { readGrammarFromDisk, getGrammarContributionValidationError } from './read-grammars.js';
 
 describe('readGrammarFromDisk', () => {
 

package/src/node/read-grammars.ts

@@ -15,15 +15,16 @@
 // *****************************************************************************
 
 import * as path from 'path';
-import * as fs from 'fs-extra';
-import { isObject } from '../common/utils';
+// A CommonJS module whose exports cannot be detected statically, so it is imported as a whole.
+import fs from 'fs-extra';
+import { isObject } from '../common/utils.js';
 import type {
     GrammarsContribution,
     NormalizeContributionsContext,
     PluginPackageGrammarsContribution,
-} from '../common/contribution-types';
+} from '../common/contribution-types.js';
 
-export type { GrammarsContribution } from '../common/contribution-types';
+export type { GrammarsContribution } from '../common/contribution-types.js';
 
 /**
  * Returns a validation error message, or `undefined` if the contribution is valid.