diff --git a/LICENSE-APACHE-2.0 b/LICENSE-APACHE-2.0 deleted file mode 100644 index 9324ba8..0000000 --- a/LICENSE-APACHE-2.0 +++ /dev/null @@ -1,201 +0,0 @@ - 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 deleted file mode 100644 index c6fca4b..0000000 --- a/LICENSE-MIT +++ /dev/null @@ -1,21 +0,0 @@ -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. diff --git a/README.md b/README.md deleted file mode 100644 index ca24575..0000000 --- a/README.md +++ /dev/null @@ -1,46 +0,0 @@ -# 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. diff --git a/flake.nix b/flake.nix index c9bf36c..7bc926b 100644 --- a/flake.nix +++ b/flake.nix @@ -23,23 +23,34 @@ ]; }; - rustTarget = pkgs.rust-bin.stable.latest.default.override { }; + rustTarget = pkgs.rust-bin.nightly."2025-01-09".default.override { + extensions = [ + "rustc-dev" + ]; + }; + craneLib = (inputs.crane.mkLib pkgs).overrideToolchain rustTarget; - dylintLib = import ./mk-lib.nix { - inherit pkgs; - inherit (inputs) crane; + lib = import ./lib { + inherit + inputs + craneLib + pkgs + ; }; lints = [ { - toolchain = "nightly-2025-01-09"; - package = dylintLib.cargo-dylint-general; + toolchain = "2025-01-09"; + package = lib.cargo-dylint-general; } ]; - dylint = dylintLib.mkDylint { inherit lints; }; + dylint = lib.mkDylint { inherit lints; }; in { - mkLib = import ./mk-lib.nix; + packages = lib // { + inherit craneLib; + rust = rustTarget; + }; devShells.default = pkgs.mkShell { nativeBuildInputs = [ diff --git a/lib/cargo-dylint-general.nix b/lib/cargo-dylint-general.nix index e17ac7d..964be22 100644 --- a/lib/cargo-dylint-general.nix +++ b/lib/cargo-dylint-general.nix @@ -20,10 +20,6 @@ let sha256 = "sha256-Z8uuewp7Buoadayc0oTafmfvwNT36KukWKiHxL/mQfI="; }; - crane = craneLib.overrideToolchain ( - pkgs.rust-bin.nightly."2025-01-09".default.override { extensions = [ "rustc-dev" ]; } - ); - commonArgs = { inherit pname version; @@ -39,20 +35,23 @@ let cargo-dylint ]; - cargoVendorDir = crane.vendorCargoDeps { cargoLock = ./cargo-dylint-general-Cargo.lock; }; + cargoVendorDir = craneLib.vendorCargoDeps { cargoLock = ./cargo-dylint-general-Cargo.lock; }; preBuild = '' cd examples/general mkdir -p .cargo ''; - cargoExtraArgs = "-p general"; + + CARGO_TARGET_X86_64_UNKNOWN_LINUX_GNU_LINKER = "dylint-link"; + + cargoExtraArgs = "-p crate_wide_allow"; RUSTUP_TOOLCHAIN = "nightly-2025-01-09"; }; in -crane.buildPackage ( +craneLib.buildPackage ( commonArgs // { cargoArtifacts = null; @@ -60,7 +59,7 @@ crane.buildPackage ( doCheck = false; postFixup = '' - mv $out/lib/libgeneral{.so,@$RUSTUP_TOOLCHAIN.so} + ${util-linux}/bin/rename .so @$RUSTUP_TOOLCHAIN.so $out/lib/*.so ''; doNotRemoveReferencesToRustToolchain = true; diff --git a/lib/default.nix b/lib/default.nix index 93be402..e0ca238 100644 --- a/lib/default.nix +++ b/lib/default.nix @@ -1,11 +1,12 @@ { pkgs, + inputs, craneLib, ... }: let - callPackage = pkgs.lib.callPackageWith (pkgs // packages // { inherit craneLib; }); + callPackage = pkgs.lib.callPackageWith (pkgs // packages // { inherit inputs craneLib; }); packages = { cargo-dylint = callPackage ./cargo-dylint.nix { }; cargo-dylint-general = callPackage ./cargo-dylint-general.nix { }; diff --git a/lib/mk-cargo-dylint-driver.nix b/lib/mk-cargo-dylint-driver.nix index face965..2286a99 100644 --- a/lib/mk-cargo-dylint-driver.nix +++ b/lib/mk-cargo-dylint-driver.nix @@ -1,24 +1,13 @@ { - pkgs, craneLib, }: -toolchainName: +toolchainName: toolchain: 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 aa70012..c1831e5 100644 --- a/lib/mk-dylint.nix +++ b/lib/mk-dylint.nix @@ -13,19 +13,20 @@ let driver_names = lib.groupBy (v: v.toolchain) lints; driverMap = builtins.mapAttrs ( name: _: - 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}" + mkCargoDylintDriver "nightly-${name}" ( + pkgs.rust-bin.nightly."${name}".default.override { + extensions = [ + "rustc-dev" + ]; + } + ) ) driver_names; - drivers = pkgs.runCommandLocal "dylint-drivers" { } '' - mkdir -p $out - - ${lib.strings.concatMapAttrsStringSep "\n" (name: driver: '' - mkdir -p $out/${name} - ln -s ${driver}/bin/dylint_driver-nix $out/${name}/dylint-driver - '') driverMap} - ''; + drivers = pkgs.runCommandLocal "dylint-drivers" { } ( + lib.strings.concatMapAttrsStringSep "\n" (name: driver: '' + mkdir -p $out/nightly-${name} + ln -s ${driver}/bin/dylint_driver-nix $out/nightly-${name}/dylint-driver + '') driverMap + ); in pkgs.runCommandLocal "cargo-dylint-wrapped" { @@ -34,8 +35,6 @@ 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 DYLINT_LIBRARY_PATH ${lib.strings.makeLibraryPath (builtins.map (v: v.package) lints)} \ --set DYLINT_DRIVER_PATH ${drivers}; '' diff --git a/mk-lib.nix b/mk-lib.nix deleted file mode 100644 index 9c58324..0000000 --- a/mk-lib.nix +++ /dev/null @@ -1,6 +0,0 @@ -{ pkgs, crane }: - -import ./lib { - inherit pkgs; - craneLib = (crane.mkLib pkgs).overrideToolchain pkgs.rust-bin.stable.latest.default; -} diff --git a/rust-toolchain.toml b/rust-toolchain.toml new file mode 100644 index 0000000..9b1b31a --- /dev/null +++ b/rust-toolchain.toml @@ -0,0 +1,3 @@ +[toolchain] +channel = "nightly-2025-03-01" +components = ["rust-src", "rustc-dev", "llvm-tools-preview"]