Merge pull request #327 from laravel/file-watchers

Improve file watcher performance

Author: joetannenbaum

php-templates/inertia.php

@@ -1,11 +1,6 @@
 <?php
 
-$config = config('inertia.testing', []);
-
-$pagePaths = collect($config['page_paths'] ?? [])->map(function($path) {
-    return LaravelVsCode::relativePath($path);
-});
-
-$config['page_paths'] = $pagePaths->toArray();
-
-echo json_encode($config);
+echo json_encode([
+    ...config('inertia.testing', []),
+    'page_paths' => collect(config('inertia.testing.page_paths', []))->map(fn($path) => LaravelVsCode::relativePath($path))->toArray(),
+]);

php-templates/routes.php

@@ -93,5 +93,4 @@ protected function getRouteReflection(\Illuminate\Routing\Route $route)
     }
 };
 
-
 echo $routes->all()->toJson();

php-templates/translations.php

@@ -12,6 +12,8 @@
 
     public $emptyParams = [];
 
+    public $directoriesToWatch = [];
+
     public function all()
     {
         $final = [];
@@ -82,6 +84,10 @@ public function collectFromPath(string $path, ?string $namespace = null)
             return [];
         }
 
+        if (!LaravelVsCode::isVendor($realPath)) {
+            $this->directoriesToWatch[] = LaravelVsCode::relativePath($realPath);
+        }
+
         return array_map(
             fn($file) => $this->fromFile($file, $path, $namespace),
             \Illuminate\Support\Facades\File::allFiles($realPath),
@@ -342,4 +348,5 @@ protected function fromPhpFile($file, $path, $namespace)
     'paths' => array_keys($translator->paths),
     'values' => array_keys($translator->values),
     'params' => array_map(fn($p) => json_decode($p, true), array_keys($translator->paramResults)),
+    'to_watch' => $translator->directoriesToWatch,
 ]);

src/extension.ts

@@ -4,6 +4,7 @@ import * as vscode from "vscode";
 
 import os from "os";
 import { LanguageClient } from "vscode-languageclient/node";
+import { bladeSpacer } from "./blade/bladeSpacer";
 import { initClient } from "./blade/client";
 import { CodeActionProvider } from "./codeAction/codeActionProvider";
 import { openFileCommand } from "./commands";
@@ -19,13 +20,15 @@ import { hoverProviders } from "./hover/HoverProvider";
 import { linkProviders } from "./link/LinkProvider";
 import { configAffected } from "./support/config";
 import { collectDebugInfo } from "./support/debug";
-import { disposeWatchers } from "./support/fileWatcher";
+import {
+    disposeWatchers,
+    watchForComposerChanges,
+} from "./support/fileWatcher";
 import { info } from "./support/logger";
 import { setParserBinaryPath } from "./support/parser";
 import { clearDefaultPhpCommand, initVendorWatchers } from "./support/php";
 import { hasWorkspace, projectPathExists } from "./support/project";
 import { cleanUpTemp } from "./support/util";
-import { bladeSpacer } from "./blade/bladeSpacer";
 
 let client: LanguageClient;
 
@@ -65,6 +68,7 @@ export function activate(context: vscode.ExtensionContext) {
     const LANGUAGES = [{ scheme: "file", language: "php" }, ...BLADE_LANGUAGES];
 
     initVendorWatchers();
+    watchForComposerChanges();
     setParserBinaryPath(context);
 
     const TRIGGER_CHARACTERS = ["'", '"'];

src/repositories/appBinding.ts

@@ -9,10 +9,10 @@ type AppBindingItem = {
     };
 };
 
-export const getAppBindings = repository<AppBindingItem>(
-    () => {
+export const getAppBindings = repository<AppBindingItem>({
+    load: () => {
         return runInLaravel<AppBindingItem>(template("app"), "App Bindings");
     },
-    "app/Providers/{,*,**/*}.php",
-    {},
-);
+    pattern: "app/Providers/{,*,**/*}.php",
+    itemsDefault: {},
+});

src/repositories/asset.ts

@@ -53,15 +53,16 @@ const getFilesInDirectory = (dir: string, depth: number = 0): Item[] => {
         .flat();
 };
 
-export const getAssets = repository<Item[]>(
-    () =>
+export const getAssets = repository<Item[]>({
+    load: () =>
         new Promise((resolve, reject) => {
             try {
                 resolve(getFilesInDirectory("public"));
             } catch (exception) {
                 reject(exception);
             }
         }),
-    "public/**/*",
-    [],
-);
+    pattern: "public/**/*",
+    itemsDefault: [],
+    reloadOnComposerChanges: false,
+});

src/repositories/auth.ts

@@ -16,8 +16,8 @@ const load = () => {
     return runInLaravel<AuthItems>(template("auth"), "Auth Data");
 };
 
-export const getPolicies = repository<AuthItems>(
+export const getPolicies = repository<AuthItems>({
     load,
-    "app/Providers/{,*,**/*}.php",
-    {},
-);
+    pattern: "app/Providers/{,*,**/*}.php",
+    itemsDefault: {},
+});

src/repositories/bladeComponents.ts

@@ -1,3 +1,4 @@
+import { inAppDirs } from "@src/support/fileWatcher";
 import { runInLaravel, template } from "@src/support/php";
 import { repository } from ".";
 
@@ -20,12 +21,15 @@ const load = () => {
     return runInLaravel<BladeComponents>(template("bladeComponents"));
 };
 
-export const getBladeComponents = repository<BladeComponents>(
+export const getBladeComponents = repository<BladeComponents>({
     load,
-    ["{,**/}{view,views}/{*,**/*}", "app/View/Components/{,*,**/*}.php"],
-    {
+    pattern: [
+        inAppDirs("{,**/}{view,views}/{*,**/*}"),
+        "app/View/Components/{,*,**/*}.php",
+    ],
+    itemsDefault: {
         components: {},
         prefixes: [],
     },
-    ["create", "delete"],
-);
+    fileWatcherEvents: ["create", "delete"],
+});

src/repositories/configs.ts

@@ -2,8 +2,8 @@ import { repository } from ".";
 import { Config } from "..";
 import { runInLaravel, template } from "../support/php";
 
-export const getConfigs = repository<Config[]>(
-    () => {
+export const getConfigs = repository<Config[]>({
+    load: () => {
         return runInLaravel<Config[]>(template("configs"), "Configs").then(
             (result) =>
                 result.map((item) => {
@@ -16,6 +16,6 @@ export const getConfigs = repository<Config[]>(
                 }),
         );
     },
-    ["config/{,*,**/*}.php", ".env"],
-    [],
-);
+    pattern: ["config/{,*,**/*}.php", ".env"],
+    itemsDefault: [],
+});

src/repositories/controllers.ts

@@ -1,3 +1,4 @@
+import { inAppDirs } from "@src/support/fileWatcher";
 import * as fs from "fs";
 import { repository } from ".";
 import { projectPath } from "../support/project";
@@ -74,12 +75,12 @@ const collectControllers = (path: string): string[] => {
     return [...controllers];
 };
 
-export const getControllers = repository<string[]>(
-    () => {
+export const getControllers = repository<string[]>({
+    load: () => {
         return new Promise((resolve) => {
             resolve(load());
         });
     },
-    "{,**/}{Controllers}{.php,/*.php,/**/*.php}",
-    [],
-);
+    pattern: inAppDirs("{,**/}{Controllers}{.php,/*.php,/**/*.php}"),
+    itemsDefault: [],
+});