Struct NpmBuild

pub struct NpmBuild { /* private fields */ }

Executes npm commands before collecting resources.

Example usage: Add build.rs with call to bundle resources:

use static_files::NpmBuild;

fn main() {
    NpmBuild::new("./web")
        .install().unwrap() // runs npm install
        .run("build").unwrap() // runs npm run build
        .target("./web/dist")
        .to_resource_dir()
        .build().unwrap();
}

Include generated code in main.rs:

include!(concat!(env!("OUT_DIR"), "/generated.rs"));

Implementations

impl NpmBuild

pub fn new<P: AsRef<Path>>(package_json_dir: P) -> Self

pub fn executable(self, executable: &str) -> Self

Allow the user to set their own npm-like executable (like yarn, for instance)

pub fn change_detection(self) -> Self

Generates change detection instructions.

It includes package.json directory, ignores by default node_modules, package.json and package-lock.json and target directory. Each time npm changes timestamps on these files, so if we do not ignore them - it runs npm each time. It is recommended to put your dist files one level deeper. For example, if you have web with package.json and dist just below that, you better generate you index.html somewhere in web\dist\sub_path\index.html. Reason is the same, npm touches dist each time and it touches the parent directory which in its turn triggers the build each time. For complete example see: Angular Router Sample. If default behavior does not work for you, you can use change-detection directly.

pub fn install(self) -> Result<Self>

Executes npm install.

pub fn run(self, cmd: &str) -> Result<Self>

Executes npm run CMD.

pub fn target<P: AsRef<Path>>(self, target_dir: P) -> Self

Sets target (default is node_modules).

pub fn stderr<S: Into<Stdio>>(self, stdio: S) -> Self

Sets stderr for the next command.

You should set it again, if you need also redirect output for the next command.

pub fn stdout<S: Into<Stdio>>(self, stdio: S) -> Self

Sets stdout for the next command.

You should set it again, if you need also redirect output for the next command.

pub fn to_resource_dir(self) -> ResourceDir

Converts to ResourceDir.

Trait Implementations

impl Debug for NpmBuild

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for NpmBuild

fn default() -> NpmBuild

Returns the “default value” for a type.

impl From<NpmBuild> for ResourceDir

fn from(npm_build: NpmBuild) -> Self

Converts to this type from the input type.