refactor(cli): remove usage of @ionic/utils-fs (#7762)

jcesarmobile · web-flow · commit 0a0dd1abf2d0 · 2024-11-20T10:52:33.000+01:00
diff --git a/cli/package.json b/cli/package.json
@@ -45,12 +45,12 @@
   },
   "dependencies": {
     "@ionic/cli-framework-output": "^2.2.5",
-    "@ionic/utils-fs": "^3.1.6",
     "@ionic/utils-subprocess": "2.1.11",
     "@ionic/utils-terminal": "^2.3.3",
     "commander": "^9.3.0",
     "debug": "^4.3.4",
     "env-paths": "^2.2.0",
+    "fs-extra": "^11.2.0",
     "kleur": "^4.1.4",
     "native-run": "^2.0.0",
     "open": "^8.4.0",
@@ -64,6 +64,7 @@
   },
   "devDependencies": {
     "@types/debug": "^4.1.7",
+    "@types/fs-extra": "^11.0.4",
     "@types/jest": "^29.5.0",
     "@types/plist": "^3.0.2",
     "@types/prompts": "^2.0.14",
diff --git a/cli/src/android/add.ts b/cli/src/android/add.ts
@@ -1,4 +1,4 @@
-import { pathExists, writeFile } from '@ionic/utils-fs';
+import { pathExists, writeFile } from 'fs-extra';
 import { homedir } from 'os';
 import { join } from 'path';
 
diff --git a/cli/src/android/common.ts b/cli/src/android/common.ts
@@ -1,4 +1,4 @@
-import { copy, remove, mkdirp, readFile, pathExists, writeFile } from '@ionic/utils-fs';
+import { copy, remove, mkdirp, readFile, pathExists, writeFile } from 'fs-extra';
 import { join, resolve } from 'path';
 
 import { checkCapacitorPlatform } from '../common';
diff --git a/cli/src/android/doctor.ts b/cli/src/android/doctor.ts
@@ -1,11 +1,12 @@
-import { pathExists, readdirp, readFile } from '@ionic/utils-fs';
+import { pathExists, readFile } from 'fs-extra';
 import { join, extname, parse } from 'path';
 
 import c from '../colors';
 import { check } from '../common';
 import type { Config } from '../definitions';
 import { fatal, isFatal } from '../errors';
 import { logSuccess } from '../log';
+import { readdirp } from '../util/fs';
 import { readXML } from '../util/xml';
 
 export async function doctorAndroid(config: Config): Promise<void> {
diff --git a/cli/src/android/open.ts b/cli/src/android/open.ts
@@ -1,5 +1,5 @@
-import { pathExists } from '@ionic/utils-fs';
 import Debug from 'debug';
+import { pathExists } from 'fs-extra';
 import open from 'open';
 
 import c from '../colors';
diff --git a/cli/src/android/update.ts b/cli/src/android/update.ts
@@ -1,5 +1,5 @@
-import { copy, remove, pathExists, readdirp, readFile, writeFile, writeJSON } from '@ionic/utils-fs';
 import Debug from 'debug';
+import { copy, remove, pathExists, readFile, writeFile, writeJSON } from 'fs-extra';
 import { dirname, extname, join, relative, resolve } from 'path';
 
 import c from '../colors';
@@ -20,7 +20,7 @@ import {
 import type { Plugin } from '../plugin';
 import { copy as copyTask } from '../tasks/copy';
 import { patchOldCapacitorPlugins } from '../tasks/migrate';
-import { convertToUnixPath } from '../util/fs';
+import { readdirp, convertToUnixPath } from '../util/fs';
 import { resolveNode } from '../util/node';
 import { extractTemplate } from '../util/template';
 
diff --git a/cli/src/common.ts b/cli/src/common.ts
@@ -1,5 +1,5 @@
-import { readJSON, pathExists } from '@ionic/utils-fs';
 import { prettyPath } from '@ionic/utils-terminal';
+import { readJSON, pathExists } from 'fs-extra';
 import { dirname, join } from 'path';
 
 import c from './colors';
diff --git a/cli/src/config.ts b/cli/src/config.ts
@@ -1,5 +1,5 @@
-import { pathExists, readFile, readJSON, writeFile, writeJSON } from '@ionic/utils-fs';
 import Debug from 'debug';
+import { pathExists, readFile, readJSON, writeFile, writeJSON } from 'fs-extra';
 import { dirname, extname, join, relative, resolve } from 'path';
 
 import c from './colors';
diff --git a/cli/src/cordova.ts b/cli/src/cordova.ts
@@ -1,4 +1,4 @@
-import { copy, ensureDir, mkdirp, pathExists, readFile, remove, writeFile } from '@ionic/utils-fs';
+import { copy, ensureDir, mkdirp, pathExists, readFile, remove, writeFile } from 'fs-extra';
 import { basename, extname, join, resolve } from 'path';
 import plist from 'plist';
 import type { PlistObject } from 'plist';
diff --git a/cli/src/ios/build.ts b/cli/src/ios/build.ts
@@ -1,4 +1,4 @@
-import { writeFileSync, unlinkSync } from '@ionic/utils-fs';
+import { writeFileSync, unlinkSync } from 'fs-extra';
 import { basename, join } from 'path';
 import rimraf from 'rimraf';
 
diff --git a/cli/src/ios/common.ts b/cli/src/ios/common.ts
@@ -1,5 +1,5 @@
-import { readFile, writeFile } from '@ionic/utils-fs';
 import { execSync } from 'child_process';
+import { readFile, writeFile } from 'fs-extra';
 import { resolve } from 'path';
 
 import c from '../colors';
diff --git a/cli/src/ios/update.ts b/cli/src/ios/update.ts
@@ -1,4 +1,4 @@
-import { copy, remove, pathExists, readFile, realpath, writeFile } from '@ionic/utils-fs';
+import { copy, remove, pathExists, readFile, realpath, writeFile } from 'fs-extra';
 import { basename, dirname, join, relative } from 'path';
 
 import c from '../colors';
diff --git a/cli/src/ipc.ts b/cli/src/ipc.ts
@@ -1,6 +1,6 @@
-import { open, mkdirp } from '@ionic/utils-fs';
 import { fork } from '@ionic/utils-subprocess';
 import Debug from 'debug';
+import { open, mkdirp } from 'fs-extra';
 import { request } from 'https';
 import { resolve } from 'path';
 
diff --git a/cli/src/plugin.ts b/cli/src/plugin.ts
@@ -1,4 +1,4 @@
-import { readJSON } from '@ionic/utils-fs';
+import { readJSON } from 'fs-extra';
 import { dirname, join } from 'path';
 
 import c from './colors';
diff --git a/cli/src/sysconfig.ts b/cli/src/sysconfig.ts
@@ -1,5 +1,5 @@
-import { readJSON, writeJSON, mkdirp } from '@ionic/utils-fs';
 import Debug from 'debug';
+import { readJSON, writeJSON, mkdirp } from 'fs-extra';
 import { dirname, resolve } from 'path';
 
 import { ENV_PATHS } from './util/cli';
diff --git a/cli/src/tasks/add.ts b/cli/src/tasks/add.ts
@@ -1,5 +1,5 @@
-import { pathExists } from '@ionic/utils-fs';
 import { prettyPath } from '@ionic/utils-terminal';
+import { pathExists } from 'fs-extra';
 
 import { addAndroid, createLocalProperties } from '../android/add';
 import { editProjectSettingsAndroid, checkAndroidPackage } from '../android/common';
diff --git a/cli/src/tasks/copy.ts b/cli/src/tasks/copy.ts
@@ -1,4 +1,4 @@
-import { copy as fsCopy, pathExists, remove, writeJSON } from '@ionic/utils-fs';
+import { copy as fsCopy, pathExists, remove, writeJSON } from 'fs-extra';
 import { basename, join, relative, resolve } from 'path';
 
 import c from '../colors';
diff --git a/cli/src/tasks/doctor.ts b/cli/src/tasks/doctor.ts
@@ -1,4 +1,4 @@
-import { readJSON } from '@ionic/utils-fs';
+import { readJSON } from 'fs-extra';
 
 import { doctorAndroid } from '../android/doctor';
 import c from '../colors';
diff --git a/cli/src/tasks/migrate.ts b/cli/src/tasks/migrate.ts
@@ -1,4 +1,4 @@
-import { writeFileSync, readFileSync, existsSync } from '@ionic/utils-fs';
+import { writeFileSync, readFileSync, existsSync } from 'fs-extra';
 import { join } from 'path';
 import rimraf from 'rimraf';
 import { coerce, gt, gte, lt } from 'semver';
diff --git a/cli/src/tasks/sourcemaps.ts b/cli/src/tasks/sourcemaps.ts
@@ -1,4 +1,4 @@
-import { readdirSync, existsSync, readFileSync, writeFileSync, unlinkSync, lstatSync } from '@ionic/utils-fs';
+import { readdirSync, existsSync, readFileSync, writeFileSync, unlinkSync, lstatSync } from 'fs-extra';
 import { join, extname } from 'path';
 
 import type { Config } from '../definitions';
diff --git a/cli/src/util/fs.ts b/cli/src/util/fs.ts
@@ -1,4 +1,6 @@
-import { existsSync, lstatSync, readdirSync, rmdirSync, unlinkSync } from '@ionic/utils-fs';
+import { statSync, type Stats } from 'fs';
+import { readdir } from 'fs/promises';
+import { existsSync, lstatSync, readdirSync, rmdirSync, unlinkSync } from 'fs-extra';
 import { join } from 'path';
 
 export const convertToUnixPath = (path: string): string => {
@@ -18,3 +20,34 @@ export const deleteFolderRecursive = (directoryPath: any): void => {
     rmdirSync(directoryPath);
   }
 };
+
+export interface ReaddirPOptions {
+  /**
+   * Filter out items from the walk process from the final result.
+   *
+   * @return `true` to keep, otherwise the item is filtered out
+   */
+  readonly filter: (item: WalkerItem) => boolean;
+}
+
+export interface WalkerItem {
+  path: string;
+  stats: Stats;
+}
+
+export async function readdirp(dir: string, { filter }: ReaddirPOptions): Promise<string[]> {
+  const dirContent = await readdir(dir, { recursive: true });
+  const dirContentWalker: WalkerItem[] = [];
+  const filteredContent: string[] = [];
+  dirContent.forEach((element) => {
+    const path = join(dir, element);
+    const stats = statSync(path);
+    dirContentWalker.push({ path, stats });
+  });
+  dirContentWalker.forEach((element) => {
+    if (filter(element)) {
+      filteredContent.push(element.path);
+    }
+  });
+  return filteredContent;
+}
diff --git a/cli/src/util/iosplugin.ts b/cli/src/util/iosplugin.ts
@@ -1,12 +1,14 @@
-import type { ReaddirPOptions } from '@ionic/utils-fs';
-import { readFileSync, readdirp, readJSONSync, writeJSONSync } from '@ionic/utils-fs';
+import { readFileSync, readJSONSync, writeJSONSync } from 'fs-extra';
 import { resolve } from 'path';
 
 import { getCordovaPlugins } from '../cordova';
 import type { Config } from '../definitions';
 import type { Plugin } from '../plugin';
 import { getPluginType, PluginType } from '../plugin';
 
+import type { ReaddirPOptions } from './fs';
+import { readdirp } from './fs';
+
 export async function getPluginFiles(plugins: Plugin[]): Promise<string[]> {
   let filenameList: string[] = [];
 
diff --git a/cli/src/util/livereload.ts b/cli/src/util/livereload.ts
@@ -1,4 +1,4 @@
-import { readJSONSync, writeJSONSync } from '@ionic/utils-fs';
+import { readJSONSync, writeJSONSync } from 'fs-extra';
 import { networkInterfaces } from 'os';
 import { join } from 'path';
 
diff --git a/cli/src/util/node.ts b/cli/src/util/node.ts
@@ -1,5 +1,5 @@
-import { readFileSync } from '@ionic/utils-fs';
 import { existsSync } from 'fs';
+import { readFileSync } from 'fs-extra';
 import { resolve } from 'path';
 import type typescript from 'typescript';
 
diff --git a/cli/src/util/spm.ts b/cli/src/util/spm.ts
@@ -1,4 +1,4 @@
-import { existsSync, readFileSync, writeFileSync } from '@ionic/utils-fs';
+import { existsSync, readFileSync, writeFileSync } from 'fs-extra';
 import { join, relative, resolve } from 'path';
 
 import type { Config } from '../definitions';
diff --git a/cli/src/util/template.ts b/cli/src/util/template.ts
@@ -1,4 +1,4 @@
-import { mkdirp } from '@ionic/utils-fs';
+import { mkdirp } from 'fs-extra';
 import tar from 'tar';
 
 export async function extractTemplate(src: string, dir: string): Promise<void> {
diff --git a/cli/src/util/xml.ts b/cli/src/util/xml.ts
@@ -1,4 +1,4 @@
-import { readFile } from '@ionic/utils-fs';
+import { readFile } from 'fs-extra';
 import xml2js from 'xml2js';
 
 export async function readXML(path: string): Promise<any> {
diff --git a/cli/test/init.spec.ts b/cli/test/init.spec.ts
@@ -1,4 +1,4 @@
-import { mkdir } from '@ionic/utils-fs';
+import { mkdir } from 'fs-extra';
 import { join } from 'path';
 
 import { APP_ID, APP_NAME, run, mktmp, MappedFS } from './util';
diff --git a/cli/test/util.ts b/cli/test/util.ts
@@ -1,5 +1,5 @@
-import { mkdir, mkdirp, readFile, pathExists, writeFile } from '@ionic/utils-fs';
 import { exec } from 'child_process';
+import { mkdir, mkdirp, readFile, pathExists, writeFile } from 'fs-extra';
 import { join, resolve } from 'path';
 import tmp from 'tmp';
 import type { DirCallback } from 'tmp';

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { pathExists, writeFile } from '@ionic/utils-fs';`
	`1`	`+import { pathExists, writeFile } from 'fs-extra';`
`2`	`2`	`import { homedir } from 'os';`
`3`	`3`	`import { join } from 'path';`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { copy, remove, mkdirp, readFile, pathExists, writeFile } from '@ionic/utils-fs';`
	`1`	`+import { copy, remove, mkdirp, readFile, pathExists, writeFile } from 'fs-extra';`
`2`	`2`	`import { join, resolve } from 'path';`
`3`	`3`
`4`	`4`	`import { checkCapacitorPlatform } from '../common';`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { copy, ensureDir, mkdirp, pathExists, readFile, remove, writeFile } from '@ionic/utils-fs';`
	`1`	`+import { copy, ensureDir, mkdirp, pathExists, readFile, remove, writeFile } from 'fs-extra';`
`2`	`2`	`import { basename, extname, join, resolve } from 'path';`
`3`	`3`	`import plist from 'plist';`
`4`	`4`	`import type { PlistObject } from 'plist';`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { writeFileSync, unlinkSync } from '@ionic/utils-fs';`
	`1`	`+import { writeFileSync, unlinkSync } from 'fs-extra';`
`2`	`2`	`import { basename, join } from 'path';`
`3`	`3`	`import rimraf from 'rimraf';`
`4`	`4`