Merge pull request #62 from nix-community/nixfmt-auto-root-flag

- Make sure generated `bun.nix` files follow `nixfmt` conventions
- Add a flag for overriding the path to copy workspace packages from;

Author: baileylu121

docs/src/using-the-command-line-tool.md

@@ -40,6 +40,7 @@ Usage
 Options
   -l, --lock-file      The Bun (v1.2+) lockfile to use to produce the Nix expression  (default bun.lock)
   -o, --output-file    The output file to write to - if no file location is provided, print to stdout instead
+  -c, --copy-prefix    The prefix to use when copying workspace or file packages  (default ./)
   -v, --version        Displays current version
   -h, --help           Displays this message
 ```
@@ -56,6 +57,7 @@ Usage: bun2nix [OPTIONS]
 Options:
   -l, --lock-file <LOCK_FILE>      The Bun (v1.2+) lockfile to use to produce the Nix expression [default: ./bun.lock]
   -o, --output-file <OUTPUT_FILE>  The output file to write to - if no file location is provided, print to stdout instead
+  -c, --copy-prefix <COPY_PREFIX>  The prefix to use when copying workspace or file packages [default: ./]
   -h, --help                       Print help
   -V, --version                    Print version
 ```

flake.lock

@@ -6,7 +6,7 @@
       checks.arbitraryInstallCompletes = pkgs.stdenv.mkDerivation {
         name = "bun2nix-exec-test";
 
-        outputHash = "sha256-xOyFWDXEhcpw/36e888JC+1vwNm5o+O3JpZfTfSsg1I=";
+        outputHash = "sha256-rMTHsppsDkgog5w8dJ5w51vU1F8XvdzAbtXXacK4Rx4=";
         outputHashAlgo = "sha256";
         outputHashMode = "recursive";
 
@@ -16,6 +16,7 @@
           nix
           cacert
           git
+          nixfmt
         ];
 
         installPhase = ''
@@ -28,11 +29,18 @@
           export HOME=$PWD/home
           mkdir -p $NIX_STATE_DIR $NIX_STORE_DIR $NIX_PROFILES_DIR $NIX_CONF_DIR $HOME
 
