renaming 'slang' to 'slang-solidity'

Author: Janther

README.md

@@ -10,11 +10,11 @@
 
 A [Prettier plugin](https://prettier.io/docs/en/plugins.html) for automatically formatting your [Solidity](https://github.com/ethereum/solidity) code.
 
-## Nomic Foundation`s Slang
+## Nomic Foundation's Slang
 
 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'`.
+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'`.
 
 ## Installation and usage
 
@@ -67,7 +67,7 @@ We follow Prettier's strategy for populating their plugins in the object `pretti
 <script>
   async function format(code) {
     return await prettier.format(code, {
-      parser: 'slang',
+      parser: 'slang-solidity',
       plugins: [solidityPlugin]
     });
   }
@@ -91,7 +91,7 @@ import solidityPlugin from 'prettier-plugin-solidity/standalone';
 
 async function format(code) {
   return await prettier.format(code, {
-    parser: "slang",
+    parser: "slang-solidity",
     plugins: [solidityPlugin],
   });
 }
@@ -112,7 +112,7 @@ The following is the default configuration internally used by this plugin.
     {
       "files": "*.sol",
       "options": {
-        "parser": "slang",
+        "parser": "slang-solidity",
         "printWidth": 80,
         "tabWidth": 4,
         "useTabs": false,

src/index.ts

@@ -3,10 +3,10 @@ import { handleComments, printComment } from './slang-comments/index.js';
 import massageAstNode from './clean.js';
 import loc from './loc.js';
 import options from './options.js';
-import solidityParse from './parser.js';
-import solidityPrint from './printer.js';
-import parse from './slangParser.js';
-import print from './slangPrinter.js';
+import parse from './parser.js';
+import print from './printer.js';
+import solidityParse from './slangSolidityParser.js';
+import slangPrint from './slangPrinter.js';
 import { isComment, isBlockComment } from './slang-utils/is-comment.js';
 import { locEnd, locStart } from './slang-utils/loc.js';
 
@@ -18,34 +18,34 @@ import type {
 } from 'prettier';
 import type { AstNode } from './slang-nodes';
 
-const parserName = 'slang';
+const parserSolidity = 'slang-solidity';
 const astFormat = 'slang-ast';
 
 // https://prettier.io/docs/en/plugins.html#languages
-// https://github.com/ikatyang/linguist-languages/blob/master/data/Solidity.json
+// https://github.com/github-linguist/linguist/blob/master/lib/linguist/languages.yml
 const languages: SupportLanguage[] = [
   {
     linguistLanguageId: 237469032,
     name: 'Solidity',
     aceMode: 'text',
     tmScope: 'source.solidity',
     extensions: ['.sol'],
-    parsers: [parserName, 'solidity-parse'],
+    parsers: [parserSolidity, 'solidity-parse'],
     vscodeLanguageIds: ['solidity']
   }
 ];
 
 // https://prettier.io/docs/en/plugins.html#parsers
-const parser = { astFormat: 'solidity-ast', parse: solidityParse, ...loc };
-const slangParser: Parser<AstNode> = {
+const parser = { astFormat: 'solidity-ast', parse, ...loc };
+const solidityParser: Parser<AstNode> = {
   astFormat,
-  parse,
+  parse: solidityParse,
   locStart,
   locEnd
 };
 
 const parsers = {
-  [parserName]: slangParser,
+  [parserSolidity]: solidityParser,
   'solidity-parse': parser
 };
 
@@ -69,15 +69,15 @@ const printer = {
   },
   isBlockComment: comments.isBlockComment,
   massageAstNode,
-  print: solidityPrint,
+  print,
   printComment: comments.printComment
 };
 const slangPrinter: Printer<AstNode> = {
   canAttachComment,
   handleComments,
   isBlockComment,
   massageAstNode,
-  print,
+  print: slangPrint,
   printComment
 };
 

src/printer.js

@@ -16,7 +16,9 @@ function once(factory) {
 }
 
 const warnDeprecation = once(() => {
-  console.warn(`'solidity-parse' has been deprecated, please use 'slang'.`);
+  console.warn(
+    `'solidity-parse' has been deprecated, please use 'slang-solidity'.`
+  );
   return true;
 });
 

src/slangParser.ts src/slangSolidityParser.tssrc/slangParser.ts renamed to src/slangSolidityParser.ts

@@ -8,7 +8,7 @@ import { SourceUnit } from './slang-nodes/SourceUnit.js';
 
 import type { NonterminalNode } from '@nomicfoundation/slang/cst';
 import type { Parser, ParserOptions } from 'prettier';
-import type { AstNode } from './slang-nodes';
+import type { AstNode } from './slang-nodes/index.js';
 
 export default function parse(
   text: string,

tests/format/AddressPayable/__snapshots__/format.test.js.snap

@@ -2,7 +2,7 @@
 
 exports[`AddressPayable.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang"]
+parsers: ["slang-solidity"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

tests/format/AddressPayable/format.test.js

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

tests/format/AllSolidityFeatures/__snapshots__/format.test.js.snap

@@ -2,7 +2,7 @@
 
 exports[`AllSolidityFeatures.sol format 1`] = `
 ====================================options=====================================
-parsers: ["slang"]
+parsers: ["slang-solidity"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

tests/format/AllSolidityFeatures/format.test.js

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

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

@@ -3,7 +3,7 @@
 exports[`AllSolidityFeatures.sol - {"compiler":"0.4.26"} format 1`] = `
 ====================================options=====================================
 compiler: "0.4.26"
-parsers: ["slang"]
+parsers: ["slang-solidity"]
 printWidth: 80
                                                                                 | printWidth
 =====================================input======================================

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

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