chore: cwd refactor

I do think it'd be good to audit usages of cwd at some point.
A few of these feel like they don't actually need the cwd.

This is good bandaid for now though.

Author: lishaduck

lib/anonymize.js

@@ -37,7 +37,7 @@ function pathsAndVersions(options, string) {
  */
 function anonymizePath(options, filePath) {
   if (options.forTests) {
-    return replaceVersion(path.relative(process.cwd(), filePath));
+    return replaceVersion(path.relative(options.cwd, filePath));
   }
 
   return filePath;

lib/build.js

@@ -366,7 +366,7 @@ function updateSourceDirectories(options, userSrc, elmJson) {
   if (options.localElmReviewSrc) {
     sourceDirectories = unique([
       ...sourceDirectories,
-      path.resolve(process.cwd(), options.localElmReviewSrc)
+      path.resolve(options.cwd, options.localElmReviewSrc)
     ]);
   }
 

lib/elm-files.js

@@ -244,7 +244,7 @@ function getSourceDirectories(options, elmJson) {
       isFromCliArguments: true,
       sourceDirectories: unique(
         options.directoriesToAnalyze.map((directory) =>
-          path.resolve(process.cwd(), directory)
+          path.resolve(options.cwd, directory)
         )
       )
     };

lib/main.js

@@ -63,7 +63,7 @@ function errorHandlerFactory(options) {
     try {
       userSrc = options.userSrc();
     } catch {
-      userSrc = process.cwd();
+      userSrc = options.cwd;
     }
 
     const reviewElmJsonPath = path.join(userSrc, 'elm.json');

lib/new-package.js

@@ -203,7 +203,7 @@ async function createProject(
   ruleType,
   license
 ) {
-  const dir = path.join(process.cwd(), packageName);
+  const dir = path.join(options.cwd, packageName);
   const ruleNameFolder = ruleName.split('.').slice(0, -1).join('/');
 
   try {
@@ -236,7 +236,7 @@ async function createProject(
   await writeFile(dir, 'README.md', readme(authorName, packageName, ruleName));
 
   Spinner.succeedAndNowDo('Adding preview folder', options.report);
-  const pathToPreview = path.join(process.cwd(), packageName, 'preview');
+  const pathToPreview = path.join(options.cwd, packageName, 'preview');
   await Init.create(options, pathToPreview, 'ReviewConfigForExample.elm');
 
   // Adding package to the example's elm.json
@@ -333,11 +333,11 @@ ElmjutsuDumMyM0DuL3.elm
       pathToFolder: 'new-package/review-config-templates/2.3.0',
       reference: null
     },
-    path.join(process.cwd(), packageName, 'review')
+    path.join(options.cwd, packageName, 'review')
   );
 
   Spinner.succeedAndNowDo('Adding maintenance scripts', options.report);
-  const maintenancePath = path.join(process.cwd(), packageName, 'maintenance');
+  const maintenancePath = path.join(options.cwd, packageName, 'maintenance');
   await FS.mkdirp(maintenancePath);
   await FS.copyFiles(
     path.join(__dirname, '../new-package/maintenance/'),
@@ -346,7 +346,7 @@ ElmjutsuDumMyM0DuL3.elm
   );
 
   const packageTests = path.join(
-    process.cwd(),
+    options.cwd,
     packageName,
     'elm-review-package-tests'
   );

lib/options.js

@@ -45,7 +45,7 @@ let containsHelp = false;
  * @param {string[]} processArgv
  * @returns {Options | never}
  */
-function compute(processArgv) {
+function compute(processArgv, pcwd = () => process.cwd()) {
   containsHelp =
     processArgv.slice(2).includes('--help') ||
     processArgv.slice(2).includes('-h');
@@ -84,18 +84,20 @@ function compute(processArgv) {
   const readmePath =
     elmJsonPath && path.join(path.dirname(elmJsonPath), 'README.md');
 
+  const cwd = pcwd();
+
   /**
    * @returns {Path}
    */
   function initPath() {
     if (args.config) {
-      return path.resolve(process.cwd(), args.config);
+      return path.resolve(cwd, args.config);
     }
 
     try {
       return path.join(projectToReview(), 'review');
     } catch {
-      return path.join(process.cwd(), 'review');
+      return path.join(cwd, 'review');
     }
   }
 
@@ -111,7 +113,7 @@ function compute(processArgv) {
 
 If you wish to run elm-review from outside your project,
 try re-running it with ${chalk.cyan('--elmjson <path-to-elm.json>')}.`,
-        path.relative(process.cwd(), 'elm.json')
+        path.relative(cwd, 'elm.json')
       );
     }
 
@@ -163,7 +165,7 @@ try re-running it with ${chalk.cyan('--elmjson <path-to-elm.json>')}.`,
    */
   function userSrc() {
     return args.config
-      ? path.resolve(process.cwd(), args.config)
+      ? path.resolve(cwd, args.config)
       : path.join(projectToReview(), 'review');
   }
 
@@ -258,7 +260,7 @@ try re-running it with ${chalk.cyan('--elmjson <path-to-elm.json>')}.`,
       : null,
 
     // PATHS - REVIEW APPLICATION
-
+    cwd,
     userSrc,
     usedConfig: Boolean(args.config),
     template,
@@ -271,7 +273,7 @@ try re-running it with ${chalk.cyan('--elmjson <path-to-elm.json>')}.`,
       path.join(elmStuffFolder(), 'review-applications', `${appHash}.js`),
     elmParserPath: (elmSyntaxVersion) =>
       path.resolve(
-        process.cwd(),
+        cwd,
         elmStuffFolder(),
         'elm-parser',
         `elm-syntax-v${elmSyntaxVersion}${args.debug ? '-debug' : ''}.js`

lib/run-review.js

@@ -36,7 +36,7 @@ async function runReview(options, app) {
       const orange = chalk.keyword('orange');
       console.log(
         `I created suppressions files in ${orange(
-          path.relative(process.cwd(), options.suppressedErrorsFolder())
+          path.relative(options.cwd, options.suppressedErrorsFolder())
         )}`
       );
     }

lib/suppressed-errors.js

@@ -52,9 +52,8 @@ async function write(options, suppressionFiles) {
           const error = intoError(err);
 
           const relativeFolderPath =
-            path.relative(process.cwd(), options.suppressedErrorsFolder()) +
-            '/';
-          const relativeFilePath = path.relative(process.cwd(), filePath);
+            path.relative(options.cwd, options.suppressedErrorsFolder()) + '/';
+          const relativeFilePath = path.relative(options.cwd, filePath);
           throw new ErrorMessage.CustomError(
             'FAILED TO UPDATE SUPPRESSION FILE',
             // prettier-ignore
@@ -181,7 +180,7 @@ Try updating ${chalk.greenBright('elm-review')} to a version that supports this
  */
 function checkForUncommittedSuppressions(options) {
   const pathToSuppressedFolder = path.relative(
-    process.cwd(),
+    options.cwd,
     options.suppressedErrorsFolder()
   );
 

lib/types/options.ts

@@ -43,6 +43,7 @@ export type Options = OptionsBase & {
   newRuleName: string | null;
   ruleType: RuleType | undefined;
 
+  cwd: Path;
   userSrc: () => Path;
   usedConfig: boolean;
   template: Template | null;

lib/watch.js

@@ -297,7 +297,7 @@ function createFileWatcher(
     )
     .on('add', async (absolutePath) => {
       const relativePath = OsHelpers.makePathOsAgnostic(
-        path.relative(process.cwd(), absolutePath)
+        path.relative(options.cwd, absolutePath)
       );
 
       Debug.log(
@@ -334,7 +334,7 @@ function createFileWatcher(
     })
     .on('change', async (absolutePath) => {
       const relativePath = OsHelpers.makePathOsAgnostic(
-        path.relative(process.cwd(), absolutePath)
+        path.relative(options.cwd, absolutePath)
       );
 
       const elmFile = AppState.getFileFromMemoryCache(relativePath) ?? {
@@ -364,7 +364,7 @@ function createFileWatcher(
     })
     .on('unlink', (absolutePath) => {
       const relativePath = OsHelpers.makePathOsAgnostic(
-        path.relative(process.cwd(), absolutePath)
+        path.relative(options.cwd, absolutePath)
       );
       Debug.log(
         `File ${Anonymize.path(options, relativePath)} has been removed`,
@@ -401,7 +401,7 @@ function createExtraFilesWatcher(options, app, runReview, onError, request) {
     )
     .on('add', async (absolutePath) => {
       const relativePath = OsHelpers.makePathOsAgnostic(
-        path.relative(process.cwd(), absolutePath)
+        path.relative(options.cwd, absolutePath)
       );
 
       const newSource = await FS.readFile(relativePath);
@@ -415,7 +415,7 @@ function createExtraFilesWatcher(options, app, runReview, onError, request) {
     })
     .on('change', async (absolutePath) => {
       const relativePath = OsHelpers.makePathOsAgnostic(
-        path.relative(process.cwd(), absolutePath)
+        path.relative(options.cwd, absolutePath)
       );
 
       const newSource = await FS.readFile(relativePath);
@@ -429,7 +429,7 @@ function createExtraFilesWatcher(options, app, runReview, onError, request) {
     })
     .on('unlink', (absolutePath) => {
       const relativePath = OsHelpers.makePathOsAgnostic(
-        path.relative(process.cwd(), absolutePath)
+        path.relative(options.cwd, absolutePath)
       );
       Debug.log(
         `Extra file ${Anonymize.path(options, relativePath)} has been removed`,