feat: replace everything with dream2nix

.github/workflows/nix.yml

@@ -2,11 +2,15 @@ name: "Nix"
 on:
   workflow_dispatch:
   pull_request:
-    branches: [ master, release-1.0 ]
+    branches: [ master ]
   push:
-    branches: [ master, release-1.0 ]
+    branches: [ master ]
 jobs:
-  brp-tests:
+  tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        builder: [crane, brp]
     runs-on: ubuntu-latest
     steps:
     - name: Checkout repo
@@ -22,48 +26,13 @@ jobs:
       with:
         name: nix-cargo-integration
         authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
-    - name: Tests
-      run: nix build -L --show-trace --no-link --impure --expr 'builtins.removeAttrs (builtins.getFlake (toString ./.)).platformChecks.brp.x86_64-linux [ "preCommitChecks" ]'
-
-  naersk-tests:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout repo
-      uses: actions/checkout@v2
-    - name: Install nix
-      uses: cachix/install-nix-action@v16
-      with:
-        extra_nix_config: |
-          experimental-features = nix-command flakes
-        nix_path: nixpkgs=channel:nixos-unstable
-    - name: Setup cachix
-      uses: cachix/cachix-action@v10
-      with:
-        name: nix-cargo-integration
-        authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
-    - name: Tests
-      run: nix build -L --show-trace --no-link --impure --expr 'builtins.removeAttrs (builtins.getFlake (toString ./.)).platformChecks.naersk.x86_64-linux [ "preCommitChecks" ]'
-
-  crate2nix-tests:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout repo
-      uses: actions/checkout@v2
-    - name: Install nix
-      uses: cachix/install-nix-action@v16
-      with:
-        extra_nix_config: |
-          experimental-features = nix-command flakes
-        nix_path: nixpkgs=channel:nixos-unstable
-    - name: Setup cachix
-      uses: cachix/cachix-action@v10
-      with:
-        name: nix-cargo-integration
-        authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
-    - name: Tests
-      run: nix build -L --show-trace --no-link --impure --expr 'builtins.removeAttrs (builtins.getFlake (toString ./.)).platformChecks.crate2nix.x86_64-linux [ "preCommitChecks" ]'
-
-  dream2nix-tests:
+    - name: Test checks
+      run: nix build -L --keep-going --show-trace --impure --expr '(builtins.getFlake (toString ./.)).${{ matrix.builder }}Tests.checks.${builtins.currentSystem}'
+    - name: Test shells
+      run: nix build -L --keep-going --show-trace --impure --expr '(builtins.getFlake (toString ./.)).${{ matrix.builder }}Tests.shells.${builtins.currentSystem}'
+    - name: Test packages
+      run: nix build -L --keep-going --show-trace --impure --expr '(builtins.getFlake (toString ./.)).${{ matrix.builder }}Tests.packages.${builtins.currentSystem}'
+  build-cli:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout repo
@@ -80,4 +49,4 @@ jobs:
         name: nix-cargo-integration
         authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
     - name: Tests
-      run: nix build -L --show-trace --no-link --impure --expr 'builtins.removeAttrs (builtins.getFlake (toString ./.)).platformChecks.dream2nix.x86_64-linux [ "preCommitChecks" ]'
+      run: nix build .#nci-cli

.gitignore

@@ -3,5 +3,5 @@ tests/**/target
 .direnv
 .envrc
 cli/target
-shell.nix
+/shell.nix
 .vscode

README.md

@@ -2,14 +2,12 @@
 
 Library to easily and effortlessly integrate Cargo projects with Nix.
 
-- Uses [naersk], [crate2nix] or [buildRustPackage] to build Cargo packages and [devshell] to provide a development shell.
-Allows changing between "build platforms" by just changing one attribute (see `buildPlatform`).
+- Uses [dream2nix] to build Cargo packages and [devshell] to provide a development shell.
 - Allows configuration from `Cargo.toml` file(s) via `package.metadata.nix` and `workspace.metadata.nix` attributes.
 - Has sensible defaults, and strives to be compatible with Cargo (autobins, etc.).
 - Aims to offload work from the user; comes with useful configuration options (like `renameOutputs`, `defaultOutputs` etc.)
 - Can generate nixpkgs-compatible Nix expressions that captures all your packages dependencies / env vars and so on.
 You don't need to maintain a seperate derivation for nixpkgs! (see `Generating a nixpkgs-compatible package expression` in manual)
-- [naersk] and [crate2nix] `buildPlatform`s allow building packages directly from `Cargo.lock`. [buildRustPackage] uses the `cargoVendorHash` attribute.
 - A CLI tool that let's you compile and run arbitrary Rust repositories directly without messing with any files or setting up overlays (see `Using the nci CLI` in manual)
 
 ## Usage
