Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ concurrency:
group: rust-ci-${{ github.ref }}
cancel-in-progress: true

env:
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true

jobs:
lint:
name: Lint (ubuntu)
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
/target
/openspec
.vscode
.idea
19 changes: 19 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ clap = { version = "4.5", features = ["derive"] }
console = "0.15"
dialoguer = "0.11"
indicatif = "0.17"
minijinja = "2.0"
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"

[dev-dependencies]
Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ngseed

`ngseed` is a Rust-powered CLI to scaffold production-ready Angular apps. Get a layered Clean Architecture baseline with optional UI integrations in seconds.
`ngseed` is a Rust-powered CLI to scaffold production-ready Angular apps. Generate a Clean or CDP (Core-Data-Presentation) architecture baseline with optional UI integrations in seconds.

## Features

Expand All @@ -10,7 +10,10 @@
- SCSS styles
- SSR disabled
- npm package manager
- Applies a Clean Architecture starter structure:
- Supports architecture profiles:
- `clean`: domain/application/infrastructure/presentation
- `cdp`: core/data/presentation
- Clean profile starter structure:
- `domain`
- `application`
- `infrastructure`
Expand All @@ -29,13 +32,14 @@ ngseed new my-app
Non-interactive mode:

```bash
ngseed new my-app --yes --ui material --package-manager pnpm
ngseed new my-app --yes --architecture cdp --ui material --package-manager pnpm
```

Flags:

- `--ui <material|primeng|none>`
- `--package-manager <npm|pnpm|yarn|bun>`
- `--architecture <clean|cdp>`
- `--skip-install`
- `--yes`

Expand Down
19 changes: 18 additions & 1 deletion src/application/ports.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,50 @@ use std::path::PathBuf;

use anyhow::Result;

use crate::domain::project::ArchitectureProfile;
use crate::domain::project::PackageManager;
use crate::domain::project::ResolvedOptions;
use crate::domain::project::UiChoice;
use crate::domain::styles_choice::StylesChoice;

pub trait UiSelector {
fn select_ui(&self) -> Result<UiChoice>;
fn select_styles(&self) -> Result<StylesChoice>;
fn select_package_manager(&self) -> Result<PackageManager>;
fn select_architecture(&self) -> Result<ArchitectureProfile>;
}

pub trait Environment {
fn project_exists(&self, project_name: &str) -> bool;
fn current_dir(&self) -> Result<PathBuf>;
fn is_ci(&self) -> bool;
fn is_interactive_terminal(&self) -> bool;
}

pub trait Seeder {
fn ensure_required_tools(&self, package_manager: PackageManager) -> Result<()>;
fn scaffold_angular_project(&self, project_name: &str, options: ResolvedOptions) -> Result<()>;
fn apply_clean_architecture_template(&self, project_dir: &Path) -> Result<()>;
fn apply_architecture_template(
&self,
project_dir: &Path,
architecture: ArchitectureProfile,
) -> Result<()>;
fn apply_ui_integration(
&self,
project_dir: &Path,
ui: UiChoice,
package_manager: PackageManager,
) -> Result<()>;
fn apply_styles(
&self,
project_dir: &Path,
styles: StylesChoice,
package_manager: PackageManager,
) -> Result<()>;
}

