SPICE-0005: Scheme-agnostic Projects #6
Conversation
Co-authored-by: Josh B <421772+HT154@users.noreply.github.com>
| ) | ||
| ---- | ||
|
|
||
| === Local Dependencies |
There was a problem hiding this comment.
Can I have non-file local dependency in my PklProject? Is not clear for me:
["fruit"] = import("modulepath:/fruit/PklProject")
Or as these changes just usable in the evaluator API, but not in the CLI?
There was a problem hiding this comment.
Will add some details here; local dependencies must be resolvable as relative path. This means same scheme, and same authority.
| Currently, paths that are prefixed with `@` _only_ have special meaning if declared within file-based, or package-based modules. | ||
| In these modules, this prefix is the marker of link:https://pkl-lang.org/main/current/language-reference/index.html#dependency-notation-uris[dependency notation]. | ||
| In all other modules, this symbol has no special meaning. | ||
| For example, in module `modulepath:/foo.pkl`, the import `@bar/bar.pkl` is resolved as `modulepath:/@bar/bar.pkl`. |
There was a problem hiding this comment.
I think it would be good to make an addendum here for modulepath:, as it's a special case because of multiple roots. Show an example using modulepath X, project root Y (with multiple roots) and import @Z, how would that be resolved.
There was a problem hiding this comment.
(summary from offline discussion)
This SPICE doesn't provide any changes to how modulepath works. With modulepath, local dependency, Z at path modulepath:/foo/bar, import "@Z/baz.pkl resolves to import modulepath:/foo/bar/baz.pkl. The meaning of modulepath:/foo/bar/baz.pkl is up to the modulepath resolver.
| 1. Instead of a "project directory", a project is identified by a base URI. | ||
| 2. Relative paths starting with `@` are _always_ treated as link:https://pkl-lang.org/main/current/language-reference/index.html#dependency-notation-uris[dependency notation], in all modules. | ||
|
|
||
| == Detailed design |
There was a problem hiding this comment.
I'm missing a table/list/etc detailing for a project defined using module key X what are the allowed module keys inside the dependencies.
I think right now if you import @foo/bar.pkl then bar.pkl can only import other projects (using @ or package://) or relative imports inside the project. If I now have a project defined with modulepath can I have modulepath: imports inside its dependencies?
There was a problem hiding this comment.
Summary from offline discussion: Projects/packages don't remove things that can be imported, they can only add to what can be imported. Even normal projects whose project dir is file: based can have an import modulepath:/ within its sources, and it still works today.
This adds changes to support loading project dependencies in non-file based projects. The design for this feature can be found in SPICE-0005: apple/pkl-evolution#6 Changes: * Consider all imports prefixed with `@` as dependency notation. * Bugfix: fix resolution of glob expressions in a local dependency. * Adjust pkl.Project: - Allow local dependencies from a scheme-local paths. - Disallow certain evaluator settings if not loaded as a file-based module. * Breaking API change: `ProjectDependenciesManager` constructor now requires `ModuleResolver` and `SecurityManager`.
Implementation: apple/pkl#486
Thanks to @HT154 for the groundwork here!