fs

Go-Core / Filesystem

Aeon Digital
rianna@aeondigital.com.br

A robust, cross-platform filesystem utility package for Go applications. This module strictly enforces absolute path resolution for every internal operation, preventing working directory dependencies and ensuring predictable behavior across Windows, Linux, and macOS.

Features

• Absolute Path Isolation: Automatically resolves relative paths, tilde prefixes (~), and dot markers (. or ..) into clean, fully-qualified absolute system paths.
• Smart Permission Management: Dynamically handles native Unix permission octals while safely managing the "Read-Only" file attribute semantics within Windows environments.
• Cross-Platform Volume Checks: Native system call wrappers (sys/unix and Win32 API) to query raw available storage bytes without low-level type mismatches.
• Safe Traversal & Deletions: Explicit directory-guard logic built into atomic helper actions to eliminate accidental or recursive structure deletion vulnerabilities.

Import Path

To use this module in your Go project, include it via:

import "://github.com"

Install

Open your shell and use go get pointing directly to this module subfolder path:

  go get ://github.com@latest

Quick Usage Example

package main

import (
	"fmt"
	"log"
	
	"://github.com"
)

func main() {
	// Paths starting with "~" or relative structures are automatically fully-resolved
	targetDir := "~/.config/aeon/data"

	// Create entire directory path with custom permissions (0700)
	err := fs.CreateDirPath(targetDir, 0700)
	if err != nil {
		log.Fatalf("failed creating directories: %v", err)
	}

	// Safely verify storage limitations before committing heavy write procedures
	hasSpace, err := fs.HasSpaceAvailable(targetDir, 1024*1024*500) // 500 MB
	if err != nil {
		log.Fatalf("failed checking storage boundaries: %v", err)
	}

	if hasSpace {
		fmt.Println("Volume has sufficient space available for processing.")
	}
}

Test Suite

To run tests targeting this module locally, navigate to the fs/ directory and execute:

  go test -v -cover ./...

Licence

This project is offered under the MIT license.