pub trait ProgressReporter {
fn show_banner(&self);
fn stage_start(&self, stage: &str, message: &str);
fn stage_ok(&self, stage: &str, message: &str);
fn stage_error(&self, stage: &str, message: &str);
Expand Down
99 changes: 89 additions & 10 deletions src/application/use_cases/new_project.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@ use crate::application::ports::Environment;
use crate::application::ports::ProgressReporter;
use crate::application::ports::Seeder;
use crate::application::ports::UiSelector;
use crate::domain::project::ArchitectureProfile;
use crate::domain::project::NewProjectRequest;
use crate::domain::project::PackageManager;
use crate::domain::project::ResolvedOptions;
use crate::domain::project::UiChoice;
use crate::domain::styles_choice::StylesChoice;

pub struct NewProjectUseCase<'a> {
env: &'a dyn Environment,
Expand Down Expand Up @@ -34,10 +37,16 @@ impl<'a> NewProjectUseCase<'a> {
let options = self.resolve_options(
request.ui,
request.package_manager,
request.styles,
request.architecture,
request.skip_install,
request.yes,
)?;

if !request.yes && !self.env.is_ci() && self.env.is_interactive_terminal() {
self.reporter.show_banner();
}

self.reporter
.stage_start("preflight", "checking required tools");
if let Err(err) = self.seeder.ensure_required_tools(options.package_manager) {
Expand Down Expand Up @@ -71,17 +80,17 @@ impl<'a> NewProjectUseCase<'a> {
let absolute_project_dir = self.env.current_dir()?.join(&request.project_name);

self.reporter
.stage_start("template", "applying clean architecture template");
.stage_start("template", "applying architecture template");
if let Err(err) = self
.seeder
.apply_clean_architecture_template(&absolute_project_dir)
.apply_architecture_template(&absolute_project_dir, options.architecture)
{
self.reporter
.stage_error("template", "clean template setup failed");
.stage_error("template", "template setup failed");
return Err(err);
}
self.reporter
.stage_ok("template", "clean architecture template applied");
.stage_ok("template", "architecture template applied");

self.reporter
.stage_start("ui setup", "applying selected UI integration");
Expand All @@ -97,6 +106,19 @@ impl<'a> NewProjectUseCase<'a> {
self.reporter
.stage_ok("ui setup", "UI integration completed");

if options.styles != StylesChoice::None {
self.reporter.stage_start("styles", "applying styles setup");
if let Err(err) = self.seeder.apply_styles(
&absolute_project_dir,
options.styles,
options.package_manager,
) {
self.reporter.stage_error("styles", "styles setup failed");
return Err(err);
}
self.reporter.stage_ok("styles", "styles setup completed");
}

self.reporter
.summary(&request.project_name, &absolute_project_dir, options);

Expand All @@ -106,22 +128,34 @@ impl<'a> NewProjectUseCase<'a> {
fn resolve_options(
&self,
cli_ui: Option<UiChoice>,
cli_package_manager: Option<crate::domain::project::PackageManager>,
cli_package_manager: Option<PackageManager>,
cli_styles: Option<StylesChoice>,
cli_architecture: Option<ArchitectureProfile>,
skip_install: bool,
yes: bool,
) -> Result<ResolvedOptions> {
let package_manager = if let Some(value) = cli_package_manager {
value
} else if yes {
crate::domain::project::PackageManager::Npm
PackageManager::Npm
} else {
self.ui_selector.select_package_manager()?
};

let architecture = if let Some(value) = cli_architecture {
value
} else if yes {
ArchitectureProfile::Clean
} else {
self.ui_selector.select_architecture()?
};

if yes {
return Ok(ResolvedOptions {
ui: cli_ui.unwrap_or(UiChoice::None),
styles: cli_styles.unwrap_or(StylesChoice::None),
package_manager,
architecture,
skip_install,
});
}
Expand All @@ -132,9 +166,17 @@ impl<'a> NewProjectUseCase<'a> {
self.ui_selector.select_ui()?
};

let styles = if let Some(value) = cli_styles {
value
} else {
self.ui_selector.select_styles()?
};

Ok(ResolvedOptions {
ui,
styles,
package_manager,
architecture,
skip_install,
})
}
Expand All @@ -156,16 +198,25 @@ mod tests {

struct FakeUiSelector {
ui: UiChoice,
styles: StylesChoice,
}

impl UiSelector for FakeUiSelector {
fn select_ui(&self) -> Result<UiChoice> {
Ok(self.ui)
}

fn select_styles(&self) -> Result<StylesChoice> {
Ok(self.styles)
}

fn select_package_manager(&self) -> Result<PackageManager> {
Ok(PackageManager::Npm)
}

fn select_architecture(&self) -> Result<ArchitectureProfile> {
Ok(ArchitectureProfile::Clean)
}
}

struct FakeEnvironment {
Expand All @@ -181,6 +232,14 @@ mod tests {
fn current_dir(&self) -> Result<PathBuf> {
Ok(self.cwd.clone())
}

fn is_ci(&self) -> bool {
false
}

fn is_interactive_terminal(&self) -> bool {
true
}
}

#[derive(Default)]
Expand All @@ -207,10 +266,14 @@ mod tests {
Ok(())
}

fn apply_clean_architecture_template(&self, _project_dir: &Path) -> Result<()> {
fn apply_architecture_template(
&self,
_project_dir: &Path,
_architecture: ArchitectureProfile,
) -> Result<()> {
self.calls
.borrow_mut()
.push("apply_clean_architecture_template".to_string());
.push("apply_architecture_template".to_string());
Ok(())
}

Expand All @@ -225,12 +288,23 @@ mod tests {
.push("apply_ui_integration".to_string());
Ok(())
}

fn apply_styles(
&self,
_project_dir: &Path,
_styles: StylesChoice,
_package_manager: PackageManager,
) -> Result<()> {
self.calls.borrow_mut().push("apply_styles".to_string());
Ok(())
}
}

#[derive(Default)]
struct FakeReporter;

impl ProgressReporter for FakeReporter {
fn show_banner(&self) {}
fn stage_start(&self, _stage: &str, _message: &str) {}
fn stage_ok(&self, _stage: &str, _message: &str) {}
fn stage_error(&self, _stage: &str, _message: &str) {}
Expand All @@ -243,7 +317,10 @@ mod tests {
exists: false,
cwd: PathBuf::from("/tmp"),
};
let ui_selector = FakeUiSelector { ui: UiChoice::None };
let ui_selector = FakeUiSelector {
ui: UiChoice::None,
styles: StylesChoice::None,
};
let seeder = FakeSeeder::default();
let reporter = FakeReporter;
let use_case = NewProjectUseCase::new(&env, &ui_selector, &seeder, &reporter);
Expand All @@ -252,7 +329,9 @@ mod tests {
.execute(NewProjectRequest {
project_name: "demo-app".to_string(),
ui: None,
styles: None,
package_manager: Some(PackageManager::Npm),
architecture: Some(ArchitectureProfile::Clean),
skip_install: true,
yes: true,
})
Expand All @@ -263,7 +342,7 @@ mod tests {
vec![
"ensure_required_tools",
"scaffold_angular_project",
"apply_clean_architecture_template",
"apply_architecture_template",
"apply_ui_integration"
]
);
Expand Down
2 changes: 2 additions & 0 deletions src/domain/mod.rs
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
pub mod project;
pub mod styles_choice;
pub mod tui_input;
Loading
Loading