use anyhow::Result;
use std::path::{Path, PathBuf};
use std::process::Command;
use serde::{Deserialize, Serialize};
use crate::config::{StandardConfig, output_config_hash, resolve_extra_inputs};
use crate::file_index::FileIndex;
use crate::graph::{BuildGraph, Product};
use crate::processors::{
Processor, SiblingFilter, anchor_display_dir, check_command_output, run_in_anchor_dir,
};
#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct NpmConfig {
#[serde(default = "crate::config::default_true")]
pub cache_output_dir: bool,
#[serde(flatten)]
pub standard: StandardConfig,
}
impl Default for NpmConfig {
fn default() -> Self {
Self {
cache_output_dir: true,
standard: StandardConfig::default(),
}
}
}
pub struct NpmProcessor {
config: NpmConfig,
}
impl NpmProcessor {
pub const fn new(config: NpmConfig) -> Self {
Self { config }
}
fn execute_npm(
&self,
ctx: &crate::build_context::BuildContext,
package_json: &Path,
) -> Result<()> {
let subcommand = "install";
let mut cmd = Command::new(&self.config.standard.command);
cmd.arg(subcommand);
for arg in &self.config.standard.args {
cmd.arg(arg);
}
let output = run_in_anchor_dir(ctx, &mut cmd, package_json)?;
check_command_output(
&output,
format_args!("npm {} in {}", subcommand, anchor_display_dir(package_json)),
)
}
}
impl Processor for NpmProcessor {
fn scan_config(&self) -> &crate::config::StandardConfig {
&self.config.standard
}
fn config_json(&self) -> Option<String> {
crate::processors::ProcessorBase::config_json(&self.config)
}
fn clean(&self, product: &crate::graph::Product, verbose: bool) -> anyhow::Result<usize> {
crate::processors::ProcessorBase::clean_output_dir(product, &product.processor, verbose)
}
fn required_tools(&self) -> Vec<String> {
vec![self.config.standard.command.clone(), "node".to_string()]
}
fn discover(
&self,
graph: &mut BuildGraph,
file_index: &FileIndex,
instance_name: &str,
) -> Result<()> {
let Some(files) = crate::processors::scan_or_skip(&self.config.standard, file_index) else {
return Ok(());
};
let hash = Some(output_config_hash(
&self.config,
&crate::config::checksum_fields_of(instance_name),
));
let extra = resolve_extra_inputs(&self.config.standard.dep_inputs)?;
let siblings = SiblingFilter {
extensions: &[".json", ".js", ".ts"],
excludes: &["/.git/", "/out/", "/.rsconstruct/", "/node_modules/"],
};
for anchor in files {
let anchor_dir = anchor
.parent()
.map(std::path::Path::to_path_buf)
.unwrap_or_default();
let sibling_files = file_index.query(
&anchor_dir,
siblings.extensions,
siblings.excludes,
&[],
&[],
&[],
);
let inputs = crate::processors::build_anchor_inputs(&anchor, &sibling_files, &extra);
if self.config.cache_output_dir {
let output_dir = if anchor_dir.as_os_str().is_empty() {
PathBuf::from("node_modules")
} else {
anchor_dir.join("node_modules")
};
graph.add_product_with_output_dir(
inputs,
vec![],
instance_name,
hash.clone(),
output_dir,
)?;
} else {
graph.add_product(inputs, vec![], instance_name, hash.clone())?;
}
}
Ok(())
}
fn execute(&self, ctx: &crate::build_context::BuildContext, product: &Product) -> Result<()> {
self.execute_npm(ctx, product.primary_input())
}
}
fn plugin_create(toml: &toml::Value) -> anyhow::Result<Box<dyn crate::processors::Processor>> {
crate::registries::deserialize_and_create(toml, |cfg| Box::new(NpmProcessor::new(cfg)))
}
inventory::submit! {
crate::registries::ProcessorPlugin {
version: 1,
name: "npm",
processor_type: crate::processors::ProcessorType::Creator,
create: plugin_create,
fields: &[
crate::config::FieldSpec { name: "cache_output_dir", ty: crate::config::FieldType::Bool,
affects_output: false, required: false,
doc: "Cache the entire output directory as a unit" },
],
omit_standard_fields: &["formats", "dep_auto", "output_dir"],
scan_defaults: Some(crate::config::ScanDefaultsData { src_dirs: &[], src_extensions: &["package.json"], src_exclude_dirs: &[] }),
defaults: Some(crate::config::ProcessorDefaults { command: "npm", ..crate::config::ProcessorDefaults::EMPTY }),
defconfig_json: crate::registries::default_config_json::<NpmConfig>,
keywords: &["javascript", "typescript", "node", "npm", "package-manager", "web", "frontend"],
description: "Install Node.js dependencies using npm",
is_native: false,
can_fix: false,
supports_batch: false,
max_jobs_cap: Some(1),
}
}