Path existence checking with configurable logging modes for robust file system operations.

中文说明

🎯 Path Existence Validation: Comprehensive checking for paths, files, and directories ⚡ Configurable Logging Modes: Multiple log levels (Noisy, Sweet, Quiet, Might) 🔄 Type-Safe Validation: Ensures paths match expected types (file vs DIR) 🌍 Error Context Enhancement: Rich error wrapping with detailed location information 📋 Convenience Functions: Simple one-line existence checks for common use cases

go get github.com/yyle88/osexistpath

package main

import (
	"os"
	"path/filepath"

	"github.com/yyle88/must"
	"github.com/yyle88/osexistpath/osmustexist"
	"github.com/yyle88/rese"
	"github.com/yyle88/zaplog"
	"go.uber.org/zap"
)

func main() {
	tempDIR := rese.V1(os.MkdirTemp("", "osexistpath-demo-*"))
	defer func() {
		must.Done(os.RemoveAll(tempDIR))
	}()

	zaplog.SUG.Debug("working in:", tempDIR)

	root := osmustexist.ROOT(tempDIR)
	zaplog.LOG.Debug("must exist DIR:", zap.String("root", root))

	path := filepath.Join(tempDIR, "test.txt")
	must.Done(os.WriteFile(path, []byte("hello world"), 0644))

	osmustexist.FILE(path)
	zaplog.LOG.Debug("must exist FILE:", zap.String("path", path))

	data := rese.A1(os.ReadFile(path))
	zaplog.LOG.Debug("read data:", zap.ByteString("data", data))
}

⬆️ Source: Source

package main

import (
	"os"
	"path/filepath"

	"github.com/yyle88/must"
	"github.com/yyle88/osexistpath/osmustexist"
	"github.com/yyle88/rese"
	"github.com/yyle88/zaplog"
	"go.uber.org/zap"
)

func main() {
	tempDIR := osmustexist.ROOT(rese.V1(os.MkdirTemp("", "osexistpath-demo-*")))
	defer func() {
		must.Done(os.RemoveAll(tempDIR))
	}()

	zaplog.SUG.Debug("working in:", tempDIR)

	path := filepath.Join(tempDIR, "test.txt")
	must.False(osmustexist.IsPath(path))
	zaplog.LOG.Debug("must not exist FILE:", zap.String("path", path))

	must.Done(os.WriteFile(path, []byte("hello world"), 0644))
	must.True(osmustexist.IsFile(path))
	zaplog.LOG.Debug("must exist FILE:", zap.String("path", path))

	data := rese.A1(os.ReadFile(osmustexist.FILE(path)))
	zaplog.LOG.Info("read data:", zap.ByteString("data", data))
}

⬆️ Source: Source

The osmustexist package provides a clean API through auto handling errors with sure.Must(). This eliminates the need to check error returns, making code more concise and readable.

Environment Setup (Recommended - osmustexist):

// Use osmustexist for clean setup code - no error handling needed
osmustexist.MustRoot("/project/config")
osmustexist.MustFile("/project/config/app.yaml")

Runtime Validation (Recommended - osmustexist):

// Use osmustexist for clean boolean checks
if osmustexist.IsFileExist("config.txt") {
    // Process config file - no need to handle error
}

Check Operations (Recommended - osmustexist):

// Use osmustexist for simple probe checks
hasConfig := osmustexist.IsFile("config.json")
hasYaml := osmustexist.IsFile("config.yaml")

Standard Error Handling (When needed):

// Use base package when you need explicit error handling
if exists, err := osexistpath.IsFileExist("config.txt"); err != nil {
    return fmt.Errorf("failed to check file: %w", err)
} else if exists {
    // Process config file
}

Using osmustexist.PATH for clean validation (Recommended):

// No error handling needed - panics on failure
configPath := osmustexist.PATH("/app/config")

Standard PATH function with explicit error handling:

configPath, err := osexistpath.PATH("/app/config")
if err != nil {
    return fmt.Errorf("config DIR missing: %w", err)
}

Chaining validations with osmustexist.ROOT (Recommended):

// Clean and readable - no error variables needed
dataPath := osmustexist.ROOT("/data")
logsPath := osmustexist.ROOT(filepath.Join(dataPath, "logs"))

osmustexist Noisy mode for debugging (Recommended):

exists := osmustexist.IsFileExists("debug.log", osexistpath.Noisy)
// Logs detailed debug information, clean syntax

osmustexist Sweet mode for production (Recommended):

exists := osmustexist.IsRootExists("/var/lib/app", osexistpath.Sweet)
// Logs just unexpected errors, no error handling needed

osmustexist: Ensure path is a file (Recommended):

if !osmustexist.IsFile("data.json") {
    return errors.New("expected file, found DIR")
}

osmustexist: Ensure path is a DIR (Recommended):

if !osmustexist.IsRoot("uploads") {
    return errors.New("expected DIR, found file")
}

osmustexist: Process config files (Recommended):

if osmustexist.IsFileExist("app-config.yaml") {
    config := loadConfig("app-config.yaml")
    applyConfig(config)
}

osmustexist: Setup logging DIR if exists (Recommended):

if osmustexist.IsRootExist("/var/log/myapp") {
    setupFileLogging("/var/log/myapp")
} else {
    setupConsoleLogging()
}

MIT License - see LICENSE.

Contributions are welcome! Report bugs, suggest features, and contribute code:

• 🐛 Mistake reports? Open an issue on GitHub with reproduction steps
• 💡 Fresh ideas? Create an issue to discuss
• 📖 Documentation confusing? Report it so we can improve
• 🚀 Need new features? Share the use cases to help us understand requirements
• ⚡ Performance issue? Help us optimize through reporting slow operations
• 🔧 Configuration problem? Ask questions about complex setups
• 📢 Follow project progress? Watch the repo to get new releases and features
• 🌟 Success stories? Share how this package improved the workflow
• 💬 Feedback? We welcome suggestions and comments

New code contributions, follow this process:

1. Fork: Fork the repo on GitHub (using the webpage UI).
2. Clone: Clone the forked project (git clone https://github.com/yourname/repo-name.git).
3. Navigate: Navigate to the cloned project (cd repo-name)
4. Branch: Create a feature branch (git checkout -b feature/xxx).
5. Code: Implement the changes with comprehensive tests
6. Testing: (Golang project) Ensure tests pass (go test ./...) and follow Go code style conventions
7. Documentation: Update documentation to support client-facing changes
8. Stage: Stage changes (git add .)
9. Commit: Commit changes (git commit -m "Add feature xxx") ensuring backward compatible code
10. Push: Push to the branch (git push origin feature/xxx).
11. PR: Open a merge request on GitHub (on the GitHub webpage) with detailed description.

Please ensure tests pass and include relevant documentation updates.

Welcome to contribute to this project via submitting merge requests and reporting issues.

Project Support:

• ⭐ Give GitHub stars if this project helps you
• 🤝 Share with teammates and (golang) programming friends
• 📝 Write tech blogs about development tools and workflows - we provide content writing support
• 🌟 Join the ecosystem - committed to supporting open source and the (golang) development scene

Have Fun Coding with this package! 🎉🎉🎉