Skip to content

Broaden NPM detection for VS Code extensions #1801

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

Open
pjcollins wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −18
Open

Broaden NPM detection for VS Code extensions #1801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 1 addition & 15 deletions src/Microsoft.ComponentDetection.Detectors/npm/NpmComponentDetector.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public NpmComponentDetector(

public override IEnumerable<ComponentType> SupportedComponentTypes { get; } = [ComponentType.Npm];

public override int Version { get; } = 3;
public override int Version { get; } = 4;

protected override async Task OnFileFoundAsync(ProcessRequest processRequest, IDictionary<string, string> detectorArgs, CancellationToken cancellationToken = default)
{
Expand Down Expand Up @@ -82,20 +82,6 @@ protected virtual bool ProcessPackageJson(string filePath, ISingleFileComponentR
return false;
}

// Check for VS Code extensions
// See https://code.visualstudio.com/api/working-with-extensions/publishing-extension#visual-studio-code-compatibility
var containsVsCodeEngine = false;
if (packageJson.Engines is not null && packageJson.Engines.ContainsKey("vscode"))
{
containsVsCodeEngine = true;
}

if (containsVsCodeEngine)
{
this.Logger.LogInformation("{NpmPackageName} found at path {NpmPackageLocation} represents a built-in VS Code extension. This package will not be registered.", name, filePath);
return false;
}

var author = this.GetAuthor(packageJson.Author, name, filePath);
var npmComponent = new NpmComponent(name, version, author: author);

Expand Down
14 changes: 11 additions & 3 deletions test/Microsoft.ComponentDetection.Detectors.Tests/NpmDetectorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ public async Task TestNpmDetector_NodeEngineDoesNotCauseSkippedPackageAsync()
}

[TestMethod]
public async Task TestNpmDetector_VSCodeEngineCausesSkippedPackageAsync()
public async Task TestNpmDetector_VSCodeEnginePackageIsDetectedAsync()
{
var componentName = GetRandomString();
var version = NewRandomVersion();
Expand All @@ -239,7 +239,11 @@ public async Task TestNpmDetector_VSCodeEngineCausesSkippedPackageAsync()
.ExecuteDetectorAsync();
scanResult.ResultCode.Should().Be(ProcessingResultCode.Success);
var detectedComponents = componentRecorder.GetDetectedComponents();
detectedComponents.Should().BeEmpty();
detectedComponents.Should().ContainSingle();
detectedComponents.Single().Component.Type.Should().Be(ComponentType.Npm);
var detectedNpmComponent = (NpmComponent)detectedComponents.Single().Component;
detectedNpmComponent.Name.Should().Be(componentName);
detectedNpmComponent.Version.Should().Be(version);
}

[TestMethod]
Expand All @@ -256,7 +260,11 @@ public async Task TestNpmDetector_EnginesAsArray_VSCodeEngine()
.ExecuteDetectorAsync();
scanResult.ResultCode.Should().Be(ProcessingResultCode.Success);
var detectedComponents = componentRecorder.GetDetectedComponents();
detectedComponents.Should().BeEmpty();
detectedComponents.Should().ContainSingle();
detectedComponents.Single().Component.Type.Should().Be(ComponentType.Npm);
var detectedNpmComponent = (NpmComponent)detectedComponents.Single().Component;
detectedNpmComponent.Name.Should().Be(packageName);
detectedNpmComponent.Version.Should().Be(packageVersion);
}

[TestMethod]
Expand Down
Loading