Merge pull request #328 from laravel/storage-feature

Autocompletion, linking, and diagnostics for Storage Disks

Author: joetannenbaum

generatable.json

@@ -60,5 +60,13 @@
             "link",
             "completion"
         ]
+    },
+    {
+        "type": "storage",
+        "features": [
+            "link",
+            "completion",
+            "diagnostics"
+        ]
     }
 ]

package.json

@@ -399,6 +399,24 @@
                     "generated": true,
                     "description": "Enable completion for route."
                 },
+                "Laravel.storage.link": {
+                    "type": "boolean",
+                    "default": true,
+                    "generated": true,
+                    "description": "Enable linking for storage."
+                },
+                "Laravel.storage.completion": {
+                    "type": "boolean",
+                    "default": true,
+                    "generated": true,
+                    "description": "Enable completion for storage."
+                },
+                "Laravel.storage.diagnostics": {
+                    "type": "boolean",
+                    "default": true,
+                    "generated": true,
+                    "description": "Enable diagnostics for storage."
+                },
                 "Laravel.translation.diagnostics": {
                     "type": "boolean",
                     "default": true,

src/completion/CompletionProvider.ts

@@ -10,22 +10,24 @@ import { completionProvider as inertia } from "@src/features/inertia";
 import { completionProvider as middleware } from "@src/features/middleware";
 import { completionProvider as mix } from "@src/features/mix";
 import { completionProvider as route } from "@src/features/route";
+import { completionProvider as storage } from "@src/features/storage";
 import { completionProvider as translation } from "@src/features/translation";
 import { completionProvider as view } from "@src/features/view";
 import { GeneratedConfigKey } from "@src/support/generated-config";
 import { CompletionProvider } from "..";
 
 const allProviders: Partial<Record<GeneratedConfigKey, CompletionProvider>> = {
     "appBinding.completion": appBinding,
+    "asset.completion": asset,
     "auth.completion": auth,
     "config.completion": config,
-    "asset.completion": asset,
+    "controllerAction.completion": controllerAction,
     "env.completion": env,
     "inertia.completion": inertia,
     "middleware.completion": middleware,
     "mix.completion": mix,
     "route.completion": route,
-    "controllerAction.completion": controllerAction,
+    "storage.completion": storage,
     "translation.completion": translation,
     "view.completion": view,
 };

src/diagnostic/diagnostic.ts

@@ -8,6 +8,7 @@ import { diagnosticProvider as inertia } from "@src/features/inertia";
 import { diagnosticProvider as middleware } from "@src/features/middleware";
 import { diagnosticProvider as mix } from "@src/features/mix";
 import { diagnosticProvider as route } from "@src/features/route";
+import { diagnosticProvider as storage } from "@src/features/storage";
 import { diagnosticProvider as translation } from "@src/features/translation";
 import { diagnosticProvider as view } from "@src/features/view";
 import { config as getConfig } from "@src/support/config";
@@ -30,6 +31,7 @@ const providers: {
     { provider: middleware, configKey: "middleware.diagnostics" },
     { provider: mix, configKey: "mix.diagnostics" },
     { provider: route, configKey: "route.diagnostics" },
+    { provider: storage, configKey: "storage.diagnostics" },
     { provider: translation, configKey: "translation.diagnostics" },
     { provider: view, configKey: "view.diagnostics" },
 ];

src/diagnostic/index.ts

@@ -25,4 +25,5 @@ export type DiagnosticCode =
     | "mix"
     | "route"
     | "translation"
-    | "view";
+    | "view"
+    | "storage_disk";

src/features/storage.ts

@@ -0,0 +1,106 @@
+import { notFound } from "@src/diagnostic";
+import AutocompleteResult from "@src/parser/AutocompleteResult";
+import { getConfigs } from "@src/repositories/configs";
+import { getPaths } from "@src/repositories/paths";
+import { config } from "@src/support/config";
+import { detectedRange, detectInDoc } from "@src/support/parser";
+import { wordMatchRegex } from "@src/support/patterns";
+import { projectPath } from "@src/support/project";
+import { facade } from "@src/support/util";
+import * as vscode from "vscode";
+import { CompletionProvider, FeatureTag, LinkProvider } from "..";
+
+const toFind: FeatureTag = {
+    class: facade("Storage"),
+    method: ["disk"],
+    argumentIndex: 0,
+};
+
+export const linkProvider: LinkProvider = (doc: vscode.TextDocument) => {
+    return detectInDoc<vscode.DocumentLink, "string">(
+        doc,
+        toFind,
+        getPaths,
+        ({ param, item }) => {
+            const configItem = getConfigs().items.find(
+                (c) => c.name === `filesystems.disks.${param.value}`,
+            );
+
+            if (!configItem || !configItem.file) {
+                return null;
+            }
+
+            return new vscode.DocumentLink(
+                detectedRange(param),
+                vscode.Uri.file(projectPath(configItem.file)).with({
+                    fragment: `L${configItem.line}`,
+                }),
+            );
+        },
+    );
+};
+
+export const diagnosticProvider = (
+    doc: vscode.TextDocument,
+): Promise<vscode.Diagnostic[]> => {
+    return detectInDoc<vscode.Diagnostic, "string">(
+        doc,
+        toFind,
+        getConfigs,
+        ({ param, item, index }) => {
+            const config = getConfigs().items.find(
+                (c) => c.name === `filesystems.disks.${param.value}`,
+            );
+
+            if (config) {
+                return null;
+            }
+
+            return notFound(
+                "Storage Disk",
+                param.value,
+                detectedRange(param),
+                "storage_disk",
+            );
+        },
+    );
+};
+
+export const completionProvider: CompletionProvider = {
+    tags() {
+        return toFind;
+    },
+
+    provideCompletionItems(
+        result: AutocompleteResult,
+        document: vscode.TextDocument,
+        position: vscode.Position,
+        token: vscode.CancellationToken,
+        context: vscode.CompletionContext,
+    ): vscode.CompletionItem[] {
+        if (!config("storage.completion", true)) {
+            return [];
+        }
+
+        return getConfigs()
+            .items.filter((config) => {
+                return (
+                    config.name.startsWith("filesystems.disks.") &&
+                    config.name.split(".").length === 3
+                );
+            })
+            .map((config) => {
+                const completeItem = new vscode.CompletionItem(
+                    config.name.replace("filesystems.disks.", ""),
+                    vscode.CompletionItemKind.Value,
+                );
+
+                completeItem.range = document.getWordRangeAtPosition(
+                    position,
+                    wordMatchRegex,
+                );
+
+                return completeItem;
+            });
+    },
+};

src/link/LinkProvider.ts

@@ -13,6 +13,7 @@ import { linkProvider as middleware } from "@src/features/middleware";
 import { linkProvider as mix } from "@src/features/mix";
 import { linkProvider as paths } from "@src/features/paths";
 import { linkProvider as route } from "@src/features/route";
+import { linkProvider as storage } from "@src/features/storage";
 import { linkProvider as translation } from "@src/features/translation";
 import { linkProvider as view } from "@src/features/view";
 import { LinkProvider as LinkProviderType } from "@src/index";
@@ -39,6 +40,7 @@ const allProviders: Partial<Record<GeneratedConfigKey, LinkProviderType>> = {
     "mix.link": mix,
     "paths.link": paths,
     "route.link": route,
+    "storage.link": storage,
     "translation.link": translation,
     "view.link": view,
 };

src/support/generated-config.ts

@@ -1 +1 @@
-export type GeneratedConfigKey = 'appBinding.diagnostics' | 'appBinding.hover' | 'appBinding.link' | 'appBinding.completion' | 'asset.diagnostics' | 'asset.hover' | 'asset.link' | 'asset.completion' | 'auth.diagnostics' | 'auth.hover' | 'auth.link' | 'auth.completion' | 'bladeComponent.link' | 'bladeComponent.completion' | 'bladeComponent.hover' | 'config.diagnostics' | 'config.hover' | 'config.link' | 'config.completion' | 'controllerAction.diagnostics' | 'controllerAction.hover' | 'controllerAction.link' | 'controllerAction.completion' | 'env.diagnostics' | 'env.hover' | 'env.link' | 'env.completion' | 'inertia.diagnostics' | 'inertia.hover' | 'inertia.link' | 'inertia.completion' | 'livewireComponent.link' | 'livewireComponent.completion' | 'middleware.diagnostics' | 'middleware.hover' | 'middleware.link' | 'middleware.completion' | 'mix.diagnostics' | 'mix.hover' | 'mix.link' | 'mix.completion' | 'paths.link' | 'route.diagnostics' | 'route.hover' | 'route.link' | 'route.completion' | 'translation.diagnostics' | 'translation.hover' | 'translation.link' | 'translation.completion' | 'view.diagnostics' | 'view.hover' | 'view.link' | 'view.completion';
+export type GeneratedConfigKey = 'appBinding.diagnostics' | 'appBinding.hover' | 'appBinding.link' | 'appBinding.completion' | 'asset.diagnostics' | 'asset.hover' | 'asset.link' | 'asset.completion' | 'auth.diagnostics' | 'auth.hover' | 'auth.link' | 'auth.completion' | 'bladeComponent.link' | 'bladeComponent.completion' | 'bladeComponent.hover' | 'config.diagnostics' | 'config.hover' | 'config.link' | 'config.completion' | 'controllerAction.diagnostics' | 'controllerAction.hover' | 'controllerAction.link' | 'controllerAction.completion' | 'env.diagnostics' | 'env.hover' | 'env.link' | 'env.completion' | 'inertia.diagnostics' | 'inertia.hover' | 'inertia.link' | 'inertia.completion' | 'livewireComponent.link' | 'livewireComponent.completion' | 'middleware.diagnostics' | 'middleware.hover' | 'middleware.link' | 'middleware.completion' | 'mix.diagnostics' | 'mix.hover' | 'mix.link' | 'mix.completion' | 'paths.link' | 'route.diagnostics' | 'route.hover' | 'route.link' | 'route.completion' | 'storage.link' | 'storage.completion' | 'storage.diagnostics' | 'translation.diagnostics' | 'translation.hover' | 'translation.link' | 'translation.completion' | 'view.diagnostics' | 'view.hover' | 'view.link' | 'view.completion';