Slang 0.18.3 #1056

Janther · 2024-10-23T01:03:26Z

adding support for slang v0.18.0 and WebAssembly.

Main changes:

adapting to small changes in the slang API
dropping (temporarily hopefully) support for UMD
bundling an esm package
removing all the use of the slang AST that is not necessary

- update module resolution to NodeNext needed by slang - update all imports to slang to the latest one - update all import type to include the extension - TerminalNode#text is no longer available so we are using TerminalNode.unparse() instead. - renamed ABICoderPragma to AbicoderPragma

- using provided `asNonterminalNode` method instead of manually casting the tree. - using Parser instead of Language - some accessors became methods and some methods became accessors - using isNodeTerminal() since Node.type was removed - cst.children used to return Node[], now it returns Edge[]

…r is preserved.

…ettier/standalone to the developer

…rettier's version

OmarTawfik · 2024-10-29T12:34:39Z

src/printer.js

@@ -23,18 +23,8 @@ const warnDeprecation = once(() => {
  return true;
 });


If this PR is explicitly dropping support for v2, I wonder if this should be kept, specifying 3.0.0 instead?

Same question for src/slangPrinter.ts

prettier 2.2.X would still load the plugin and fail miserably when using it, so we needed the check for >=2.3.0 to show the reasons why it was failing.
Now prettier 2.X.X won't even load the plugin so the code will never reach this code.
there is a check in peerDependencies in package.json and I'll add this info on the readme.

OmarTawfik · 2024-10-29T12:39:40Z

tests/config/get-plugins.js

+  const prettier = await getPrettier();
+
+  const prettierPath = path.dirname(require.resolve("prettier"));
+  const pluginPrefix = satisfies(prettier.version, "^2.3.0")


remaining v2 support. I wonder if it should be removed?

Same question for src/common/backward-compatibility.js

yes. thanks for finding this.

OmarTawfik · 2024-10-29T12:43:01Z

tests/unit/slang-utils/create-parser.test.js

    });
  }

