├── NuJet ├── build │ ├── NuJetVersion.txt │ └── NuJet.props ├── props │ ├── localOrRemote.props │ ├── commonProperties.props │ ├── continuousIntegration.props │ ├── enableSourceLink.props │ ├── logMessages.props │ └── localDevelopment.props ├── NuJet.csproj ├── Directory.Build.targets └── Directory.Build.props ├── images └── nujet.png ├── Examples ├── 01. Simple example │ ├── Program.cs │ ├── SimpleExample.csproj │ └── SimpleExample.sln ├── 02. Simple example but with configs │ ├── Program.cs │ ├── SimpleExampleWithConfigs.csproj │ └── SimpleExampleWithConfigs.sln └── 03. Advanced example │ ├── AdvancedExample │ ├── Program.cs │ └── AdvancedExample.csproj │ ├── NuJetWrapper │ └── NuJetWrapper.csproj │ └── AdvancedExample.sln ├── LICENSE ├── NuJet.sln ├── .github └── workflows │ └── ci.yml ├── README.md └── .gitignore /NuJet/build/NuJetVersion.txt: -------------------------------------------------------------------------------- 1 | v0.0.1 2 | -------------------------------------------------------------------------------- /images/nujet.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gioce90/NuJet/HEAD/images/nujet.png -------------------------------------------------------------------------------- /Examples/01. Simple example/Program.cs: -------------------------------------------------------------------------------- 1 | // See https://aka.ms/new-console-template for more information 2 | Console.WriteLine("Hello, World!"); 3 | -------------------------------------------------------------------------------- /Examples/02. Simple example but with configs/Program.cs: -------------------------------------------------------------------------------- 1 | // See https://aka.ms/new-console-template for more information 2 | Console.WriteLine("Hello, World!"); 3 | -------------------------------------------------------------------------------- /Examples/03. Advanced example/AdvancedExample/Program.cs: -------------------------------------------------------------------------------- 1 | // See https://aka.ms/new-console-template for more information 2 | Console.WriteLine("Hello, World!"); 3 | -------------------------------------------------------------------------------- /NuJet/props/localOrRemote.props: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | false 6 | 7 | 8 | true 9 | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /NuJet/props/commonProperties.props: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | Add text here 10 | Add text here 11 | Add text here 12 | 13 | 14 | -------------------------------------------------------------------------------- /NuJet/NuJet.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Library 5 | net8.0 6 | enable 7 | enable 8 | 9 | 0.0.1 10 | Enhance your NuGet development cycle experience! 11 | 12 | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /Examples/01. Simple example/SimpleExample.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Exe 5 | net8.0 6 | enable 7 | enable 8 | 9 | 10 | 11 | 12 | all 13 | runtime; build; native; contentfiles; analyzers; buildtransitive 14 | 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /Examples/03. Advanced example/AdvancedExample/AdvancedExample.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Exe 5 | net8.0 6 | enable 7 | enable 8 | 9 | 1.0.0 10 | 11 | 12 | 13 | 14 | all 15 | runtime; build; native; contentfiles; analyzers; buildtransitive 16 | 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /Examples/02. Simple example but with configs/SimpleExampleWithConfigs.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Exe 5 | net8.0 6 | enable 7 | enable 8 | 9 | 10 | 11 | 12 | all 13 | runtime; build; native; contentfiles; analyzers; buildtransitive 14 | 15 | 16 | 17 | 18 | $(NuGetPackageRoot)locale 19 | AnotherSuffix 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /NuJet/Directory.Build.targets: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 12 | 13 | 14 | 15 | true 16 | build\props\ 17 | 18 | 19 | 24 | 25 | 26 | true 27 | build\ 28 | 29 | 30 | 34 | 35 | 36 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2024 Gioacchino Piazzolla 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /Examples/01. Simple example/SimpleExample.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 17 4 | VisualStudioVersion = 17.11.35312.102 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SimpleExample", "SimpleExample.csproj", "{30EDC743-8BCB-4BD0-AA89-F074FB820FDC}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|Any CPU = Debug|Any CPU 11 | Release|Any CPU = Release|Any CPU 12 | EndGlobalSection 13 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 14 | {30EDC743-8BCB-4BD0-AA89-F074FB820FDC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 15 | {30EDC743-8BCB-4BD0-AA89-F074FB820FDC}.Debug|Any CPU.Build.0 = Debug|Any CPU 16 | {30EDC743-8BCB-4BD0-AA89-F074FB820FDC}.Release|Any CPU.ActiveCfg = Release|Any CPU 17 | {30EDC743-8BCB-4BD0-AA89-F074FB820FDC}.Release|Any CPU.Build.0 = Release|Any CPU 18 | EndGlobalSection 19 | GlobalSection(SolutionProperties) = preSolution 20 | HideSolutionNode = FALSE 21 | EndGlobalSection 22 | GlobalSection(ExtensibilityGlobals) = postSolution 23 | SolutionGuid = {3E8DFAE6-75DE-4E29-A347-2FCADA2EB61A} 24 | EndGlobalSection 25 | EndGlobal 26 | -------------------------------------------------------------------------------- /Examples/02. Simple example but with configs/SimpleExampleWithConfigs.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 17 4 | VisualStudioVersion = 17.11.35312.102 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SimpleExampleWithConfigs", "SimpleExampleWithConfigs.csproj", "{30EDC743-8BCB-4BD0-AA89-F074FB820FDC}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|Any CPU = Debug|Any CPU 11 | Release|Any CPU = Release|Any CPU 12 | EndGlobalSection 13 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 14 | {30EDC743-8BCB-4BD0-AA89-F074FB820FDC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 15 | {30EDC743-8BCB-4BD0-AA89-F074FB820FDC}.Debug|Any CPU.Build.0 = Debug|Any CPU 16 | {30EDC743-8BCB-4BD0-AA89-F074FB820FDC}.Release|Any CPU.ActiveCfg = Release|Any CPU 17 | {30EDC743-8BCB-4BD0-AA89-F074FB820FDC}.Release|Any CPU.Build.0 = Release|Any CPU 18 | EndGlobalSection 19 | GlobalSection(SolutionProperties) = preSolution 20 | HideSolutionNode = FALSE 21 | EndGlobalSection 22 | GlobalSection(ExtensibilityGlobals) = postSolution 23 | SolutionGuid = {3E8DFAE6-75DE-4E29-A347-2FCADA2EB61A} 24 | EndGlobalSection 25 | EndGlobal 26 | -------------------------------------------------------------------------------- /NuJet/props/continuousIntegration.props: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 10 | true 11 | 12 | 13 | 14 | 17 | 18 | 20 | 21 | 22 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /Examples/03. Advanced example/NuJetWrapper/NuJetWrapper.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Library 5 | net8.0 6 | enable 7 | enable 8 | 9 | 1.0.0 10 | 11 | Your name 12 | Your Company name 13 | 14 | 15 | An example of a NuJet Wrapper! 16 | If you have many private nuget packages with different personalized settings, do not use NuJet directly: produce a wrapper package instead. 17 | The wrapper will brings all your properties and settings in one place. 18 | And will be the only package that need to reference NuJet diretly. 19 | Your packages need to reference only your personalized NuJet Wrapper! 20 | Advice: you can call it as you wish, for example: My.NuJet.Wrapper or My.Company.NuJet.Wrapper. 21 | In this example is called NuJetWrapper.1.0.0-Local.nupkg 22 | 23 | 24 | 25 | 26 | 27 | all 28 | runtime; build; native; contentfiles; analyzers; buildtransitive 29 | 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /NuJet.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 17 4 | VisualStudioVersion = 17.11.35312.102 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NuJet", "Nujet\NuJet.csproj", "{D2525EC5-D553-4173-8263-41D80D4A5890}" 7 | EndProject 8 | Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{0F6DEAEC-FAA4-4FFD-AB46-16990F79ED21}" 9 | ProjectSection(SolutionItems) = preProject 10 | images\nujet.png = images\nujet.png 11 | README.md = README.md 12 | EndProjectSection 13 | EndProject 14 | Global 15 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 16 | Debug|Any CPU = Debug|Any CPU 17 | Release|Any CPU = Release|Any CPU 18 | EndGlobalSection 19 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 20 | {D2525EC5-D553-4173-8263-41D80D4A5890}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 21 | {D2525EC5-D553-4173-8263-41D80D4A5890}.Debug|Any CPU.Build.0 = Debug|Any CPU 22 | {D2525EC5-D553-4173-8263-41D80D4A5890}.Release|Any CPU.ActiveCfg = Release|Any CPU 23 | {D2525EC5-D553-4173-8263-41D80D4A5890}.Release|Any CPU.Build.0 = Release|Any CPU 24 | EndGlobalSection 25 | GlobalSection(SolutionProperties) = preSolution 26 | HideSolutionNode = FALSE 27 | EndGlobalSection 28 | GlobalSection(ExtensibilityGlobals) = postSolution 29 | SolutionGuid = {88F6408F-B8D7-4A70-B43D-F1CC0E1A1D74} 30 | EndGlobalSection 31 | EndGlobal 32 | -------------------------------------------------------------------------------- /Examples/03. Advanced example/AdvancedExample.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 17 4 | VisualStudioVersion = 17.11.35312.102 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NuJetWrapper", "NuJetWrapper\NuJetWrapper.csproj", "{FC9BBFDA-6396-462B-A7D7-4AF38171979C}" 7 | EndProject 8 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AdvancedExample", "AdvancedExample\AdvancedExample.csproj", "{44917149-9DB4-4108-B34A-6AD31BBFC9F5}" 9 | EndProject 10 | Global 11 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 12 | Debug|Any CPU = Debug|Any CPU 13 | Release|Any CPU = Release|Any CPU 14 | EndGlobalSection 15 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 16 | {FC9BBFDA-6396-462B-A7D7-4AF38171979C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 17 | {FC9BBFDA-6396-462B-A7D7-4AF38171979C}.Debug|Any CPU.Build.0 = Debug|Any CPU 18 | {FC9BBFDA-6396-462B-A7D7-4AF38171979C}.Release|Any CPU.ActiveCfg = Release|Any CPU 19 | {FC9BBFDA-6396-462B-A7D7-4AF38171979C}.Release|Any CPU.Build.0 = Release|Any CPU 20 | {44917149-9DB4-4108-B34A-6AD31BBFC9F5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 21 | {44917149-9DB4-4108-B34A-6AD31BBFC9F5}.Debug|Any CPU.Build.0 = Debug|Any CPU 22 | {44917149-9DB4-4108-B34A-6AD31BBFC9F5}.Release|Any CPU.ActiveCfg = Release|Any CPU 23 | {44917149-9DB4-4108-B34A-6AD31BBFC9F5}.Release|Any CPU.Build.0 = Release|Any CPU 24 | EndGlobalSection 25 | GlobalSection(SolutionProperties) = preSolution 26 | HideSolutionNode = FALSE 27 | EndGlobalSection 28 | GlobalSection(ExtensibilityGlobals) = postSolution 29 | SolutionGuid = {3E8DFAE6-75DE-4E29-A347-2FCADA2EB61A} 30 | EndGlobalSection 31 | EndGlobal 32 | -------------------------------------------------------------------------------- /NuJet/props/enableSourceLink.props: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | true 11 | 12 | true 13 | 14 | embedded 15 | 16 | 17 | 18 | 19 | 20 | 22 | 23 | 24 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | # This is a basic workflow to help you get started with Actions 2 | 3 | name: CI 4 | 5 | # Controls when the workflow will run 6 | on: 7 | # Triggers the workflow on push or pull request events but only for the "main" branch 8 | push: 9 | branches: [ "main" ] 10 | pull_request: 11 | branches: [ "main" ] 12 | 13 | # Allows you to run this workflow manually from the Actions tab 14 | workflow_dispatch: 15 | 16 | # A workflow run is made up of one or more jobs that can run sequentially or in parallel 17 | jobs: 18 | # This workflow contains a single job called "build" 19 | build: 20 | # The type of runner that the job will run on 21 | runs-on: ubuntu-latest 22 | 23 | # Steps represent a sequence of tasks that will be executed as part of the job 24 | steps: 25 | # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it 26 | - uses: actions/checkout@v4 27 | 28 | # Runs a single command using the runners shell 29 | - name: Run a one-line script 30 | run: echo NuJet is ready to be build and pack! 31 | 32 | # Set .NET environment 33 | - name: Setup .NET 34 | uses: actions/setup-dotnet@v4 35 | with: 36 | dotnet-version: '8.0' 37 | 38 | # Restore dependencies 39 | - name: Restore dependencies 40 | run: dotnet restore NuJet 41 | 42 | # Build the solution 43 | - name: Build solution 44 | run: dotnet build NuJet --configuration Release 45 | 46 | # Pack the NuGet package 47 | - name: Pack the NuGet package 48 | run: dotnet pack NuJet --configuration Release --output ./artifacts 49 | 50 | # Publish the NuGet package 51 | - name: Publish to NuGet 52 | run: dotnet nuget push ./artifacts/*.nupkg --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json 53 | -------------------------------------------------------------------------------- /NuJet/Directory.Build.props: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 12 | true 13 | 14 | 15 | true 16 | 17 | 18 | Gioacchino Piazzolla - Gioce90 19 | Gioce90 20 | 21 | 22 | 23 | 25 | 26 | 27 | 30 | 31 | 32 | 33 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | -------------------------------------------------------------------------------- /NuJet/build/NuJet.props: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 12 | true 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 75 | 76 | 77 | 82 | 83 | 84 | -------------------------------------------------------------------------------- /NuJet/props/logMessages.props: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | high 7 | 8 | 9 | 10 | normal 11 | 12 | 13 | 14 | high 15 | 16 | 17 | 18 | normal 19 | 20 | 21 | 22 | 23 | 24 | 25 | 27 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | -------------------------------------------------------------------------------- /NuJet/props/localDevelopment.props: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | $(NuGetPackageRoot).localPackages 15 | 16 | 17 | Local 19 | 20 | 21 | 22 | $(NuGetPackageRoot)$(PackageId) 23 | 24 | 25 | 26 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 49 | 50 | 51 | 52 | 53 | 55 | 56 | 57 | 58 | 59 | 60 | 65 | 66 | 67 | 68 | 69 | 70 | true 71 | 72 | 73 | 74 | 76 | 77 | 78 | 81 | 84 | 85 | 86 | 87 | 88 | 89 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # NuJet 2 | 3 | ![nujet](images/nujet.png) 4 | 5 | **Enhance your NuGet developer experience! Speed up the inner-loop development and local testing of NuGet packages, and more.** 6 | 7 | 8 | ## 🚀 What is NuJet? 9 | NuJet is a tool designed to make NuGet package development faster, easier, and more efficient. Whether you're building, testing, or troubleshooting your NuGet packages locally, NuJet has got you covered. 10 | 11 | > **"Is it just me, or is local testing of NuGet packages way harder than it should be?"** 12 | > — *Any frustrated developer who hasn’t tried NuJet yet* 13 | 14 | Working with NuGet packages on the local machine often comes with [known issues](#-key-features---what-problem-does-nujet-solve). 15 | 16 | How can you solve these problems? Simply include NuJet in your package project, just like any other package... and that's it! 17 | 18 | You can now instantly test your package in other projects locally — no more continuous, unnecessary version bumps or cache issues! 19 | 20 | 21 | ## 👨‍💻 How it works 22 | When a package project includes NuJet as a reference, every build will automatically pack a pre-release version (with a `"-Local"` suffix) and copy it to a [Local Feed](https://learn.microsoft.com/en-us/nuget/hosting-packages/local-feeds). 23 | 24 | In NuJet, by default, the Local Feed is a `.localPackages` directory located under the [_Global-Packages folder_](https://learn.microsoft.com/en-us/nuget/consume-packages/managing-the-global-packages-and-cache-folders) on your local machine: 25 | - `%userprofile%\.nuget\packages\.localPackages` (on Windows) or 26 | - `~/.nuget/packages/.localPackages` (on MacOS or Linux) 27 | 28 | ### Example: 29 | - `My.Wonderful.Package`: a package project with version `1.2.3` 30 | - `My.App.Project`: a project that uses `My.Wonderful.Package` 31 | 32 | ```mermaid 33 | graph RL; 34 | NuJet(📦 NuJet) 35 | My.Wonderful.Package(📦 My.Wonderful.Package) 36 | My.Wonderful.Package --> NuJet 37 | My.App.Project --> My.Wonderful.Package 38 | ``` 39 | 40 | When you build the `My.Wonderful.Package` project with Visual Studio, a file named `My.Wonderful.Package.1.2.3-Local.nupkg` will be copied to the `.localPackages` directory. 41 | 42 | When testing `My.App.Project`, you simply reference this local pre-release version (`1.2.3-Local`) of the `My.Wonderful.Package` package. 43 | 44 | This version will be automatically updated with every build, eliminating inconvenient caching issues. 45 | On your local machine you no longer need to modify the .csproj files or manually bump versions! 46 | 47 | > [!NOTE] 48 | > Of course, bumping the version is still important. 49 | However, you can now leave this task to your project's CI/CD pipeline, or do the bump manually only when you're ready to release an official version of the package! 50 | 51 | See the How-To section for more information! [TODO] 52 | 53 | 54 | ## 🛠 Installation 55 | To get started with NuJet, add it to your package project using the NuGet package manager: 56 | 57 | ```bash 58 | dotnet add package NuJet 59 | ``` 60 | 61 | Your project file will now include the following: 62 | ``` 63 | 64 | 65 | all 66 | runtime; build; native; contentfiles; analyzers; buildtransitive 67 | 68 | 69 | ``` 70 | 71 | Now on every build your package will be packed with an additional `"-Local"` suffix in the Local Feed (a `.localPackages` folder) on your machine. 72 | 73 | 74 | ## 📄 Configuration 75 | NuJet is designed to work with minimal configuration. 76 | However, your consumers projects need to find your Local pre-release packages: add the Local Feed in your `nuget.config` [file](https://learn.microsoft.com/en-us/nuget/consume-packages/configuring-nuget-behavior#config-file-locations-and-uses). 77 | 78 | In short, for Windows add this line: 79 | 80 | ``` 81 | 82 | ``` 83 | 84 | For MacOS or Linux: 85 | 86 | ``` 87 | 88 | ``` 89 | 90 | The result will look similar to: 91 | 92 | ``` 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | ``` 102 | 103 | Now the local pre-release version of your package can be found by consumer projects. 104 | 105 | 106 | ## 🎯 Key Features - What Problem Does NuJet Solve? 107 | Developing and testing multiple interdependent NuGet packages locally can be a frustrating and time-consuming process. 108 | Common challenges include: 109 | - Version management headaches: Repeatedly bumping version numbers for local testing 110 | - Cache issues: When the version number remains the same, NuGet often fails to recognize updated versions of your package without manual intervention. 111 | - Time inefficiencies: Switching between projects to bump versions and test changes disrupts your workflow. 112 | 113 | These problems are not uncommon and have been discussed extensively in the NuGet community. For instance, the following GitHub issues highlight these frustrations: 114 | 115 | * [NuGet/Home#6579: Enhance the experience for the testing of packages in development](https://github.com/NuGet/Home/issues/6579) 116 | * [NuGet/Home#9366: Improve inner-loop testing for packages](https://github.com/NuGet/Home/issues/9366) 117 | * [NuGet/Home#8745: Force no cache for single package source in nuget.config](https://github.com/NuGet/Home/issues/8745) 118 | * [NuGet/Home#13918: \[Feature Request\] Disable caching for Local Feed](https://github.com/NuGet/Home/issues/13918) 119 | * [NuGet/Home#8251: \[Feature Request\] Disable caching for local/file system feeds](https://github.com/NuGet/Home/issues/8251) 120 | * [NuGet/Home#5713: NuGet locals command should allow deleting specific packages from NuGet global packages folder](https://github.com/NuGet/Home/issues/5713) 121 | * [NuGet/Home#10377: Remove specific package from cache](https://github.com/NuGet/Home/issues/10377) 122 | * [NuGet/Home#7678: There is no way to force a true reinstall of a package from the actual source](https://github.com/NuGet/Home/issues/7678) 123 | * [NuGet/Home#12515: Add ability to preempt nuget search with local folder ('NuGetPrefetchFolder')](https://github.com/NuGet/Home/issues/12515) 124 | * [NuGet/Home#9891: Feature request - Option to update user global packages folder automatically after successful pack](https://github.com/NuGet/Home/issues/9891) 125 | 126 | NuJet eliminates these hurdles by automating the creation and management of local pre-release versions of your package. 127 | 128 | With NuJet: 129 | - **Speedy Local Testing**: Simplify and accelerate the process of testing your `.nupkg` files locally. 130 | - Local builds are seamlessly available for testing without manual configuration. 131 | - Cache problems and unnecessary version bumps are a thing of the past. 132 | - You can focus on development and testing, rather than battling infrastructure issues. 133 | - **Enhanced Developer Experience**: Enjoy a smoother, faster inner-loop development process. 134 | - NuJet makes your NuGet development workflow faster, simpler, and more reliable! 135 | - **Flexible and Extensible**: Works seamlessly with existing tools and workflows. 136 | 137 | 138 | ## 👨‍💻📝 Contributing 139 | We welcome contributions to NuJet! Whether you're fixing bugs, improving documentation, or adding new features, feel free to open an issue or submit a pull request. 140 | 141 | 142 | ## 📜 License 143 | NuJet is licensed under the [MIT License](LICENSE). 144 | 145 | 146 | ## 📦 Package Status 147 | NuJet is currently in **alpha** stage. It is actively being developed, but we recommend using it for testing purposes only. 148 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.rsuser 8 | *.suo 9 | *.user 10 | *.userosscache 11 | *.sln.docstates 12 | 13 | # User-specific files (MonoDevelop/Xamarin Studio) 14 | *.userprefs 15 | 16 | # Mono auto generated files 17 | mono_crash.* 18 | 19 | # Build results 20 | [Dd]ebug/ 21 | [Dd]ebugPublic/ 22 | [Rr]elease/ 23 | [Rr]eleases/ 24 | x64/ 25 | x86/ 26 | [Ww][Ii][Nn]32/ 27 | [Aa][Rr][Mm]/ 28 | [Aa][Rr][Mm]64/ 29 | bld/ 30 | [Bb]in/ 31 | [Oo]bj/ 32 | [Ll]og/ 33 | [Ll]ogs/ 34 | 35 | # Visual Studio 2015/2017 cache/options directory 36 | .vs/ 37 | # Uncomment if you have tasks that create the project's static files in wwwroot 38 | #wwwroot/ 39 | 40 | # Visual Studio 2017 auto generated files 41 | Generated\ Files/ 42 | 43 | # MSTest test Results 44 | [Tt]est[Rr]esult*/ 45 | [Bb]uild[Ll]og.* 46 | 47 | # NUnit 48 | *.VisualState.xml 49 | TestResult.xml 50 | nunit-*.xml 51 | 52 | # Build Results of an ATL Project 53 | [Dd]ebugPS/ 54 | [Rr]eleasePS/ 55 | dlldata.c 56 | 57 | # Benchmark Results 58 | BenchmarkDotNet.Artifacts/ 59 | 60 | # .NET Core 61 | project.lock.json 62 | project.fragment.lock.json 63 | artifacts/ 64 | 65 | # ASP.NET Scaffolding 66 | ScaffoldingReadMe.txt 67 | 68 | # StyleCop 69 | StyleCopReport.xml 70 | 71 | # Files built by Visual Studio 72 | *_i.c 73 | *_p.c 74 | *_h.h 75 | *.ilk 76 | *.meta 77 | *.obj 78 | *.iobj 79 | *.pch 80 | *.pdb 81 | *.ipdb 82 | *.pgc 83 | *.pgd 84 | *.rsp 85 | *.sbr 86 | *.tlb 87 | *.tli 88 | *.tlh 89 | *.tmp 90 | *.tmp_proj 91 | *_wpftmp.csproj 92 | *.log 93 | *.tlog 94 | *.vspscc 95 | *.vssscc 96 | .builds 97 | *.pidb 98 | *.svclog 99 | *.scc 100 | 101 | # Chutzpah Test files 102 | _Chutzpah* 103 | 104 | # Visual C++ cache files 105 | ipch/ 106 | *.aps 107 | *.ncb 108 | *.opendb 109 | *.opensdf 110 | *.sdf 111 | *.cachefile 112 | *.VC.db 113 | *.VC.VC.opendb 114 | 115 | # Visual Studio profiler 116 | *.psess 117 | *.vsp 118 | *.vspx 119 | *.sap 120 | 121 | # Visual Studio Trace Files 122 | *.e2e 123 | 124 | # TFS 2012 Local Workspace 125 | $tf/ 126 | 127 | # Guidance Automation Toolkit 128 | *.gpState 129 | 130 | # ReSharper is a .NET coding add-in 131 | _ReSharper*/ 132 | *.[Rr]e[Ss]harper 133 | *.DotSettings.user 134 | 135 | # TeamCity is a build add-in 136 | _TeamCity* 137 | 138 | # DotCover is a Code Coverage Tool 139 | *.dotCover 140 | 141 | # AxoCover is a Code Coverage Tool 142 | .axoCover/* 143 | !.axoCover/settings.json 144 | 145 | # Coverlet is a free, cross platform Code Coverage Tool 146 | coverage*.json 147 | coverage*.xml 148 | coverage*.info 149 | 150 | # Visual Studio code coverage results 151 | *.coverage 152 | *.coveragexml 153 | 154 | # NCrunch 155 | _NCrunch_* 156 | .*crunch*.local.xml 157 | nCrunchTemp_* 158 | 159 | # MightyMoose 160 | *.mm.* 161 | AutoTest.Net/ 162 | 163 | # Web workbench (sass) 164 | .sass-cache/ 165 | 166 | # Installshield output folder 167 | [Ee]xpress/ 168 | 169 | # DocProject is a documentation generator add-in 170 | DocProject/buildhelp/ 171 | DocProject/Help/*.HxT 172 | DocProject/Help/*.HxC 173 | DocProject/Help/*.hhc 174 | DocProject/Help/*.hhk 175 | DocProject/Help/*.hhp 176 | DocProject/Help/Html2 177 | DocProject/Help/html 178 | 179 | # Click-Once directory 180 | publish/ 181 | 182 | # Publish Web Output 183 | *.[Pp]ublish.xml 184 | *.azurePubxml 185 | # Note: Comment the next line if you want to checkin your web deploy settings, 186 | # but database connection strings (with potential passwords) will be unencrypted 187 | *.pubxml 188 | *.publishproj 189 | 190 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 191 | # checkin your Azure Web App publish settings, but sensitive information contained 192 | # in these scripts will be unencrypted 193 | PublishScripts/ 194 | 195 | # NuGet Packages 196 | *.nupkg 197 | # NuGet Symbol Packages 198 | *.snupkg 199 | # The packages folder can be ignored because of Package Restore 200 | **/[Pp]ackages/* 201 | # except build/, which is used as an MSBuild target. 202 | !**/[Pp]ackages/build/ 203 | # Uncomment if necessary however generally it will be regenerated when needed 204 | #!**/[Pp]ackages/repositories.config 205 | # NuGet v3's project.json files produces more ignorable files 206 | *.nuget.props 207 | *.nuget.targets 208 | 209 | # Microsoft Azure Build Output 210 | csx/ 211 | *.build.csdef 212 | 213 | # Microsoft Azure Emulator 214 | ecf/ 215 | rcf/ 216 | 217 | # Windows Store app package directories and files 218 | AppPackages/ 219 | BundleArtifacts/ 220 | Package.StoreAssociation.xml 221 | _pkginfo.txt 222 | *.appx 223 | *.appxbundle 224 | *.appxupload 225 | 226 | # Visual Studio cache files 227 | # files ending in .cache can be ignored 228 | *.[Cc]ache 229 | # but keep track of directories ending in .cache 230 | !?*.[Cc]ache/ 231 | 232 | # Others 233 | ClientBin/ 234 | ~$* 235 | *~ 236 | *.dbmdl 237 | *.dbproj.schemaview 238 | *.jfm 239 | *.pfx 240 | *.publishsettings 241 | orleans.codegen.cs 242 | 243 | # Including strong name files can present a security risk 244 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 245 | #*.snk 246 | 247 | # Since there are multiple workflows, uncomment next line to ignore bower_components 248 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 249 | #bower_components/ 250 | 251 | # RIA/Silverlight projects 252 | Generated_Code/ 253 | 254 | # Backup & report files from converting an old project file 255 | # to a newer Visual Studio version. Backup files are not needed, 256 | # because we have git ;-) 257 | _UpgradeReport_Files/ 258 | Backup*/ 259 | UpgradeLog*.XML 260 | UpgradeLog*.htm 261 | ServiceFabricBackup/ 262 | *.rptproj.bak 263 | 264 | # SQL Server files 265 | *.mdf 266 | *.ldf 267 | *.ndf 268 | 269 | # Business Intelligence projects 270 | *.rdl.data 271 | *.bim.layout 272 | *.bim_*.settings 273 | *.rptproj.rsuser 274 | *- [Bb]ackup.rdl 275 | *- [Bb]ackup ([0-9]).rdl 276 | *- [Bb]ackup ([0-9][0-9]).rdl 277 | 278 | # Microsoft Fakes 279 | FakesAssemblies/ 280 | 281 | # GhostDoc plugin setting file 282 | *.GhostDoc.xml 283 | 284 | # Node.js Tools for Visual Studio 285 | .ntvs_analysis.dat 286 | node_modules/ 287 | 288 | # Visual Studio 6 build log 289 | *.plg 290 | 291 | # Visual Studio 6 workspace options file 292 | *.opt 293 | 294 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 295 | *.vbw 296 | 297 | # Visual Studio 6 auto-generated project file (contains which files were open etc.) 298 | *.vbp 299 | 300 | # Visual Studio 6 workspace and project file (working project files containing files to include in project) 301 | *.dsw 302 | *.dsp 303 | 304 | # Visual Studio 6 technical files 305 | *.ncb 306 | *.aps 307 | 308 | # Visual Studio LightSwitch build output 309 | **/*.HTMLClient/GeneratedArtifacts 310 | **/*.DesktopClient/GeneratedArtifacts 311 | **/*.DesktopClient/ModelManifest.xml 312 | **/*.Server/GeneratedArtifacts 313 | **/*.Server/ModelManifest.xml 314 | _Pvt_Extensions 315 | 316 | # Paket dependency manager 317 | .paket/paket.exe 318 | paket-files/ 319 | 320 | # FAKE - F# Make 321 | .fake/ 322 | 323 | # CodeRush personal settings 324 | .cr/personal 325 | 326 | # Python Tools for Visual Studio (PTVS) 327 | __pycache__/ 328 | *.pyc 329 | 330 | # Cake - Uncomment if you are using it 331 | # tools/** 332 | # !tools/packages.config 333 | 334 | # Tabs Studio 335 | *.tss 336 | 337 | # Telerik's JustMock configuration file 338 | *.jmconfig 339 | 340 | # BizTalk build output 341 | *.btp.cs 342 | *.btm.cs 343 | *.odx.cs 344 | *.xsd.cs 345 | 346 | # OpenCover UI analysis results 347 | OpenCover/ 348 | 349 | # Azure Stream Analytics local run output 350 | ASALocalRun/ 351 | 352 | # MSBuild Binary and Structured Log 353 | *.binlog 354 | 355 | # NVidia Nsight GPU debugger configuration file 356 | *.nvuser 357 | 358 | # MFractors (Xamarin productivity tool) working folder 359 | .mfractor/ 360 | 361 | # Local History for Visual Studio 362 | .localhistory/ 363 | 364 | # Visual Studio History (VSHistory) files 365 | .vshistory/ 366 | 367 | # BeatPulse healthcheck temp database 368 | healthchecksdb 369 | 370 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 371 | MigrationBackup/ 372 | 373 | # Ionide (cross platform F# VS Code tools) working folder 374 | .ionide/ 375 | 376 | # Fody - auto-generated XML schema 377 | FodyWeavers.xsd 378 | 379 | # VS Code files for those working on multiple tools 380 | .vscode/* 381 | !.vscode/settings.json 382 | !.vscode/tasks.json 383 | !.vscode/launch.json 384 | !.vscode/extensions.json 385 | *.code-workspace 386 | 387 | # Local History for Visual Studio Code 388 | .history/ 389 | 390 | # Windows Installer files from build outputs 391 | *.cab 392 | *.msi 393 | *.msix 394 | *.msm 395 | *.msp 396 | 397 | # JetBrains Rider 398 | *.sln.iml 399 | --------------------------------------------------------------------------------