feat: barebones dependency conversion

[0xteddybear]

merge after #58

closes #60

adding support for git dependencies means we'll probably also support projects where the dependencies are not explicitly stated in remappings.txt, the build instead relying on foundry's implicit remappings. To fully handle those cases, this project should invoke forge remappings instead of reading remappings.txt

TODO

• convert dependencies
  • do so robustly -- se gitmodules parsing below
• replace lib similarly to node_modules in transformRemappings

.gitmodules parsing

I tried to use the ini npm package since .gitmodules seem to be .ini files, but didn't behave as expected.

It didn't recognize the various path and url fields as part of the relevant submodule subsections, instead assignig them as items of submodule, so after parsing an entire file only the last two remained:

[submodule foo]
  path=foo
  url=http://foo
[submodule bar]
  path=bar
  url=http://bar

would yield

{
  path: bar,
  url: http://bar
}

The current implementation works for machine-generated .gitmodules, but will break if a subseciton is populated in two passes like so:

[submodule foo]
  path=foo
[submodule bar]
  path=bar
  url=http://bar
[submodule foo]
  url=http://foo

or if path and url are out of order (which is perfectly valid for git)

[submodule foo]
  url=http://foo
  path=foo

and probably other cases that are syntactically valid ini, and sematically valid submodule definitions, but that dont match my arbitrary regex

I deem this good enough for now, specially considering we are doing the same problematic regex-parsing for solidity files

[0xOneTony]

LGTM!

[0xOneTony]

Maybe worth also having a case where the gitmodules exist but is not in the format we expect it

[0xteddybear]

added them in 52b257b

[0xDiscotech]

If is not, shouldn't it throw an error describing the issue?
I see this as a NTH tho

[0xteddybear]

52b257b
added a test for a valid .gitmodules that breaks it, but am not explicitly throwing an error in that case, as figuring out if the precondition is met or not would involve extra logic

[0xDiscotech]

Approved with a comment, agreed with Tony that would be nice to cover the case where the submodules file contains a different format than what we are expecting.

Nice one!

[gas1cent]

I've tried running the tests locally and got the following output. Looks like the file mock doesn't work, because creating the remappings.txt file manually results in the output containing different errors. I'm on a mac, using node v22 if that helps.

1) parseGitmodulesDependencies
      with a file with several dependencies
        should be able to parse them:
    AssertionError: expected undefined to equal 'https://github.com/foundry-rs/forge-s…'
    at Context.<anonymous> (test/unit/parseGitmodulesDependencies.spec.ts:47:50)
    at processImmediate (node:internal/timers:491:21)

2) parseGitmodulesDependencies
      with a file with extra (valid) keys besides path and url
        should be able to parse them:
    AssertionError: expected undefined to equal 'https://github.com/foundry-rs/forge-s…'
    at Context.<anonymous> (test/unit/parseGitmodulesDependencies.spec.ts:72:50)
    at processImmediate (node:internal/timers:491:21)

3) transformRemappings
      should leave unrelated imports alone:
    AssertionError: expected '' to include 'import \'./Contract.sol\';'
    at Context.<anonymous> (test/unit/transformRemappings.spec.ts:161:35)
    at processImmediate (node:internal/timers:491:21)

4) transformRemappings
      should leave unrelated statements alone:
    AssertionError: expected '' to include '// import \'./Contract.sol\';'
    at Context.<anonymous> (test/unit/transformRemappings.spec.ts:178:35)
    at processImmediate (node:internal/timers:491:21)

5) transformRemappings
      with remapping for local file only
        should replace remapped path if its not at the beggining of string:
    AssertionError: expected '' to include 'import \'../../../../interfaces/ITest…'
    at Context.<anonymous> (test/unit/transformRemappings.spec.ts:29:37)
    at processImmediate (node:internal/timers:491:21)

6) transformRemappings
      with remapping for local file only
        should replace path as instructed by remapping with all import syntaxes:
    AssertionError: expected '' to include 'import \'../../interfaces/ITest.sol\';'
    at Context.<anonymous> (test/unit/transformRemappings.spec.ts:48:37)
    at processImmediate (node:internal/timers:491:21)

7) transformRemappings
      with remapping for local file only
        should remove node_modules from import paths:
    AssertionError: expected '' to include 'import \'some-package/Contract.sol\';'
    at Context.<anonymous> (test/unit/transformRemappings.spec.ts:72:37)
    at processImmediate (node:internal/timers:491:21)

8) transformRemappings
      with remapping for path inside node_modules
        should apply remapping and then remove node_modules from path:
    AssertionError: expected '' to include 'import {FixedPointMathLib} from \'sol…'
    at Context.<anonymous> (test/unit/transformRemappings.spec.ts:106:37)
    at processImmediate (node:internal/timers:491:21)

9) transformRemappings
      with remapping for path inside lib/
        should apply remapping and then remove lib from path:
    AssertionError: expected '' to include 'import {FixedPointMathLib} from \'sol…'
    at Context.<anonymous> (test/unit/transformRemappings.spec.ts:137:37)
    at processImmediate (node:internal/timers:491:21)

[0xOneTony]

Why are some tests being skipped?

[0xteddybear]

to acknowledge, yet thoroughly document the limitations of the current implementation. Example of a previous discussion: #58 (comment)

This test in particular was added to document the consequences of not doing proper git-config format parsing (I couldn't find an existing implementation, and the generic .ini parser in npm was not enough either)

[0xteddybear]

@gas1cent

using node v22

oh, sorry I didn't add it in the description, the file mocking lib works only on node versions <=18 , that is actually the blocker for #57 , which I will get to at a later time 😬

[0xDiscotech]

Tests passed using 18 as node version. Nicely done ser!