-  test('should throw an error if there are incompatible ranges', function () {
+  test.skip('should throw an error if there are incompatible ranges', function () {


this test is skipped. not sure if that was intended?

It's intended to be skipped for now.

before we were joining pragma versions into a single string and it was straight forward to find an inconsistency, but as you pointed out, there are some edge cases where this approach leads to an error. Now we evaluate each pragma version against slang's supported versions, and now an incompatibility in the pragma versions is no different from an eager developer chasing to use the latest solidity release which might not be supported by slang just yet but with a syntax fully supported by slang.

so we might choose to remove this test as it might not be a responsibility of prettier-solidity or we will have to add extra steps in the version inference to double check for the validity of the pragmas.

OmarTawfik · 2024-10-29T12:56:11Z

src/slang-utils/create-parser.ts

+}
+
+function tryToCollectPragmas(text: string, version: string): string[] {
+  const language = Parser.create(version);


suggestion to remove the need for the extra dependency, and to be able to handle things like newlines/other corner cases:

const fileCursor = parser.parse(NonterminalKind.SourceUnit, source).createTreeCursor(); const values = []; while (fileCursor.goToNextNonterminalWithKind(NonterminalKind.VersionExpressionSets)) { const versionCursor = fileCursor.spawn(); let value = ""; while (versionCursor.goToNextTerminal()) { const terminal = versionCursor.node.asTerminalNode()!; if (TerminalKindExtensions.isTrivia(terminal.kind)) { value += " "; // to break up any possible consecutive identifiers } else { value += terminal.unparse(); } } values.push(value); }

I tried using this and tests aren't passing.
I suspect this is happening when there are no pragmas and the syntax is old.

That syntax node should be consistent across all Solidity versions:
https://nomicfoundation.github.io/slang/0.18.3/solidity-specification/01-file-structure/03-pragma-directives/#VersionExpressionSets

I wonder if you have a commit # I can try out? Happy to help if I can debug the failure..

OmarTawfik · 2024-10-29T13:03:36Z

package.json

@@ -1,18 +1,27 @@
 {


I wonder if we have integration tests that run this inside a browser?
I see that the README.md says _Disabled during v2.0.0-beta_. Is this correct?

We were running all of our tests in a virtual empty javascript context. But had to drop it because it wouldn't load wasm files and that configuration was design for commonjs.
I'll research adding an integration test with a browser. karma seems to be deprecated now.

I'll update the Readme

I've used puppeteer before for CI testing, and IIRC, you can load an .html in-memory and just query the elements there.

OmarTawfik

Left a few suggestions/question. Thank you! 🚀🚀

Janther added 23 commits October 9, 2024 20:02

cleaning extra new lines

82b16e6

updating dependencies

5ce0db0

Update import statements for slang-comments

430a85d

Update import statements for slang-printers

b1a2d9d

Update import statements for slang-utils

fd25110

updating webpack config and dependencies

81e45dc

updating ts

64785ca

using strip-comments

6d500e4

cleaned up infer-language based on Omar's feedback

22a22d7

webpack configuration for 'es'

5c698b5

standalone tests

f6223bd

updating dependencies

970494c

removing export: 'default' from configuration

9b5cdbf

solc tests

209064d

avoid using the ast more than once since we can't ensure the pointe…

a7e0dcb

…r is preserved.

pre-load plugins in standalone

e800d69

since we moved to esm we no longer need proxyquire

98e151a

dropping umd for integration testing

7fc3f84

enablig CI standalone testing

e20dc6c

add esmock to standalone testing

368c18f

supporting prettier/standalone for old versions of prettier in test app

977a284

Janther force-pushed the slang-0.18.0 branch from a1f98c7 to 977a284 Compare October 23, 2024 02:35

Janther added 3 commits October 23, 2024 15:40

using prettier in the bundle and passing the responsibility to use pr…

d9bafa3

…ettier/standalone to the developer

loading prettier/standalone.js directly in tests when we can't know p…

ba684a1

…rettier's version

using the last version of slang

7208bf1

Janther force-pushed the slang-0.18.0 branch from 0019dab to 7208bf1 Compare October 27, 2024 10:42

Janther added 2 commits October 28, 2024 21:22

dropping support for prettier v2

0694945

node 16 doesn't finish jest properly in CI

550d147

Janther force-pushed the slang-0.18.0 branch from 0d653e2 to 550d147 Compare October 28, 2024 08:50

Janther changed the title ~~Slang 0.18.2~~ Slang 0.18.3 Oct 28, 2024

Janther added 2 commits October 29, 2024 13:34

removing unnecessary else-if

bf03386

updating dependencies

f6c9016

Janther requested a review from fvictorio October 29, 2024 04:58

OmarTawfik reviewed Oct 29, 2024

View reviewed changes

Janther force-pushed the slang-0.18.0 branch 2 times, most recently from 87a3d86 to a1a6198 Compare October 30, 2024 01:42

Janther added 2 commits October 30, 2024 14:51

addressing suggestions by Omar

8333c24

not using sandbox anymore

a173756

Janther force-pushed the slang-0.18.0 branch from a1a6198 to a173756 Compare October 30, 2024 01:52

Janther added 3 commits October 30, 2024 16:33

rename index.d.ts to types.d.ts

643439e

dropping support for prettier v2 parser function signature

6f112bc

strip-comments must be a dependency

5f2e2e2

OmarTawfik approved these changes Oct 30, 2024

View reviewed changes

loading properly in the browser

a0316e5

Janther merged commit 1cf3dfd into v2 Nov 2, 2024
7 checks passed

Janther deleted the slang-0.18.0 branch November 2, 2024 10:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Slang 0.18.3 #1056

Slang 0.18.3 #1056

Janther commented Oct 23, 2024

OmarTawfik Oct 29, 2024 •

edited

Loading

Janther Oct 29, 2024

OmarTawfik Oct 29, 2024

Janther Oct 29, 2024

OmarTawfik Oct 29, 2024

Janther Oct 29, 2024

OmarTawfik Oct 29, 2024

Janther Oct 30, 2024 •

edited

Loading

OmarTawfik Oct 30, 2024 •

edited

Loading

OmarTawfik Oct 29, 2024

Janther Oct 29, 2024

OmarTawfik Oct 30, 2024

OmarTawfik left a comment

		@@ -23,18 +23,8 @@ const warnDeprecation = once(() => {
		return true;
		});

Slang 0.18.3 #1056

Slang 0.18.3 #1056

Conversation

Janther commented Oct 23, 2024

OmarTawfik Oct 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Janther Oct 30, 2024 • edited Loading

Choose a reason for hiding this comment

OmarTawfik Oct 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OmarTawfik left a comment

Choose a reason for hiding this comment

OmarTawfik Oct 29, 2024 •

edited

Loading

Janther Oct 30, 2024 •

edited

Loading

OmarTawfik Oct 30, 2024 •

edited

Loading