VSCode integration with remappings.txt

[douglasqian]

Component

Forge

Have you ensured that all of these are up to date?

• Foundry
• Foundryup

What version of Foundry are you on?

forge 0.2.0 (2457e5f 2022-06-16T00:04:29.19997Z)

What command(s) is the bug in?

No response

Operating System

macOS (Intel)

Describe the bug

Context

Been others report this issue on the support Telegram as well, and it doesn't seem like there is a great resolution beyond what is covered in this page (which most seem to have already tried):
https://book.getfoundry.sh/config/vscode.html

VSCode doesn't seem to be picking up what I have defined in remappings.txt.

Not a blocker because I can still run forge build and forge test just fine, but wondering if there is something I'm missing here.

Other config files

Using v0.0.139 (latest) of Juan Blanco's Solidity VSC extension

This is what my remappings.txt looks like:

ds-test/=lib/forge-std/lib/ds-test/src/
forge-std/=lib/forge-std/src/
@openzeppelin/=lib/openzeppelin-contracts/

This is what my foundry.toml looks like:

[default]
src = 'src'
out = 'out'
libs = ['lib']
solc_version = "0.8.10"

# See more config options https://github.com/foundry-rs/foundry/tree/master/config

This is what my VSC settings.json looks like:

{
    "solidity.defaultCompiler": "remote",
    "solidity.compileUsingRemoteVersion": "v0.8.10",
    "solidity.packageDefaultDependenciesContractsDirectory": "src",
    "solidity.packageDefaultDependenciesDirectory": "lib",
    "solidity.remappings": ["forge-std/=lib/forge-std/src/", "@openzeppelin/=lib/openzeppelin-contracts/"]
}

That last line I decided to add because I saw someone recommend it on the support Telegram but the problem persists.

Any help would be much appreciated! Thanks!

[Elyx0]

Does it go away with "solidity.defaultCompiler": "localNodeModule", ? with solc in devDependencies of the package.json ?

[onbjerg]

Try removing src and lib, as the docs state:

If you use a non-standard project layout, you may have to add the following to your .vscode/settings.json:

I don't remember who wrote the original docs for the VSCode integration, but going by the VSCode Solidity extension docs, these two settings are for something else and might overwrite remappings.txt.

Also make sure that the remappings.txt is in the root of your project.

(Also marking this as a question since there isn't really anything we can do to make this integration better other than using npm for packages, which you can already do)

[douglasqian]

@onbjerg Commenting out those 2 lines did the trick! Maybe y'all could look into updating that foundry book page because the way it's phrased right now is quite confusing. Anyways, thanks for the help. Here's what my .vscode/settings.json looks like now:

{
    "editor.formatOnSave": true,
    "solidity.formatter": "prettier",
    "solidity.defaultCompiler": "localFile",
    "solidity.compileUsingRemoteVersion": "v0.8.10",
    "solidity.compileUsingLocalVersion": "/Users/dzq/spirals/soljson-v0.8.10+commit.fc410830.js",
    // "solidity.packageDefaultDependenciesContractsDirectory": "src",
    // "solidity.packageDefaultDependenciesDirectory": "lib",
    "git.ignoreLimitWarning": true
}

[alexbakers]

Afret commenting 2 lines:

@douglasqian Do you have such a problem?

[alexbakers]

Solution.

% tree . -d -L 4

.
└── packages
    └── foundry
        ├── lib
        │   ├── forge-std
        │   └── openzeppelin-contracts
        ├── script
        ├── src
        └── test

% cat remappings.txt

ds-test/=lib/forge-std/lib/ds-test/src/
forge-std/=lib/forge-std/src/
@openzeppelin/=lib/openzeppelin-contracts/

The path is relative to the project folder lib/, not the root packages/foundry/lib/

...
  "solidity.remappings": [
    "@openzeppelin/=packages/foundry/lib/openzeppelin-contracts/",
    "ds-test/=packages/foundry/lib/forge-std/lib/ds-test/src/",
    "forge-std/=packages/foundry/lib/forge-std/src/"
  ],
...

The path is relative to the root packages/foundry/lib/, not the project folder lib/

[SkyYap]

I have face this same issue after forge init contract --no-git and forge install OpenZeppelin/openzeppelin-contracts --no-git. I didn't add any vscode/settings.json file.

Here's the first step:

Add forge remappings > remappings.txt. Then you will have these in your remappings.txt file

ds-test/=lib/forge-std/lib/ds-test/src/
erc4626-tests/=lib/openzeppelin-contracts/lib/erc4626-tests/
forge-std/=lib/forge-std/src/
openzeppelin-contracts/=lib/openzeppelin-contracts/

Add this @openzeppelin/=lib/openzeppelin-contracts/ below. Make it like this:

ds-test/=lib/forge-std/lib/ds-test/src/
erc4626-tests/=lib/openzeppelin-contracts/lib/erc4626-tests/
forge-std/=lib/forge-std/src/
openzeppelin-contracts/=lib/openzeppelin-contracts/
@openzeppelin/=lib/openzeppelin-contracts/

Then run command touch remappings.txt and reload the VSC. Solved.