If "$HOME/.jq" is a file, it is sourced into the main program.
entries:
+ - title: "`import RelativePathString as NAME [<metadata>];`"
body: |
Imports a module found at the given path relative to a
the relative path string. The module's symbols are prefixed
with "NAME::".
- - title: "`import RelativePathString;`"
- body: |
-
- Imports a module found at the given path relative to a
- directory in a search path. A ".jq" suffix will be added to
- the relative path string. The module's symbols are imported
- into the caller's namespace as if the module's content had
- been included directly.
-
- - title: "`import RelativePathString as NAME <metadata>;`"
- body: |
-
- Imports a module found at the given path relative to a
- directory in a search path. A ".jq" suffix will be added to
- the relative path string. The module's symbols are prefixed
- with "NAME::".
-
- The metadata must be a constant jq expression. It should be
- an object with keys like "homepage" and so on. At this time
- jq only uses the "search" key/value of the metadata. The
- metadata is also made available to users via the `modulemeta`
- builtin.
+ The optional metadata must be a constant jq expression. It
+ should be an object with keys like "homepage" and so on. At
+ this time jq only uses the "search" key/value of the metadata.
+ The metadata is also made available to users via the
+ `modulemeta` builtin.
The "search" key in the metadata, if present, should have a
string or array value (array of strings); this is the search
path to be prefixed to the top-level search path.
- - title: "`import RelativePathString as $NAME;`"
+ - title: "`import RelativePathString [<metadata>];`"
body: |
- Imports a JSON file found at the given path relative to a
- directory in a search path. A ".json" suffix will be added to
- the relative path string. The file's data will be available
- as `$NAME::NAME`.
+ Imports a module found at the given path relative to a
+ directory in a search path as if it were included in place. A
+ ".jq" suffix will be added to the relative path string. The
+ module's symbols are imported into the caller's namespace as
+ if the module's content had been included directly.
+
+ The optional metadata must be a constant jq expression. It
+ should be an object with keys like "homepage" and so on. At
+ this time jq only uses the "search" key/value of the metadata.
+ The metadata is also made available to users via the
+ `modulemeta` builtin.
- - title: "`import RelativePathString as $NAME <metadata>;`"
+ - title: "`import RelativePathString as $NAME [<metadata>];`"
body: |
Imports a JSON file found at the given path relative to a
the relative path string. The file's data will be available
as `$NAME::NAME`.
- The metadata must be a constant jq expression. It should be
- an object with keys like "homepage" and so on. At this time
- jq only uses the "search" key/value of the metadata. The
- metadata is also made available to users via the `modulemeta`
- builtin.
+ The optional metadata must be a constant jq expression. It
+ should be an object with keys like "homepage" and so on. At
+ this time jq only uses the "search" key/value of the metadata.
+ The metadata is also made available to users via the
+ `modulemeta` builtin.
The "search" key in the metadata, if present, should have a
string or array value (array of strings); this is the search