feat: add lua scripting to configure lsr

.gitignore

@@ -1,4 +1,5 @@
 bin/
+build/
 assets/demo-dir
 .cache/
 

CMakeLists.txt

@@ -0,0 +1,61 @@
+cmake_minimum_required(VERSION 3.18)
+
+project(lsr LANGUAGES C)
+
+set(CMAKE_C_FLAGS_DEBUG "-g -DDEBUG -fsanitize=address -Wall -Wextra -pedantic")
+set(CMAKE_C_FLAGS_RELEASE "-O2 -DNDEBUG")
+
+find_package(Lua51 REQUIRED)
+
+if (NOT LUA51_FOUND)
+    message(FATAL_ERROR "Lua5.1 libraries not found")
+else()
+    message(STATUS "Lua include directory: ${LUA_INCLUDE_DIR}")
+    message(STATUS "Lua libraries: ${LUA_LIBRARIES}")
+endif()
+
+if(NOT LUA_INCLUDE_DIR)
+    message(FATAL_ERROR "Lua headers not found")
+else()
+    message(STATUS "Lua include directory: ${LUA_INCLUDE_DIR}")
+endif()
+
+include_directories("${LUA_INCLUDE_DIR}")
+
+file(GLOB_RECURSE SRCS "${CMAKE_CURRENT_SOURCE_DIR}/src/*.c")
+
+include_directories("${CMAKE_CURRENT_SOURCE_DIR}/include")
+
+add_executable(lsr ${SRCS})
+
+target_include_directories(lsr PRIVATE ${LUA_INCLUDE_DIR})
+target_link_libraries(lsr PRIVATE ${LUA_LIBRARIES})
+
+add_custom_target(format COMMAND clang-format -i ${SRCS})
+
+set(LUA_SCRIPTS "${CMAKE_CURRENT_SOURCE_DIR}/lua/*.lua")
+
+set(LUA_INSTALL_PATH "/usr/local/share/lsr")
+
+add_custom_command(TARGET lsr POST_BUILD
+    COMMAND ${CMAKE_COMMAND} -E make_directory "${LUA_INSTALL_PATH}"
+    COMMAND ${CMAKE_COMMAND} -E copy ${LUA_SCRIPTS} "${LUA_INSTALL_PATH}"
+    COMMENT "Copying ${LUA_SCRIPTS} to ${LUA_INSTALL_PATH}"
+)
+
+install(TARGETS lsr DESTINATION /usr/local/bin)
+
+if(NOT TARGET uninstall)
+    configure_file(
+        "${CMAKE_CURRENT_SOURCE_DIR}/cmake_uninstall.cmake.in"
+        "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake"
+        IMMEDIATE @ONLY)
+
+    add_custom_target(uninstall
+        COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake
+
+        COMMAND ${CMAKE_COMMAND} -E remove_directory "${LUA_INSTALL_PATH}"
+        COMMENT "Removing Lua scripts from ${LUA_INSTALL_PATH}"
+    )
+endif()
+

CONFIGURATION.md

