renaming format-test.js to run-format-test.js and run_spec to runForm…

…atTest

.eslintrc

@@ -4,7 +4,7 @@
   },
   "extends": ["airbnb-base", "prettier"],
   "globals": {
-    "run_spec": false
+    "runFormatTest": "readonly"
   },
   "parserOptions": {
     "ecmaVersion": "latest",

jest.config.js

@@ -11,7 +11,7 @@ if (TEST_STANDALONE) {
 
 export default {
   runner: 'jest-light-runner',
-  setupFiles: ['<rootDir>/tests/config/setup.js'],
+  setupFiles: ['<rootDir>/tests/config/format-test-setup.js'],
   snapshotSerializers: [
     'jest-snapshot-serializer-raw',
     'jest-snapshot-serializer-ansi'

tests/config/format-test-setup.js

@@ -0,0 +1,3 @@
+import runFormatTest from "./run-format-test.js";
+
+globalThis.runFormatTest = runFormatTest;

tests/config/require-standalone.cjs

@@ -35,7 +35,7 @@ module.exports = {
         };
         prettier.formatWithCursor($$$input, options);
       `,
-      { $$$input: input, $$$options: options, ...sandbox }
+      { $$$input: input, $$$options: options, ...sandbox },
     );
   },
 
@@ -57,7 +57,7 @@ module.exports = {
           $$$options: options,
           $$$devOptions: devOptions,
           ...sandbox,
-        }
+        },
       );
     },
   },

tests/config/format-test.js → tests/config/run-format-test.js

@@ -1,13 +1,15 @@
 import fs from "node:fs";
 import path from "node:path";
 import url from "node:url";
+
 import createEsmUtils from "esm-utils";
+
 import getPrettier from "./get-prettier.js";
 import compileContract from "./utils/compile-contract.js";
-import createSnapshot from "./utils/create-snapshot.js";
-import visualizeEndOfLine from "./utils/visualize-end-of-line.js";
 import consistentEndOfLine from "./utils/consistent-end-of-line.js";
+import createSnapshot from "./utils/create-snapshot.js";
 import stringifyOptionsForTitle from "./utils/stringify-options-for-title.js";
+import visualizeEndOfLine from "./utils/visualize-end-of-line.js";
 
 const { __dirname } = createEsmUtils(import.meta);
 
@@ -112,7 +114,7 @@ const isTestDirectory = (dirname, name) =>
     path.join(__dirname, "../format", name) + path.sep,
   );
 
-function runSpec(fixtures, parsers, options) {
+function runFormatTest(fixtures, parsers, options) {
   let { importMeta, snippets = [] } = fixtures.importMeta
     ? fixtures
     : { importMeta: fixtures };
@@ -326,15 +328,15 @@ async function runTest({
   if (!shouldSkipEolTest(code, formatResult.options)) {
     for (const eol of ["\r\n", "\r"]) {
       const { eolVisualizedOutput: output } = await format(
-        code.replace(/\n/g, eol),
+        code.replace(/\n/gu, eol),
         formatOptions,
       );
       // Only if `endOfLine: "auto"` the result will be different
       const expected =
         formatOptions.endOfLine === "auto"
           ? visualizeEndOfLine(
               // All `code` use `LF`, so the `eol` of result is always `LF`
-              formatResult.outputWithCursor.replace(/\n/g, eol),
+              formatResult.outputWithCursor.replace(/\n/gu, eol),
             )
           : formatResult.eolVisualizedOutput;
       expect(output).toEqual(expected);
@@ -452,4 +454,4 @@ async function format(originalText, originalOptions) {
   };
 }
 
-export default runSpec;
+export default runFormatTest;

tests/format/AddressPayable/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/AllSolidityFeatures/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/AllSolidityFeaturesV0.4.26/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse'], { compiler: '0.4.26' });
+runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.4.26' });

tests/format/Arrays/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/Assembly/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/AssemblyV0.4.26/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse'], { compiler: '0.4.26' });
+runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.4.26' });

tests/format/BasicIterator/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse'], { compiler: '0.4.26' });
+runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.4.26' });

tests/format/BinaryOperators/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse'], { compiler: '0.5.8' });
+runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.5.8' });

tests/format/BreakingChangesV0.7.4/format.test.js

@@ -1,14 +1,14 @@
-run_spec(import.meta, ['solidity-parse'], { compiler: '0.7.4' });
-run_spec(import.meta, ['solidity-parse'], {
+runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.7.4' });
+runFormatTest(import.meta, ['solidity-parse'], {
   compiler: '0.7.4',
   bracketSpacing: true
 });
-run_spec(import.meta, ['solidity-parse'], { compiler: '0.7.3' });
-run_spec(import.meta, ['solidity-parse'], {
+runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.7.3' });
+runFormatTest(import.meta, ['solidity-parse'], {
   compiler: '0.7.3',
   bracketSpacing: true
 });
-run_spec(import.meta, ['solidity-parse']);
-run_spec(import.meta, ['solidity-parse'], {
+runFormatTest(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse'], {
   bracketSpacing: true
 });

tests/format/BreakingChangesV0.8.0/format.test.js

@@ -1,3 +1,3 @@
-run_spec(import.meta, ['solidity-parse']);
-run_spec(import.meta, ['solidity-parse'], { compiler: '0.8.0' });
-run_spec(import.meta, ['solidity-parse'], { compiler: '0.7.0' });
+runFormatTest(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.8.0' });
+runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.7.0' });

tests/format/Comments/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse'], { compiler: '0.4.24' });
+runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.4.24' });

tests/format/Conditional/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/Constructors/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/ContractDefinitions/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/CustomErrors/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/EnumDefinitions/format.test.js

@@ -1,2 +1,2 @@
-run_spec(import.meta, ['solidity-parse']);
-run_spec(import.meta, ['solidity-parse'], { bracketSpacing: true });
+runFormatTest(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse'], { bracketSpacing: true });

tests/format/Etc/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/ExperimentalTernaries/format.test.js

@@ -1,10 +1,10 @@
-run_spec(import.meta, ['solidity-parse']);
-run_spec(import.meta, ['solidity-parse'], { experimentalTernaries: true });
-run_spec(import.meta, ['solidity-parse'], {
+runFormatTest(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse'], { experimentalTernaries: true });
+runFormatTest(import.meta, ['solidity-parse'], {
   experimentalTernaries: true,
   tabWidth: 1
 });
-run_spec(import.meta, ['solidity-parse'], {
+runFormatTest(import.meta, ['solidity-parse'], {
   experimentalTernaries: true,
   useTabs: true
 });

tests/format/ForStatements/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/FunctionCalls/format.test.js

@@ -1,2 +1,2 @@
-run_spec(import.meta, ['solidity-parse']);
-run_spec(import.meta, ['solidity-parse'], { bracketSpacing: true });
+runFormatTest(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse'], { bracketSpacing: true });

tests/format/FunctionDefinitions/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse'], { compiler: '0.8.0' });
+runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.8.0' });

tests/format/FunctionDefinitionsV0.5.0/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse'], { compiler: '0.5.0' });
+runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.5.0' });

tests/format/HexLiteral/format.test.js

@@ -1,8 +1,8 @@
-run_spec(import.meta, ['solidity-parse'], {
+runFormatTest(import.meta, ['solidity-parse'], {
   compiler: '0.8.6',
   singleQuote: true
 });
-run_spec(import.meta, ['solidity-parse'], {
+runFormatTest(import.meta, ['solidity-parse'], {
   compiler: '0.8.6',
   singleQuote: false
 });

tests/format/IfStatements/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/Immutable/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/ImportDirective/format.test.js

@@ -1,2 +1,2 @@
-run_spec(import.meta, ['solidity-parse']);
-run_spec(import.meta, ['solidity-parse'], { bracketSpacing: true });
+runFormatTest(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse'], { bracketSpacing: true });

tests/format/Inbox/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/IndexOf/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse'], { compiler: '0.4.26' });
+runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.4.26' });

tests/format/IndexRangeAccess/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/InheritanceSpecifier/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/Issues/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/Libraries/format.test.js

@@ -1,2 +1,2 @@
-run_spec(import.meta, ['solidity-parse']);
-run_spec(import.meta, ['solidity-parse'], { bracketSpacing: true });
+runFormatTest(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse'], { bracketSpacing: true });

tests/format/Markdown/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['markdown']);
+runFormatTest(import.meta, ['markdown']);

tests/format/MemberAccess/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/ModifierDefinitions/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/ModifierInvocations/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse'], { compiler: '0.8.0' });
+runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.8.0' });

tests/format/MultipartStrings/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/NameValueExpression/format.test.js

@@ -1,2 +1,2 @@
-run_spec(import.meta, ['solidity-parse']);
-run_spec(import.meta, ['solidity-parse'], { bracketSpacing: true });
+runFormatTest(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse'], { bracketSpacing: true });

tests/format/NumberLiteral/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/Ownable/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/Parentheses/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse'], { compiler: '0.8.6' });
+runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.8.6' });

tests/format/Pragma/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/PrettierIgnore/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/Proxy/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse'], { compiler: '0.4.24' });
+runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.4.24' });

tests/format/RespectDefaultOptions/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['babel']);
+runFormatTest(import.meta, ['babel']);

tests/format/SampleCrowdsale/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/SimpleAuction/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/SimpleStorage/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/SplittableCommodity/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/StateVariableDeclarations/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/StringLiteral/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/StyleGuide/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse'], { compiler: '0.5.0' });
+runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.5.0' });

tests/format/TryCatch/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/Tuples/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/TypeDefinition/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/WhileStatements/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);

tests/format/WrongCompiler/format.test.js

@@ -1,10 +1,10 @@
 // Should warn twice
-run_spec(import.meta, ['solidity-parse'], { compiler: '0.8.4' });
+runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.8.4' });
 // Should warn once
-run_spec(import.meta, ['solidity-parse'], {
+runFormatTest(import.meta, ['solidity-parse'], {
   compiler: 'v0.7.5-nightly.2020.11.9+commit.41f50365'
 });
 // Should not warn
-run_spec(import.meta, ['solidity-parse'], {
+runFormatTest(import.meta, ['solidity-parse'], {
   compiler: 'v0.7.3+commit.9bfce1f6'
 });

tests/format/quotes/format.test.js

@@ -1,2 +1,2 @@
-run_spec(import.meta, ['solidity-parse'], { singleQuote: true });
-run_spec(import.meta, ['solidity-parse'], { singleQuote: false });
+runFormatTest(import.meta, ['solidity-parse'], { singleQuote: true });
+runFormatTest(import.meta, ['solidity-parse'], { singleQuote: false });

tests/format/strings/format.test.js

@@ -1 +1 @@
-run_spec(import.meta, ['solidity-parse']);
+runFormatTest(import.meta, ['solidity-parse']);