Set default circomspect library paths when versions allow #116
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sangaline
commented
Jul 8, 2024
| @@ -32,6 +32,7 @@ const currentDirectoryPath = path.dirname(currentFilePath); | |||
| */ | |||
| export function checkCommandExists(command: string): Promise<boolean> { | |||
| return new Promise((resolve) => { | |||
| // TODO: Circomspect doesn't support this argument, so this will always fail for that command. | |||
There was a problem hiding this comment.
This is an unrelated bug, I'll make a followup ticket.
sangaline
commented
Jul 8, 2024
| @@ -130,7 +131,10 @@ export async function execCommand( | |||
| `"${process.env.SINDRI_FORCE_DOCKER}".`, | |||
| ); | |||
| } else if (await checkCommandExists(command)) { | |||
| logger?.debug(`Executing the "${command}" command locally.`); | |||
| logger?.debug( | |||
| { args, command }, | |||
There was a problem hiding this comment.
This and below are just making the logging more useful by including the command arguments.
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Circomspect added support for a
-L/--librarysearch path flag in analogy to Circom's-largument (as of trailofbits/circomspect#21) that we use on the backend with defaults of the project root and thenode_modulessubdirectory. This PR updates thesindri lintcommand to check whether the current Circomspect version supports the argument, and then to specify the same search paths if the argument is supported. We'll probably end up making the search paths configurable, but this makes the backend consistent withsindri lintin the meantime.For testing it manually, you can run
docker compose up -d docker compose exec sindri-js bashon the latest branch, change into a directory with one of our example Circom circuits that has been failing linting, and then run:
to make sure that things work as expected.