@reliverse/pathkit 1.2.8 → 1.3.0

package/bin/mod.d.ts

@@ -96,13 +96,14 @@ declare function convertStringAliasRelative({ importPath, importerFile, pathPatt
     targetDir: string;
 }): Promise<string>;
 /**
- * main function to convert import paths from aliases to relative paths
+ * main function to convert import/export paths from aliases to relative paths
  */
-declare function convertImportsAliasToRelative({ targetDir, aliasToReplace, pathExtFilter, displayLogsOnlyFor, }: {
+declare function convertImportsAliasToRelative({ targetDir, aliasToReplace, pathExtFilter, displayLogsOnlyFor, displayLogs, }: {
     targetDir: string;
     aliasToReplace: string;
     pathExtFilter: PathExtFilter;
     displayLogsOnlyFor?: string[];
+    displayLogs?: boolean;
 }): Promise<{
     file: string;
     changes: {
@@ -111,13 +112,14 @@ declare function convertImportsAliasToRelative({ targetDir, aliasToReplace, path
     }[];
 }[]>;
 /**
- * converts extensions in import paths from one format to another
+ * converts extensions in import/export paths from one format to another
  */
-declare function convertImportsExt({ targetDir, extFrom, extTo, alias, }: {
+declare function convertImportsExt({ targetDir, extFrom, extTo, alias, displayLogs, }: {
     targetDir: string;
     extFrom: ImportExtType;
     extTo: ImportExtType;
     alias?: string;
+    displayLogs?: boolean;
 }): Promise<{
     file: string;
     changes: {
@@ -141,11 +143,12 @@ declare function stripPathSegments(path: string, count?: number, alias?: string)
  * @param extensionsToProcess - Array of file extensions to process (default: EXTENSIONS)
  * @returns Array of processed files and their changes
  */
-declare function stripPathSegmentsInDirectory({ targetDir, segmentsToStrip, alias, extensionsToProcess, }: {
+declare function stripPathSegmentsInDirectory({ targetDir, segmentsToStrip, alias, extensionsToProcess, displayLogs, }: {
     targetDir: string;
     segmentsToStrip: number;
     alias?: string;
     extensionsToProcess?: string[];
+    displayLogs?: boolean;
 }): Promise<{
     file: string;
     changes: {
@@ -168,18 +171,19 @@ declare function attachPathSegments(path: string, segments: string | string[], o
     preserveAlias?: string;
 }): string;
 /**
- * recursively processes files in a directory to attach path segments to import statements
+ * recursively processes files in a directory to attach path segments to import/export statements
  * @param targetDir - The directory to process
  * @param segments - The segments to attach
  * @param options - Configuration options for path segment attachment
  * @param extensionsToProcess - Array of file extensions to process (default: EXTENSIONS)
  * @returns Array of processed files and their changes
  */
-declare function attachPathSegmentsInDirectory({ targetDir, segments, options, extensionsToProcess, }: {
+declare function attachPathSegmentsInDirectory({ targetDir, segments, options, extensionsToProcess, displayLogs, }: {
     targetDir: string;
     segments: string | string[];
     options?: Parameters<typeof attachPathSegments>[2];
     extensionsToProcess?: string[];
+    displayLogs?: boolean;
 }): Promise<{
     file: string;
     changes: {
@@ -202,26 +206,12 @@ declare const _pathBase: {
     relative: (from: string, to: string) => string;
     filename: typeof filename;
 };
-declare const path: PlatformPath & {
-    sep: string;
-    normalize: (path: string) => string;
-    join: (...segments: string[]) => string;
-    resolve: (...args: string[]) => string;
-    isAbsolute: (p: string) => boolean;
-    dirname: (p: string) => string;
-    basename: (p: string, ext?: string) => string;
-    extname: (p: string) => string;
-    format: (p: FormatInputPathObject) => string;
-    parse: (p: string) => ParsedPath;
-    toNamespacedPath: (p: string) => string;
-    relative: (from: string, to: string) => string;
-    filename: typeof filename;
-} & {
+declare const path: PlatformPath & typeof _pathBase & {
     posix: PlatformPath;
     win32: PlatformPath;
 };
 declare const win32: PlatformPath;
-declare const delimiter: string;
+declare const delimiter: ";" | ":";
 export type { PlatformPath, PathExtFilter, ImportExtType, ImportExportInfo, ImportExportSpecifier, GetFileImportsExportsOptions, };
 export { _pathBase as posix, win32, basename, delimiter, dirname, extname, filename, format, isAbsolute, join, normalize, parse, relative, resolve, sep, toNamespacedPath, normalizeAliases, resolveAlias, reverseResolveAlias, normalizeWindowsPath, convertStringAliasRelative, convertImportsAliasToRelative, convertImportsExt, stripPathSegments, stripPathSegmentsInDirectory, attachPathSegments, attachPathSegmentsInDirectory, getFileImportsExports, };
 export default path;

package/bin/mod.js

@@ -10,8 +10,8 @@ const filteredLogger = (msg) => {
   const message = typeof msg === "function" ? msg() : msg;
   console.log(`\x1B[36;2m${message}\x1B[0m`);
 };
+const DEBUG_MODE = false;
 const logInternal = (msg) => {
-  const DEBUG_MODE = true;
   if (DEBUG_MODE) {
     const message = typeof msg === "function" ? msg() : msg;
     console.log(`\x1B[36;2m${message}\x1B[0m`);
@@ -464,8 +464,8 @@ function replaceAllInString(original, searchValue, replaceValue) {
   }
   return result;
 }
-async function processFile(filePath, aliasToReplace, targetDir, pathExtFilter, displayLogsOnlyFor) {
-  const shouldLog = !displayLogsOnlyFor || displayLogsOnlyFor.includes(filePath);
+async function processFile(filePath, aliasToReplace, targetDir, pathExtFilter, displayLogsOnlyFor, displayLogs = false) {
+  const shouldLog = displayLogs && (!displayLogsOnlyFor || displayLogsOnlyFor.includes(filePath));
   const log = (msg) => shouldLog && filteredLogger(msg);
   const content = await fs.readFile(filePath, "utf-8");
   let updated = content;
@@ -483,7 +483,9 @@ async function processFile(filePath, aliasToReplace, targetDir, pathExtFilter, d
     if (!importPath) continue;
     log(`  Processing import: ${importPath}`);
     if (!importPath.startsWith(baseAlias)) {
-      log(`  - skipping: import doesn't start with ${baseAlias}`);
+      if (DEBUG_MODE) {
+        log(`  - skipping: import/export doesn't start with ${baseAlias}`);
+      }
       continue;
     }
     const importExt = extname(importPath);
@@ -519,7 +521,9 @@ async function processFile(filePath, aliasToReplace, targetDir, pathExtFilter, d
     await fs.writeFile(filePath, updated);
     log(`\u2713 processed: ${filePath}`);
   } else {
-    log(`  - no changes made to file`);
+    if (DEBUG_MODE) {
+      log(`  - no changes made to file: ${filePath}`);
+    }
   }
   return changes;
 }
@@ -575,7 +579,8 @@ async function convertImportsAliasToRelative({
   targetDir,
   aliasToReplace,
   pathExtFilter,
-  displayLogsOnlyFor
+  displayLogsOnlyFor,
+  displayLogs = false
 }) {
   const normalizedAlias = aliasToReplace.endsWith("/*") ? aliasToReplace : `${aliasToReplace}/*`;
   regularLogger(
@@ -592,7 +597,7 @@ async function convertImportsAliasToRelative({
     pathExtFilter,
     displayLogsOnlyFor
   });
-  if (results.length > 0) {
+  if (results.length > 0 && displayLogs) {
     regularLogger("\n[convertImportsAliasToRelative] Summary of changes:");
     for (const { file, changes } of results) {
       const displayPath = relative(targetDir, file) || basename(file);
@@ -602,14 +607,15 @@ async function convertImportsAliasToRelative({
       }
     }
   }
-  regularLogger("Import path conversion process complete.");
+  regularLogger("Import/export path conversion process complete.");
   return results;
 }
 async function convertImportsExt({
   targetDir,
   extFrom,
   extTo,
-  alias
+  alias,
+  displayLogs = false
 }) {
   const fromExtStr = extFrom === "none" ? "" : `.${extFrom}`;
   const toExtStr = extTo === "none" ? "" : `.${extTo}`;
@@ -691,7 +697,7 @@ async function convertImportsExt({
         }
       })
     );
-    if (results.length > 0) {
+    if (results.length > 0 && displayLogs) {
       regularLogger("\n[convertImportsExt] Summary of changes:");
       for (const { file, changes } of results) {
         const displayPath = relative(targetDir, file) || basename(file);
@@ -760,7 +766,8 @@ async function stripPathSegmentsInDirectory({
   targetDir,
   segmentsToStrip,
   alias = "",
-  extensionsToProcess = EXTENSIONS
+  extensionsToProcess = EXTENSIONS,
+  displayLogs = false
 }) {
   regularLogger(
     () => `[stripPathSegmentsInDirectory] Processing directory: ${targetDir}`
@@ -822,7 +829,7 @@ async function stripPathSegmentsInDirectory({
         }
       })
     );
-    if (results.length > 0) {
+    if (results.length > 0 && displayLogs) {
       regularLogger(() => "[stripPathSegmentsInDirectory] Summary of changes:");
       for (const { file, changes } of results) {
         const displayPath = relative(targetDir, file) || basename(file);
@@ -881,7 +888,8 @@ async function attachPathSegmentsInDirectory({
   targetDir,
   segments,
   options = {},
-  extensionsToProcess = EXTENSIONS
+  extensionsToProcess = EXTENSIONS,
+  displayLogs = false
 }) {
   try {
     const entries = await fs.readdir(targetDir, { withFileTypes: true });
@@ -929,7 +937,7 @@ async function attachPathSegmentsInDirectory({
         }
       })
     );
-    if (results.length > 0) {
+    if (results.length > 0 && displayLogs) {
       regularLogger(
         () => "\n[attachPathSegmentsInDirectory] Summary of changes:"
       );

package/package.json

@@ -5,7 +5,7 @@
   "license": "MIT",
   "name": "@reliverse/pathkit",
   "type": "module",
-  "version": "1.2.8",
+  "version": "1.3.0",
   "devDependencies": {},
   "exports": {
     ".": "./bin/mod.js"