Configuration

Configuration

Smake can be configured either globally or locally.

Configuring Globally

Global Configuration Locations:
Windows: %APPDATA%\Syntad\Smake\config.json
MacOS and Linux: $HOME/.smake/config.json

If you do not use the provided install file to install Smake for the first time, you may have to create the directories yourself. You will have to create config.json if this is your first time configuring Smake.

Global Options:

• pluginsDirectory: An absolute path to your global plugins directory. Defaults to %PROGRAMDATA%\smake\plugins on Windows and $HOME/.smake/plugins on MacOS and Linux.
• smakeFileName: The default file name for Smake files. Defaults to "smake.lua".

Configuring Locally

This is useful for configuring Smake for your project. Simply create a smake.json file in your project directory and write your configuration there.

Local Options:

• pluginsDirectory: A relative path to your project's Smake plugins directory.
• smakeFileName: The file name for the Smake file. Defaults to "smake.lua".
• defaultCommand: The default command to execute when typing smake. This is build by default.
• aliases: A map of aliases for commands. Example:

{
    "b": "build",
    "i": "install"
}