add library search functionality #21
Merged
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
added a commit
to Sindri-Labs/sindri-js
that referenced
this pull request
Jul 10, 2024
Circomspect added support for a `-L`/`--library` search path flag in analogy to Circom's `-l` argument (as of trailofbits/circomspect#21) that we use on the backend with defaults of the project root and the `node_modules` subdirectory. This PR updates the `sindri lint` command 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 with `sindri lint` in the meantime. For testing it manually, you can run ```bash docker compose up -d docker compose exec sindri-js bash ``` on the latest branch, change into a directory with one of our example Circom circuits that has been failing linting, and then run: ```bash sindri lint ``` to make sure that things work as expected. Merges #116 LGTM given by: @KPreisner
# 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.
Adds a new argument vector specified with
-Lor--libraryto either add a library file or directory.These "library paths" are then stored in the
FileStackand when the time comes to include a file, we first try to resolve the file relative to the current file (current behavior). if that fails, we try to resolve the include in the order the libraries were specified. if the specified library path is a directory, it appends the include path if it does not start with.(this is currently stricter than what circom does) because IMOinclude "./path"should be meant for local includes only. if the specified library path is a file, we check that the filename is the same as the include path, which should not contain any directory separators.i believe adding the library files to the
FileStackwill make the analysis aware of any templates inside, so if there is any additional work please let me know