dropping support for prettier v2

Author: Janther

.github/workflows/CI.yml

@@ -41,26 +41,6 @@ jobs:
       - name: Run tests
         run: npm run test:standalone
 
-  test_prettier_v2:
-    name: Prettier V2
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          cache: 'npm'
-      - name: Install
-        run: npm install
-      - name: Build with Prettier V3
-        run: npm run build
-      - name: Downgrade Prettier to V2
-        run: npm install [email protected]
-      - name: Build test app
-        run: npm run build:test
-      - name: Run standalone tests
-        run: npm run test:standalone
-
   test_linux:
     name: Test on Linux with Node ${{ matrix.node }}
     runs-on: ubuntu-latest

package-lock.json

@@ -19,9 +19,9 @@
     "lint:fix": "npm run eslint -- --fix && npm run prettier -- --write",
     "prepublishOnly": "npm run build && npx tsc",
     "prettier": "prettier './*.{ts,js,cjs,json,md,yml}' '{src,tests}/**/*.{ts,js,cjs}'",
-    "test": "NODE_OPTIONS=\"--loader=ts-node/esm --loader=esmock\" jest",
-    "test:all": "cross-env FULL_TEST=1 NODE_OPTIONS=\"--loader=ts-node/esm --loader=esmock\" c8 jest",
-    "test:standalone": "cross-env TEST_STANDALONE=1 FULL_TEST=1 NODE_OPTIONS=\"--loader=esmock\" jest"
+    "test": "NODE_OPTIONS=\"--loader=ts-node/esm\" jest",
+    "test:all": "cross-env FULL_TEST=1 NODE_OPTIONS=\"--loader=ts-node/esm\" c8 jest",
+    "test:standalone": "cross-env TEST_STANDALONE=1 FULL_TEST=1 jest"
   },
   "files": [
     "src",
@@ -94,7 +94,6 @@
     "eslint": "^9.13.0",
     "eslint-config-prettier": "^9.1.0",
     "esm-utils": "^4.3.0",
-    "esmock": "^2.6.9",
     "jest": "^29.7.0",
     "jest-light-runner": "^0.6.0",
     "jest-snapshot-serializer-ansi": "^2.1.0",
@@ -116,7 +115,7 @@
     "semver": "^7.6.3"
   },
   "peerDependencies": {
-    "prettier": ">=2.3.0"
+    "prettier": ">=3.0.0"
   },
   "browserslist": {
     "production": [

package.json

@@ -23,18 +23,8 @@ const warnDeprecation = once(() => {
   return true;
 });
 
-const prettierVersionCheck = once(() => {
-  if (!prettierVersionSatisfies('>=2.3.0')) {
-    throw new Error(
-      'The version of prettier in your node-modules does not satisfy the required ">=2.3.0" constraint. Please update the version of Prettier.'
-    );
-  }
-  return true;
-});
-
 function genericPrint(path, options, print) {
   warnDeprecation();
-  prettierVersionCheck();
 
   const node = path.getValue();
   if (node === null) {

src/printer.js

@@ -1,6 +1,6 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { util } from 'prettier';
-import { getNextNonSpaceNonCommentCharacter } from '../../slang-utils/backward-compatibility.js';
+import { locEnd } from '../../slang-utils/loc.js';
 import addCollectionNodeLastComment from './add-collection-node-last-comment.js';
 
 import type { HandlerParams } from './types.d.ts';
@@ -18,7 +18,10 @@ export default function handleContractDefinitionComments({
     return false;
   }
 
-  const nextCharacter = getNextNonSpaceNonCommentCharacter(text, comment);
+  const nextCharacter = util.getNextNonSpaceNonCommentCharacter(
+    text,
+    locEnd(comment)
+  );
 
   // Everything before the InheritanceSpecifier is pushed onto the beginning of
   // the ContractDefinition.

src/slang-comments/handlers/handle-contract-definition-comments.ts

@@ -1,6 +1,6 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { util } from 'prettier';
-import { getNextNonSpaceNonCommentCharacter } from '../../slang-utils/backward-compatibility.js';
+import { locEnd } from '../../slang-utils/loc.js';
 import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
 
 import type { HandlerParams } from './types.d.ts';
@@ -23,7 +23,10 @@ export default function handleIfStatementComments({
   //   if (a /* comment */) {}
   // The only workaround I found is to look at the next character to see if
   // it is a ).
-  const nextCharacter = getNextNonSpaceNonCommentCharacter(text, comment);
+  const nextCharacter = util.getNextNonSpaceNonCommentCharacter(
+    text,
+    locEnd(comment)
+  );
   if (nextCharacter === ')') {
     addTrailingComment(precedingNode, comment);
     return true;

src/slang-comments/handlers/handle-if-statement-comments.ts

@@ -1,5 +1,6 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
-import { getNextNonSpaceNonCommentCharacter } from '../../slang-utils/backward-compatibility.js';
+import { util } from 'prettier';
+import { locEnd } from '../../slang-utils/loc.js';
 import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
 import addCollectionNodeLastComment from './add-collection-node-last-comment.js';
 
@@ -16,7 +17,10 @@ export default function handleInterfaceDefinitionComments({
     return false;
   }
 
-  const nextCharacter = getNextNonSpaceNonCommentCharacter(text, comment);
+  const nextCharacter = util.getNextNonSpaceNonCommentCharacter(
+    text,
+    locEnd(comment)
+  );
 
   // The comment is at the end of the body of the InterfaceDefinition.
   if (precedingNode?.kind === NonterminalKind.InterfaceMembers) {

src/slang-comments/handlers/handle-interface-definition-comments.ts

@@ -1,5 +1,6 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
-import { getNextNonSpaceNonCommentCharacter } from '../../slang-utils/backward-compatibility.js';
+import { util } from 'prettier';
+import { locEnd } from '../../slang-utils/loc.js';
 import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
 import addCollectionNodeLastComment from './add-collection-node-last-comment.js';
 
@@ -16,7 +17,10 @@ export default function handleLibraryDefinitionComments({
     return false;
   }
 
-  const nextCharacter = getNextNonSpaceNonCommentCharacter(text, comment);
+  const nextCharacter = util.getNextNonSpaceNonCommentCharacter(
+    text,
+    locEnd(comment)
+  );
 
   // The comment is at the end of the body of the ContractDefinition.
   if (precedingNode?.kind === NonterminalKind.LibraryMembers) {

src/slang-comments/handlers/handle-library-definition-comments.ts

@@ -1,6 +1,6 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { util } from 'prettier';
-import { getNextNonSpaceNonCommentCharacter } from '../../slang-utils/backward-compatibility.js';
+import { locEnd } from '../../slang-utils/loc.js';
 import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
 
 import type { HandlerParams } from './types.d.ts';
@@ -18,7 +18,10 @@ export default function handleModifierInvocationComments({
     return false;
   }
 
-  const nextCharacter = getNextNonSpaceNonCommentCharacter(text, comment);
+  const nextCharacter = util.getNextNonSpaceNonCommentCharacter(
+    text,
+    locEnd(comment)
+  );
 
   // The last comments before the body.
   if (

src/slang-comments/handlers/handle-modifier-invocation-comments.ts

@@ -1,6 +1,6 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { util } from 'prettier';
-import { getNextNonSpaceNonCommentCharacter } from '../../slang-utils/backward-compatibility.js';
+import { locEnd } from '../../slang-utils/loc.js';
 import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
 
 import type { HandlerParams } from './types.d.ts';
@@ -26,7 +26,10 @@ export default function handleWhileStatementComments({
   //   while (a /* comment */) {}
   // The only workaround I found is to look at the next character to see if
   // it is a ).
-  const nextCharacter = getNextNonSpaceNonCommentCharacter(text, comment);
+  const nextCharacter = util.getNextNonSpaceNonCommentCharacter(
+    text,
+    locEnd(comment)
+  );
   if (nextCharacter === ')' || enclosingNode.condition === precedingNode) {
     addTrailingComment(precedingNode, comment);
     return true;