Skip to content

Add Filesystem API to jars #963

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Filesystem API to jars #963

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
42 changes: 26 additions & 16 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@
{
"id": "java",
"extensions": [
".cfr"
".cfr",
".class"
]
},
{
Expand Down Expand Up @@ -427,6 +428,11 @@
"category": "Metals",
"title": "Run all Scalafix rules"
},
{
"command": "metals.show-libraries-folder",
"category": "Metals",
"title": "Show libraries folder in file explorer"
},
{
"command": "metals.show-tasty",
"category": "Metals",
Expand Down Expand Up @@ -592,33 +598,37 @@
}
],
"commandPalette": [
{
"command": "metals.show-libraries-folder",
"when": "metals:enabled"
},
{
"command": "metals.show-tasty",
"when": "metals:enabled && resourceExtname==.scala || metals:enabled && resourceExtname==.tasty || metals:enabled && resourceExtname==.tasty-decoded"
"when": "metals:enabled && resourceScheme != metalsfs && resourceExtname==.scala || metals:enabled && resourceExtname==.tasty-decoded"
},
{
"command": "metals.show-cfr",
"when": "metals:enabled && resourceExtname==.java || metals:enabled && resourceExtname==.scala || metals:enabled && resourceExtname==.class || metals:enabled && resourceExtname==.cfr"
"when": "metals:enabled && resourceScheme != metalsfs && resourceExtname==.java || metals:enabled && resourceScheme != metalsfs && resourceExtname==.scala || metals:enabled && resourceExtname==.cfr"
},
{
"command": "metals.show-javap",
"when": "metals:enabled && resourceExtname==.java || metals:enabled && resourceExtname==.scala || metals:enabled && resourceExtname==.class || metals:enabled && resourceExtname==.javap"
"when": "metals:enabled && resourceScheme != metalsfs && resourceExtname==.java || metals:enabled && resourceScheme != metalsfs && resourceExtname==.scala || metals:enabled && resourceScheme == metalsfs && resourceExtname==.class || metals:enabled && resourceExtname==.javap"
},
{
"command": "metals.show-javap-verbose",
"when": "metals:enabled && resourceExtname==.java || metals:enabled && resourceExtname==.scala || metals:enabled && resourceExtname==.class || metals:enabled && resourceExtname==.javap-verbose"
"when": "metals:enabled && resourceScheme != metalsfs && resourceExtname==.java || metals:enabled && resourceScheme != metalsfs && resourceExtname==.scala || metals:enabled && resourceScheme == metalsfs && resourceExtname==.class || metals:enabled && resourceExtname==.javap-verbose"
},
{
"command": "metals.show-semanticdb-compact",
"when": "metals:enabled && resourceExtname==.java || metals:enabled && resourceExtname==.scala || metals:enabled && resourceExtname==.semanticdb || metals:enabled && resourceExtname==.semanticdb-compact"
"when": "metals:enabled && resourceExtname==.java || metals:enabled && resourceExtname==.scala || metals:enabled && resourceScheme == metalsfs && resourceExtname==.class || metals:enabled && resourceExtname==.semanticdb-compact"
},
{
"command": "metals.show-semanticdb-detailed",
"when": "metals:enabled && resourceExtname==.java || metals:enabled && resourceExtname==.scala || metals:enabled && resourceExtname==.semanticdb || metals:enabled && resourceExtname==.semanticdb-detailed"
"when": "metals:enabled && resourceExtname==.java || metals:enabled && resourceExtname==.scala || metals:enabled && resourceScheme == metalsfs && resourceExtname==.class || metals:enabled && resourceExtname==.semanticdb-detailed"
},
{
"command": "metals.show-semanticdb-proto",
"when": "metals:enabled && resourceExtname==.java || metals:enabled && resourceExtname==.scala || metals:enabled && resourceExtname==.semanticdb || metals:enabled && resourceExtname==.semanticdb-proto"
"when": "metals:enabled && resourceExtname==.java || metals:enabled && resourceExtname==.scala || metals:enabled && resourceScheme == metalsfs && resourceExtname==.class || metals:enabled && resourceExtname==.semanticdb-proto"
},
{
"command": "metals.reveal-active-file",
Expand Down Expand Up @@ -686,11 +696,11 @@
},
{
"command": "metals.new-scala-file",
"when": "metals:enabled"
"when": "metals:enabled && resourceScheme != metalsfs"
},
{
"command": "metals.new-java-file",
"when": "metals:enabled"
"when": "metals:enabled && resourceScheme != metalsfs"
},
{
"command": "metals.new-scala-project",
Expand Down Expand Up @@ -728,12 +738,12 @@
"explorer/context": [
{
"command": "metals.new-scala-file",
"when": "metals:enabled",
"when": "metals:enabled && resourceScheme != metalsfs",
"group": "navigation@1"
},
{
"command": "metals.new-java-file",
"when": "metals:enabled",
"when": "metals:enabled && resourceScheme != metalsfs",
"group": "navigation@2"
},
{
Expand All @@ -745,22 +755,22 @@
"metals.analyze": [
{
"command": "metals.show-tasty",
"when": "metals:enabled && resourceExtname==.scala || metals:enabled && resourceExtname==.tasty || metals:enabled && resourceExtname==.tasty-decoded",
"when": "metals:enabled && resourceScheme != metalsfs && resourceExtname==.scala || metals:enabled && resourceExtname==.tasty || metals:enabled && resourceExtname==.tasty-decoded",
"group": "metals-1@1"
},
{
"command": "metals.show-cfr",
"when": "metals:enabled && resourceExtname==.java || metals:enabled && resourceExtname==.scala || metals:enabled && resourceExtname==.class",
"when": "metals:enabled && resourceScheme != metalsfs && resourceExtname==.java || metals:enabled && resourceScheme != metalsfs && resourceExtname==.scala || metals:enabled && resourceScheme != metalsfs && resourceExtname==.class",
"group": "metals-2@1"
},
{
"command": "metals.show-javap",
"when": "metals:enabled && resourceExtname==.java || metals:enabled && resourceExtname==.scala || metals:enabled && resourceExtname==.class",
"when": "metals:enabled && resourceScheme != metalsfs && resourceExtname==.java || metals:enabled && resourceScheme != metalsfs && resourceExtname==.scala || metals:enabled && resourceExtname==.class",
"group": "metals-3@1"
},
{
"command": "metals.show-javap-verbose",
"when": "metals:enabled && resourceExtname==.java || metals:enabled && resourceExtname==.scala || metals:enabled && resourceExtname==.class",
"when": "metals:enabled && resourceScheme != metalsfs && resourceExtname==.java || metals:enabled && resourceScheme != metalsfs && resourceExtname==.scala || metals:enabled && resourceExtname==.class",
"group": "metals-3@2"
},
{
Expand Down
161 changes: 103 additions & 58 deletions src/extension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import {
ProviderResult,
Hover,
TextDocument,
FileSystemProvider,
} from "vscode";
import {
LanguageClient,
Expand Down Expand Up @@ -78,7 +79,11 @@ import {
startFindInFilesProvider,
} from "./findInFiles";
import * as ext from "./hoverExtension";
import { decodeAndShowFile, MetalsFileProvider } from "./metalsContentProvider";
import {
decodeAndShowFile,
DecodeExtension,
MetalsFileProvider,
} from "./metalsContentProvider";
import {
getJavaHomeFromConfig,
getTextDocumentPositionParams,
Expand All @@ -91,6 +96,7 @@ import { getServerVersion } from "./getServerVersion";
import { getCoursierMirrorPath } from "./mirrors";
import { DoctorProvider } from "./doctor";
import { showReleaseNotes } from "./releaseNotesProvider";
import MetalsFileSystemProvider from "./metalsFileSystemProvider";

const outputChannel = window.createOutputChannel("Metals");
const openSettingsAction = "Open settings";
Expand All @@ -99,6 +105,8 @@ const downloadJava = "Download Java";
const installJava11Action = "Install Java (JDK 11)";
const installJava17Action = "Install Java (JDK 17)";

const librariesURI = Uri.parse("metalsfs:/metalsLibraries");

let treeViews: MetalsTreeViews | undefined;
let currentClient: LanguageClient | undefined;

Expand Down Expand Up @@ -358,6 +366,7 @@ function launchMetals(
icons: "vscode",
inputBoxProvider: true,
isVirtualDocumentSupported: true,
isLibraryFileSystemSupported: true,
openFilesOnRenameProvider: true,
openNewWindowProvider: true,
quickPickProvider: true,
Expand All @@ -373,8 +382,8 @@ function launchMetals(
documentSelector: [
{ scheme: "file", language: "scala" },
{ scheme: "file", language: "java" },
{ scheme: "jar", language: "scala" },
{ scheme: "jar", language: "java" },
{ scheme: "metalsfs", language: "scala" },
{ scheme: "metalsfs", language: "java" },
],
synchronize: {
configurationSection: "metals",
Expand Down Expand Up @@ -449,6 +458,18 @@ function launchMetals(
);
}

function registerFileSystemProvider(
scheme: string,
provider: FileSystemProvider
) {
context.subscriptions.push(
workspace.registerFileSystemProvider(scheme, provider, {
isCaseSensitive: true,
isReadonly: true,
})
);
}

function registerTextDocumentContentProvider(
scheme: string,
provider: TextDocumentContentProvider
Expand All @@ -459,52 +480,26 @@ function launchMetals(
}

const metalsFileProvider = new MetalsFileProvider(client);

registerTextDocumentContentProvider("metalsDecode", metalsFileProvider);
registerTextDocumentContentProvider("jar", metalsFileProvider);

registerCommand("metals.show-cfr", async (uri: Uri) => {
await decodeAndShowFile(client, metalsFileProvider, uri, "cfr");
});

registerCommand("metals.show-javap-verbose", async (uri: Uri) => {
await decodeAndShowFile(client, metalsFileProvider, uri, "javap-verbose");
});

registerCommand("metals.show-javap", async (uri: Uri) => {
await decodeAndShowFile(client, metalsFileProvider, uri, "javap");
});

registerCommand("metals.show-semanticdb-compact", async (uri: Uri) => {
await decodeAndShowFile(
client,
metalsFileProvider,
uri,
"semanticdb-compact"
);
});

registerCommand("metals.show-semanticdb-detailed", async (uri: Uri) => {
await decodeAndShowFile(
client,
metalsFileProvider,
uri,
"semanticdb-detailed"
);
});

registerCommand("metals.show-semanticdb-proto", async (uri: Uri) => {
await decodeAndShowFile(
client,
metalsFileProvider,
uri,
"semanticdb-proto"
);
});
registerCommand("metals.show-libraries-folder", async () =>
addLibrariesFolder()
);

registerCommand("metals.show-tasty", async (uri: Uri) => {
await decodeAndShowFile(client, metalsFileProvider, uri, "tasty-decoded");
});
const decodeCommands: [string, DecodeExtension][] = [
["cfr", "cfr"],
["javap-verbose", "javap-verbose"],
["javap", "javap"],
["semanticdb-compact", "semanticdb-compact"],
["semanticdb-detailed", "semanticdb-detailed"],
["semanticdb-proto", "semanticdb-proto"],
["tasty", "tasty-decoded"],
];
decodeCommands.forEach((command) =>
registerCommand(`metals.show-${command[0]}`, async (uri: Uri) => {
await decodeAndShowFile(client, metalsFileProvider, uri, command[1]);
})
);

registerCommand(
"metals.restartServer",
Expand Down Expand Up @@ -658,7 +653,7 @@ function launchMetals(
codeLensRefresher
);
languages.registerCodeLensProvider(
{ scheme: "jar", language: "scala" },
{ scheme: "metalsfs", language: "scala" },
codeLensRefresher
);

Expand Down Expand Up @@ -725,6 +720,19 @@ function launchMetals(
case ClientCommands.ReloadDoctor:
doctorProvider.reloadOrRefreshDoctor(params);
break;
case "metals-library-filesystem-ready": {
const metalsFileSystemProvider = new MetalsFileSystemProvider(
client,
librariesURI
);
registerFileSystemProvider(
librariesURI.scheme,
metalsFileSystemProvider
);

metalsFileSystemProvider.reinitialiseURI(librariesURI);
break;
}
case ClientCommands.FocusDiagnostics:
commands.executeCommand(ClientCommands.FocusDiagnostics);
break;
Expand Down Expand Up @@ -898,7 +906,7 @@ function launchMetals(
registerCommand("metals.reveal-active-file", () => {
if (treeViews) {
const editor = window.visibleTextEditors.find((e) =>
isSupportedLanguage(e.document.languageId)
isSupportedDocument(e.document)
);
if (editor) {
const params = getTextDocumentPositionParams(editor);
Expand Down Expand Up @@ -975,7 +983,6 @@ function launchMetals(
client,
findInFilesProvider,
findInFilesView,
metalsFileProvider,
outputChannel
)
);
Expand Down Expand Up @@ -1021,7 +1028,7 @@ function launchMetals(
);

window.onDidChangeActiveTextEditor((editor) => {
if (editor && isSupportedLanguage(editor.document.languageId)) {
if (editor && isSupportedDocument(editor.document)) {
client.sendNotification(
MetalsDidFocus.type,
editor.document.uri.toString()
Expand Down Expand Up @@ -1277,14 +1284,52 @@ function detectLaunchConfigurationChanges() {
);
}

function isSupportedLanguage(languageId: TextDocument["languageId"]): boolean {
switch (languageId) {
case "scala":
case "sc":
case "java":
return true;
default:
return false;
function isSupportedDocument(textDocument: TextDocument): boolean {
return (
["metalsfs", "file"].includes(textDocument.uri.scheme) &&
["scala", "sc", "java"].includes(textDocument.languageId)
);
}

function addLibrariesFolder() {
const libraryFolderName = "Metals - Libraries";

// filesystem can be persistent across VSCode sessions so may already exist
const newLibraryFolder = {
uri: librariesURI,
name: libraryFolderName,
};
const folderByUri = workspace.getWorkspaceFolder(librariesURI);
if (folderByUri && folderByUri.name != libraryFolderName) {
// wrong name on libraries folder
workspace.updateWorkspaceFolders(folderByUri.index, 1, newLibraryFolder);
} else {
const folderByName = workspace.workspaceFolders?.find(
(folder) => folder.name == libraryFolderName
);
if (folderByName && folderByName.uri.toString != librariesURI.toString) {
if (folderByUri) {
// too many libraries folders
workspace.updateWorkspaceFolders(folderByName.index, 1);
} else {
// wrong root on libraries folder
workspace.updateWorkspaceFolders(
folderByName.index,
1,
newLibraryFolder
);
}
} else if (!folderByUri) {
// missing libraries folder
const workspaceCount = workspace.workspaceFolders?.length;
if (workspaceCount) {
workspace.updateWorkspaceFolders(
workspaceCount,
null,
newLibraryFolder
);
}
}
}
}

Expand Down
Loading