Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/easybuild-org/EasyBuild.FileSystemProvider
https://github.com/easybuild-org/EasyBuild.FileSystemProvider
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/easybuild-org/EasyBuild.FileSystemProvider
- Owner: easybuild-org
- Created: 2024-04-09T14:28:02.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-04-24T19:43:35.000Z (2 months ago)
- Last Synced: 2024-04-24T21:06:11.084Z (2 months ago)
- Language: F#
- Size: 203 KB
- Stars: 23
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Lists
- awesome-fsharp - EasyBuild.FileSystemProvider - Type provider to provide a typed representation of files and directories based on your project structure or a virtual file system (Type providers / Performance analysis)
README
# EasyBuild.FileSystemProvider
[](https://www.nuget.org/packages/EasyBuild.FileSystemProvider)
[](https://mangelmaxime.github.io/sponsors/)
EasyBuild.FileSystemProvider is a library that provides a set of F# Type Providers to provide a typed representation of files and directories based on your project structure or a virtual file system.
## Why?
In every project of mine, I need to orchestrate tasks like building, testing, etc. which involves working with files and directories. The standard way of doing it is by using hardcoded `string` but it is easy to break. You also need to remember what is current working directory or relative path you are working with.
To fix this problem, I created this library that provides 2 F# Type Providers:
- `RelativeFileSystemProvider`, typed representation of files and directories based on your project structure.
- `VirtualFileSystemProvider`, typed representation of files and directories based on a virtual file system.
### When to use each one?
Use `RelativeFileSystemProvider` when you want to access files and directories that are tracked in your project. For example, you want to access the path of your `fsproj` file or a `public` assets folder.
Use `VirtualFileSystemProvider` when you want to access files and directories that are not tracked in your project. For example, you want to use a destination folder or access a `obj`, `bin` folder.
## Installation
```bash
dotnet add package EasyBuild.FileSystemProvider
```
## Usage
### `RelativeFileSystemProvider`
Provide a representation based on your file system structure.
```fsharp
open EasyBuild.FileSystemProvider
// Path the relative path you want to work with
// You can use `"."` or `""` to represent the current directory
type Workspace = RelativeFileSystem<".">
type SourceWorkspace = RelativeFileSystem<"./src/">
```
Each folder have 2 special properties and 1 static method:
- ` ``.`` `: Represents the current folder
- ` ``..`` `: Represents the parent folder
- `ToString()`: alias to ` ``.`` ` if you don't want to use the backtick syntax
Example:
Imagine you have the following project structure:
```text
/home/project/
├── client/
│ ├── index.html
│ └── app.js
└── docs/
```
```fsharp
// Workspace represents the root folder `/home/project/`
type Workspace = RelativeFileSystem<".">
Workspace.client.``index.html`` // gives you "/home/project/client/index.html"
Workspace.client.``.`` // gives you "/home/project/client"
Workspace.client.``..``.docs // gives you "/home/project/docs"
// etc.
```
> [!WARNING]
> At the time of writing, `RelativeFileSystemProvider` does not watch you filesystem for changes. In order for your IDE, to pick changes, you either need to restart it or make a change to `RelativeFileSystemProvider<".">` to force a refresh.
>
> This is [planned](https://github.com/easybuild-org/EasyBuild.FileSystemProvider/issues/1) to be improved in the future
### `VirtualFileSystemProvider`
Provide a representation based on a virtual file system.
```fsharp
open EasyBuild.FileSystemProvider
type VirtualWorkspace =
VirtualFileSystem<
".", // Relative path for the root folder
"""
dist
client
index.html
app.js
docs/
public
style.css
"""
>
```
Template format:
- Empty directories are represented by a line with the directory name followed by `/`:
```text
docs/
```
- Files are represented by a line with the file name:
```text
index.html
docs
```
Here `docs` is a file, not a directory because it does not have a `/` at the end.
- Indentation is used to represent the hierarchy of the files and directories.
> [!NOTE]
> You can use any number of spaces or tabs for indentation.
```text
dist
client
index.html
app.js
docs/
public
style.css
```
Example:
We consider that you are initializing the `VirtualWorkspace` at `/home/project/`.
```fsharp
// VirtualWorkspace represents the root folder `/home/project/`
type VirtualWorkspace =
VirtualFileSystem<
".",
"""
dist
client
index.html
app.js
docs/
public
style.css
"""
>
VirtualWorkspace.dist.client.``index.html`` // gives you "/home/project/dist/client/index.html"
VirtualWorkspace.dist.client.``.`` // gives you "/home/project/dist/client"
VirtualWorkspace.dist.``..``.docs.``.`` // gives you "/home/project/docs"
```
## Contributing
If you want to contribute to this project, and see errors in the `build` because of the Type Providers, it is possible that you need to build them manually once.
1.
```bash
dotnet build src
```
2. Reload the project in your IDE
3. Everything should be fine now