Feature request: Allow to set the path for the plugins

[juanfranblanco]

Hi I hope you are all well,

Vscode is not able to load the plugins as these will not be packaged with the extension, to workaround this it will be ideal if a path could be passed to load the plugins together with the list of names.

solhint/lib/rules/index.js

Line 53 in 32ec781

const plugins = require(`solhint-plugin-${pluginName}`)

This is how it is handled in prettier.

Suggestion: The solhint.json file could include a path or allow to set this by the ide by setting the path to be the same as the current project node_modules.

Reference: juanfranblanco/vscode-solidity#169

[fvictorio]

Hi @juanfranblanco, sorry for not responding before. I'm not 100% sure I understand what would work for you. In the linked issue you suggest having a flag similar to prettier's --plugin-search-dir, is that correct? If we implement that, would that solve the issue for you?

[juanfranblanco]

Don't worry, responding issues is really hard and takes time.

You are right that is how it works with prettier. So the extension could do the usual magic of letting the user set it on the solhint file, in the extension user settings or if nothing is set, use the the default node_modules in the workspace.

This is how I have integrated with prettier if it helps:
https://github.com/juanfranblanco/vscode-solidity/blob/master/src/formatter/prettierFormatter.ts#L17-L18

[fvictorio]

I see, makes sense. Will try that approach then, thanks 👍

I guess you are using solhint as an executable binary, right? In version 3.0 we tried to also properly export it as a "library", so maybe you want to try this. That's not documented yet, but it's just:

const { processStr } = require('solhint')

processStr(source, config, filename)

Both config and filename are optional. In this case, I guess you'd pass the pluginSearchDirs options there.

[fvictorio]

Oh, and we should document what is returned by that function 🤦‍♂️ I'll try to do it when I have some time, but for the time being you can probably figure it out by inspecting it 😅 Let me know if you have any questions about that.

[juanfranblanco]

Solium is used as follows: https://github.com/juanfranblanco/vscode-solidity/blob/master/src/linter/solium.ts it was contributed by yourselves :). So all the integration is done internally.

[fvictorio]

This is solhint, not solium 😄

[juanfranblanco]

Oh my!! Sorry :)

[juanfranblanco]

@fvictorio it seems that we are having issues with extends too [solhint:recommended] will this be related, it used to work before.

[Jaime-Iglesias]

Any update on this issue ? I'd love to see custom plugins and the recommended rule set working on the extension :D

friendly ping @fvictorio

[fvictorio]

Not yet, hopefully this week.

[fvictorio]

Hey @juanfranblanco, could you try installing Solhint from github, using the plugin-search-dir branch, and see if this works for you?

You should call it like this:

processStr(solidityCode, config, {
  pluginSearchDir: '/path/to/dir'
})

Where solidityCode is a string with the code to lint, config is an object like the one in .solhint.json, and pluginSearchDir is the path to where the node_modules directory with the plugins is located. That means that you should use /path/to/plugins, not /path/to/plugins/node_modules.

[fvictorio]

I just did the same change for shareable configs (aka extends) too. Same branch, so you should be able to test it.

Of course, that means that pluginSearchDir is a bad name, I will think of something better (extensionsDir?), but first I want to see if it works 😄

[Jaime-Iglesias]

@juanfranblanco friendly ping