chain_width                = 80
# Don't combine control expressions with function calls.
combine_control_expr       = false
# Replace multiple `_` with a single `..` in tuple patterns.
condense_wildcard_suffixes = true
# Flatten any single-line expressions.
fn_single_line             = true
# Format string literals if they are too long.
format_strings             = true
# Set the layout of imports in a block.
imports_layout             = "HorizontalVertical"
# Put a trailing comma after a block-based match arm.
match_block_trailing_comma = true
# Set the max code with to 120.
# This will automatically set the margins of a lot of other options.
max_width                  = 120
# Reports TODOs in the code.
report_todo                = "Always"
# Removes commas from the last element.
trailing_comma             = "Never"
unstable_features          = true
wrap_comments              = true

# Allowed values are "bell", "flashing", and "nothing".
bell style="nothing"
# Allowed values are "emacs" and "vi".
edit mode="emacs"
history auto add lines=true
# The file to write history to, must be writable (e.g. in an existing directory).
history file="/home/valley/.local/share/crust/crust.history"
history spaces ignored=true
history size=500
# Example of how prompt looks:
# [05:47 AM]-[Mon Jan 10]
# [valley@gentoo]
# [/home/valley/projects/crust]->
prompt=""[F<MAGENTA>%{T12}%{rf}]-[F<CYAN>%{D}%{rf}]\n[F<GREEN>%{U}%{rf}@F<BLUE>%(hostname)%{rf}]\n[F<WHITE>%{CL}%{rf}]F<YELLOW>->%{rf} "
should be invalid="N/A"

#!/usr/bin/env bash
# Adding debug info to release builds.
prep() {
    # Define the release profile which contains debug info.
    local release_profile="[profile.release]\ndebug = 1"
    # Append the debug profile to the project's config.
    echo -e "${release_profile}" >> Cargo.toml
    # Build in release mode.
    cargo build --release
    # Remove the debug info from release builds,
    # as well as the extra newlines added by removing the debug info.
    sed -i -z -e 's/\[profile\.release\]\ndebug = 1//' -e '$!N; /^\(.*\)\n\1$/!P; D' Cargo.toml
}
run_perf() {
    # Run perf to profile the build, with args to run commands in a pipeline.
    # `perf` requires root to get more detailed information do to kernel integration.
    printf "Don't panic, perf requires root to get more detailed info due to kernel integration.\n"
    sudo perf record -g --call-graph dwarf target/release/crust -c "ls src/ | sed s/src/source/g"
    printf "Information is recorded to 'perf.data'.\nUse commands like 'sudo perf annotate' and 'sudo perf report' to get the info.\n"
}
run_valgrind() {
    # Run valgrind to get more info.
    valgrind --tool=callgrind --dump-instr=yes --collect-jumps=yes \
        target/release/crust -c "ls src/ | sed s/src/source/g"
    printf "Valgrind information was gathered.\nUse commands like 'callgrind_annotate' to get the info.\n"
}
profile() {
    case "${1}" in
        perf) run_perf;;
        valgrind) run_valgrind;;
        *)
            printf "Profiling with both tools due to none being specified.\n"
            run_perf
            run_valgrind
            ;;
    esac
}
case "${1}" in
    prep) prep;;
    profile) profile "${2}";;
    *)
        printf "Uses:\n%s prep\n%s profile [perf|valgrind]*\n* Don't specify any tool to run both.\n" \
            "${0}" "${0}"
        exit 1
        ;;
esac

