tonydamage/nux-env
1
1
Fork 0
mirror of https://github.com/tonydamage/nux-env.git synced 2025-12-11 13:24:28 +01:00
Code Issues 19 Releases Wiki Activity

nuxfs: Added some doc details.

Browse source 
Signed-off-by: Tony Tkacik <tonydamage@gmail.com>
This commit is contained in:
Tony Tkáčik 2017-06-21 15:12:31 +02:00
parent 0b48a2c851
commit 1d3fd0b3c3
1 changed files with 23 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

28
bin/nuxfs
View file

@ -26,13 +26,15 @@
## ln -s github/nux-env/bashrc .bashrc ## ln -s github/nux-env/bashrc .bashrc
## ##
nux.use nux.dsl
nux.use nuxfs
local WORKDIR=$(pwd) local WORKDIR=$(pwd)
local TEMPLATE_DIR=$NUX_ENV_DIR/templates local TEMPLATE_DIR=$NUX_ENV_DIR/templates
local SUFFIX=".nuxfs" local SUFFIX=".nuxfs"
local TEMPLATE_FILTER="*$SUFFIX" local TEMPLATE_FILTER="*$SUFFIX"
nux.use nux.dsl
nux.use nuxfs
GIT_BIN=$(which git) GIT_BIN=$(which git)
@ -43,8 +45,8 @@ GIT_BIN=$(which git)
## Verifies that directories and files matches the specification ## Verifies that directories and files matches the specification
## in *.nuxfs* definition ## in *.nuxfs* definition
### ###
### Check is non-descructive operation, whose only output is printing out ### Check is non-descructive operation, whose only output is printing
### information ### files violating nuxfs definition.
task.check() { task.check() {
nuxfs.dsl.process "$@"; nuxfs.dsl.process "$@";
} }
@ -57,15 +59,31 @@ task.describe() {
## Creates missing files as specified in *.nuxfs* definition. ## Creates missing files as specified in *.nuxfs* definition.
## **DOES NOT MODIFY** existing files breaking specification. ## **DOES NOT MODIFY** existing files breaking specification.
## ##
### Keywords have following resolution:
### dir::
### If directory does not exists, create it
### git::
### If git repository does not exists, clone it
### link::
### If symlink does not exists, create it
### cathegorize::
### If cathegory directories does not exists, create them
task.apply() { task.apply() {
nuxfs.dsl.process "$@"; nuxfs.dsl.process "$@";
} }
## fix:: [<subtree>] ## fix:: [<subtree>]
## Performs apply and tries to fix warnings and errors and files as ## Performs apply and tries to fix warnings and errors and files as
## specified in nuxfs definition. This operation **DOES MODIFY** ## specified in nuxfs definition. This operation **DOES MODIFY** and may **DELETE**
## existing files. ## existing files.
## ##
### Keywords have similar resolution as an *apply* with following exceptions:
### cathegorize::
### Matched files to cathegory directories
### should-not-exists::
### Matched files are deleted
###
task.fix() { task.fix() {
nuxfs.dsl.process "$@"; nuxfs.dsl.process "$@";
} }