Description

FolderMaker is a tool to create folders and files with custom content with writing as few code as possible.

Usage

To run FolderMaker run python Main.py <config folder> <destination folder> in terminal. This will create folders and files in destination folder according to the recipe in config folder.

Example: python Main.py ".\ExampleConfigs\Fykos\FykosTexJmenoUlohy\" "."

Config Folder

Each config folder must have inside a config.json file. It can also have fileVariables and scriptVariables folders.

Example configs

Example configs are configs of folders for common czech competitions. Use them at your free wish.

Config File

Config file is a json with a dictionary. The dictionary can have a following keys in it:

• dir
• variables
• fileVariables
• scriptVariables
• templates

Dir

Dictionary under key dir specifies how the maked directories and files will look like. The dictionary contains folders, files and templates, that will be created in the destination folder.

The contents of this dictionary can be recipes for:

• files: "fileName": "fileContent", which creates file fileName with content fileContent at the current folder
• folders: "folderName": {folder contents}, which creates folder folderName with its contents (contents are specified in a same way as in this directory - recursively).
• temlates: temlateName: [] or temlateName: "...", where string evalutes to list (see list evaluation). This corresponds to several callings of template, where in i-th call arguments are i-th element in this array.

Folder creation variables

For FolderMaker to be highly customisable, it can create names and file contents, that change based on variables. For adding variables into names and contents we use string evaluation, which works simmilary to f-strings:

Variable to string

Variable to string is evaluated when enclosed in {}. Consider variable myVar that equals "1". String "a{myVar}{myVar}b" then evaluates to a11b.

Variable to list

Varibles are evaluated to lists when first character of the string is "$". Then the entire string is treated as the result is the list. List variables are evaluated and added together:
myList = ["1"]
"${myList} + ["1", "2"]" evalutes to "["1", "1", "2"]"
"${myList} + ["1", {myList}]" evalutes to "["1", "1", ["1"]]"

Variables

Variables can be three types:

• basic
• file
• script
• special

Basic variables

Basic variables are included in config.json and their string form is automatically evaluated before file creation.

Syntax:

"variables": {
    "variable1": "foo",
    "variable2": "not {variable1}"
}

File variables

File variables are loaded from ./fileVariables folder. This option is designed in order to reduce config.json text with limited functionality. Beware: File variables are not evaluated!

Syntax:

"fileVariables": {
    "variable": "file1.txt"
}

Script variables

Script variables are python programs, that are given thier arguments and variable contents are the results they return. Arguments of scripts are automatically evaluated, whilist their results are not.

Syntax:

"scriptVariables": {
    "variable": {
        "filename": "GetVar", // name of python script
        "func": "foo",  // function to call
        "args": ["arg1", "{variable1}"]  // function arguments
    }
}

Use script variables when you can't get something by normal varibles e.g. loading data from web or getting lowest available folder name

Special variables

Special variables are not defined by the user, but are defined by the program. Those are:

• "\\configDir": path to Config directory
• "\\path": path to destination folder, where folders and files are made

Global File and Script variables

To reduce unneccessary duplication of files, it is possible to use files from globalVariables folder. To do so, add "g\\" before path to the file you would like to use, for example:

"fileVariables": {
    "variable": "g\\folder\\file1.txt"
}

Which loads form \\globalVariables\\fileVariables\\folder\\file1.txt.

For Script variables:

"scriptVariables": {
    "variable": {
        "filename": "g\\folder\\GetVar",
        "func": "foo",
        "args": ["arg1", "{variable1}"]
    }
}

Which uses script from \\globalVariables\\scriptVariables\\folder\\GetVar.py.

Warning: If you have same name of script file in scriptVariables and one of the globalVariables folders (e. g. getVar and g\\folder\\GetVar) the one from scriptVariables will be used.

Global file variables overview

Global file variables are divided into following folders:

• Cpp - C++ templates
• Py - Python templates
• Rust - Rust templates
• Tex - Tex templates

Global script variables overview

Global file variables are divided into following folders:

• Utility - Various useful scripts
  • findLowestFree - finds next free name for folder of given reg-ex
  • nameTools - various tools for working with names of tasks
• GetTasks - These scripts load tasks from respective competition:
  • KSP
  • FIKS
  • Fykos
  • KSP-SK

Templates

Templates are folder/file recipts to reduce lenght of dir. They are defined in templates dictionary. They have similar syntax to dir dictionary, but can have local variables, that are given as arguments, but can use global variables as well.

Syntax:

"template1": {
    "arguments": ["folderName", "fileName"],
    "dir": {
        "{folderName}": {
            "{fileName}.{fileType}":  "example1"
        }
    }
}

(Here fileType is a global variable) When using templates in dir dictionary use template name as key and list or string that evaluates to list as arguments: \

"dir"`: {
    "folder1": {
        "template1": ["1", "{var1}"]
    }
}