{{{
 ▄████████    ▄████████ ███    █▄     ▄████████     ███
███    ███   ███    ███ ███    ███   ███    ███ ▀█████████▄
███    █▀    ███    ███ ███    ███   ███    █▀     ▀███▀▀██
███         ▄███▄▄▄▄██▀ ███    ███   ███            ███   ▀
███        ▀▀███▀▀▀▀▀   ███    ███ ▀███████████     ███    
███    █▄  ▀███████████ ███    ███          ███     ███    
███    ███   ███    ███ ███    ███    ▄█    ███     ███    
████████▀    ███    ███ ████████▀   ▄████████▀     ▄████▀  
             ███    ███
}}}
{{https://user-images.githubusercontent.com/44369810/136675409-34ebf5b6-16a1-4720-9a07-f0dd0fa0c650.png|crusty mascot}}
^ Say hello to crust's mascot :D ^
crust is a WIP shell written in Rust by [[https://github.com/Phate6660|Phate6660]] and [[https://github.com/TheOnAndOnlyZenomat|Zenomat]].
Some of the functionality is split off into features, to reduce the amount of crates pulled in by default. They are:
* colors (for colorized output in ls (and other builtins once implemented))
* readline (a default feature (but can be turned off), for having a nice interactible prompt)
** when disabled, you'll have very basic line input (think of shells like dash)
** NOTE: the prompt is customizable regardless of whether or not you choose to enable the feature
* time (for getting the time with the %{D12} and %{D24} variables)
If you don't want any features at all, then build or run with the arg //--no-default-features//.
== Running ==
To run an interactive shell:\\
//cargo run --release//
To run a non-interactive shell with a command:\\
//cargo run --release -- -c "echo test | sed s/test/success/g"//
== Roadmap ==
=== Shell ===
| FEATURE        | TODO  | WIP  | DONE  |
| Basic commands |       |      | X     |
| CMDs with args |       |      | X     |
| Paging         |       |      | X     |
| Piping         |       |      | X     |
| Prompt         |       |      | X     |
| Redirection    |       |      | X     |
| Builtins       |       | X    |       |
| Config file    |       | X    |       |
| Job control    |       | X    |       |
| Line editor    |       | X    |       |
| Env variables  | X     |      |       |
| Scripting      | X     |      |       |
==== Prompt ====
| FEATURE               | TODO  | WIP  | DONE  |
| Automatically update  |       |      | X     |
| Colors                |       |      | X     |
| Command output        |       |      | X     |
| File content          |       |      | X     |
| Replaceable variables |       |      | X     |
| Set via env var       |       |      | X     |
The default prompt looks like:\\
{{images/default-prompt.png|Default Prompt}}
Customize the prompt by setting the PROMPT variable in the environment or through the config.\\
What you can use in the prompt:
Information variables:
* %{CL} for the full current working directory (e.g. /home/valley/projects/crust).
* %{CS} for the short current working directory (e.g. crust).
* %{D} for the date (e.g. Wed Dec 15).
* %{H} for the current user's home directory.
* %{T12} and %{T24} for 12 and 24 hour time respectively.
* %{U} for the current user.
* %(//command//) for capturing the output of //command//.
* %[//file//] to get the contents of //file//.
Formatting:
* %{b} to make text bold.
* %{i} to italicize text.
* %{rb} to reset the background color.
* %{re} to reset all text attributes.
* %{rf} to reset the text color.
* %{u} to underline text.
* B<//COLOR//> for changing the background color.
* F<//COLOR//> for changing the text color.
* \n for newline.
* Anything else will be printed as-is.
//COLOR// should be replaced with one of:
* BLACK
* RED
* GREEN
* YELLOW
* BLUE
* MAGENTA
* CYAN
* WHITE
Example for formatting:\\
//PROMPT="%{b}F<MAGENTA>%{T24}%{re} - %{i}%{U}@%(hostname)%{re}\nB<GREEN>F<BLACK>%{CL}%{re}» "//\\
Which for me looks like this:\\
{{images/customized-prompt.png|Customized Prompt}}\\
This showcases a multiline prompt with different foreground and background colors, as well as a command substitution and shell-prompt-features, like time and user.
==== Line Editing ====
===== Basic Line Editing =====
| FEATURE       | TODO | WIP | DONE |
| Command Input |      |     | X    |
| Arrow Keys    | X    |     |      |
| Backspace     | X    |     |      |
===== Rustyline =====
| FEATURE                | TODO  | WIP  | DONE  |
| Basic line editing     |       |      | X     |
| Command history        |       |      | X     |
| Completions            | X     |      |       |
| Modifiable keybindings | X     |      |       |
| Syntax highlighting    | X     |      |       |
=== Builtins ===
==== calc ====
| FEATURE    | TODO  | WIP  | DONE  |
| Basic math |       |      | X     |
| Equations  | X     |      |       |
| PEMDAS     | X     |      |       |
==== cat ====
| FEATURE             | TODO | WIP | DONE |
| Read file           |      |     | X    |
| Print line numbers  |      |     | X    |
| Print specific line |      |     | X    |
| Paging support      | X    |     |      |
| Syntax highlighting | X    |     |      |
==== cd ====
| FEATURE        | TODO  | WIP  | DONE  |
| Exact paths    |       |      | X     |
| Relative paths |       |      | X     |
| Previous dir   |       |      | X     |
==== echo ====
| FEATURE          | TODO  | WIP  | DONE  |
| Basic output     |       |      | X     |
| Escape sequences |       | X    |       |
==== help ====
| FEATURE                     | TODO  | WIP  | DONE  |
| Invidual helps for builtins |       |      | X     |
| List builtins               |       |      | X     |
| Quick start / tutorial      | X     |      |       |
==== ls ====
| FEATURE              | TODO  | WIP  | DONE  |
| Basic colored output |       |      | X     |
| Cross-platform       |       |      | X     |
| List files           |       |      | X     |
| Additional details   | X     |      |       |
=== Config File ===
| OPTION                 | TODO | WIP | DONE |
| Edit mode              |      |     | X    |
| History auto add lines |      |     | X    |
| History file           |      |     | X    |
| History ignore spaces  |      |     | X    |
| History size           |      |     | X    |
| Prompt                 |      |     | X    |
Notes:
* A default config is created for you if non-existant, look at //example-config// in the repo for an example.
* Comments (lines that start with //*//) or ignored.
* Invalid options are ignored and a warning is issued.

Everything in this project is placed into the public domain.
Any and all rights to this software are waived, by any contributors and I.

[package]
authors = ["Phate6660", "Zenomat"]
edition = "2018"
exclude = [".github/"]
keywords = ["cross-platform", "shell"]
license-file = "LICENSE"
name = "crust"
readme = "README.creole"
repository = "https://github.com/Phate6660/crust"
version = "0.1.0"
[dependencies]
chrono = { version = "0.4.19", optional = true }
colored = { version = "2.0.0", optional = true }
conf = { git = "https://github.com/Phate6660/conf" }
rustyline = { version = "9.0.0", optional = true }
sflib = { git = "https://github.com/Phate6660/sflib", branch = "master" }
[features]
colors = ["colored"]
default = ["readline"]
readline = ["rustyline"]
time = ["chrono"]