Add MakeRelative alias to DirectoryPath and FilePath

[augustoproiete]

What You Are Seeing?

MakeAbsolute is a useful alias to transform a relative path into an absolute path based on the current WorkingDirectory, but there's not an equivalent alias for doing the opposite, that is, transform an absolute path into a relative path.

What is Expected?

I'd like Cake to provide a MakeRelative alias that transforms an absolute path into a relative path, which is useful when printing messages to the console log, for ease of reading.

e.g.

// Environment.WorkingDirectory => "C:/Working/"

var relativePath = MakeRelative("C:/Working/build/MyApp.csproj");
// relativePath should be "./build/MyApp.csproj"

What version of Cake are you using?

0.38.4

---

ps: I'm happy to send a PR that adds this feature.

[devlead]

Might be a good edition
Example of code making path relative

cake/src/Cake.Common/IO/Zipper.cs

Lines 225 to 233 in 80d787c

	private string GetRelativePath(DirectoryPath root, Path path)
	{
	if (path != null && !path.FullPath.StartsWith(root.FullPath, _comparison))
	{
	const string format = "Path '{0}' is not relative to root path '{1}'.";
	throw new CakeException(string.Format(CultureInfo.InvariantCulture, format, path.FullPath, root.FullPath));
	}
	return path?.FullPath.Substring(root.FullPath.Length + (root.FullPath.Length > 1 && path.FullPath.Length > root.FullPath.Length ? 1 : 0));
	}

A MakeRelative alias should take rootPath as the last parameter and be optional, that way it could default to working directory but you could also specify a path.

[patriksvensson]

@augustoproiete @devlead Better to use the RelativePathResolver which was made for this: https://github.com/cake-build/cake/blob/develop/src/Cake.Core/IO/RelativePathResolver.cs

The method above should probably be rewritten to use that as well...

[devlead]

Fixed by #2923

[cake-build-bot]

🎉 This issue has been resolved in version v1.0.0 🎉

The release is available on:

• GitHub Release
• NuGet Package
• Chocolatey Package
• .Net Global Tool

Your GitReleaseManager bot 📦🚀