dropping backward compatibility in the antlr parser (#1173)

* dropping backward compatibility in the `antlr` parser

* removing backward-compatibility from c8 configuration

* initialising variable in the for loop instead of outside of it

Author: Janther

.c8rc

@@ -5,7 +5,7 @@
   "functions": 90,
   "statements": 90,
   "exclude": ["/node_modules/"],
-  "include": ["src/**/*.ts", "!src/slang-utils/backward-compatibility.ts"],
+  "include": ["src/**/*.ts"],
   "reporter": ["lcov", "text"],
   "temp-dir": "./coverage/"
 }

src/binary-operator-printers/logical.js

@@ -7,8 +7,7 @@ import { shouldGroupOrIndent } from './utils/should-group-or-indent.js';
 const { indent } = doc.builders;
 
 const indentIfNecessaryBuilder = (path, options) => (document) => {
-  let node = path.getNode();
-  for (let i = 0; ; i += 1) {
+  for (let i = 0, { node } = path; ; i += 1) {
     const parentNode = path.getParentNode(i);
     if (notIndentParentTypes.includes(parentNode.type)) return document;
     if (

src/binary-operator-printers/printers/create-binary-operation-printer.js

@@ -11,7 +11,7 @@ const rightOperandPrinter = (node, path, print, options) => {
 
   // If it's a single binary operation, avoid having a small right
   // operand like - 1 on its own line
-  const parent = path.getParentNode();
+  const { parent } = path;
   return node.left.type !== 'BinaryOperation' &&
     (parent.type !== 'BinaryOperation' || assignment.match(parent.operator))
     ? group(right)

src/binary-operator-printers/printers/create-group-if-necessary-builder.js

@@ -5,8 +5,8 @@ const { group } = doc.builders;
 
 export const createGroupIfNecessaryBuilder =
   (shouldIndentMatchers) => (path) => (document) => {
-    const parentNode = path.getParentNode();
-    if (shouldGroupOrIndent(parentNode, shouldIndentMatchers))
+    const { parent } = path;
+    if (shouldGroupOrIndent(parent, shouldIndentMatchers))
       return group(document);
     return document;
   };

src/binary-operator-printers/printers/create-indent-if-necessary-builder.js

@@ -12,8 +12,7 @@ export const notIndentParentTypes = [
 
 export const createIndentIfNecessaryBuilder =
   (shouldIndentMatchers) => (path) => (document) => {
-    let node = path.getNode();
-    for (let i = 0; ; i += 1) {
+    for (let i = 0, { node } = path; ; i += 1) {
       const parentNode = path.getParentNode(i);
       if (notIndentParentTypes.includes(parentNode.type)) return document;
       if (shouldGroupOrIndent(parentNode, shouldIndentMatchers))

src/comments/handlers/handleContractDefinitionComments.js

@@ -1,7 +1,11 @@
 import { util } from 'prettier';
-import { getNextNonSpaceNonCommentCharacter } from '../../common/backward-compatibility.js';
 
-const { addLeadingComment, addTrailingComment, addDanglingComment } = util;
+const {
+  addLeadingComment,
+  addTrailingComment,
+  addDanglingComment,
+  getNextNonSpaceNonCommentCharacter
+} = util;
 
 function handleContractDefinitionComments({
   text,
@@ -22,8 +26,7 @@ function handleContractDefinitionComments({
   // it is a {}.
   const nextCharacter = getNextNonSpaceNonCommentCharacter(
     text,
-    comment,
-    options.locEnd
+    options.locEnd(comment)
   );
 
   // The comment is behind the start of the Block `{}` or behind a base contract

src/comments/handlers/handleModifierInvocationComments.js

@@ -1,7 +1,11 @@
 import { util } from 'prettier';
-import { getNextNonSpaceNonCommentCharacter } from '../../common/backward-compatibility.js';
 
-const { addLeadingComment, addTrailingComment, addDanglingComment } = util;
+const {
+  addLeadingComment,
+  addTrailingComment,
+  addDanglingComment,
+  getNextNonSpaceNonCommentCharacter
+} = util;
 
 function handleModifierInvocationComments({
   text,
@@ -21,8 +25,7 @@ function handleModifierInvocationComments({
   // it is a ().
   const nextCharacter = getNextNonSpaceNonCommentCharacter(
     text,
-    comment,
-    options.locEnd
+    options.locEnd(comment)
   );
 
   // The comment is behind the start of the Parentheses `()`

src/common/backward-compatibility.js

@@ -1,11 +1,7 @@
-import { doc } from 'prettier';
-import {
-  isLast,
-  isNextLineEmpty,
-  isPrettier2
-} from './backward-compatibility.js';
+import { doc, util } from 'prettier';
 
 const { group, indent, join, line, softline, hardline } = doc.builders;
+const { isNextLineEmpty } = util;
 
 export const printComments = (node, path, options, filter = () => true) => {
   if (!node.comments) return '';
@@ -26,14 +22,7 @@ export const printComments = (node, path, options, filter = () => true) => {
       .filter(Boolean)
   );
 
-  // The following if statement will never be 100% covered in a single run
-  // since it depends on the version of Prettier being used.
-  // Mocking the behaviour will introduce a lot of maintenance in the tests.
-  /* c8 ignore start */
-  return isPrettier2
-    ? document.parts // Prettier V2
-    : document; // Prettier V3
-  /* c8 ignore stop */
+  return document;
 };
 
 export function printPreservingEmptyLines(path, key, options, print) {
@@ -56,7 +45,7 @@ export function printPreservingEmptyLines(path, key, options, print) {
 
     // Only attempt to append an empty line if `node` is not the last item
     if (
-      !isLast(childPath, key, index) &&
+      !childPath.isLast &&
       isNextLineEmpty(options.originalText, options.locEnd(node) + 1)
     ) {
       // Append an empty line if the original text already had an one after

src/common/printer-helpers.js

@@ -4,7 +4,7 @@ import { printSeparatedItem } from '../common/printer-helpers.js';
 const { group, hardline, ifBreak, indent, line, softline } = doc.builders;
 
 const experimentalTernaries = (node, path, print, options) => {
-  const parent = path.getParentNode();
+  const { parent } = path;
   const isNested = parent.type === 'Conditional';
   const isNestedAsTrueExpression = isNested && parent.trueExpression === node;
   const falseExpressionIsNested = node.falseExpression.type === 'Conditional';
@@ -68,7 +68,7 @@ const traditionalTernaries = (path, print) =>
     indent([
       // Nested trueExpression and falseExpression are always printed in a new
       // line
-      path.getParentNode().type === 'Conditional' ? hardline : line,
+      path.parent.type === 'Conditional' ? hardline : line,
       '? ',
       path.call(print, 'trueExpression'),
       line,