From 22378a7c39ac5bd7695a539836ce02dec8e979b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20M=C3=BCller?= Date: Tue, 4 Mar 2025 10:06:02 +0100 Subject: [PATCH 1/7] Add Licenses MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marcel Müller --- LICENSE-APACHE-2.0 | 201 +++++++++++++++++++++++++++++++++++++++++++++ LICENSE-MIT | 21 +++++ 2 files changed, 222 insertions(+) create mode 100644 LICENSE-APACHE-2.0 create mode 100644 LICENSE-MIT diff --git a/LICENSE-APACHE-2.0 b/LICENSE-APACHE-2.0 new file mode 100644 index 0000000..9324ba8 --- /dev/null +++ b/LICENSE-APACHE-2.0 @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2025 Marcel Müller + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..c6fca4b --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Marcel Müller + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From 89f5401e5ddbaabc76b0874e9b083891e6c4df10 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20M=C3=BCller?= Date: Tue, 4 Mar 2025 10:36:46 +0100 Subject: [PATCH 2/7] Build main binary with the latest stable MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marcel Müller --- flake.nix | 6 +----- lib/cargo-dylint-general.nix | 15 ++++++++------- lib/mk-dylint.nix | 12 +++++++----- 3 files changed, 16 insertions(+), 17 deletions(-) diff --git a/flake.nix b/flake.nix index 7bc926b..2b4a11b 100644 --- a/flake.nix +++ b/flake.nix @@ -23,11 +23,7 @@ ]; }; - rustTarget = pkgs.rust-bin.nightly."2025-01-09".default.override { - extensions = [ - "rustc-dev" - ]; - }; + rustTarget = pkgs.rust-bin.stable.latest.default.override { }; craneLib = (inputs.crane.mkLib pkgs).overrideToolchain rustTarget; lib = import ./lib { diff --git a/lib/cargo-dylint-general.nix b/lib/cargo-dylint-general.nix index 964be22..e17ac7d 100644 --- a/lib/cargo-dylint-general.nix +++ b/lib/cargo-dylint-general.nix @@ -20,6 +20,10 @@ let sha256 = "sha256-Z8uuewp7Buoadayc0oTafmfvwNT36KukWKiHxL/mQfI="; }; + crane = craneLib.overrideToolchain ( + pkgs.rust-bin.nightly."2025-01-09".default.override { extensions = [ "rustc-dev" ]; } + ); + commonArgs = { inherit pname version; @@ -35,23 +39,20 @@ let cargo-dylint ]; - cargoVendorDir = craneLib.vendorCargoDeps { cargoLock = ./cargo-dylint-general-Cargo.lock; }; + cargoVendorDir = crane.vendorCargoDeps { cargoLock = ./cargo-dylint-general-Cargo.lock; }; preBuild = '' cd examples/general mkdir -p .cargo ''; - - CARGO_TARGET_X86_64_UNKNOWN_LINUX_GNU_LINKER = "dylint-link"; - - cargoExtraArgs = "-p crate_wide_allow"; + cargoExtraArgs = "-p general"; RUSTUP_TOOLCHAIN = "nightly-2025-01-09"; }; in -craneLib.buildPackage ( +crane.buildPackage ( commonArgs // { cargoArtifacts = null; @@ -59,7 +60,7 @@ craneLib.buildPackage ( doCheck = false; postFixup = '' - ${util-linux}/bin/rename .so @$RUSTUP_TOOLCHAIN.so $out/lib/*.so + mv $out/lib/libgeneral{.so,@$RUSTUP_TOOLCHAIN.so} ''; doNotRemoveReferencesToRustToolchain = true; diff --git a/lib/mk-dylint.nix b/lib/mk-dylint.nix index c1831e5..06cbdb4 100644 --- a/lib/mk-dylint.nix +++ b/lib/mk-dylint.nix @@ -21,12 +21,14 @@ let } ) ) driver_names; - drivers = pkgs.runCommandLocal "dylint-drivers" { } ( - lib.strings.concatMapAttrsStringSep "\n" (name: driver: '' + drivers = pkgs.runCommandLocal "dylint-drivers" { } '' + mkdir -p $out + + ${lib.strings.concatMapAttrsStringSep "\n" (name: driver: '' mkdir -p $out/nightly-${name} ln -s ${driver}/bin/dylint_driver-nix $out/nightly-${name}/dylint-driver - '') driverMap - ); + '') driverMap} + ''; in pkgs.runCommandLocal "cargo-dylint-wrapped" { @@ -35,6 +37,6 @@ pkgs.runCommandLocal "cargo-dylint-wrapped" } '' makeWrapper ${cargo-dylint}/bin/cargo-dylint $out/bin/cargo-dylint \ - --set DYLINT_LIBRARY_PATH ${lib.strings.makeLibraryPath (builtins.map (v: v.package) lints)} \ + --set-default DYLINT_LIBRARY_PATH "${lib.strings.makeLibraryPath (builtins.map (v: v.package) lints)}" \ --set DYLINT_DRIVER_PATH ${drivers}; '' From 85ba1e39cc7a45214a002191bfed974772d7ac8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20M=C3=BCller?= Date: Tue, 4 Mar 2025 10:53:57 +0100 Subject: [PATCH 3/7] Use mkLib pattern MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marcel Müller --- flake.nix | 19 ++++++------------- lib/default.nix | 3 +-- mk-lib.nix | 6 ++++++ 3 files changed, 13 insertions(+), 15 deletions(-) create mode 100644 mk-lib.nix diff --git a/flake.nix b/flake.nix index 2b4a11b..5863704 100644 --- a/flake.nix +++ b/flake.nix @@ -24,29 +24,22 @@ }; rustTarget = pkgs.rust-bin.stable.latest.default.override { }; - craneLib = (inputs.crane.mkLib pkgs).overrideToolchain rustTarget; - lib = import ./lib { - inherit - inputs - craneLib - pkgs - ; + dylintLib = import ./mk-lib.nix { + inherit pkgs; + inherit (inputs) crane; }; lints = [ { toolchain = "2025-01-09"; - package = lib.cargo-dylint-general; + package = dylintLib.cargo-dylint-general; } ]; - dylint = lib.mkDylint { inherit lints; }; + dylint = dylintLib.mkDylint { inherit lints; }; in { - packages = lib // { - inherit craneLib; - rust = rustTarget; - }; + mkLib = import ./mk-lib.nix; devShells.default = pkgs.mkShell { nativeBuildInputs = [ diff --git a/lib/default.nix b/lib/default.nix index e0ca238..93be402 100644 --- a/lib/default.nix +++ b/lib/default.nix @@ -1,12 +1,11 @@ { pkgs, - inputs, craneLib, ... }: let - callPackage = pkgs.lib.callPackageWith (pkgs // packages // { inherit inputs craneLib; }); + callPackage = pkgs.lib.callPackageWith (pkgs // packages // { inherit craneLib; }); packages = { cargo-dylint = callPackage ./cargo-dylint.nix { }; cargo-dylint-general = callPackage ./cargo-dylint-general.nix { }; diff --git a/mk-lib.nix b/mk-lib.nix new file mode 100644 index 0000000..9c58324 --- /dev/null +++ b/mk-lib.nix @@ -0,0 +1,6 @@ +{ pkgs, crane }: + +import ./lib { + inherit pkgs; + craneLib = (crane.mkLib pkgs).overrideToolchain pkgs.rust-bin.stable.latest.default; +} From 520a91a22e7e722b57e72624f3f1f7d80243b2be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20M=C3=BCller?= Date: Tue, 4 Mar 2025 10:56:58 +0100 Subject: [PATCH 4/7] Strip prefix rather than prepending nightly MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marcel Müller --- lib/mk-dylint.nix | 8 ++++---- rust-toolchain.toml | 3 --- 2 files changed, 4 insertions(+), 7 deletions(-) delete mode 100644 rust-toolchain.toml diff --git a/lib/mk-dylint.nix b/lib/mk-dylint.nix index 06cbdb4..c13e9c7 100644 --- a/lib/mk-dylint.nix +++ b/lib/mk-dylint.nix @@ -13,8 +13,8 @@ let driver_names = lib.groupBy (v: v.toolchain) lints; driverMap = builtins.mapAttrs ( name: _: - mkCargoDylintDriver "nightly-${name}" ( - pkgs.rust-bin.nightly."${name}".default.override { + mkCargoDylintDriver "${name}" ( + pkgs.rust-bin.nightly."${lib.removePrefix "nightly-" name}".default.override { extensions = [ "rustc-dev" ]; @@ -25,8 +25,8 @@ let mkdir -p $out ${lib.strings.concatMapAttrsStringSep "\n" (name: driver: '' - mkdir -p $out/nightly-${name} - ln -s ${driver}/bin/dylint_driver-nix $out/nightly-${name}/dylint-driver + mkdir -p $out/${name} + ln -s ${driver}/bin/dylint_driver-nix $out/${name}/dylint-driver '') driverMap} ''; in diff --git a/rust-toolchain.toml b/rust-toolchain.toml deleted file mode 100644 index 9b1b31a..0000000 --- a/rust-toolchain.toml +++ /dev/null @@ -1,3 +0,0 @@ -[toolchain] -channel = "nightly-2025-03-01" -components = ["rust-src", "rustc-dev", "llvm-tools-preview"] From bd031f91058026ad4d171c3ff31645cf46137905 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20M=C3=BCller?= Date: Tue, 4 Mar 2025 11:04:11 +0100 Subject: [PATCH 5/7] Throw an error if there is channel prefix MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit For example if someone just puts in a date Signed-off-by: Marcel Müller --- flake.nix | 2 +- lib/mk-dylint.nix | 22 ++++++++++++++-------- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/flake.nix b/flake.nix index 5863704..c9bf36c 100644 --- a/flake.nix +++ b/flake.nix @@ -32,7 +32,7 @@ lints = [ { - toolchain = "2025-01-09"; + toolchain = "nightly-2025-01-09"; package = dylintLib.cargo-dylint-general; } ]; diff --git a/lib/mk-dylint.nix b/lib/mk-dylint.nix index c13e9c7..da6c62b 100644 --- a/lib/mk-dylint.nix +++ b/lib/mk-dylint.nix @@ -13,13 +13,17 @@ let driver_names = lib.groupBy (v: v.toolchain) lints; driverMap = builtins.mapAttrs ( name: _: - mkCargoDylintDriver "${name}" ( - pkgs.rust-bin.nightly."${lib.removePrefix "nightly-" name}".default.override { - extensions = [ - "rustc-dev" - ]; - } - ) + lib.throwIf ((builtins.match "^[[:digit:]].*$" name) != null) + "Rust toolchains generally do not start with numbers. Make sure you include the channel, as in `nightly-YYYY-MM-DD`. Given '${name}'" + mkCargoDylintDriver + "${name}" + ( + pkgs.rust-bin.nightly."${lib.removePrefix "nightly-" name}".default.override { + extensions = [ + "rustc-dev" + ]; + } + ) ) driver_names; drivers = pkgs.runCommandLocal "dylint-drivers" { } '' mkdir -p $out @@ -37,6 +41,8 @@ pkgs.runCommandLocal "cargo-dylint-wrapped" } '' makeWrapper ${cargo-dylint}/bin/cargo-dylint $out/bin/cargo-dylint \ - --set-default DYLINT_LIBRARY_PATH "${lib.strings.makeLibraryPath (builtins.map (v: v.package) lints)}" \ + --set-default DYLINT_LIBRARY_PATH "${ + lib.strings.makeLibraryPath (builtins.map (v: v.package) lints) + }" \ --set DYLINT_DRIVER_PATH ${drivers}; '' From c394a61aa047867896f9c762aad894694eb197cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20M=C3=BCller?= Date: Tue, 4 Mar 2025 11:08:21 +0100 Subject: [PATCH 6/7] Directly use the toolchain as given MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Previously we hardcoded the nightly chain. This might not be true in the future! Signed-off-by: Marcel Müller --- lib/mk-cargo-dylint-driver.nix | 13 ++++++++++++- lib/mk-dylint.nix | 7 ------- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/lib/mk-cargo-dylint-driver.nix b/lib/mk-cargo-dylint-driver.nix index 2286a99..face965 100644 --- a/lib/mk-cargo-dylint-driver.nix +++ b/lib/mk-cargo-dylint-driver.nix @@ -1,13 +1,24 @@ { + pkgs, craneLib, }: -toolchainName: toolchain: +toolchainName: let pname = "cargo-dylint-driver-${toolchainName}"; version = "4.0.0"; src = ../dylint_driver; + toolchain = + (pkgs.rust-bin.fromRustupToolchainFile ( + pkgs.writeText "${toolchainName}-toolchain.toml" toolchainName + )).override + { + extensions = [ + "rustc-dev" + ]; + }; + in (craneLib.overrideToolchain toolchain).buildPackage ({ diff --git a/lib/mk-dylint.nix b/lib/mk-dylint.nix index da6c62b..aa70012 100644 --- a/lib/mk-dylint.nix +++ b/lib/mk-dylint.nix @@ -17,13 +17,6 @@ let "Rust toolchains generally do not start with numbers. Make sure you include the channel, as in `nightly-YYYY-MM-DD`. Given '${name}'" mkCargoDylintDriver "${name}" - ( - pkgs.rust-bin.nightly."${lib.removePrefix "nightly-" name}".default.override { - extensions = [ - "rustc-dev" - ]; - } - ) ) driver_names; drivers = pkgs.runCommandLocal "dylint-drivers" { } '' mkdir -p $out From c7066340b8e152f14a347fb2f0e1707464f8d3b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20M=C3=BCller?= Date: Tue, 4 Mar 2025 11:09:38 +0100 Subject: [PATCH 7/7] Add README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marcel Müller --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ca24575 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# Dylint as a nix library + +This repository contains a nix library that allows easy access to the +[dylint](https://github.com/trailofbits/dylint) project in a reproducible way. + + +## How to use + +Dylint has some [great +documentation](https://github.com/trailofbits/dylint/blob/f4cdda1d071022a2bb846b810333544d1238559b/docs/2024-10-11%20Linting%20with%20Dylint%20(EuroRust).pdf) +on how Dylint itself works. + +This library then compiles and assembles the different parts you need to get it +working inside nix. + +### Prerequisites + +Using `nix-dylint` requires the following: + +- A `nixpkgs` instance with the `rust-overlay` applied from + [`oxalica/rust-overlay`](https://github.com/oxalica/rust-overlay/tree/master). +- A list of lints and their nightly toolchains, formatted as e.g. + `nightly-{date}` + +### Building a dylint instance + +Dylint tries its best to do everything for you, but this clashes with the way +`nix`-users generally use their software. So this library generates a +`cargo-dylint` wrapper with the relevant env variables set such that it should +not build anything. + +Assembling it all, it might look like this: + +```nix + dylintLib = inputs.nix-dylint.mkLib { inherit pkgs crane; }; + dylint = dylintLib.mkDylint { lints = [ + { + toolchain = "nightly-2025-01-09"; + package = dylintLib.cargo-dylint-general; + } + ]; } +``` + + +`dylint` is then a derivation that provides the `cargo-dylint` executable. One +can then use it as usual.