ethereum
Add lint preventing EIP references in backticks
Many authors attempt to circumvent the EIP link requirements by putting EIP-XXXX in backticks (eg. `EIP-1234`.) This is bad form, and should be rejected.
Done! Be aware that we need to be careful to allow things like ERC20 or IERC7777 because they're interface names, but prevent EIP-7777 because that isn't valid code.
@SamWilsn I would love to work on this repo. Could you please assign me?
@Hari-Bombon we should give the user above a chance to work on this, since she asked first. #11 or #5 might be good candidates to try instead?
Hi @SamWilsn, I have added the lint rule but my test keeps failing. What do you think I'm doing wrong?
@VictoriaAde I'd need to see a bit more of your code (do you have a branch somewhere?) but if I had to guess, it looks like your src variable isn't a correctly formatted EIP document. It's missing the --- somewhere.
@SamWilsn I looked at what you said and now if I run cargo run or test, it will giving the below message.
<SOURCE>... I can't seem to figure out what the issue is.
Right, forgot about that. The project is divided into a few crates (aka packages):
eipwis at the root of the repository, and provides a command-line interface to the tool.eipw-preambleis a library that provides functions for parsing the preamble of EIPs (the stuff at the beginning of proposals between---lines.)eipw-lintis where the majority of the interesting code lives, including the lints themselves.eipw-lint-jsis the glue that connects to JavaScript, and will likely be uninteresting for this issue.
To run the tests for lints, you'll need to change directory into eipw-lint, and run the tests there:
cd eipw-lint
cargo test
Alternatively, you can run all the tests from the root directory:
cargo test --all
Regarding the <SOURCES>... message, the tool is asking for the file you'd like to check. For example:
cargo run -- ~/EIPs/EIPS/eip-3074.md