Skip to content

Language contributions shouldn't force an entrypoint #839

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 21, 2023
Merged

Language contributions shouldn't force an entrypoint #839

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
133be8c
remove pre-commit hooks
joaomoreno Feb 21, 2023
25174be
language contributions shouldn't force an entrypoint
joaomoreno Feb 21, 2023
719f288
Merge branch 'main' into joao/tricky-leopard
joaomoreno Feb 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
157 changes: 74 additions & 83 deletions src/package.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ export interface VSIX {
}

export class BaseProcessor implements IProcessor {
constructor(protected manifest: Manifest) {}
constructor(protected manifest: Manifest) { }
assets: IAsset[] = [];
tags: string[] = [];
vsix: VSIX = Object.create(null);
Expand Down Expand Up @@ -499,8 +499,8 @@ export class ManifestProcessor extends BaseProcessor {
localizedLanguages:
manifest.contributes && manifest.contributes.localizations
? manifest.contributes.localizations
.map(loc => loc.localizedLanguageName ?? loc.languageName ?? loc.languageId)
.join(',')
.map(loc => loc.localizedLanguageName ?? loc.languageName ?? loc.languageId)
.join(',')
: '',
preRelease: !!this.options.preRelease,
sponsorLink: manifest.sponsor?.url || '',
Expand Down Expand Up @@ -801,10 +801,9 @@ export class MarkdownProcessor extends BaseProcessor {
// Issue in own repository
result =
prefix +
`[#${issueNumber}](${
this.isGitHub
? urljoin(this.repositoryUrl, 'issues', issueNumber)
: urljoin(this.repositoryUrl, '-', 'issues', issueNumber)
`[#${issueNumber}](${this.isGitHub
? urljoin(this.repositoryUrl, 'issues', issueNumber)
: urljoin(this.repositoryUrl, '-', 'issues', issueNumber)
})`;
}

Expand Down Expand Up @@ -1061,8 +1060,8 @@ function getExtensionKind(manifest: Manifest): ExtensionKind[] {
const result: ExtensionKind[] = Array.isArray(manifest.extensionKind)
? manifest.extensionKind
: manifest.extensionKind === 'ui'
? ['ui', 'workspace']
: [manifest.extensionKind];
? ['ui', 'workspace']
: [manifest.extensionKind];

// Add web kind if the extension can run as web extension
if (deduced.includes('web') && !result.includes('web')) {
Expand Down Expand Up @@ -1215,12 +1214,14 @@ export function validateManifest(manifest: Manifest): Manifest {
validateEngineCompatibility(engineVersion);

const hasActivationEvents = !!manifest.activationEvents;
const hasImplicitActivationEvents =
const hasImplicitLanguageActivationEvents = manifest.contributes?.languages;
const hasOtherImplicitActivationEvents =
manifest.contributes?.commands ||
manifest.contributes?.authentication ||
manifest.contributes?.languages ||
manifest.contributes?.customEditors ||
manifest.contributes?.views;
const hasImplicitActivationEvents = hasImplicitLanguageActivationEvents || hasOtherImplicitActivationEvents;

const hasMain = !!manifest.main;
const hasBrowser = !!manifest.browser;

Expand All @@ -1237,7 +1238,7 @@ export function validateManifest(manifest: Manifest): Manifest {
((engineVersion === '*' || semver.satisfies(parsedEngineVersion, '>=1.74', { includePrerelease: true })) &&
hasImplicitActivationEvents)
) {
if (!hasMain && !hasBrowser) {
if (!hasMain && !hasBrowser && (hasActivationEvents || !hasImplicitLanguageActivationEvents)) {
throw new Error(
"Manifest needs either a 'main' or 'browser' property, given it has a 'activationEvents' property."
);
Expand Down Expand Up @@ -1371,84 +1372,74 @@ export async function toVsixManifest(vsix: VSIX): Promise<string> {
<Tags>${escape(vsix.tags)}</Tags>
<Categories>${escape(vsix.categories)}</Categories>
<GalleryFlags>${escape(vsix.flags)}</GalleryFlags>
${
!vsix.badges
? ''
: `<Badges>${vsix.badges
.map(
badge =>
`<Badge Link="${escape(badge.href)}" ImgUri="${escape(badge.url)}" Description="${escape(
badge.description
)}" />`
)
.join('\n')}</Badges>`
}
${!vsix.badges
? ''
: `<Badges>${vsix.badges
.map(
badge =>
`<Badge Link="${escape(badge.href)}" ImgUri="${escape(badge.url)}" Description="${escape(
badge.description
)}" />`
)
.join('\n')}</Badges>`
}
<Properties>
<Property Id="Microsoft.VisualStudio.Code.Engine" Value="${escape(vsix.engine)}" />
<Property Id="Microsoft.VisualStudio.Code.ExtensionDependencies" Value="${escape(vsix.extensionDependencies)}" />
<Property Id="Microsoft.VisualStudio.Code.ExtensionPack" Value="${escape(vsix.extensionPack)}" />
<Property Id="Microsoft.VisualStudio.Code.ExtensionKind" Value="${escape(vsix.extensionKind)}" />
<Property Id="Microsoft.VisualStudio.Code.LocalizedLanguages" Value="${escape(vsix.localizedLanguages)}" />
${vsix.preRelease ? `<Property Id="Microsoft.VisualStudio.Code.PreRelease" Value="${escape(vsix.preRelease)}" />` : ''}
${
vsix.sponsorLink
? `<Property Id="Microsoft.VisualStudio.Code.SponsorLink" Value="${escape(vsix.sponsorLink)}" />`
: ''
}
${
!vsix.links.repository
? ''
: `<Property Id="Microsoft.VisualStudio.Services.Links.Source" Value="${escape(vsix.links.repository)}" />
${vsix.sponsorLink
? `<Property Id="Microsoft.VisualStudio.Code.SponsorLink" Value="${escape(vsix.sponsorLink)}" />`
: ''
}
${!vsix.links.repository
? ''
: `<Property Id="Microsoft.VisualStudio.Services.Links.Source" Value="${escape(vsix.links.repository)}" />
<Property Id="Microsoft.VisualStudio.Services.Links.Getstarted" Value="${escape(vsix.links.repository)}" />
${
vsix.links.github
? `<Property Id="Microsoft.VisualStudio.Services.Links.GitHub" Value="${escape(vsix.links.github)}" />`
: `<Property Id="Microsoft.VisualStudio.Services.Links.Repository" Value="${escape(
vsix.links.repository
)}" />`
}`
}
${
vsix.links.bugs
? `<Property Id="Microsoft.VisualStudio.Services.Links.Support" Value="${escape(vsix.links.bugs)}" />`
: ''
}
${
vsix.links.homepage
? `<Property Id="Microsoft.VisualStudio.Services.Links.Learn" Value="${escape(vsix.links.homepage)}" />`
: ''
}
${
vsix.galleryBanner.color
? `<Property Id="Microsoft.VisualStudio.Services.Branding.Color" Value="${escape(
vsix.galleryBanner.color
)}" />`
: ''
}
${
vsix.galleryBanner.theme
? `<Property Id="Microsoft.VisualStudio.Services.Branding.Theme" Value="${escape(
vsix.galleryBanner.theme
)}" />`
: ''
}
${vsix.links.github
? `<Property Id="Microsoft.VisualStudio.Services.Links.GitHub" Value="${escape(vsix.links.github)}" />`
: `<Property Id="Microsoft.VisualStudio.Services.Links.Repository" Value="${escape(
vsix.links.repository
)}" />`
}`
}
${vsix.links.bugs
? `<Property Id="Microsoft.VisualStudio.Services.Links.Support" Value="${escape(vsix.links.bugs)}" />`
: ''
}
${vsix.links.homepage
? `<Property Id="Microsoft.VisualStudio.Services.Links.Learn" Value="${escape(vsix.links.homepage)}" />`
: ''
}
${vsix.galleryBanner.color
? `<Property Id="Microsoft.VisualStudio.Services.Branding.Color" Value="${escape(
vsix.galleryBanner.color
)}" />`
: ''
}
${vsix.galleryBanner.theme
? `<Property Id="Microsoft.VisualStudio.Services.Branding.Theme" Value="${escape(
vsix.galleryBanner.theme
)}" />`
: ''
}
<Property Id="Microsoft.VisualStudio.Services.GitHubFlavoredMarkdown" Value="${escape(vsix.githubMarkdown)}" />
<Property Id="Microsoft.VisualStudio.Services.Content.Pricing" Value="${escape(vsix.pricing)}"/>

