Add Solidity plugin #1405

lucaperret · 2021-11-04T22:38:07Z

Plugin Solidity

Adds support for Solidity's import statement.

See this solidity file as an example.
You should be able to click "./IERC721.sol" within import "./IERC721.sol"; and see that file.

Demo

Todo

Update packages/blob-reader fixture to add Solidity support on issues highlighted code?
Publish @octolinker/plugin-solidity npm package
Add export statement to the packages/core/load-plugins.js
Add @octolinker/plugin-solidity to packages/core/package.json

lucaperret · 2021-11-05T12:55:21Z

Hey @stefanbuck, not sure how to configure the TRAVIS_PULL_REQUEST_SLUG and TRAVIS_PULL_REQUEST_BRANCH env var to make the build action working. Could you please help here?

stefanbuck · 2021-11-05T13:39:25Z

This looks outdated, we don't use Travis anymore. It might due to the fact you run the tests from a fork and this might doesn't work. I'll have a closer look at your PR tonight.

xt0rted · 2021-11-05T15:09:27Z

@stefanbuck the e2e instructions are out dated https://github.com/OctoLinker/OctoLinker/tree/2b2c34147fc15099f8059fec0d3953eb8ef0cfa2/e2e#contribution

xt0rted · 2021-11-05T15:30:24Z

@lucaperret there's 2 things missing which is why the tests are failing. The plugin needs to be added to core/package.json and core/load-plugins.js. Once you do that you can use yarn start & yarn chrome-open to browse your test files and they should be linked (just verified it myself).

If you're using Node 17 the yarn scripts won't work without first adding set NODE_OPTIONS=--openssl-legacy-provider && to the beginning of them (this is if you're on Windows, it's similar for macOS & Linux).

lucaperret · 2021-11-05T15:52:40Z

@lucaperret there's 2 things missing which is why the tests are failing. The plugin needs to be added to core/package.json and core/load-plugins.js. Once you do that you can use yarn start & yarn chrome-open to browse your test files and they should be linked (just verified it myself).

If you're using Node 17 the yarn scripts won't work without first adding set NODE_OPTIONS=--openssl-legacy-provider && to the beginning of them (this is if you're on Windows, it's similar for macOS & Linux).

Locally I run the tests by adding the following code to the load-plugins.js file:

export { default as Solidity } from '../plugin-solidity';

As the package isn't published yet, I guessed I shouldn't add it the import as @octolinker/plugin-solidity same for the package.json.

xt0rted · 2021-11-05T16:03:11Z

These don't get published to npm, webpack will resolve them from the local folder when it bundles everything. These two changes are all you should need to make:

index 3199f3a..f5d9d3b 100644
--- a/packages/core/load-plugins.js
+++ b/packages/core/load-plugins.js
@@ -25,6 +25,7 @@ export { default as Ruby } from '@octolinker/plugin-ruby';
 export { default as Rust } from '@octolinker/plugin-rust';
 export { default as RustCargo } from '@octolinker/plugin-rust-cargo';
 export { default as Sass } from '@octolinker/plugin-sass';
+export { default as Solidity } from '@octolinker/plugin-solidity';
 export { default as TypeScript } from '@octolinker/plugin-typescript';
 export { default as Vim } from '@octolinker/plugin-vim';
 export { default as GitHubActions } from '@octolinker/plugin-github-actions';

diff --git a/packages/core/package.json b/packages/core/package.json
index 6c72b41..bbed834 100644
--- a/packages/core/package.json
+++ b/packages/core/package.json
@@ -43,6 +43,7 @@
     "@octolinker/plugin-rust": "1.0.0",
     "@octolinker/plugin-rust-cargo": "1.0.0",
     "@octolinker/plugin-sass": "1.0.0",
+    "@octolinker/plugin-solidity": "1.0.0",
     "@octolinker/plugin-typescript": "1.0.0",
     "@octolinker/plugin-vim": "1.0.0",
     "@octolinker/user-interface": "1.0.0",

xt0rted · 2021-11-05T16:38:35Z

packages/plugin-solidity/index.js

