diff --git a/Cargo.toml b/Cargo.toml index 9878dd9..82258ae 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,12 +1,12 @@ [workspace] resolver = "2" members = [ - "pay-respects", - "pay-respects-parser", - "pay-respects-utils", + "core", + "parser", + "utils", # optional modules - "pay-respects-module-runtime-rules", - "pay-respects-fallback-request-ai", + "module-runtime-rules", + "module-request-ai", ] [profile.release] diff --git a/README.md b/README.md index eacb32f..33635ab 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ Typed a wrong command or don't know what to do? Pay Respects will suggest a fix to your console command by simply pressing `F`! - 🚀 **Blazing fast suggestion**: You won't notice any delay for asking suggestions! +- đŸŽ¯ **Accurate results**: Suggestions are verified before being prompted to the user, no `sudo` suggestions when you are using `doas`! - âœī¸ **Easy to write rules**: You don't need to know Rust. The rules are written in a TOML file! - 🔩 **Modular**: TOML not your taste? Add sources with your favorite language with a custom module! -- đŸŽ¯ **Accurate results**: Suggestions are verified before being prompted to the user, no `sudo` suggestions when you are using `doas`! - 🤖 **AI Support**: AI module comes in aid when there is no rule for your error! - đŸĒļ **Tiny binary size**: Not even 1MB for core features! @@ -119,17 +119,10 @@ curl -sSfL https://raw.githubusercontent.com/iffse/pay-respects/main/install.sh > cargo install --path . > ``` -> Features: -> -> - `runtime-rules`: Read rules in runtime -> - `request-ai`: Request AI for suggestion -> - `libcurl`: Dynamically link `libcurl` for requests, which requires openssl at compile time -> - Only matters to package maintainers, as by turning it off gives fewer headaches when cross-compiling - -## Rule Files +## Rules & Modules See [writing rules](./rules.md) for how to write rules. diff --git a/pay-respects/Cargo.toml b/core/Cargo.toml similarity index 79% rename from pay-respects/Cargo.toml rename to core/Cargo.toml index c79d563..0582b19 100644 --- a/pay-respects/Cargo.toml +++ b/core/Cargo.toml @@ -21,5 +21,5 @@ regex-lite = "0.1" inquire = "0.7.5" -pay-respects-parser = { version = "0.3.2", path = "../pay-respects-parser" } -pay-respects-utils = {version = "0.1.0", path = "../pay-respects-utils"} +pay-respects-parser = { version = "0.3.2", path = "../parser" } +pay-respects-utils = {version = "0.1.0", path = "../utils"} diff --git a/pay-respects/i18n/i18n.toml b/core/i18n/i18n.toml similarity index 100% rename from pay-respects/i18n/i18n.toml rename to core/i18n/i18n.toml diff --git a/pay-respects/rules/c_typo.toml b/core/rules/c_typo.toml similarity index 100% rename from pay-respects/rules/c_typo.toml rename to core/rules/c_typo.toml diff --git a/pay-respects/rules/cargo.toml b/core/rules/cargo.toml similarity index 100% rename from pay-respects/rules/cargo.toml rename to core/rules/cargo.toml diff --git a/pay-respects/rules/cat.toml b/core/rules/cat.toml similarity index 100% rename from pay-respects/rules/cat.toml rename to core/rules/cat.toml diff --git a/pay-respects/rules/cd.toml b/core/rules/cd.toml similarity index 100% rename from pay-respects/rules/cd.toml rename to core/rules/cd.toml diff --git a/pay-respects/rules/cp.toml b/core/rules/cp.toml similarity index 100% rename from pay-respects/rules/cp.toml rename to core/rules/cp.toml diff --git a/pay-respects/rules/git.toml b/core/rules/git.toml similarity index 100% rename from pay-respects/rules/git.toml rename to core/rules/git.toml diff --git a/pay-respects/rules/mkdir.toml b/core/rules/mkdir.toml similarity index 100% rename from pay-respects/rules/mkdir.toml rename to core/rules/mkdir.toml diff --git a/pay-respects/rules/mv.toml b/core/rules/mv.toml similarity index 100% rename from pay-respects/rules/mv.toml rename to core/rules/mv.toml diff --git a/pay-respects/rules/npm.toml b/core/rules/npm.toml similarity index 100% rename from pay-respects/rules/npm.toml rename to core/rules/npm.toml diff --git a/pay-respects/rules/pacman.toml b/core/rules/pacman.toml similarity index 100% rename from pay-respects/rules/pacman.toml rename to core/rules/pacman.toml diff --git a/pay-respects/rules/pr_general.toml b/core/rules/pr_general.toml similarity index 100% rename from pay-respects/rules/pr_general.toml rename to core/rules/pr_general.toml diff --git a/pay-respects/rules/pr_privilege.toml b/core/rules/pr_privilege.toml similarity index 100% rename from pay-respects/rules/pr_privilege.toml rename to core/rules/pr_privilege.toml diff --git a/pay-respects/rules/rm.toml b/core/rules/rm.toml similarity index 100% rename from pay-respects/rules/rm.toml rename to core/rules/rm.toml diff --git a/pay-respects/rules/touch.toml b/core/rules/touch.toml similarity index 100% rename from pay-respects/rules/touch.toml rename to core/rules/touch.toml diff --git a/pay-respects/rules/yarn.toml b/core/rules/yarn.toml similarity index 100% rename from pay-respects/rules/yarn.toml rename to core/rules/yarn.toml diff --git a/pay-respects/src/args.rs b/core/src/args.rs similarity index 100% rename from pay-respects/src/args.rs rename to core/src/args.rs diff --git a/pay-respects/src/main.rs b/core/src/main.rs similarity index 100% rename from pay-respects/src/main.rs rename to core/src/main.rs diff --git a/pay-respects/src/modes.rs b/core/src/modes.rs similarity index 100% rename from pay-respects/src/modes.rs rename to core/src/modes.rs diff --git a/pay-respects-module-runtime-rules/src/replaces.rs b/core/src/replaces.rs similarity index 100% rename from pay-respects-module-runtime-rules/src/replaces.rs rename to core/src/replaces.rs diff --git a/pay-respects/src/rules.rs b/core/src/rules.rs similarity index 100% rename from pay-respects/src/rules.rs rename to core/src/rules.rs diff --git a/pay-respects/src/shell.rs b/core/src/shell.rs similarity index 100% rename from pay-respects/src/shell.rs rename to core/src/shell.rs diff --git a/pay-respects/src/style.rs b/core/src/style.rs similarity index 100% rename from pay-respects/src/style.rs rename to core/src/style.rs diff --git a/pay-respects/src/suggestions.rs b/core/src/suggestions.rs similarity index 100% rename from pay-respects/src/suggestions.rs rename to core/src/suggestions.rs diff --git a/pay-respects/src/system.rs b/core/src/system.rs similarity index 100% rename from pay-respects/src/system.rs rename to core/src/system.rs diff --git a/pay-respects-fallback-request-ai/Cargo.toml b/module-request-ai/Cargo.toml similarity index 100% rename from pay-respects-fallback-request-ai/Cargo.toml rename to module-request-ai/Cargo.toml diff --git a/pay-respects-fallback-request-ai/i18n/i18n.toml b/module-request-ai/i18n/i18n.toml similarity index 100% rename from pay-respects-fallback-request-ai/i18n/i18n.toml rename to module-request-ai/i18n/i18n.toml diff --git a/pay-respects-fallback-request-ai/src/main.rs b/module-request-ai/src/main.rs similarity index 100% rename from pay-respects-fallback-request-ai/src/main.rs rename to module-request-ai/src/main.rs diff --git a/pay-respects-fallback-request-ai/src/requests.rs b/module-request-ai/src/requests.rs similarity index 100% rename from pay-respects-fallback-request-ai/src/requests.rs rename to module-request-ai/src/requests.rs diff --git a/pay-respects-module-runtime-rules/Cargo.toml b/module-runtime-rules/Cargo.toml similarity index 73% rename from pay-respects-module-runtime-rules/Cargo.toml rename to module-runtime-rules/Cargo.toml index 9062594..4251793 100644 --- a/pay-respects-module-runtime-rules/Cargo.toml +++ b/module-runtime-rules/Cargo.toml @@ -8,4 +8,4 @@ regex-lite = "0.1" toml = { version = "0.8" } serde = { version = "1.0", features = ["derive"] } -pay-respects-utils = {version = "0.1.0", path = "../pay-respects-utils"} +pay-respects-utils = {version = "0.1.0", path = "../utils"} diff --git a/pay-respects-module-runtime-rules/src/main.rs b/module-runtime-rules/src/main.rs similarity index 100% rename from pay-respects-module-runtime-rules/src/main.rs rename to module-runtime-rules/src/main.rs diff --git a/pay-respects/src/replaces.rs b/module-runtime-rules/src/replaces.rs similarity index 100% rename from pay-respects/src/replaces.rs rename to module-runtime-rules/src/replaces.rs diff --git a/pay-respects-module-runtime-rules/src/rules.rs b/module-runtime-rules/src/rules.rs similarity index 100% rename from pay-respects-module-runtime-rules/src/rules.rs rename to module-runtime-rules/src/rules.rs diff --git a/pay-respects-parser/.gitignore b/parser/.gitignore similarity index 100% rename from pay-respects-parser/.gitignore rename to parser/.gitignore diff --git a/pay-respects-parser/.rustfmt.toml b/parser/.rustfmt.toml similarity index 100% rename from pay-respects-parser/.rustfmt.toml rename to parser/.rustfmt.toml diff --git a/pay-respects-parser/Cargo.toml b/parser/Cargo.toml similarity index 100% rename from pay-respects-parser/Cargo.toml rename to parser/Cargo.toml diff --git a/pay-respects-parser/src/lib.rs b/parser/src/lib.rs similarity index 100% rename from pay-respects-parser/src/lib.rs rename to parser/src/lib.rs diff --git a/pay-respects-parser/src/replaces.rs b/parser/src/replaces.rs similarity index 100% rename from pay-respects-parser/src/replaces.rs rename to parser/src/replaces.rs diff --git a/rules b/rules index 1c65a51..a10a0e5 120000 --- a/rules +++ b/rules @@ -1 +1 @@ -pay-respects/rules \ No newline at end of file +core/rules \ No newline at end of file diff --git a/pay-respects-utils/Cargo.toml b/utils/Cargo.toml similarity index 100% rename from pay-respects-utils/Cargo.toml rename to utils/Cargo.toml diff --git a/pay-respects-utils/src/evals.rs b/utils/src/evals.rs similarity index 100% rename from pay-respects-utils/src/evals.rs rename to utils/src/evals.rs diff --git a/pay-respects-utils/src/files.rs b/utils/src/files.rs similarity index 100% rename from pay-respects-utils/src/files.rs rename to utils/src/files.rs diff --git a/pay-respects-utils/src/lib.rs b/utils/src/lib.rs similarity index 100% rename from pay-respects-utils/src/lib.rs rename to utils/src/lib.rs