Configuration

Config

Nift in 101ween font

The configuration file for a Nift project is stored in .nsm/nift.config. You can check the location of the global configuration file when starting FLASHELL with nift sh.

Contents

Syntax

To use a command, enter nift command parameters or nsm command parameters in to a terminal, command prompt or power shell window.

Project Configuration Files

Each Nift project has its own configuration file located at .nsm/nift.config. The project configuration file for this website is:

contentDir 'content/'
contentExt '.content'
outputDir 'site/'
outputExt '.html'
scriptExt '.f'
defaultTemplate 'template/page.template'

backupScripts 1

buildThreads -1

paginateThreads -1

incrementalMode -2022

terminal ''

lolcat 1
lolcatCmd "lolcat-cc -f"

unixTextEditor 'subl -n'
winTextEditor 'notepad'

rootBranch 'stage'
outputBranch 'master'

Global Configuration File

Each system you have Nift installed on will have its own global configuration file, you can check the location of the global configuration file when starting FLASHELL with nift sh.

defaultTemplate '/home/nick/.nift/template/global.template'

backupScripts 1

lolcat 1
lolcatCmd "lolcat-cc -f"

buildThreads -1

paginateThreads -1

incrementalMode -2022

terminal '*nix'

unixTextEditor 'subl -nw'
winTextEditor 'notepad'

Configurable

The table below contains information about what can be configured in the configuration files:

Name Description Valid Values Global Project
contentDir path to content directory quoted path Y
contentExt extension used for content files quoted extension Y
outputDir path to output directory quoted path Y
outputExt extension used for build files quoted extension Y
scriptExt extension used for pre/post build scripts quoted extension Y
defaultTemplate default template file to use when tracking new pages quoted path Y Y
backupScripts backup scripts before running them {0,1} Y Y
lolcat whether to use lolcat for output {0,1} Y Y
lolcatCmd quoted command to use when running lolcat {0,1} Y Y
buildThreads max number of threads to use when building ($-x \rightarrow x*no\_cores$) integer Y Y
paginateThreads max number of threads to use with pagination ($-x \rightarrow x*no\_cores$) integer Y Y
incrementalMode choose between incremental mode using modification times or file hashes {mod, hash, hybrid} Y Y
terminal mostly just to change output background colour for Powershell on Windows "ps" or "powershell" Y Y
unixTextEditor specifies which text editor to use on *nix machines eg. "subl -n" or "vi" Y Y
winTextEditor specifies which text editor to use on Windows machines eg. "subl -n" or "notepad" Y Y
Name Description Valid Values Global Project