development/vscode
development/vscode
1
0
Fork 0
mirror of https://github.com/Microsoft/vscode synced 2024-10-02 09:18:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Warn about star activation (#173112)

Browse source 
* star activation bad

* better message

* info level
This commit is contained in:
Tyler James Leonhardt 2023-02-02 15:59:09 -05:00 committed by GitHub
parent 1108c31f0d
commit 262ab0e7bf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
extensions/extension-editing/src/extensionLinter.ts
View file

@ -33,6 +33,7 @@ const relativeBadgeUrlRequiresHttpsRepository = l10n.t("Relative badge URLs requ
const apiProposalNotListed = l10n.t("This proposal cannot be used because for this extension the product defines a fixed set of API proposals. You can test your extension but before publishing you MUST reach out to the VS Code team.");
const implicitActivationEvent = l10n.t("This activation event cannot be explicitly listed by your extension.");
const redundantImplicitActivationEvent = l10n.t("This activation event can be removed as VS Code generates these automatically from your package.json contribution declarations.");
const starActivation = l10n.t("Using '*' activation is usually a bad idea as it impacts performance.");
enum Context {
ICON,
@ -155,19 +156,33 @@ export class ExtensionLinter {
if (activationEventsNode?.type === 'array' && activationEventsNode.children) {
for (const activationEventNode of activationEventsNode.children) {
const activationEvent = getNodeValue(activationEventNode);
// Redundant Implicit Activation
if (info.implicitActivationEvents?.has(activationEvent) && redundantImplicitActivationEventPrefixes.some((prefix) => activationEvent.startsWith(prefix))) {
const start = document.positionAt(activationEventNode.offset);
const end = document.positionAt(activationEventNode.offset + activationEventNode.length);
diagnostics.push(new Diagnostic(new Range(start, end), redundantImplicitActivationEvent, DiagnosticSeverity.Warning));
} else {
for (const implicitActivationEventPrefix of reservedImplicitActivationEventPrefixes) {
if (activationEvent.startsWith(implicitActivationEventPrefix)) {
const start = document.positionAt(activationEventNode.offset);
const end = document.positionAt(activationEventNode.offset + activationEventNode.length);
diagnostics.push(new Diagnostic(new Range(start, end), implicitActivationEvent, DiagnosticSeverity.Error));
}
}
// Reserved Implicit Activation
for (const implicitActivationEventPrefix of reservedImplicitActivationEventPrefixes) {
if (activationEvent.startsWith(implicitActivationEventPrefix)) {
const start = document.positionAt(activationEventNode.offset);
const end = document.positionAt(activationEventNode.offset + activationEventNode.length);
diagnostics.push(new Diagnostic(new Range(start, end), implicitActivationEvent, DiagnosticSeverity.Error));
}
}
// Star activation
if (activationEvent === '*') {
const start = document.positionAt(activationEventNode.offset);
const end = document.positionAt(activationEventNode.offset + activationEventNode.length);
const diagnostic = new Diagnostic(new Range(start, end), starActivation, DiagnosticSeverity.Information);
diagnostic.code = {
value: 'star-activation',
target: Uri.parse('https://code.visualstudio.com/api/references/activation-events#Start-up'),
};
diagnostics.push(diagnostic);
}
}
}
}