@@ -0,0 +1,151 @@
+<div align="center">
+
+# Configure laser!
+
+</div>
+
+## Table of contents
+   1. [Creating Your Own Configuration File](#creating-your-own-configuration-file)
+   2. [Writing Your Own Configuration](#writing-your-own-configuration)
+      1. [Constants](#constants)
+         1. [`L_colors`](#`l_colors`)
+      2. [Functions](#functions)
+         1. [`L_compare_entries()`](#`l_compare_entries()`)
+         2. [`L_long_format()`](#`l_long_format()`)
+      3. [Using Defaults](#using-defaults)
+
+Laser is highly customizable through Lua scripts. The default configuration
+file is located at `/usr/local/share/lsr/lsr.lua`. This file is loaded by the
+program and sets the default behavior for laser. You can modify this file or
+create your own configuration file to change the behavior of laser.
+
+## Creating Your Own Configuration File
+
+To create your own configuration all that you need to do is to create a lua
+file at `~/.config/lsr/lsr.lua`. This will be the default file where laser will
+look for your configuration. You can of course add more files to this directory
+(check the `lua` directory in the repo). Other files in this directory will not
+be loaded by laser but you can do a `require` to them to load them into the
+`lsr.lua` file.
+
+## Writing Your Own Configuration
+
+The default configuration file is located at `/usr/local/share/lsr/lsr.lua`.
+You can copy these files and edit them to your liking. But here comes a small
+guide on what you can do with a blank `lsr.lua` file.
+
+> [!NOTE] 
+> All laser-specific functions and constants are prefixed with `L_`.
+
+### Constants
+
+#### `L_colors`
+
+You can configure the colors of the different entry types by modifying the
+global `L_colors` table. You can even add glyphs or text as it is just a normal
+string. The definition of the table should be placed in the `lsr.lua` file
+(check the [Writing Your Own Configuration](#writing-your-own-configuration)).
+But if you check the `lua` directory in the repo you will find the default
+colors are placed in a different file. You can do this by doing a
+`require("colors")` in the `lsr.lua` (assuming that the `colors.lua` file is in
+the same directory).
+
+The default configuration of `L_colors` is:
+```lua
+L_colors = {
+    DIR = "\x1b[34m",
+    SYMLINK = "\x1b[36m",
+    FILE = "\x1b[0m",
+    HIDDEN = "\x1b[90m",
+    EXEC = "\x1b[32;4m",
+    ARCHIVE = "\x1b[31m",
+    MEDIA = "\x1b[33m",
+    DOCUMENT = "\x1b[35;3m",
+}
+```
+
+### Functions
+
+There are a few functions you can use to modify the behavior of the program.
+
+#### `L_compare_entries()`
+
+This function is used to sort the entries in the directory. This is by default
+used to add "gravity" to files so that they fall at the bottom of the list. And
+directories being placed at the top.
+
+This fcuntion have the following signature: 
+
+```lua
+L_compare_entries(entry1, entry2, entry1_is_dir, entry2_is_dir)
+```
+
+```lua
+-- files should get "gravity" and fall to the bottom of the list
+-- then the entries are sorted alphabetically
+function L_compare_entries(entry1, entry2, entry1_is_dir, entry2_is_dir)
+    if entry1_is_dir and not entry2_is_dir then return -1 end
+    if not entry1_is_dir and entry2_is_dir then return 1 end
+
+    return entry1 < entry2 and -1 or (entry1 > entry2 and 1 or 0)
+end
+```
+
+#### `L_long_format()`
+
+This function is used to format the entries in long format. This is by default
+used to show the permissions, the size, last modified and owner of the entry.
+
+This fcuntion have the following signature:
+
+```lua
+L_long_format(entry, longest_name)
+```
+
+Where `entry` is a table with the following keys:
+
+- `name`: The name of the entry
+- `mode`: The c stat mode of the entry (this can be used to get the permissions
+  and do much more, there is a default util function called
+  `utils.getPerms(mode)`)
+- `size`: The size of the entry (there is a default util function called
+  `utils.formatSize(size)` to make it human readable)
+- `mtime`: The last modified time of the entry you can pass it through
+  `os.date` to format it
+- `owner`: The name of the owner of the entry
+- `type`: The type of the entry in one character
+    - `d`: Directory
+    - `l`: Symlink
+    - `c`: Character device
+    - `b`: Block device
+    - `p`: Named pipe (fifo)
+    - `s`: Socket
+    - `-`: File
+
+The `longest_name` is the length of the longest name in the directory. This
+could be used to align the output.
+
+The default function is:
+
+```lua
+function L_long_format(entry, longest_name)
+    local perms = string.format("%s%s", entry.type, utils.getPerms(entry.mode))
+
+    local last_modified = os.date("%b %d %H:%M", entry.mtime)
+    local size = utils.formatSize(entry.size)
+    local owner = string.format("%-" .. longest_name .. "s ", entry.owner)
+
+    return string.format("%s %s%s %s%s %s%s ",
+        perms,
+        L_colors.SYMLINK,
+        last_modified, L_colors.MEDIA, size,
+        L_colors.SYMLINK, owner)
+end
+```
+
+### Using Defaults
+
+If you do not define these functions in your configuration file, the default
+functions from the default configuration file will be used automatically. If
+there is a missing constant or function the default configuration file will be
+used.

CONTRIBUTING.md

@@ -7,16 +7,22 @@ See the [Table of Contents](#table-of-contents) for different ways to help and
 details about how this project handles them. Please make sure to read the 
 relevant section before making your contribution.
 
-## Table of Contents
-
-- [I Have a Question](#i-have-a-question)
-- [I Want To Contribute](#i-want-to-contribute)
-- [Reporting Bugs](#reporting-bugs)
-- [Suggesting Enhancements](#suggesting-enhancements)
-- [Your First Code Contribution](#your-first-code-contribution)
-- [Improving The Documentation](#improving-the-documentation)
-- [Styleguides](#styleguides)
-- [Commit Messages](#commit-messages)
+## Table of contents
+1. [I Have a Question](#i-have-a-question)
+2. [I Want To Contribute](#i-want-to-contribute)
+  1. [Reporting Bugs](#reporting-bugs)
+     1. [Before Submitting a Bug Report](#before-submitting-a-bug-report)
+  2. [Suggesting Enhancements](#suggesting-enhancements)
+     1. [Before Submitting an
+        Enhancement](#before-submitting-an-enhancement)
+     2. [How Do I Submit a Good Enhancement
+        Suggestion?](#how-do-i-submit-a-good-enhancement-suggestion?)
+  3. [Your First Code Contribution](#your-first-code-contribution)
+     1. [Development Environment Setup](#development-environment-setup)
+     2. [Code formatting](#code-formatting)
+  4. [Improving The Documentation](#improving-the-documentation)
+3. [Styleguides](#styleguides)
+  1. [Commit Messages](#commit-messages)
 
 ## I Have a Question
 

README.md

@@ -8,10 +8,22 @@
 
 </div>
 
+## Table of contents
+   1. [Installation](#installation)
+      1. [From Homebrew](#from-homebrew)
+      2. [Building from source](#building-from-source)
+   2. [Usage](#usage)
+      1. [Configure](#configure)
+      2. [Command-line options](#command-line-options)
+1. [Contributing](#contributing)
+2. [Authors](#authors)
+
 **lsr** basically `ls` but with colorization and sorting for better readability.
 It offers filtering options, making it easy to
 locate specific files and folders (with grep you'll find exactly what you need)
 It can even display the directory contents in a tree-like structure! :fire:
+If that wasn't enough you can even extend the program with lua! 
+(I'm too proud of that )
 
 ## Installation
 
@@ -38,13 +50,15 @@ cd laser
 Install system-wide:
 
 ```sh
-sudo make install
+cmake -S . -B build
+cmake --build build
+sudo cmake --install build
 ```
 
-To uninstall you can run
+To uninstall you can run the following while being in the `laser` directory:
 
 ```sh
-sudo make uninstall
+cmake --build build --target uninstall
 ```
 
 > [!NOTE]
@@ -63,25 +77,17 @@ lsr
 lsr some-directory
 ```
 
-### Change colors or add icons
+### Configure
 
-If you want to change the colors of the output you can set an environment 
-variable called `LSR_COLORS` for example if you want to add nerd font icons to
-the existing colors you can use:
+If you'd like to configure the program's behavior, or change the default colors,
+add icons and more. You can configure the program with lua :fire:. A default 
+configuration will be installed at `/usr/local/share/lsr/`. But if you want to 
+write some own configuration you can place it in `~/.config/lsr/lsr.lua`.
 
-```sh
-export LSR_COLORS="DIR=\x1b[34m :\
-SYMLINK=\x1b[36m :\
-FILE=\x1b[0m :\
-HIDDEN=\x1b[90m :\
-EXEC=\x1b[32;4m :\
-ARCHIVE=\x1b[31m :\
-MEDIA=\x1b[33m :\
-DOCUMENT=\x1b[35;3m :"
-```
+Copy the files from `/usr/local/share/lsr/` to `~/.config/lsr/` and you can edit 
+them now.
 
-You don't have to change all of these if there is only one you want to change
-you can do that, to leave the rest on default
+Check out the [configuration guide](/CONFIGURATION.md)
 
 ### Command-line options