faithlife / cloneleeroy Goto Github PK

View Code? Open in Web Editor NEW

0.0 4.0 2.0 169 KB

Clones all the repositories specified by a Leeroy config

License: MIT License

PowerShell 4.72% C# 95.28%

cloneleeroy's Introduction

CloneLeeroy

Clones all the repositories specified by a Leeroy config.

Release Notes

Installation

Install the dotnet global tool from NuGet:

dotnet tool install --global CloneLeeroy

Upgrading from clone-leeroy (npm)

If you were using the clone-leeroy npm package, uninstall it with:

npm uninstall -g clone-leeroy

The npm clone-leeroy would always create a SolutionInfo.cs and SolutionInfo.h file whenever it ran. Since most projects are moving away from that and instead using Directory.Build.props, that legacy behavior is now opt-in. To create those files (e.g., for a first-time clone), run

clone-leeroy --solution-info-csharp --solution-info-header [ProjectName]

Use

In the parent folder of the cloned repositories, run:

clone-leeroy <project name>

To save the project name as the default for this folder, run:

clone-leeroy --save <project name>

From then on, you just need to run clone-leeroy to clone that project.

Testing Leeroy Config Changes

CloneLeeroy clones the configuration repo to %LOCALAPPDATA%\CloneLeeroy\Configuration and reads the configuration files from there. You can edit files in that folder to test a configuration change locally before pushing it.

Suggestions

CloneLeeroy supports tab completion on the command line. To enable it, follow the steps here to install dotnet-suggest and add a script to your shell profile.

Debugging

To test suggestions while developing the application, create %USERPROFILE%\.dotnet-suggest-registration.txt containing the line C:\Full\Path\To\bin\Debug\net5.0\CloneLeeroy.exe. Then restart your shell.

Now running .\CloneLeeroy.exe <TAB> will provide suggestions.

cloneleeroy's People

Contributors

Watchers

Forkers

fallback martinpotter

cloneleeroy's Issues

Usage instructions include all project names with tab completion enabled

Unavoidable, perhaps, but it might be nice if all projects weren't listed as possible arguments in the usage instructions.

Smart completion doesn't work immediately

I followed the README instructions to install but smart completion didn't start working until after I successfully cloned my first project.

README should mention the old npm tool

It would be nice to mention the old npm tool and how to uninstall it.

Feature request: Auto-detect needing solution info files based on a config setting

Problem: New developers frequently miss project-specific documentation specifying to use, e.g. --solution-info-csharp, on an initial clone.

Idea: Support something like requiredSolutionInfoFiles: [ csharp ] in the Leeroy config definition and add the relevant flags when cloning as needed.

ArgumentOutOfRangeException in StringBuilder.ToString

Unhandled exception: System.ArgumentOutOfRangeException: Index was out of range. Must be non-negative and less than the size of the collection. (Parameter 'chunkLength')
   at System.Text.StringBuilder.ToString()
   at CloneLeeroy.Program.RunGit(String workingDirectory, String[] arguments) in /_/src/CloneLeeroy/Program.cs:line 229
   at CloneLeeroy.Program.UpdateSubmodule(String folder, String name, String branch) in /_/src/CloneLeeroy/Program.cs:line 168
   at CloneLeeroy.Program.Run(Boolean save, Boolean solutionInfoCsharp, Boolean solutionInfoHeader, String project) in /_/src/CloneLeeroy/Program.cs:line 112
   at CloneLeeroy.Program.<>c.<<Main>b__0_1>d.MoveNext() in /_/src/CloneLeeroy/Program.cs:line 53

Could presumably happen due to multithreaded access of the StringBuilder: https://stackoverflow.com/questions/38564486/system-argumentoutofrangeexception-parameter-name-chunklength-at-system-text-st

Although await process.WaitForExitAsync(); happens before the StringBuilder is accessed, it's plausible that the event handler is still running in the background.

We should solve this with a lock.

Usage instructions give the wrong program name

Usage:
  CloneLeeroy [options] <project>

should be

Usage:
  clone-leeroy [options] <project>

Default project to current directory name

If there is no saved configuration, it would be nice if the name of the current directory was used as the project name.