+          bun_nix=$(${lib.getExe self'.packages.bun2nix})
+
           nix eval \
             --extra-experimental-features nix-command \
-            --expr "$(${lib.getExe self'.packages.bun2nix})"
+            --expr "$bun_nix"
+
+          echo ${self'.packages.bun2nix.version} > "$out"
 
-          echo ${self'.packages.bun2nix.version} > $out
+          if [ "$bun_nix" != "$(echo "$bun_nix" | nixfmt)" ]; then
+            printf '\n\033[31mError:\033[0m %s\n\n' "bun2nix generated file should be nix formatted"
+            exit 1
+          fi
         '';
       };
     };

nix/checks/arbitrary-install-completes.nix

@@ -21,7 +21,7 @@ path = "src/lib.rs"
 
 [package]
 name = "bun2nix"
-version = "2.0.4"
+version = "2.0.5"
 edition = "2021"
 
 [profile.release]

programs/bun2nix/Cargo.lock

@@ -1,31 +1,35 @@
 #!/usr/bin/env bun
 
-import { convert_lockfile_to_nix_expression } from "./bun2nix-wasm.js";
+import { convert_lockfile_to_nix_expression, Options } from "./bun2nix-wasm.js";
 
 import sade from "sade";
 import pkgJson from "./package.json" with { type: "json" };
 
 const prog = sade("bun2nix", true);
 
 /** `bun2nix` command line options. */
-type Opts = {
+type CliOpts = {
   /** String path to the lockfile to read in. */
   "lock-file": string;
   /** Output file to write to - writes to stdout if undefined. */
   "output-file": string | undefined;
+  /** The prefix to use when copying workspace or file packages. */
+  "copy-prefix": string;
 };
 
 /**
  * Generate a nix expression for a given bun lockfile
  * Writes to stdout if `output-file` is not specified.
  *
- * @param {Opts} opts - An instance of bun2nix CLI options
+ * @param {CliOpts} opts - An instance of bun2nix CLI options
  */
-export async function generateNixExpression(opts: Opts): Promise<void> {
+export async function generateNixExpression(opts: CliOpts): Promise<void> {
   const lock_file = Bun.file(opts["lock-file"]);
   const contents = await lock_file.text();
 
-  const nix_expression = convert_lockfile_to_nix_expression(contents);
+  const options = new Options(opts["copy-prefix"]);
+
+  const nix_expression = convertLockfileToNixExpression(contents, options);
 
   const output_file = opts["output-file"] || Bun.stdout;
   await Bun.write(output_file, nix_expression + "\n");
@@ -43,6 +47,11 @@ prog
     "-o, --output-file",
     "The output file to write to - if no file location is provided, print to stdout instead",
   )
+  .option(
+    "-c, --copy-prefix",
+    "The prefix to use when copying workspace or file packages",
+    "./",
+  )
   .action((opts) => generateNixExpression(opts));
 
 prog.parse(process.argv);
@@ -51,8 +60,12 @@ prog.parse(process.argv);
  * Convert Bun Lockfile to a Nix expression
  *
  * @param {string} contents - The contents of a bun lockfile
+ * @param {Options} options - Lockfile conversion options
  * @return {string} The generated nix expression
  */
-export function convertLockfileToNixExpression(contents: string): string {
-  return convert_lockfile_to_nix_expression(contents);
+export function convertLockfileToNixExpression(
+  contents: string,
+  options: Options,
+): string {
+  return convert_lockfile_to_nix_expression(contents, options);
 }

programs/bun2nix/Cargo.toml

@@ -1,6 +1,6 @@
 {
   "name": "bun2nix",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "module": "index.ts",
   "bin": {
     "bun2nix": "index.ts"

programs/bun2nix/index.ts

@@ -6,12 +6,13 @@
 pub mod error;
 pub mod lockfile;
 pub mod nix_expression;
+pub mod options;
 pub mod package;
 
-use askama::Template;
 pub use error::{Error, Result};
 pub use lockfile::Lockfile;
 use nix_expression::NixExpression;
+pub use options::Options;
 pub use package::Package;
 
 #[cfg(target_arch = "wasm32")]
@@ -22,7 +23,7 @@ use wasm_bindgen::prelude::*;
 /// Takes a string input of the contents of a bun lockfile and converts it into a ready to use Nix expression which fetches the packages
 #[cfg_attr(target_arch = "wasm32", wasm_bindgen)]
 #[cfg_attr(target_arch = "wasm32", no_mangle)]
-pub fn convert_lockfile_to_nix_expression(contents: String) -> Result<String> {
+pub fn convert_lockfile_to_nix_expression(contents: String, options: Options) -> Result<String> {
     let lockfile = contents.parse::<Lockfile>()?;
 
     if lockfile.lockfile_version != 1 {
@@ -33,5 +34,5 @@ pub fn convert_lockfile_to_nix_expression(contents: String) -> Result<String> {
     packages.sort();
     packages.dedup_by(|a, b| a.name == b.name);
 
-    Ok(NixExpression::new(packages)?.render()?)
+    NixExpression::new(packages)?.render_with_options(options)
 }

programs/bun2nix/package.json

@@ -3,7 +3,7 @@
 
 #![warn(missing_docs)]
 
-use bun2nix::{Result, convert_lockfile_to_nix_expression};
+use bun2nix::{Options, Result, convert_lockfile_to_nix_expression};
 use log::error;
 
 use std::{
@@ -27,6 +27,10 @@ pub struct Cli {
     /// if no file location is provided, print to stdout instead.
     #[arg(short, long)]
     output_file: Option<PathBuf>,
+
+    /// The prefix to use when copying workspace or file packages
+    #[arg(short, long, default_value = "./")]
+    copy_prefix: String,
 }
 
 fn main() {
@@ -48,7 +52,12 @@ fn run() -> Result<()> {
 
     let lockfile = fs::read_to_string(&cli.lock_file)?;
 
-    let nix = convert_lockfile_to_nix_expression(lockfile)?;
+    let nix = convert_lockfile_to_nix_expression(
+        lockfile,
+        Options {
+            copy_prefix: cli.copy_prefix,
+        },
+    )?;
 
     if let Some(output_file) = cli.output_file {
         let mut output = File::create(output_file)?;

programs/bun2nix/src/lib.rs

@@ -4,8 +4,9 @@ mod nix_escaper;
 
 pub use nix_escaper::NixEscaper;
 
-use crate::error::Result;
+use crate::{Options, error::Result};
 use askama::Template;
+use std::{any::Any, collections::HashMap};
 
 use crate::Package;
 
@@ -25,4 +26,14 @@ impl NixExpression {
     pub fn new(packages: Vec<Package>) -> Result<Self> {
         Ok(Self { packages })
     }
+
+    /// # Render with options
+    ///
+    /// Renders a `NixExpression` with the supplied config options
+    pub fn render_with_options(self, options: Options) -> Result<String> {
+        let mut values: HashMap<&str, Box<dyn Any>> = HashMap::new();
+        values.insert("options", Box::new(options));
+
+        Ok(self.render_with_values(&values)?)
+    }
 }