rename: om hack -> om develop

Author: srid

bacon.toml

@@ -96,14 +96,14 @@ command = [
 need_stdout = true
 allow_warnings = true
 
-[jobs.hack]
+[jobs.develop]
 command = [
   "cargo",
   "run",
   "--color",
   "always",
   "--",
-  "hack",
+  "develop",
   ".",
 ]
 need_stdout = true

crates/omnix-cli/src/command/core.rs

@@ -7,7 +7,7 @@ pub enum Command {
 
     Init(super::init::InitCommand),
 
-    Hack(super::hack::HackCommand),
+    Develop(super::develop::DevelopCommand),
 
     CI(super::ci::CICommand),
 
@@ -26,7 +26,7 @@ impl Command {
         match self {
             Command::Show(cmd) => cmd.run().await,
             Command::Init(cmd) => cmd.run().await,
-            Command::Hack(cmd) => cmd.run().await,
+            Command::Develop(cmd) => cmd.run().await,
             Command::CI(cmd) => cmd.run(verbosity).await,
             Command::Health(cmd) => cmd.run().await,
             Command::Completion(cmd) => cmd.run(),

crates/omnix-cli/src/command/hack.rs crates/omnix-cli/src/command/develop.rscrates/omnix-cli/src/command/hack.rs renamed to crates/omnix-cli/src/command/develop.rs

@@ -2,9 +2,9 @@ use std::path::PathBuf;
 
 use clap::Parser;
 
-/// Prepare to hack on a flake project
+/// Prepare to hack (develop) on a flake project
 #[derive(Parser, Debug)]
-pub struct HackCommand {
+pub struct DevelopCommand {
     /// Directory of the project
     #[arg(name = "DIR", default_value = ".")]
     dir: PathBuf,
@@ -24,17 +24,17 @@ enum Stage {
     PostShell,
 }
 
-impl HackCommand {
+impl DevelopCommand {
     pub async fn run(&self) -> anyhow::Result<()> {
         tracing::info!(
             "⌨️  Preparing to develop project at {:}",
             self.dir.display()
         );
         let prj = omnix_develop::core::Project::new(&self.dir).await?;
         match self.stage {
-            Some(Stage::PreShell) => omnix_develop::core::hack_on_pre_shell(&prj).await?,
-            Some(Stage::PostShell) => omnix_develop::core::hack_on_post_shell(&prj).await?,
-            None => omnix_develop::core::hack_on(&prj).await?,
+            Some(Stage::PreShell) => omnix_develop::core::develop_on_pre_shell(&prj).await?,
+            Some(Stage::PostShell) => omnix_develop::core::develop_on_post_shell(&prj).await?,
+            None => omnix_develop::core::develop_on(&prj).await?,
         }
         Ok(())
     }

crates/omnix-cli/src/command/mod.rs

@@ -1,7 +1,7 @@
 pub mod ci;
 pub mod completion;
 pub mod core;
-pub mod hack;
+pub mod develop;
 pub mod health;
 pub mod init;
 pub mod show;

crates/omnix-develop/Cargo.toml

@@ -5,7 +5,7 @@ edition = "2021"
 name = "omnix-develop"
 version = "0.1.0"
 repository = "https://github.com/juspay/omnix"
-description = "Implementation for the `om hack` command"
+description = "Implementation for the `om develop` command"
 license = "Apache-2.0"
 
 [lib]

crates/omnix-develop/src/config.rs

@@ -6,7 +6,7 @@ use omnix_common::config::OmConfig;
 use crate::readme::Readme;
 
 #[derive(Debug, Deserialize, Clone, Default)]
-pub struct HackConfig {
+pub struct DevelopConfig {
     pub readme: Readme,
 }
 
@@ -16,9 +16,9 @@ pub struct CacheConfig {
     pub url: String,
 }
 
-impl HackConfig {
+impl DevelopConfig {
     pub async fn from_flake(url: &FlakeUrl) -> anyhow::Result<Self> {
-        let v = OmConfig::<Self>::from_flake_url(NixCmd::get().await, url, &["om.hack"])
+        let v = OmConfig::<Self>::from_flake_url(NixCmd::get().await, url, &["om.develop"])
             .await?
             .config;
         let config = v.get("default").cloned().unwrap_or_default();

crates/omnix-develop/src/core.rs

@@ -5,34 +5,34 @@ use nix_rs::{flake::url::FlakeUrl, info::NixInfo};
 use omnix_common::markdown::print_markdown;
 use omnix_health::{check::caches::CachixCache, traits::Checkable, NixHealth};
 
-use crate::config::HackConfig;
+use crate::config::DevelopConfig;
 
-/// A project that an be hacked on locally.
+/// A project that an be developed on locally.
 pub struct Project {
     /// The directory of the project.
     pub dir: PathBuf,
     /// [FlakeUrl] corresponding to the project.
     pub flake: FlakeUrl,
-    /// The hack configuration
-    pub cfg: HackConfig,
+    /// The develop configuration
+    pub cfg: DevelopConfig,
 }
 
 impl Project {
     pub async fn new(dir: &Path) -> anyhow::Result<Self> {
         let dir = dir.canonicalize()?;
         let flake: FlakeUrl = Into::<FlakeUrl>::into(dir.as_ref());
-        let cfg = HackConfig::from_flake(&flake).await?;
+        let cfg = DevelopConfig::from_flake(&flake).await?;
         Ok(Self { dir, flake, cfg })
     }
 }
 
-pub async fn hack_on(prj: &Project) -> anyhow::Result<()> {
-    hack_on_pre_shell(prj).await?;
-    hack_on_post_shell(prj).await?;
+pub async fn develop_on(prj: &Project) -> anyhow::Result<()> {
+    develop_on_pre_shell(prj).await?;
+    develop_on_post_shell(prj).await?;
     Ok(())
 }
 
-pub async fn hack_on_pre_shell(prj: &Project) -> anyhow::Result<()> {
+pub async fn develop_on_pre_shell(prj: &Project) -> anyhow::Result<()> {
     // Run relevant `om health` checks
     let health = NixHealth::from_flake(&prj.flake).await?;
     let nix_info = NixInfo::get()
@@ -78,7 +78,7 @@ pub async fn hack_on_pre_shell(prj: &Project) -> anyhow::Result<()> {
     Ok(())
 }
 
-pub async fn hack_on_post_shell(prj: &Project) -> anyhow::Result<()> {
+pub async fn develop_on_post_shell(prj: &Project) -> anyhow::Result<()> {
     eprintln!();
     print_markdown(&prj.dir, prj.cfg.readme.get_markdown()).await?;
     Ok(())

crates/omnix-develop/src/readme.rs

@@ -2,7 +2,7 @@ use serde::Deserialize;
 
 const DEFAULT: &str = r#"🍾 Welcome to the project
 
-*(Want to show custom instructions here? Add them to the `om.hack.default.readme` field in your `flake.nix` file)*
+*(Want to show custom instructions here? Add them to the `om.develop.default.readme` field in your `flake.nix` file)*
 "#;
 
 /// The README to display at the end.

doc/src/SUMMARY.md

@@ -7,7 +7,7 @@
 - [CLI](om/index.md)
     - [Show](om/show.md)
     - [Health](om/health.md)
-    - [Hack](om/hack.md)
+    - [Develop](om/develop.md)
     - [CI](om/ci.md)
     - [Init](om/init.md)
 

doc/src/history.md

@@ -4,7 +4,7 @@
 
 ### Enhancements
 
-- `om hack`: New command
+- `om develop`: New command
 - `om init`
   - Initial working version of `om init` command
 - `om health`