@@ -55,16 +53,12 @@ You can also couple it with [niv](https://github.com/nmattia/niv):
 ### Examples
 
 - [Basic flake.nix template with commented fields and overrides](./docs/example_flake.nix)
-- [crate2nix build platform crate overrides usage](https://gitlab.com/veloren/veloren/-/blob/master/flake.nix)
-- [Modifying cargo build options to build a specific feature and changing outputs based on the feature used](https://github.com/yusdacra/bernbot/blob/master/flake.nix)
-- [Flake using a bit of everything](https://github.com/harmony-development/Crust/blob/master/flake.nix)
+- [Flake using a bit of everything](https://github.com/helix-editor/helix/blob/master/flake.nix)
 
 ## Documentation
 
 You can find library API documentation and others at [the manual](./docs/MANUAL.md).
 
 [devshell]: https://github.com/numtide/devshell "devshell"
-[naersk]: https://github.com/nmattia/naersk "naersk"
-[crate2nix]: https://github.com/kolloch/crate2nix "crate2nix"
 [flake-compat]: https://github.com/edolstra/flake-compat "flake-compat"
-[buildRustPackage]: https://github.com/NixOS/nixpkgs/blob/master/doc/languages-frameworks/rust.section.md#compiling-rust-applications-with-cargo-compiling-rust-applications-with-cargo "buildRustPackage"
+[dream2nix]: https://github.com/nix-community/dream2nix "dream2nix"

cli/Cargo.toml

@@ -3,6 +3,7 @@ name = "nci-cli"
 version = "0.1.0"
 edition = "2018"
 authors = ["Yusuf Bera Ertan <y.bera003.06@protonmail.com>"]
+license = "MIT"
 
 [package.metadata.nix]
 build = true

cli/src/flk.nix

@@ -7,7 +7,11 @@
     nci.url = "path:nci_source";
   };
 
-  outputs = { source, nci, ... }@inputs:
+  outputs = {
+    source,
+    nci,
+    ...
+  } @ inputs:
     nci.lib.makeOutputs {
       root = source;
       overrides = {

default.nix

@@ -4,4 +4,4 @@ let
     sha256 = "sha256:0x2jn3vrawwv9xp15674wjz9pixwjyj3j771izayl962zziivbx2";
   };
 in
-(import compat { src = ./.; }).defaultNix.lib
+  (import compat {src = ./.;}).defaultNix.lib

docs/MANUAL.md

@@ -1,7 +1,6 @@
 # Index
 
 - [Library documentation](#library-documentation)
-- [Build platform specific usage](#build-platform-specific-usage)
 - [Generating a nixpkgs-compatible package expression](#generating-a-nixpkgs-compatible-package-expression)
 - [Using the `nci` CLI](#using-the-nci-cli)
 - [Enabling trace](#enabling-trace)
@@ -12,49 +11,36 @@
 **IMPORTANT** public API promises: Any API that is not documented here **IS NOT** counted
 as "public" and therefore can be changed without breaking SemVer. This does not mean that
 changes will be done without any notice. You are still welcome to create issues / discussions
-about them. Upstream projects such as [devshell], `nixpkgs` ([buildRustPackage]) etc. can have
-breaking changes, these breakages will be limited to `overrides`' `shell` and `build` in the
-public API, since these directly modify [devshell] / `buildPlatform` configs.
-
-NOTE: `nix-cargo-integration` does not directly use upstream [naersk] / [crate2nix]. It uses
-forks of them which contain additional fixes and features that aren't upstream.
+about them. Upstream projects such as [devshell], [dream2nix] etc. can have breaking changes,
+these breakages will be limited to `overrides.shell` and `overrides.build` in the public API,
+since these directly modify [devshell] / [dream2nix] builder configs.
 
 ### The `common` attribute set
 
 This attribute set is passed to (almost) all overrides. It contains everything you may
-need for adding stuff, such as the nixpkgs package set (`common.pkgs`), library with
-`nix-cargo-integration` utilities (`common.lib`) and other shared data between build
-and development shell (`common.buildInputs`, `common.env` etc.). For more information
-on what `common` actually exports, please check the bottom of [common.nix](./src/common.nix).
+need for adding stuff, such as the nixpkgs package set (`common.pkgs`) and other shared
+data between build and development shell (`common.buildInputs`, `common.env` etc.). For
+more information on what `common` actually exports, please check the bottom of [common.nix](./src/common.nix).
 
 ### `makeOutputs`
 
 Generates outputs for all systems specified in `Cargo.toml` (defaults to `defaultSystems` of `nixpkgs`).
 
 #### Arguments
 
+- `builder`: which dream2nix builder to use (type: string) (default: `"crane"`)
 - `enablePreCommitHooks`: whether to enable pre-commit hooks (type: boolean) (default: `false`)
-- `buildPlatform`: platform to build crates with (type: `"naersk", "crate2nix" or "buildRustPackage"`) (default: `"naersk"`)
-- `root`: directory where `Cargo.lock` and `Cargo.toml` (workspace or pacakge manifest) is in (type: path)
-- `cargoVendorHash`: vendor hash feeded into [buildRustPackage]'s `cargoSha256` (type: string) (default: `lib.fakeHash`)
-- `useCrate2NixFromPkgs`: toggles using the `crate2nix` package from `nixpkgs` instead of the package in `crate2nix` source (type: boolean) (default: `false`)
-    - this can be helpful if you are facing frequent rebuilds of `crate2nix` (see https://github.com/yusdacra/nix-cargo-integration/issues/38)
+- `root`: directory where `Cargo.lock` and `Cargo.toml` (workspace or package manifest) is in (type: path)
 - `overrides`: overrides for devshell, build and common (type: attrset) (default: `{ }`)
     - `overrides.systems`: mutate the list of systems to generate for (type: `def: [ ]`)
     - `overrides.sources`: override for the sources used by common (type: `common: prev: { }`)
-    - `overrides.pkgs`: override for the configuration while importing nixpkgs in common (type: `common: prev: { }`)
+    - `overrides.pkgsOverlays`: overlays to apply to the nixpkgs package set (type: list of nixpkgs overlays)
     - `overrides.crateOverrides`: override for crate overrides (type: `common: prev: { }`)
-        - with [crate2nix], this will allow you to override per-crate
-        - with [naersk], the overrides here will be collected and be used for
-        overriding the dependencies derivation / main derivation.
-        - with [buildRustPackage], the overrides here will be collected and
-        be used for overriding the resulting derivation.
     - `overrides.common`: override for common (type: `prev: { }`)
         - this will override *all* common attribute set(s), refer to [common.nix](./src/common.nix) for more information
     - `overrides.shell`: override for devshell (type: `common: prev: { }`)
         - this will override *all* [devshell] configuration(s), refer to [devshell] for more information
     - `overrides.build`: override for build config (type: `common: prev: { }`)
-        - this will override [naersk]/[crate2nix]/[buildRustPackage] build config, refer to [naersk]/[crate2nix]/[buildRustPackage] for more information
 - `renameOutputs`: which crates to rename in package names and output names (type: attrset) (default: `{ }`)
 - `defaultOutputs`: which outputs to set as default (type: attrset) (default: `{ }`)
     - `defaultOutputs.app`: app output name to set as default app (`defaultApp`) output (type: string)
@@ -131,12 +117,6 @@ Refer to [devshell] documentation.
 
 NOTE: Attributes specified here **will not** be used if a top-level `devshell.toml` file exists.
 
-## Build platform specific usage
-
-- Disabling tests:
-    - for `crate2nix`: add `runTests = false;` to the `build` override.
-    - for `naersk` and `buildRustPackage`: add `doCheck = false;` to the `build` override.
-
 ## Generating a nixpkgs-compatible package expression
 
 `nix-cargo-integration` will generate outputs named `<packageOutputName>-derivation`.
@@ -172,12 +152,6 @@ variable to `1` and passing `--impure` to `nix`. Example:
 NCI_DEBUG=1 nix build --impure .
 ```
 
-[devshell]: https://github.com/numtide/devshell "devshell"
-[naersk]: https://github.com/nmattia/naersk "naersk"
-[crate2nix]: https://github.com/kolloch/crate2nix "crate2nix"
-[flake-compat]: https://github.com/edolstra/flake-compat "flake-compat"
-[buildRustPackage]: https://github.com/NixOS/nixpkgs/blob/master/doc/languages-frameworks/rust.section.md#compiling-rust-applications-with-cargo-compiling-rust-applications-with-cargo "buildRustPackage"
-
 ## Tips and tricks
 
 ### Ignoring `Cargo.lock` in Rust libraries
@@ -198,3 +172,7 @@ A neat fix for that is to track the path to `Cargo.lock` without staging it
 $ git add --intend-to-add Cargo.lock
 ```
 Add `--force` if your `Cargo.lock` is listed in `.gitignore`.
+
+[devshell]: https://github.com/numtide/devshell "devshell"
+[flake-compat]: https://github.com/edolstra/flake-compat "flake-compat"
+[dream2nix]: https://github.com/nix-community/dream2nix "dream2nix"