[TODO] getCurrentPkgDir: Returns the path to the closest enclosing nimble package dir

[timotheecour]

getCurrentPkgDir(dir), getCurrentPkgDir(): Returns the path to the closest enclosing nimble package dir.

This enables referring to current nimble package without interference from potential other nimble packages already installed with same name (eg a different version).

Suppose we have a nimble package (ie containing /pathto/nim-myjester/jester.nimble)
in /pathto/nim-myjester/bar/baz.nim:

import os
proc main()=
  static: doAssert getCurrentPkgDir() == "/pathto/nim-myjester"
  static: doAssert getCurrentPkgDir("/pathto/nim-myjester/bar/baz.nim") == "/pathto/nim-myjester"
main()

example use cases

# reliable way to access a specific file inside a nimble package regardless of where calling module is located inside nimble pkg
const file = getCurrentPkgDir() / "foo.txt"
# in combination with https://github.com/nim-lang/Nim/pull/10527:
importInterp getCurrentPkgDir() / "foo/bar"

note:

added [backport] as I'd like to have this in next release (19.6) in case there's such a release

[Araq]

This enables referring to current nimble package without interference from potential other nimble packages already installed with same name (eg a different version).

I don't see how this interference could happen. We have nimble develop and well, versions, a build should use the latest version. But let's assume the interference does happen. Is this a feature patching over a Nimble bug/misdesign? Do we then go on and add a tiny flag to getCurrentPkgDir() later? Or maybe getNimblePkgDir("jester")? I mean, it enables a feature, can't be bad right...

[Araq]

Rejected. New features should have an RFC anyway.