prettier-solidity · fvictorio · Apr 29, 2025 · Apr 29, 2025
diff --git a/README.md b/README.md
@@ -14,9 +14,9 @@ A [Prettier plugin](https://prettier.io/docs/en/plugins.html) for automatically
 
 Nomic Foundation has put a lot of effort in providing a set of compiler APIs that helped us rethink our approach to parsing and rely on their flexibility, detail oriented solution and continuos support of new and old Solidity syntaxes.
 
-Since v2.0.0 this package will ship with the Slang parser and this change must be implemented in existing configurations by replacing `parser: 'solidity-parse'` with `parser: 'slang-solidity'`.
+Since v2.0.0 this package will ship with the Slang parser and this change must be implemented in existing configurations by replacing `parser: 'antlr'` with `parser: 'slang'`.
 
-The `antlr4` parser (`solidity-parse`) is still supported for the time being and will trigger a deprecation warning, since Slang gives us a much more powerful tool, is faster, allowed us to fully transition into typescript (minimizing the introduction of mismatching type bugs), and allows prettier to format the code in a much more decoupled way and position comments with a greater precision.
+The `antlr4` parser (`antlr`) is still supported for the time being and will trigger a deprecation warning, since Slang gives us a much more powerful tool, is faster, allowed us to fully transition into typescript (minimizing the introduction of mismatching type bugs), and allows prettier to format the code in a much more decoupled way and position comments with a greater precision.
 
 ## Installation and usage
 
@@ -73,7 +73,7 @@ We follow Prettier's strategy for populating their plugins in the object `pretti
 
   async function format(code) {
     return await prettier.format(code, {
-      parser: 'slang-solidity',
+      parser: 'slang',
       plugins: [solidityPlugin]
     });
   }
@@ -97,7 +97,7 @@ import solidityPlugin from 'prettier-plugin-solidity/standalone';
 
 async function format(code) {
   return await prettier.format(code, {
-    parser: "slang-solidity",
+    parser: "slang",
     plugins: [solidityPlugin],
   });
 }
@@ -118,7 +118,7 @@ The following is the default configuration internally used by this plugin.
     {
       "files": "*.sol",
       "options": {
-        "parser": "slang-solidity",
+        "parser": "slang",
         "printWidth": 80,
         "tabWidth": 4,
         "useTabs": false,

diff --git a/src/index.ts b/src/index.ts
@@ -18,10 +18,10 @@ import type {
 } from 'prettier';
 import type { AstNode } from './slang-nodes/types.d.ts';
 
-const slangParserId = 'slang-solidity';
-const antlrParserId = 'solidity-parse';
+const slangParserId = 'slang';
+const antlrParserId = 'antlr';
 const slangAstId = 'slang-ast';
-const antlrAstId = 'solidity-ast';
+const antlrAstId = 'antlr-ast';
 
 // https://prettier.io/docs/en/plugins.html#languages
 // https://github.com/github-linguist/linguist/blob/master/lib/linguist/languages.yml

diff --git a/src/printer.js b/src/printer.js
@@ -18,7 +18,7 @@ function once(factory) {
 
 const warnDeprecation = once(() => {
   printWarning(
-    `'solidity-parse' has been deprecated, please use 'slang-solidity'.`
+    `The 'antlr' parser has been deprecated, please use 'slang' instead.`
   );
   return true;
 });

diff --git a/tests/config/run-format-test.js b/tests/config/run-format-test.js
@@ -322,7 +322,7 @@ async function runTest({
   }
 
   if (
-    formatOptions.parser === "slang-solidity" &&
+    formatOptions.parser === "slang" &&
     !isAntlrMismatch(filename, formatOptions)
   ) {
     // Compare with ANTLR's format
@@ -335,7 +335,7 @@ async function runTest({
       compiler:
         formatOptions.compiler ||
         createParser(code, formatOptions)[0].languageVersion,
-      parser: "solidity-parse",
+      parser: "antlr",
       plugins: await getPlugins(),
     });
     expect(antlrOutput).toEqual(formatResult.output);

diff --git a/tests/format/AddressPayable/__snapshots__/format.test.js.snap b/tests/format/AddressPayable/__snapshots__/format.test.js.snap
@@ -2,7 +2,7 @@
 
 exports[`AddressPayable.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/AddressPayable/format.test.js b/tests/format/AddressPayable/format.test.js
@@ -1 +1 @@
-runFormatTest(import.meta, ['slang-solidity']);
+runFormatTest(import.meta, ['slang']);
diff --git a/tests/format/AllSolidityFeatures/__snapshots__/format.test.js.snap b/tests/format/AllSolidityFeatures/__snapshots__/format.test.js.snap
@@ -2,7 +2,7 @@
 
 exports[`AllSolidityFeatures.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/AllSolidityFeatures/format.test.js b/tests/format/AllSolidityFeatures/format.test.js
@@ -1 +1 @@
-runFormatTest(import.meta, ['slang-solidity']);
+runFormatTest(import.meta, ['slang']);
diff --git a/tests/format/AllSolidityFeaturesV0.4.26/__snapshots__/format.test.js.snap b/tests/format/AllSolidityFeaturesV0.4.26/__snapshots__/format.test.js.snap
@@ -2,7 +2,7 @@
 
 exports[`AllSolidityFeatures.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/AllSolidityFeaturesV0.4.26/format.test.js b/tests/format/AllSolidityFeaturesV0.4.26/format.test.js
@@ -1 +1 @@
-runFormatTest(import.meta, ['slang-solidity']);
+runFormatTest(import.meta, ['slang']);
diff --git a/tests/format/Arrays/__snapshots__/format.test.js.snap b/tests/format/Arrays/__snapshots__/format.test.js.snap
@@ -2,7 +2,7 @@
 
 exports[`Arrays.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/Arrays/format.test.js b/tests/format/Arrays/format.test.js
@@ -1 +1 @@
-runFormatTest(import.meta, ['slang-solidity']);
+runFormatTest(import.meta, ['slang']);
diff --git a/tests/format/Assembly/__snapshots__/format.test.js.snap b/tests/format/Assembly/__snapshots__/format.test.js.snap
@@ -2,7 +2,7 @@
 
 exports[`Assembly.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/Assembly/format.test.js b/tests/format/Assembly/format.test.js
@@ -1 +1 @@
-runFormatTest(import.meta, ['slang-solidity']);
+runFormatTest(import.meta, ['slang']);
diff --git a/tests/format/AssemblyV0.4.26/__snapshots__/format.test.js.snap b/tests/format/AssemblyV0.4.26/__snapshots__/format.test.js.snap
@@ -2,7 +2,7 @@
 
 exports[`Assembly.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/AssemblyV0.4.26/format.test.js b/tests/format/AssemblyV0.4.26/format.test.js
@@ -1 +1 @@
-runFormatTest(import.meta, ['slang-solidity']);
+runFormatTest(import.meta, ['slang']);
diff --git a/tests/format/BasicIterator/__snapshots__/format.test.js.snap b/tests/format/BasicIterator/__snapshots__/format.test.js.snap
@@ -2,7 +2,7 @@
 
 exports[`BasicIterator.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/BasicIterator/format.test.js b/tests/format/BasicIterator/format.test.js
@@ -1 +1 @@
-runFormatTest(import.meta, ['slang-solidity']);
+runFormatTest(import.meta, ['slang']);
diff --git a/tests/format/BinaryOperationHierarchy/__snapshots__/format.test.js.snap b/tests/format/BinaryOperationHierarchy/__snapshots__/format.test.js.snap
@@ -2,7 +2,7 @@
 
 exports[`Group.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================
@@ -1317,7 +1317,7 @@ contract Group {
 
 exports[`Indent.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/BinaryOperationHierarchy/format.test.js b/tests/format/BinaryOperationHierarchy/format.test.js
@@ -1 +1 @@
-runFormatTest(import.meta, ['slang-solidity']);
+runFormatTest(import.meta, ['slang']);
diff --git a/tests/format/BinaryOperators/__snapshots__/format.test.js.snap b/tests/format/BinaryOperators/__snapshots__/format.test.js.snap
@@ -2,7 +2,7 @@
 
 exports[`BinaryOperators.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================
@@ -687,7 +687,7 @@ contract LogicalOperators {
 
 exports[`Parentheses.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/BinaryOperators/format.test.js b/tests/format/BinaryOperators/format.test.js
@@ -1 +1 @@
-runFormatTest(import.meta, ['slang-solidity']);
+runFormatTest(import.meta, ['slang']);
diff --git a/tests/format/BreakingChangesV0.7.4/__snapshots__/format.test.js.snap b/tests/format/BreakingChangesV0.7.4/__snapshots__/format.test.js.snap
@@ -4,7 +4,7 @@ exports[`BreakingChangesV0.7.4.sol - {"compiler":"0.7.3","bracketSpacing":true}
 ====================================options=====================================
 bracketSpacing: true
 compiler: "0.7.3"
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================
@@ -35,7 +35,7 @@ import { symbol1 as alias1, symbol2 as alias2, symbol3 as alias3, symbol4 } from
 exports[`BreakingChangesV0.7.4.sol - {"compiler":"0.7.3"} format 1`] = `
 ====================================options=====================================
 compiler: "0.7.3"
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================
@@ -67,7 +67,7 @@ exports[`BreakingChangesV0.7.4.sol - {"compiler":"0.7.4","bracketSpacing":true}
 ====================================options=====================================
 bracketSpacing: true
 compiler: "0.7.4"
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================
@@ -103,7 +103,7 @@ import {
 exports[`BreakingChangesV0.7.4.sol - {"compiler":"0.7.4"} format 1`] = `
 ====================================options=====================================
 compiler: "0.7.4"
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/BreakingChangesV0.7.4/format.test.js b/tests/format/BreakingChangesV0.7.4/format.test.js
@@ -1,10 +1,10 @@
-runFormatTest(import.meta, ['slang-solidity'], { compiler: '0.7.4' });
-runFormatTest(import.meta, ['slang-solidity'], {
+runFormatTest(import.meta, ['slang'], { compiler: '0.7.4' });
+runFormatTest(import.meta, ['slang'], {
   compiler: '0.7.4',
   bracketSpacing: true
 });
-runFormatTest(import.meta, ['slang-solidity'], { compiler: '0.7.3' });
-runFormatTest(import.meta, ['slang-solidity'], {
+runFormatTest(import.meta, ['slang'], { compiler: '0.7.3' });
+runFormatTest(import.meta, ['slang'], {
   compiler: '0.7.3',
   bracketSpacing: true
 });
diff --git a/tests/format/BreakingChangesV0.8.0/__snapshots__/format.test.js.snap b/tests/format/BreakingChangesV0.8.0/__snapshots__/format.test.js.snap
@@ -3,7 +3,7 @@
 exports[`BreakingChangesV0.8.0.sol - {"compiler":"0.7.0"} format 1`] = `
 ====================================options=====================================
 compiler: "0.7.0"
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================
@@ -91,7 +91,7 @@ contract BreakingChangesV080 {
 exports[`BreakingChangesV0.8.0.sol - {"compiler":"0.8.0"} format 1`] = `
 ====================================options=====================================
 compiler: "0.8.0"
-parsers: ["solidity-parse"]
+parsers: ["antlr"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================
@@ -178,7 +178,7 @@ contract BreakingChangesV080 {
 
 exports[`BreakingChangesV0.8.0.sol format 1`] = `
 ====================================options=====================================
-parsers: ["solidity-parse"]
+parsers: ["antlr"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/BreakingChangesV0.8.0/format.test.js b/tests/format/BreakingChangesV0.8.0/format.test.js
@@ -1,3 +1,3 @@
-runFormatTest(import.meta, ['solidity-parse']);
-runFormatTest(import.meta, ['solidity-parse'], { compiler: '0.8.0' });
-runFormatTest(import.meta, ['slang-solidity'], { compiler: '0.7.0' });
+runFormatTest(import.meta, ['antlr']);
+runFormatTest(import.meta, ['antlr'], { compiler: '0.8.0' });
+runFormatTest(import.meta, ['slang'], { compiler: '0.7.0' });
diff --git a/tests/format/Comments/__snapshots__/format.test.js.snap b/tests/format/Comments/__snapshots__/format.test.js.snap
@@ -2,7 +2,7 @@
 
 exports[`Comments.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/Comments/format.test.js b/tests/format/Comments/format.test.js
@@ -1 +1 @@
-runFormatTest(import.meta, ['slang-solidity']);
+runFormatTest(import.meta, ['slang']);
diff --git a/tests/format/Conditional/__snapshots__/format.test.js.snap b/tests/format/Conditional/__snapshots__/format.test.js.snap
@@ -2,7 +2,7 @@
 
 exports[`Conditional.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/Conditional/format.test.js b/tests/format/Conditional/format.test.js
@@ -1 +1 @@
-runFormatTest(import.meta, ['slang-solidity']);
+runFormatTest(import.meta, ['slang']);
diff --git a/tests/format/Constructors/__snapshots__/format.test.js.snap b/tests/format/Constructors/__snapshots__/format.test.js.snap
@@ -2,7 +2,7 @@
 
 exports[`Constructors.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/Constructors/format.test.js b/tests/format/Constructors/format.test.js
@@ -1 +1 @@
-runFormatTest(import.meta, ['slang-solidity']);
+runFormatTest(import.meta, ['slang']);
diff --git a/tests/format/ConstructorsV0.4.26/__snapshots__/format.test.js.snap b/tests/format/ConstructorsV0.4.26/__snapshots__/format.test.js.snap
@@ -2,7 +2,7 @@
 
 exports[`Constructors.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/ConstructorsV0.4.26/format.test.js b/tests/format/ConstructorsV0.4.26/format.test.js
@@ -1 +1 @@
-runFormatTest(import.meta, ['slang-solidity']);
+runFormatTest(import.meta, ['slang']);
diff --git a/tests/format/ContractDefinitions/__snapshots__/format.test.js.snap b/tests/format/ContractDefinitions/__snapshots__/format.test.js.snap
@@ -2,7 +2,7 @@
 
 exports[`ContractDefinitions.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/ContractDefinitions/format.test.js b/tests/format/ContractDefinitions/format.test.js
@@ -1 +1 @@
-runFormatTest(import.meta, ['slang-solidity']);
+runFormatTest(import.meta, ['slang']);
diff --git a/tests/format/CustomErrors/__snapshots__/format.test.js.snap b/tests/format/CustomErrors/__snapshots__/format.test.js.snap
@@ -2,7 +2,7 @@
 
 exports[`CustomErrors.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/CustomErrors/format.test.js b/tests/format/CustomErrors/format.test.js
@@ -1 +1 @@
-runFormatTest(import.meta, ['slang-solidity']);
+runFormatTest(import.meta, ['slang']);
diff --git a/tests/format/EnumDefinitions/__snapshots__/format.test.js.snap b/tests/format/EnumDefinitions/__snapshots__/format.test.js.snap
@@ -2,7 +2,7 @@
 
 exports[`EnumDefinitions.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/EnumDefinitions/format.test.js b/tests/format/EnumDefinitions/format.test.js
@@ -1 +1 @@
-runFormatTest(import.meta, ['slang-solidity']);
+runFormatTest(import.meta, ['slang']);
diff --git a/tests/format/Etc/__snapshots__/format.test.js.snap b/tests/format/Etc/__snapshots__/format.test.js.snap
@@ -2,7 +2,7 @@
 
 exports[`Etc.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang-solidity"]
+parsers: ["slang"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

diff --git a/tests/format/Etc/format.test.js b/tests/format/Etc/format.test.js
@@ -1 +1 @@
-runFormatTest(import.meta, ['slang-solidity']);
+runFormatTest(import.meta, ['slang']);
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		runFormatTest(import.meta, ['slang-solidity']);
		runFormatTest(import.meta, ['slang']);