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

Start documenting breaking changes

Browse source
This commit is contained in:
Jakub Žádník 2021-12-13 12:14:03 +02:00 committed by GitHub
parent 906c0e6bca
commit 486f91e3a7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/Beaking_Changes.md Normal file
View file

@ -0,0 +1,15 @@
# Beaking Changes
This file attempts to list all breaking changes that came with the new engine update.
## Variable Name Changes
* `$nu.home-dir` is now called `$nu.home-path`
* `$nu.temp-dir` is now called `$nu.temp-path`
* All config is now contained within `$config` which can be initialized by `config.nu`. There is no `config.toml` anymore.
## `main` Command in Scripts
If the script contains `main` it will be ran after all the script is executed.
It also accepts arguments from the command line.
You can run it like this: `nu foo.nu arg1 --flag` of if the script contains a hashbang line (`#!/usr/bin/env nu`): `./foo.nu arg1 --flag`.