Anonymize version and path in test code rather than in shipped code

Includes removing options.forTests.

Author: jfmengels

.eslintrc.js

@@ -101,7 +101,6 @@ module.exports = {
     '@typescript-eslint/ban-ts-comment': [
       'warn',
       {
-        'ts-expect-error': {descriptionFormat: '^\\(TS\\d+\\): .+$'},
         'ts-check': false
       }
     ],

lib/anonymize.js

@@ -15,7 +15,6 @@ const fs = require('graceful-fs');
 const wrap = require('wrap-ansi');
 const exit = require('../vendor/exit');
 const elmCompiler = require('../vendor/node-elm-compiler');
-const Anonymize = require('./anonymize');
 const Benchmark = require('./benchmark');
 const Debug = require('./debug');
 const {getElmBinary} = require('./elm-binary');
@@ -166,10 +165,7 @@ please use ${chalk.greenBright('--config some/path/to/review')}`,
   let elmModulePath = options.elmModulePath(appHash);
   if (!options.forceBuild && fs.existsSync(elmModulePath)) {
     Debug.log(
-      `Review application is already built. Using ${Anonymize.path(
-        options,
-        elmModulePath
-      )}`,
+      `Review application is already built. Using ${elmModulePath}`,
       options.debug
     );
   } else {
@@ -285,11 +281,7 @@ function createSymLinkForLocalElmReview(options, buildFolder, reviewElmJson) {
  * @returns {Promise<BuildResult>}
  */
 async function buildFromGitHubTemplate(options, template) {
-  Spinner.setText(
-    'Fetching template information',
-    options.report,
-    options.forTests
-  );
+  Spinner.setText('Fetching template information', options.report);
   const commit = await RemoteTemplate.getRelevantCommit(options, template);
   const reviewElmJson = await RemoteTemplate.getRemoteElmJson(
     options,
@@ -304,10 +296,7 @@ async function buildFromGitHubTemplate(options, template) {
   let elmModulePath = options.templateElmModulePath(commit);
   if (fs.existsSync(elmModulePath)) {
     Debug.log(
-      `Review application is already built. Using ${Anonymize.path(
-        options,
-        elmModulePath
-      )}`,
+      `Review application is already built. Using ${elmModulePath}`,
       options.debug
     );
 
@@ -319,11 +308,7 @@ async function buildFromGitHubTemplate(options, template) {
 
     const buildFolder = path.join(options.buildFolder(), 'template');
 
-    Spinner.setText(
-      'Downloading configuration files',
-      options.report,
-      options.forTests
-    );
+    Spinner.setText('Downloading configuration files', options.report);
     // Download all files from the template
     await RemoteTemplate.downloadSourceDirectories(
       options,
@@ -335,11 +320,7 @@ async function buildFromGitHubTemplate(options, template) {
 
     Debug.log('Starting template review application build', options.debug);
 
-    Spinner.setText(
-      'Building review application',
-      options.report,
-      options.forTests
-    );
+    Spinner.setText('Building review application', options.report);
 
     const cleanupSymlink = createSymLinkForLocalElmReview(
       options,

lib/build.js

@@ -6,7 +6,6 @@
 const path = require('node:path');
 const chalk = require('chalk');
 const {glob} = require('tinyglobby');
-const Anonymize = require('./anonymize');
 const Benchmark = require('./benchmark');
 const Cache = require('./cache');
 const Debug = require('./debug');
@@ -158,7 +157,7 @@ async function readFile(
   relativePathToElmJson,
   filePath
 ) {
-  Debug.log(` - ${Anonymize.path(options, filePath)}`, options.debug);
+  Debug.log(` - ${filePath}`, options.debug);
   const relativeFilePath = path.relative(relativePathToElmJson, filePath);
 
   const lastUpdatedTime = options.watch

lib/elm-files.js

@@ -4,7 +4,6 @@
  */
 const chalk = require('chalk');
 const stripAnsi = require('strip-ansi');
-const Anonymize = require('./anonymize');
 
 class CustomError extends Error {
   /**
@@ -28,20 +27,14 @@ class CustomError extends Error {
  */
 function report(options, err, defaultPath) {
   if (options.report === 'json') {
-    return Anonymize.pathsAndVersions(
-      options,
-      Anonymize.pathsAndVersions(
-        options,
-        JSON.stringify(
-          formatJson(options.debug, err, defaultPath),
-          null,
-          options.debug || options.forTests ? 2 : 0
-        )
-      )
+    return JSON.stringify(
+      formatJson(options.debug, err, defaultPath),
+      null,
+      options.debug ? 2 : 0
     );
   }
 
-  return Anonymize.pathsAndVersions(options, formatHuman(options.debug, err));
+  return formatHuman(options.debug, err);
 }
 
 /**

lib/error-message.js

@@ -2,7 +2,6 @@
  * @import {Options} from './types/options';
  */
 const chalk = require('chalk');
-const Anonymize = require('./anonymize');
 const Flags = require('./flags');
 
 /**
@@ -14,7 +13,7 @@ function review(options) {
 
   console.log(
     // prettier-ignore
-    `You are using ${chalk.greenBright(`elm-review ${Anonymize.version(options)}`)}.
+    `You are using ${chalk.greenBright(`elm-review ${options.packageJsonVersion}`)}.
 
     ${chalk.magenta('elm-review <zero-or-more-files-or-directories>')}
         Analyzes your project, and lists the locations where patterns forbidden

lib/help.js

@@ -8,7 +8,6 @@ const fs = require('graceful-fs');
 const chalk = require('chalk');
 const prompts = require('prompts');
 const FS = require('./fs-wrapper');
-const Anonymize = require('./anonymize');
 const RemoteTemplate = require('./remote-template');
 const {getElmBinary, getElmVersion} = require('./elm-binary');
 const TemplateDependencies = require('./template-dependencies');
@@ -31,7 +30,7 @@ async function promptAndCreate(options) {
       message: `Would you like me to create ${chalk.yellow(
         'elm.json'
       )} and ${chalk.yellow('src/ReviewConfig.elm')} inside ${chalk.yellow(
-        Anonymize.path(options, directory)
+        directory
       )}?`,
       initial: true
     });
@@ -94,12 +93,12 @@ async function createFromTemplate(options, template, directory) {
  */
 function logInit(options, directory) {
   const message = options.template
-    ? templateInitMessage(options, directory)
-    : regularInitMessage(options, directory);
+    ? templateInitMessage(directory)
+    : regularInitMessage(directory);
 
   console.log(
     `All done! I have created a review project at ${chalk.green(
-      (Anonymize.path(options, directory) + '/').replace(/\/\//g, '/')
+      (directory + '/').replace(/\/\//g, '/')
     )} for you.
 
 ${message}
@@ -116,29 +115,27 @@ ${options.template ? templateRecommendation : ''}`
 }
 
 /**
- * @param {Options} options
  * @param {Path} directory
  * @returns {string}
  */
-function regularInitMessage(options, directory) {
+function regularInitMessage(directory) {
   return `You can now define your review configuration by editing ${chalk.green(
-    Anonymize.path(options, path.join(directory, 'src/ReviewConfig.elm'))
+    path.join(directory, 'src/ReviewConfig.elm')
   )}.`;
 }
 
 const orange = chalk.keyword('orange');
 
 /**
- * @param {Options} options
  * @param {Path} directory
  * @returns {string}
  */
-function templateInitMessage(options, directory) {
+function templateInitMessage(directory) {
   return `You chose to use someone's review configuration which can be great to get started
 but don't forget to review the configuration to make sure it fits your needs,
 both by removing rules you disagree with and by finding new rules to aid you.
 You can do so by editing ${chalk.green(
-    Anonymize.path(options, path.join(directory, 'src/ReviewConfig.elm'))
+    path.join(directory, 'src/ReviewConfig.elm')
   )}.`;
 }
 

lib/init.js

@@ -5,7 +5,6 @@ const path = require('node:path');
 const process = require('node:process');
 const chalk = require('chalk');
 const exit = require('../vendor/exit');
-const Anonymize = require('./anonymize');
 const AppWrapper = require('./app-wrapper');
 const Builder = require('./build');
 const ElmBinary = require('./elm-binary');
@@ -221,7 +220,7 @@ async function main() {
  */
 async function app(options, errorHandler) {
   if (options.version) {
-    console.log(Anonymize.version(options));
+    console.log(options.packageJsonVersion);
     return;
   }
 

lib/main.js

@@ -213,7 +213,7 @@ async function createProject(
     await FS.mkdirp(path.join(dir, 'tests', ruleNameFolder));
   } catch {}
 
-  Spinner.setText('Adding elm.json', options.report, options.forTests);
+  Spinner.setText('Adding elm.json', options.report);
   const packageElmJson = elmJson(authorName, packageName, ruleName, license);
   await writeFile(dir, 'elm.json', JSON.stringify(packageElmJson, null, 4));
 

lib/new-package.js

@@ -185,8 +185,6 @@ try re-running it with ${chalk.cyan('--elmjson <path-to-elm.json>')}.`,
     ? parseTemplate(subcommand, args.template)
     : null;
 
-  const forTests = args['FOR-TESTS'];
-
   const gitHubPat = parseGitHubAuth(subcommand, args['github-auth']);
 
   const localElmReview = process.env.LOCAL_ELM_REVIEW;
@@ -221,7 +219,6 @@ try re-running it with ${chalk.cyan('--elmjson <path-to-elm.json>')}.`,
   return {
     debug: args.debug,
     showBenchmark: args['benchmark-info'],
-    forTests,
     enableExtract: args.extract,
     version: args.version,
     help: args.help,