forked from extern/nushell
9d8845d7ad
Given we can write nu scripts. As the codebase grows, splitting into many smaller nu scripts is necessary.
In general, when we work with paths and files we seem to face quite a few difficulties. Here we just tackle one of them and it involves sourcing
files that also source other nu files and so forth. The current working directory becomes important here and being on a different directory
when sourcing scripts will not work. Mostly because we expand the path on the current working directory and parse the files when a source command
call is done.
For the moment, we introduce a `lib_dirs` configuration value and, unfortunately, introduce a new dependency in `nu-parser` (`nu-data`) to get
a handle of the configuration file to retrieve it. This should give clues and ideas as the new parser engine continues (introduce a way to also know paths)
With this PR we can do the following:
Let's assume we want to write a nu library called `my_library`. We will have the code in a directory called `project`: The file structure will looks like this:
```
project/my_library.nu
project/my_library/hello.nu
project/my_library/name.nu
```
This "pattern" works well, that is, when creating a library have a directory named `my_library` and next to it a `my_library.nu` file. Filling them like this:
```
source my_library/hello.nu
source my_library/name.nu
```
```
def hello [] {
"hello world"
}
```
```
def name [] {
"Nu"
end
```
Assuming this `project` directory is stored at `/path/to/lib/project`, we can do:
```
config set lib_dirs ['path/to/lib/project']
```
Given we have this `lib_dirs` configuration value, we can be anywhere while using Nu and do the following:
```
source my_library.nu
echo (hello) (name)
```
|
||
|---|---|---|
| .. | ||
| nu_plugin_binaryview | ||
| nu_plugin_chart | ||
| nu_plugin_fetch | ||
| nu_plugin_from_bson | ||
| nu_plugin_from_mp4 | ||
| nu_plugin_from_sqlite | ||
| nu_plugin_inc | ||
| nu_plugin_match | ||
| nu_plugin_post | ||
| nu_plugin_ps | ||
| nu_plugin_query_json | ||
| nu_plugin_s3 | ||
| nu_plugin_selector | ||
| nu_plugin_start | ||
| nu_plugin_sys | ||
| nu_plugin_textview | ||
| nu_plugin_to_bson | ||
| nu_plugin_to_sqlite | ||
| nu_plugin_tree | ||
| nu_plugin_xpath | ||
| nu-ansi-term | ||
| nu-cli | ||
| nu-command | ||
| nu-completion | ||
| nu-data | ||
| nu-engine | ||
| nu-errors | ||
| nu-json | ||
| nu-parser | ||
| nu-path | ||
| nu-plugin | ||
| nu-pretty-hex | ||
| nu-protocol | ||
| nu-serde | ||
| nu-source | ||
| nu-stream | ||
| nu-table | ||
| nu-test-support | ||
| nu-value-ext | ||
| README.md | ||
Nushell core libraries and plugins
These sub-crates form both the foundation for Nu and a set of plugins which extend Nu with additional functionality.
Foundational libraries are split into two kinds of crates:
- Core crates - those crates that work together to build the Nushell language engine
- Support crates - a set of crates that support the engine with additional features like JSON support, ANSI support, and more.
Plugins are likewise also split into two types:
- Core plugins - plugins that provide part of the default experience of Nu, including access to the system properties, processes, and web-connectivity features.
- Extra plugins - these plugins run a wide range of differnt capabilities like working with different file types, charting, viewing binary data, and more.