+  getPattern() {
+    return {
+      pathRegexes: [/\.sol$/],
+      githubClasses: ['type-solidity', 'highlight-source-solidity'],


@stefanbuck is the build failing because this is set but no example exists for it in /packages/blob-reader/fixtures/github.com/issue/code.html?

As far as I remember yes. This HTML is just the output from OctoLinker/testrepo#2. I added a solidity snippet at the end which should make this test pass. The fixture are updated on each CI run https://github.com/OctoLinker/OctoLinker/blob/main/packages/blob-reader/scripts/update-fixtures.sh. Just for debugging purpose we store the output within the repo. I'll take care of updating the fixture.

@stefanbuck you missed the ".sol" extension I think

@stefanbuck ~~without the .sol extension an exception is thrown.~~ Will the code snippet support even do anything with this plugin? I'm trying to test it but I'm not having any luck getting it to link anything for me.

Turns out my markdown was wrong, it throws an exception even with the .sol extension.

Using ```sol ... results in highlight-source-gerber. ```solidity ... results in highlight-source-solidity so this should work.

I'm not to fuzzy about adding those classes. The only purpose is to make linking in code snippets work. @lucaperret feel free to leave the githubClasses array empty

I would rather prefer to have it working on code snippet.

I need to look into this a bit closer. Unfortunately I don't have capability for this today, but I'll have a look tomorrow evening.

xt0rted · 2021-11-05T20:45:26Z

When testing a code snippet if the import starts with ./ I get the following exception:

app.js:37107 Uncaught (in promise) TypeError: Path must be a string. Received undefined
    at assertPath (app.js:37107)
    at dirname (app.js:37372)
    at __WEBPACK_DEFAULT_EXPORT__ (app.js:10584)
    at Object.resolve (app.js:10082)
    at app.js:7658
    at Array.forEach (<anonymous>)
    at __WEBPACK_DEFAULT_EXPORT__ (app.js:7650)
    at run (app.js:52853)
    at app.js:52893
    at gitHubInjection (app.js:22052)

I'm not really sure why that's happening though. If you remove the . it goes away so I guess it's something in the file resolver.

If the import is import "foo" then it resolves to https://github.com/jasonLaster/foo

lucaperret · 2021-11-05T20:55:45Z

Correct, the solidity import should start with "./" for relative path, and if not, it is a npm package.
@stefanbuck any idea to resolve the build action?

stefanbuck · 2021-11-07T21:05:59Z

When testing a code snippet if the import starts with ./ I get the following exception:

Looks like a regression introduced in an earlier version which seems to affect code snippets only. Code snippets are not covered by end to end tests. I tried updating all fixtures files but then the unit tests start failing. To make this PR pass I pushed just the fixture change for the code snippets.

stefanbuck · 2021-11-07T21:59:59Z

Thanks for your contribution @lucaperret As mentioned I’m going to look into the snippet issue and update the store version later this week.

lucaperret · 2021-11-24T10:55:40Z

Hey @stefanbuck, when are you planning to release OctoLinker with this feature?

stefanbuck · 2021-11-24T12:15:44Z

Thanks for the reminder. I wanted to fix the highlight issue we discovered first, but I'm maxed out with other things right now. Therefore maybe best to just ship it. I'm going to tackle this at some point this week (sorry my schedule is very tight).

lucaperret · 2021-12-02T07:20:26Z

If I can do anything to help you @stefanbuck feel free :)

stefanbuck · 2021-12-04T21:32:23Z

Hi @lucaperret, sorry for the delay I was off sick. I just created a new release which will be available very soon. Watch out for v6.10.0.

Thanks again for your contribution and taking the time adding Solidity support.

feat(plugins): add Solidity language

53487a7

fix(plugin-solidity): add import and dep on package.json

3381472

xt0rted reviewed Nov 5, 2021

View reviewed changes

lucaperret marked this pull request as draft November 5, 2021 20:04

feat(plugin-solidity): add npm resolver

b65d138

lucaperret marked this pull request as ready for review November 5, 2021 20:40

Update code snippet fixture

e1ba947

stefanbuck merged commit 486b00d into OctoLinker:main Nov 7, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Solidity plugin #1405

Add Solidity plugin #1405

lucaperret commented Nov 4, 2021 •

edited

Loading

lucaperret commented Nov 5, 2021

stefanbuck commented Nov 5, 2021

xt0rted commented Nov 5, 2021

xt0rted commented Nov 5, 2021

lucaperret commented Nov 5, 2021 •

edited

Loading

xt0rted commented Nov 5, 2021

xt0rted Nov 5, 2021

stefanbuck Nov 5, 2021

lucaperret Nov 5, 2021

xt0rted Nov 5, 2021 •

edited

Loading

stefanbuck Nov 5, 2021

stefanbuck Nov 5, 2021

lucaperret Nov 5, 2021

stefanbuck Nov 5, 2021

xt0rted commented Nov 5, 2021 •

edited

Loading

lucaperret commented Nov 5, 2021

stefanbuck commented Nov 7, 2021

stefanbuck commented Nov 7, 2021

lucaperret commented Nov 24, 2021

stefanbuck commented Nov 24, 2021

lucaperret commented Dec 2, 2021

stefanbuck commented Dec 4, 2021

Add Solidity plugin #1405

Add Solidity plugin #1405

Conversation

lucaperret commented Nov 4, 2021 • edited Loading

Plugin Solidity

Demo

Todo

lucaperret commented Nov 5, 2021

stefanbuck commented Nov 5, 2021

xt0rted commented Nov 5, 2021

xt0rted commented Nov 5, 2021

lucaperret commented Nov 5, 2021 • edited Loading

xt0rted commented Nov 5, 2021

xt0rted Nov 5, 2021

Choose a reason for hiding this comment

stefanbuck Nov 5, 2021

Choose a reason for hiding this comment

lucaperret Nov 5, 2021

Choose a reason for hiding this comment

xt0rted Nov 5, 2021 • edited Loading

Choose a reason for hiding this comment

stefanbuck Nov 5, 2021

Choose a reason for hiding this comment

stefanbuck Nov 5, 2021

Choose a reason for hiding this comment

lucaperret Nov 5, 2021

Choose a reason for hiding this comment

stefanbuck Nov 5, 2021

Choose a reason for hiding this comment

xt0rted commented Nov 5, 2021 • edited Loading

lucaperret commented Nov 5, 2021

stefanbuck commented Nov 7, 2021

stefanbuck commented Nov 7, 2021

lucaperret commented Nov 24, 2021

stefanbuck commented Nov 24, 2021

lucaperret commented Dec 2, 2021

stefanbuck commented Dec 4, 2021

lucaperret commented Nov 4, 2021 •

edited

Loading

lucaperret commented Nov 5, 2021 •

edited

Loading

xt0rted Nov 5, 2021 •

edited

Loading

xt0rted commented Nov 5, 2021 •

edited

Loading