Mirrors/nushell
2
0
Fork 0
mirror of https://github.com/nushell/nushell synced 2024-12-27 05:23:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

nu-cmd-lang readme (#9446)

Browse source 
Add a Readme file to the crate nu-cmd-lang to better explain what this
crate is about.
This commit is contained in:
Michael Angerman 2023-06-15 08:45:23 -07:00 committed by GitHub
parent b072d75300
commit e09d482fb7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
crates/nu-cmd-lang/README.md Normal file
View file

@ -0,0 +1,22 @@
# nu-cmd-lang
## the base language and command crate of nu
The commands in this crate are the *core commands* of the nu language.
It is also the base crate upon which all other command crates sit on
top of including:
* nu-command
* nu-cli
* nu-cmd-dataframe
* nu-cmd-extra
As time goes on and the nu language develops further in parallel with nushell we will be adding other command crates to the system.
### What does it mean to be a base crate ?
A base crate is one with minimal dependencies in our system so that other developers can come along and use this crate without having a lot of baggage in terms of other crates which will bloat their underlying application.
### Background on nu-cmd-lang
This crate was designed to be a small, concise set of tools or commands that serve as the *foundation layer* of both nu and nushell. These are the core commands needed to have a nice working version of the *nu language* without all of the support that the other commands provide inside nushell. Prior to the launch of this crate all of our commands were housed in the crate *nu-command*. Moving forward we would like to *slowly* break out the commands in nu-command into different crates; the naming and how this will work and where all the commands will be located is a "work in progress" especially now that the *standard library* is starting to become more popular as a location for commands. As time goes on some of our commands written in rust will be migrated to nu and when this happens they will be moved into the *standard library*.