refactor: replace yaml package for reducing the extension size

Author: juanrgm

package.json

@@ -143,12 +143,13 @@
     "workspaceContains:**/phpstan.neon.dist"
   ],
   "dependencies": {
-    "yaml": "^2.1.1"
+    "js-yaml": "^4.1.0"
   },
   "devDependencies": {
     "@changesets/changelog-github": "^0.4.6",
     "@changesets/cli": "^2.24.4",
     "@trivago/prettier-plugin-sort-imports": "^3.3.0",
+    "@types/js-yaml": "^4.0.5",
     "@types/node": "^18.7.18",
     "@types/vscode": "^1.50.0",
     "@typescript-eslint/eslint-plugin": "^5.37.0",
@@ -167,4 +168,4 @@
     "vscode": "^1.50.0"
   },
   "icon": "assets/logo.png"
-}
+}

pnpm-lock.yaml

@@ -8,10 +8,7 @@ export default async function findPHPStanConfigPath(ext: Ext) {
     ? isAbsolute(settings.configPath)
       ? settings.configPath
       : join(rootPath, settings.configPath)
-    : await find({
-        cwd: ext.cwd,
-        binPath: ext.settings.path,
-      });
+    : await find(ext.cwd);
 
   if (!configPath) throw new Error(`Config path not found.`);
   outputChannel.appendLine(`# Config path: ${configPath}`);

src/commands/findPHPStanConfigPath.ts

@@ -1,11 +1,12 @@
 import { Ext } from "../extension";
-import { parsePHPStanConfig } from "../utils/phpstan";
+import { parsePHPStanConfigFile } from "../utils/phpstan";
+import { dirname, join, normalize } from "path";
 
 export default async function loadPHPStanConfig(ext: Ext) {
   if (!ext.store.phpstan.configPath) throw new Error("Config path is required");
-  const config = await parsePHPStanConfig(ext.store.phpstan.configPath, {
-    cwd: ext.cwd,
-    binPath: ext.settings.path,
+  const config = await parsePHPStanConfigFile(ext.store.phpstan.configPath, {
+    currentWorkingDirectory: ext.cwd,
+    rootDir: normalize(dirname(join(ext.cwd, ext.settings.path))),
   });
   ext.outputChannel.appendLine(`# Config:\n${JSON.stringify(config, null, 2)}`);
   return config;

src/commands/loadPHPStanConfig.ts

@@ -0,0 +1,15 @@
+import { readFile } from "fs/promises";
+import { load } from "js-yaml";
+
+export function resolveNeon(contents: string, env: Record<string, string>) {
+  return contents.replace(/(?:%(\w+)%)/g, (_, name) => env[name] ?? "");
+}
+
+export async function parseNeonFile<T = unknown>(
+  path: string,
+  env: Record<string, string> = {}
+): Promise<T> {
+  const contents = (await readFile(path)).toString();
+  const yaml = resolveNeon(contents.replace(/\t/g, "  "), env);
+  return load(yaml) as Promise<T>;
+}

src/utils/neon.ts

@@ -1,3 +1,5 @@
+import { isAbsolute, join, normalize } from "path";
+
 /**
  * @link https://github.com/microsoft/vscode/blob/84a3473d/src/vs/workbench/contrib/terminal/common/terminalEnvironment.ts#L227
  */
@@ -8,3 +10,8 @@ export function sanitizeFsPath(path: string) {
     return path;
   }
 }
+
+export function resolvePath(path: string, cwd: string): string {
+  if (!isAbsolute(path)) path = join(cwd, path);
+  return normalize(path);
+}

src/utils/path.ts

@@ -1,6 +1,7 @@
 import { checkFile } from "./fs";
-import { parseYamlFile } from "./yaml";
-import { isAbsolute, join, normalize } from "path";
+import { parseNeonFile } from "./neon";
+import { resolvePath } from "./path";
+import { join } from "path";
 
 export type PHPStanAnalyseResult = {
   totals: {
@@ -25,74 +26,53 @@ export type PHPStanConfig = {
     paths?: string[];
     excludes_analyse?: string[];
     fileExtensions?: string[];
+    bootstrapFiles?: string[];
   };
 };
 
-export type PHPStanSettings = {
-  binPath: string;
-  cwd: string;
+export type PHPStanConfigEnv = {
+  rootDir: string;
+  currentWorkingDirectory: string;
 };
 
-function resolveConfigItemValue(
-  value: string,
-  settings: PHPStanSettings
-): string {
-  const rootDir = join(settings.cwd, settings.binPath);
-  return value
-    .replace(/%currentWorkingDirectory%/g, settings.cwd)
-    .replace(/%rootDir%/g, rootDir);
-}
-
-function resolveConfigItemPath(
-  value: string,
-  settings: PHPStanSettings
-): string {
-  value = resolveConfigItemValue(value, settings);
-  if (!isAbsolute(value)) value = join(settings.cwd, value);
-  return normalize(value);
-}
-
 export function parsePHPStanAnalyseResult(
   stdout: string
 ): PHPStanAnalyseResult {
   return JSON.parse(stdout);
 }
 
-export async function parsePHPStanConfig(
+export async function parsePHPStanConfigFile(
   path: string,
-  settings: PHPStanSettings,
-  resolve = true
+  env: PHPStanConfigEnv
 ): Promise<PHPStanConfig> {
-  const config = await parseYamlFile<PHPStanConfig>(path);
-  return resolve ? resolvePHPStanConfig(config, settings) : config;
+  const config = await parseNeonFile<PHPStanConfig>(path, env);
+  return normalizePHPStanConfig(config, env.currentWorkingDirectory);
 }
 
 export async function findPHPStanConfigPath(
-  settings: PHPStanSettings
+  cwd: string
 ): Promise<string | undefined> {
-  const dir = settings.cwd;
   const baseNames = ["phpstan.neon", "phpstan.neon.dist"];
   for (const basename of baseNames) {
-    const path = join(dir, basename);
+    const path = join(cwd, basename);
     if (await checkFile(path)) {
       return path;
     }
   }
 }
 
-export function resolvePHPStanConfig(
+export function normalizePHPStanConfig(
   config: PHPStanConfig,
-  settings: PHPStanSettings
+  cwd: string
 ): PHPStanConfig {
   config = Object.assign({}, config);
   config.parameters = Object.assign({}, config.parameters);
   const params = config.parameters;
-  if (Array.isArray(params.paths))
-    params.paths = params.paths.map((v) => resolveConfigItemPath(v, settings));
-  if (Array.isArray(params.excludes_analyse))
-    params.excludes_analyse = params.excludes_analyse.map((v) =>
-      resolveConfigItemPath(v, settings)
-    );
+  const resolve = (v: string) => resolvePath(v, cwd);
+
+  params.paths = params.paths?.map(resolve);
+  params.excludes_analyse = params.excludes_analyse?.map(resolve);
+  params.bootstrapFiles = params.bootstrapFiles?.map(resolve);
 
   return config;
 }

src/utils/phpstan.ts

@@ -25,7 +25,7 @@ export default defineConfig({
       ],
       output: {
         manualChunks: {
-          vendor: ["yaml"],
+          vendor: ["js-yaml"],
         },
       },
     },