Replace path with pathe (#2481)

AndreasArvidsson · web-flow · commit 57047bfccc8a · 2024-07-11T15:06:56.000Z
This is a simple way of getting rid of node path references in common and engine. I thought it best to also replace it in vscode so we don't have different implementations for path in the bundle. I guess for things like running tests and ours setup scrips then just using node path is probably fine? I could go either way. https://www.npmjs.com/package/pathe ## Checklist - [/] I have added [tests](https://www.cursorless.org/docs/contributing/test-case-recorder/) - [/] I have updated the [docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and [cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet) - [/] I have not broken the cheatsheet
diff --git a/packages/common/package.json b/packages/common/package.json
@@ -17,6 +17,7 @@
   "license": "MIT",
   "dependencies": {
     "lodash-es": "^4.17.21",
+    "pathe": "^1.1.2",
     "vscode-uri": "^3.0.8"
   },
   "devDependencies": {
diff --git a/packages/common/src/testUtil/getFixturePaths.ts b/packages/common/src/testUtil/getFixturePaths.ts
@@ -1,5 +1,5 @@
 import * as yaml from "js-yaml";
-import * as path from "path";
+import * as path from "pathe";
 import { walkFilesSync } from "../util/walkSync";
 import { getCursorlessRepoRoot } from "./getCursorlessRepoRoot";
 import { TestCaseFixtureLegacy } from "../types/TestCaseFixture";
diff --git a/packages/common/src/util/walkAsync.ts b/packages/common/src/util/walkAsync.ts
@@ -1,4 +1,4 @@
-import * as path from "path";
+import * as path from "pathe";
 import { readdir } from "fs/promises";
 import { flatten } from "lodash-es";
 
diff --git a/packages/common/src/util/walkSync.ts b/packages/common/src/util/walkSync.ts
@@ -1,4 +1,4 @@
-import * as path from "path";
+import * as path from "pathe";
 import { readdirSync } from "fs";
 
 /**
diff --git a/packages/cursorless-cheatsheet/package.json b/packages/cursorless-cheatsheet/package.json
@@ -27,7 +27,8 @@
     "@cursorless/common": "workspace:*",
     "immer": "^10.0.4",
     "lodash-es": "^4.17.21",
-    "node-html-parser": "^6.1.12"
+    "node-html-parser": "^6.1.12",
+    "pathe": "^1.1.2"
   },
   "devDependencies": {
     "@types/lodash-es": "4.17.0"
diff --git a/packages/cursorless-cheatsheet/src/Cheatsheet.ts b/packages/cursorless-cheatsheet/src/Cheatsheet.ts
@@ -1,9 +1,9 @@
 import { getCursorlessRepoRoot, type IDE } from "@cursorless/common";
-import { readFile, writeFile } from "fs/promises";
+import { readFile, writeFile } from "node:fs/promises";
 import { produce } from "immer";
 import { sortBy } from "lodash-es";
 import { parse } from "node-html-parser";
-import * as path from "path";
+import * as path from "pathe";
 
 /**
  * The argument expected by the cheatsheet command.
diff --git a/packages/cursorless-engine/package.json b/packages/cursorless-engine/package.json
@@ -29,6 +29,8 @@
     "lodash-es": "^4.17.21",
     "moo": "0.5.2",
     "nearley": "2.20.1",
+    "node-html-parser": "^6.1.12",
+    "pathe": "^1.1.2",
     "sbd": "^1.0.19",
     "uuid": "^9.0.1",
     "zod": "3.22.4"
diff --git a/packages/cursorless-engine/src/ScopeTestRecorder.ts b/packages/cursorless-engine/src/ScopeTestRecorder.ts
@@ -11,7 +11,7 @@ import {
 } from "@cursorless/common";
 import * as fs from "node:fs";
 import * as fsPromises from "node:fs/promises";
-import * as path from "node:path";
+import * as path from "pathe";
 
 export class ScopeTestRecorder {
   constructor(private ide: IDE) {
diff --git a/packages/cursorless-engine/src/actions/ShowParseTree.ts b/packages/cursorless-engine/src/actions/ShowParseTree.ts
@@ -1,5 +1,5 @@
 import { FlashStyle, Range, TextDocument } from "@cursorless/common";
-import * as path from "node:path";
+import * as path from "pathe";
 import type { Tree, TreeCursor } from "web-tree-sitter";
 import type { TreeSitter } from "../typings/TreeSitter";
 import { ide } from "../singletons/ide.singleton";
diff --git a/packages/cursorless-engine/src/languages/LanguageDefinition.ts b/packages/cursorless-engine/src/languages/LanguageDefinition.ts
@@ -4,7 +4,7 @@ import {
   SimpleScopeType,
   showError,
 } from "@cursorless/common";
-import { basename, dirname, join } from "path";
+import { basename, dirname, join } from "pathe";
 import { TreeSitterScopeHandler } from "../processTargets/modifiers/scopeHandlers";
 import { ide } from "../singletons/ide.singleton";
 import { TreeSitter } from "../typings/TreeSitter";
diff --git a/packages/cursorless-engine/src/languages/LanguageDefinitions.ts b/packages/cursorless-engine/src/languages/LanguageDefinitions.ts
@@ -8,7 +8,7 @@ import {
   isTesting,
   showError,
 } from "@cursorless/common";
-import { join } from "path";
+import { join } from "pathe";
 import { SyntaxNode } from "web-tree-sitter";
 import { TreeSitter } from "../typings/TreeSitter";
 import { ide } from "../singletons/ide.singleton";
diff --git a/packages/cursorless-engine/src/nodeCommon/TalonSpokenFormsJsonReader.ts b/packages/cursorless-engine/src/nodeCommon/TalonSpokenFormsJsonReader.ts
@@ -1,7 +1,7 @@
 import { Disposable, FileSystem, Notifier } from "@cursorless/common";
 import { readFile } from "fs/promises";
 
-import * as path from "path";
+import * as path from "pathe";
 import {
   NeedsInitialTalonUpdateError,
   SpokenFormEntry,
diff --git a/packages/cursorless-engine/src/scripts/transformRecordedTests/moveFile.ts b/packages/cursorless-engine/src/scripts/transformRecordedTests/moveFile.ts
@@ -1,5 +1,5 @@
 import { promises as fsp } from "fs";
-import * as path from "path";
+import * as path from "pathe";
 import * as yaml from "js-yaml";
 import { mkdir, rename } from "fs/promises";
 import { TestCaseFixture } from "@cursorless/common";
diff --git a/packages/cursorless-engine/src/testCaseRecorder/TestCaseRecorder.ts b/packages/cursorless-engine/src/testCaseRecorder/TestCaseRecorder.ts
@@ -27,7 +27,7 @@ import * as fs from "fs";
 import { access, readFile } from "fs/promises";
 import { invariant } from "immutability-helper";
 import { merge } from "lodash-es";
-import * as path from "path";
+import * as path from "pathe";
 import { CommandRunner } from "../CommandRunner";
 import { StoredTargetMap } from "../core/StoredTargets";
 import { SpokenFormGenerator } from "../generateSpokenForm";
diff --git a/packages/cursorless-vscode-e2e/package.json b/packages/cursorless-vscode-e2e/package.json
@@ -34,6 +34,7 @@
     "chai": "^5.1.0",
     "js-yaml": "^4.1.0",
     "mocha": "^10.3.0",
+    "pathe": "^1.1.2",
     "sinon": "^17.0.1"
   },
   "types": "./out/index.d.ts",
diff --git a/packages/cursorless-vscode-e2e/src/suite/commandHistory.vscode.test.ts b/packages/cursorless-vscode-e2e/src/suite/commandHistory.vscode.test.ts
@@ -12,7 +12,7 @@ import {
 import { assert } from "chai";
 import { existsSync } from "node:fs";
 import { readFile, readdir, rm } from "node:fs/promises";
-import path from "node:path";
+import * as path from "pathe";
 import * as vscode from "vscode";
 import { endToEndTestSetup } from "../endToEndTestSetup";
 import { produce } from "immer";
diff --git a/packages/cursorless-vscode-e2e/src/suite/keyboard/basic.vscode.test.ts b/packages/cursorless-vscode-e2e/src/suite/keyboard/basic.vscode.test.ts
@@ -3,7 +3,7 @@ import { assert } from "chai";
 import * as vscode from "vscode";
 import { endToEndTestSetup, sleepWithBackoff } from "../../endToEndTestSetup";
 import sinon from "sinon";
-import path from "path";
+import * as path from "pathe";
 import { getCursorlessRepoRoot } from "@cursorless/common";
 import { readFile } from "node:fs/promises";
 
diff --git a/packages/cursorless-vscode-e2e/src/suite/testCaseRecorder.vscode.test.ts b/packages/cursorless-vscode-e2e/src/suite/testCaseRecorder.vscode.test.ts
@@ -14,8 +14,7 @@ import { assert } from "chai";
 import * as crypto from "crypto";
 import { mkdir, readdir, readFile, rm } from "fs/promises";
 import * as os from "os";
-import * as path from "path";
-import { basename } from "path";
+import * as path from "pathe";
 import * as vscode from "vscode";
 import { endToEndTestSetup } from "../endToEndTestSetup";
 
@@ -158,7 +157,7 @@ async function checkRecordedTest(tmpdir: string) {
   assert.lengthOf(paths, 1);
 
   const actualRecordedTestPath = paths[0];
-  assert.equal(basename(actualRecordedTestPath), "takeHarp.yml");
+  assert.equal(path.basename(actualRecordedTestPath), "takeHarp.yml");
 
   const expected = (
     await readFile(
diff --git a/packages/cursorless-vscode/package.json b/packages/cursorless-vscode/package.json
@@ -1248,6 +1248,7 @@
     "itertools": "^2.2.5",
     "lodash-es": "^4.17.21",
     "nearley": "2.20.1",
+    "pathe": "^1.1.2",
     "semver": "^7.6.0",
     "tinycolor2": "1.6.0",
     "trie-search": "2.0.0",
diff --git a/packages/cursorless-vscode/src/VscodeSnippets.ts b/packages/cursorless-vscode/src/VscodeSnippets.ts
@@ -12,7 +12,7 @@ import {
 } from "@cursorless/cursorless-engine";
 import { readFile, stat, open } from "fs/promises";
 import { max } from "lodash-es";
-import { join } from "path";
+import { join } from "pathe";
 
 const CURSORLESS_SNIPPETS_SUFFIX = ".cursorless-snippets";
 const SNIPPET_DIR_REFRESH_INTERVAL_MS = 1000;
diff --git a/packages/cursorless-vscode/src/extension.ts b/packages/cursorless-vscode/src/extension.ts
@@ -27,7 +27,7 @@ import {
 } from "@cursorless/vscode-common";
 import * as crypto from "crypto";
 import * as os from "os";
-import * as path from "path";
+import * as path from "pathe";
 import * as vscode from "vscode";
 import { constructTestHelpers } from "./constructTestHelpers";
 import { FakeFontMeasurements } from "./ide/vscode/hats/FakeFontMeasurements";
diff --git a/packages/cursorless-vscode/src/ide/vscode/VscodeFileSystem.ts b/packages/cursorless-vscode/src/ide/vscode/VscodeFileSystem.ts
@@ -4,7 +4,7 @@ import {
   PathChangeListener,
   RunMode,
 } from "@cursorless/common";
-import { isAbsolute, join } from "path";
+import { isAbsolute, join } from "pathe";
 import * as vscode from "vscode";
 
 export class VscodeFileSystem implements FileSystem {
diff --git a/packages/cursorless-vscode/src/ide/vscode/hats/VscodeHatRenderer.ts b/packages/cursorless-vscode/src/ide/vscode/hats/VscodeHatRenderer.ts
@@ -8,7 +8,7 @@ import {
 import { VscodeApi } from "@cursorless/vscode-common";
 import { cloneDeep, isEqual } from "lodash-es";
 import * as fs from "fs/promises";
-import * as path from "node:path";
+import * as path from "pathe";
 import * as vscode from "vscode";
 import { vscodeGetConfigurationString } from "../VscodeConfiguration";
 import VscodeEnabledHatStyleManager, {
diff --git a/packages/cursorless-vscode/src/scripts/populateDist/populateDist.ts b/packages/cursorless-vscode/src/scripts/populateDist/populateDist.ts
@@ -1,7 +1,7 @@
 // Copies files into `dist` directory for packaging
 import { copy, exists } from "fs-extra";
 import { lstat, mkdir, readFile, rm, writeFile } from "fs/promises";
-import * as path from "path";
+import * as path from "pathe";
 import { assets } from "./assets";
 import { Context } from "./context";
 
diff --git a/packages/cursorless-vscode/src/scripts/preprocessSvgHats.ts b/packages/cursorless-vscode/src/scripts/preprocessSvgHats.ts
@@ -1,7 +1,7 @@
 import { getCursorlessRepoRoot } from "@cursorless/common";
 import * as parser from "fast-xml-parser";
 import { promises as fsp, readdirSync } from "fs";
-import * as path from "path";
+import * as path from "pathe";
 
 async function main() {
   const directory = path.join(getCursorlessRepoRoot(), "images/hats");
diff --git a/packages/file-system-common/package.json b/packages/file-system-common/package.json
@@ -25,7 +25,8 @@
   },
   "dependencies": {
     "@cursorless/common": "workspace:*",
-    "glob": "^10.3.10"
+    "glob": "^10.3.10",
+    "pathe": "^1.1.2"
   },
   "devDependencies": {
     "@types/glob": "^8.1.0"
diff --git a/packages/file-system-common/src/FileSystemCommandHistoryStorage.ts b/packages/file-system-common/src/FileSystemCommandHistoryStorage.ts
@@ -3,8 +3,8 @@ import type {
   CommandHistoryStorage,
 } from "@cursorless/common";
 import { glob } from "glob";
-import fs from "node:fs/promises";
-import path from "node:path";
+import * as fs from "node:fs/promises";
+import * as path from "pathe";
 
 export class FileSystemCommandHistoryStorage implements CommandHistoryStorage {
   constructor(private dir: string) {}
diff --git a/packages/meta-updater/src/toPosixPath.ts b/packages/meta-updater/src/toPosixPath.ts
@@ -1,4 +1,4 @@
-import path from "path";
+import * as path from "path";
 
 export function toPosixPath(p: string) {
   return p.split(path.sep).join(path.posix.sep);
diff --git a/packages/meta-updater/src/updateTSConfig.ts b/packages/meta-updater/src/updateTSConfig.ts
@@ -1,6 +1,6 @@
 import type { FormatPluginFnOptions } from "@pnpm/meta-updater";
 import normalizePath from "normalize-path";
-import path from "path";
+import * as path from "path";
 import { pathExists } from "path-exists";
 import { PackageJson, TsConfigJson } from "type-fest";
 import { toPosixPath } from "./toPosixPath";
diff --git a/packages/test-harness/package.json b/packages/test-harness/package.json
@@ -23,7 +23,8 @@
   "license": "MIT",
   "dependencies": {
     "@cursorless/common": "workspace:*",
-    "glob": "^10.3.10"
+    "glob": "^10.3.10",
+    "pathe": "^1.1.2"
   },
   "devDependencies": {
     "@types/glob": "^8.1.0",
diff --git a/packages/test-harness/src/launchVscodeAndRunTests.ts b/packages/test-harness/src/launchVscodeAndRunTests.ts
@@ -1,5 +1,5 @@
 import * as cp from "child_process";
-import * as path from "path";
+import * as path from "pathe";
 import * as os from "os";
 import {
   downloadAndUnzipVSCode,
diff --git a/packages/test-harness/src/runAllTests.ts b/packages/test-harness/src/runAllTests.ts
@@ -1,5 +1,5 @@
 import Mocha from "mocha";
-import * as path from "path";
+import * as path from "pathe";
 import { getCursorlessRepoRoot } from "@cursorless/common";
 import { runTestSubset, testSubsetGrepString } from "./testSubset";
 import { glob } from "glob";
diff --git a/packages/test-harness/src/scripts/runTestsCI.ts b/packages/test-harness/src/scripts/runTestsCI.ts
@@ -3,7 +3,7 @@
  */
 
 import { getCursorlessRepoRoot } from "@cursorless/common";
-import * as path from "path";
+import * as path from "pathe";
 import { launchVscodeAndRunTests } from "../launchVscodeAndRunTests";
 
 (async () => {
diff --git a/packages/test-harness/src/testSubset.ts b/packages/test-harness/src/testSubset.ts
@@ -1,5 +1,5 @@
 import * as fs from "fs";
-import * as path from "path";
+import * as path from "pathe";
 import { getCursorlessRepoRoot } from "@cursorless/common";
 
 /**
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import * as path from "path";`
	`1`	`+import * as path from "pathe";`
`2`	`2`	`import { readdir } from "fs/promises";`
`3`	`3`	`import { flatten } from "lodash-es";`
`4`	`4`