Support for the Yul language

Author: Janther

README.md

@@ -109,15 +109,26 @@ The following is the default configuration internally used by this plugin.
   "plugins": ["prettier-plugin-solidity"],
   "overrides": [
     {
-      "files": "*.sol",
+      "files": ["*.sol", "*.yul"],
       "options": {
-        "parser": "slang",
         "printWidth": 80,
         "tabWidth": 4,
         "useTabs": false,
         "singleQuote": false,
         "bracketSpacing": false,
       }
+    },
+    {
+      "files": "*.sol",
+      "options": {
+        "parser": "slang"
+      }
+    },
+    {
+      "files": "*.yul",
+      "options": {
+        "parser": "slang-yul"
+      }
     }
   ]
 }

src/index.ts

@@ -6,6 +6,7 @@ import options from './options.js';
 import antlrParse from './parser.js';
 import antlrPrint from './printer.js';
 import slangParse from './slangSolidityParser.js';
+import yulParse from './slangYulParser.js';
 import slangPrint from './slangPrinter.js';
 import { isBlockComment, isComment } from './slang-utils/is-comment.js';
 import { locEnd, locStart } from './slang-utils/loc.js';
@@ -19,6 +20,7 @@ import type {
 import type { AstNode } from './slang-nodes/types.d.ts';
 
 const slangParserId = 'slang';
+const slangYulParserId = 'slang-yul';
 const antlrParserId = 'antlr';
 const slangAstId = 'slang-ast';
 const antlrAstId = 'antlr-ast';
@@ -34,6 +36,15 @@ const languages: SupportLanguage[] = [
     extensions: ['.sol'],
     parsers: [slangParserId, antlrParserId],
     vscodeLanguageIds: ['solidity']
+  },
+  {
+    linguistLanguageId: 237469033,
+    name: 'Yul',
+    aceMode: 'text',
+    tmScope: 'source.yul',
+    extensions: ['.yul'],
+    parsers: [slangYulParserId],
+    vscodeLanguageIds: ['yul']
   }
 ];
 
@@ -45,9 +56,16 @@ const slangParser: Parser<AstNode> = {
   locStart,
   locEnd
 };
+const yulParser: Parser<AstNode> = {
+  astFormat: slangAstId,
+  parse: yulParse,
+  locStart,
+  locEnd
+};
 
 const parsers = {
   [slangParserId]: slangParser,
+  [slangYulParserId]: yulParser,
   [antlrParserId]: antlrParser
 };
 

src/slangYulParser.ts

@@ -0,0 +1,40 @@
+// https://prettier.io/docs/en/plugins.html#parsers
+import { YulBlock as SlangYulBlock } from '@nomicfoundation/slang/ast';
+import { NonterminalKind } from '@nomicfoundation/slang/cst';
+import { Parser } from '@nomicfoundation/slang/parser';
+import { LanguageFacts } from '@nomicfoundation/slang/utils';
+import { coerce } from 'semver';
+import { clearOffsets } from './slang-utils/metadata.js';
+import { YulBlock } from './slang-nodes/YulBlock.js';
+
+import type { ParserOptions } from 'prettier';
+import type { AstNode } from './slang-nodes/types.d.ts';
+
+export default function parse(
+  text: string,
+  options: ParserOptions<AstNode>
+): AstNode {
+  // const [parser, parseOutput] = createParser(text, options);
+  const compiler = coerce(options.compiler);
+  const supportedVersions = LanguageFacts.allVersions();
+
+  const parser = Parser.create(
+    compiler && supportedVersions.includes(compiler.version)
+      ? compiler.version
+      : supportedVersions[supportedVersions.length - 1]
+  );
+
+  const parseOutput = parser.parseNonterminal(NonterminalKind.YulBlock, text);
+
+  if (parseOutput.isValid()) {
+    // We update the compiler version by the inferred one.
+    options.compiler = parser.languageVersion;
+    const parsed = new YulBlock(
+      new SlangYulBlock(parseOutput.tree.asNonterminalNode()),
+      options
+    );
+    clearOffsets();
+    return parsed;
+  }
+  throw new Error(parseOutput.errors()[0].message);
+}

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

@@ -0,0 +1,74 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`example1.yul format 1`] = `
+====================================options=====================================
+parsers: ["slang-yul"]
+printWidth: 80
+                                                                                | printWidth
+=====================================input======================================
+{
+    function power(base, exponent) -> result
+    {
+        switch exponent
+        case 0 { result := 1 }
+        case 1 { result := base }
+        default
+        {
+            result := power(mul(base, base), div(exponent, 2))
+            switch mod(exponent, 2)
+                case 1 { result := mul(base, result) }
+        }
+    }
+}
+=====================================output=====================================
+{
+    function power(base, exponent) -> result {
+        switch exponent
+        case 0 {
+            result := 1
+        }
+        case 1 {
+            result := base
+        }
+        default {
+            result := power(mul(base, base), div(exponent, 2))
+            switch mod(exponent, 2)
+            case 1 {
+                result := mul(base, result)
+            }
+        }
+    }
+}
+================================================================================
+`;
+
+exports[`example2.yul format 1`] = `
+====================================options=====================================
+parsers: ["slang-yul"]
+printWidth: 80
+                                                                                | printWidth
+=====================================input======================================
+{
+      function power(base, exponent) -> result
+     {
+        result := 1 for { let i := 0 } lt(i, exponent) { i := add(i, 1) }
+        {
+            result    :=   mul(result,   base)
+        }
+    }
+}
+=====================================output=====================================
+{
+    function power(base, exponent) -> result {
+        result := 1
+        for {
+            let i := 0
+        } lt(i, exponent) {
+            i := add(i, 1)
+        } {
+            result := mul(result, base)
+        }
+    }
+}
+================================================================================
+`;

tests/format/Yul/example1.yul

@@ -0,0 +1,14 @@
+{
+    function power(base, exponent) -> result
+    {
+        switch exponent
+        case 0 { result := 1 }
+        case 1 { result := base }
+        default
+        {
+            result := power(mul(base, base), div(exponent, 2))
+            switch mod(exponent, 2)
+                case 1 { result := mul(base, result) }
+        }
+    }
+}

tests/format/Yul/example2.yul

@@ -0,0 +1,9 @@
+{
+      function power(base, exponent) -> result
+     {
+        result := 1 for { let i := 0 } lt(i, exponent) { i := add(i, 1) }
+        {
+            result    :=   mul(result,   base)
+        }
+    }
+}

tests/format/Yul/format.test.js

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