https://github.com/cake-contrib/cake.pathtildehelper

:cake: :jigsaw: :house: Cake build helper to convert paths with a leading tilde (~) characters to the home path of the user
https://github.com/cake-contrib/cake.pathtildehelper

augustoproiete cake cake-addin cake-build hacktoberfest path resolve tilde

Last synced: 10 days ago
JSON representation

:cake: :jigsaw: :house: Cake build helper to convert paths with a leading tilde (~) characters to the home path of the user

• Host: GitHub
• URL: https://github.com/cake-contrib/cake.pathtildehelper
• Owner: cake-contrib
• License: mit
• Created: 2018-07-26T19:48:37.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-11-18T01:47:49.000Z (about 1 month ago)
• Last Synced: 2024-11-18T02:40:28.243Z (about 1 month ago)
• Topics: augustoproiete, cake, cake-addin, cake-build, hacktoberfest, path, resolve, tilde
• Language: C#
• Homepage: https://cakebuild.net/extensions/cake-pathtildehelper/
• Size: 99.6 KB
• Stars: 3
• Watchers: 8
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
## Cake.PathTildeHelper

[Cake](https://cakebuild.net/) add-in to provide aliases to help translate tilde (`~`) characters to absolute paths usable in locations requiring a full path.

## Give a Star! :star:

If you like or are using this project please give it a star. Thanks!

### When do I use it?

Most of the Cake path systems don't seem to handle the tilde (`~`) character. They typically make them a path relative to the working directory with the name of `~`. If you ever want to provide input paths to a Cake script that have a leading tilde (`~`) in them, such as `~/Projects/my-cool-file.txt` or `~/Documents`, these helpers will translate those values to an absolute path that other Cake aliases and add-ins will be able to handle.

### How do I use it?

Add a directive to the top of your **build.cake** file to include the project NuGet package.

```

#addin nuget:?package=Cake.PathTildeHelper

```

After that, you can call the `PathReplaceTilde` alias from your Cake script and any tasks within it.

```csharp

Information(PathReplaceTilde(new FilePath("~/Documents/awesome-stuff.txt")));

```

On Windows, that will translate the path to something like `C:\Users\yourusername\Documents\awesome-stuff.txt` (though Cake will keep that path with `/` slashes instead).

On macOS and friends, that will translate the path to something like `/Users/yourusername/Documents/awesome-stuff.txt`.

You can also use it for directories, swapping the `FilePath` for a `DirectoryPath`.

```csharp

Information(PathReplaceTilde(new DirectoryPath("~/Documents")));

```

## Discussion

For questions and to discuss ideas & feature requests, use the [GitHub discussions on the Cake GitHub repository](https://github.com/cake-build/cake/discussions), under the [Extension Q&A](https://github.com/cake-build/cake/discussions/categories/extension-q-a) category.

[![Join in the discussion on the Cake repository](https://img.shields.io/badge/GitHub-Discussions-green?logo=github)](https://github.com/cake-build/cake/discussions)

## Release History

Click on the [Releases](https://github.com/cake-contrib/Cake.PathTildeHelper/releases) tab on GitHub.

---

_Copyright © 2018-2021 Cake Contributors - Provided under the [MIT License](LICENSE)._