${
vsix.enableMarketplaceQnA !== undefined
? `<Property Id="Microsoft.VisualStudio.Services.EnableMarketplaceQnA" Value="${escape(
vsix.enableMarketplaceQnA
)}" />`
: ''
}
${
vsix.customerQnALink !== undefined
? `<Property Id="Microsoft.VisualStudio.Services.CustomerQnALink" Value="${escape(
vsix.customerQnALink
)}" />`
: ''
}
${vsix.enableMarketplaceQnA !== undefined
? `<Property Id="Microsoft.VisualStudio.Services.EnableMarketplaceQnA" Value="${escape(
vsix.enableMarketplaceQnA
)}" />`
: ''
}
${vsix.customerQnALink !== undefined
? `<Property Id="Microsoft.VisualStudio.Services.CustomerQnALink" Value="${escape(
vsix.customerQnALink
)}" />`
: ''
}
</Properties>
${vsix.license ? `<License>${escape(vsix.license)}</License>` : ''}
${vsix.icon ? `<Icon>${escape(vsix.icon)}</Icon>` : ''}
Expand All @@ -1460,8 +1451,8 @@ export async function toVsixManifest(vsix: VSIX): Promise<string> {
<Assets>
<Asset Type="Microsoft.VisualStudio.Code.Manifest" Path="extension/package.json" Addressable="true" />
${vsix.assets
.map(asset => `<Asset Type="${escape(asset.type)}" Path="${escape(asset.path)}" Addressable="true" />`)
.join('\n')}
.map(asset => `<Asset Type="${escape(asset.type)}" Path="${escape(asset.path)}" Addressable="true" />`)
.join('\n')}
</Assets>
</PackageManifest>`;
}
Expand Down Expand Up @@ -1680,8 +1671,8 @@ function writeVsix(files: IFile[], packagePath: string): Promise<void> {
files.forEach(f =>
isInMemoryFile(f)
? zip.addBuffer(typeof f.contents === 'string' ? Buffer.from(f.contents, 'utf8') : f.contents, f.path, {
mode: f.mode,
})
mode: f.mode,
})
: zip.addFile(f.localPath, f.path, { mode: f.mode })
);
zip.end();
Expand Down
13 changes: 13 additions & 0 deletions src/test/package.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,6 +429,19 @@ describe('validateManifest', () => {
})
);

validateManifest(
createManifest({
engines: { vscode: '>=1.74.0' },
contributes: {
languages: [
{
id: 'typescript',
}
]
}
})
);

assert.throws(() =>
validateManifest(
createManifest({
Expand Down