Light

vmware-archive / go-ape Goto Github PK

View Code? Open in Web Editor NEW

4.0 5.0 4.0 74 KB

Utilities for copying files and reading local and remote files in a consistent way

License: Apache License 2.0

Go 100.00%

golang go file

go-ape's Introduction

go-ape

go-ape provides some file utilities in two packages:

pkg/filecopy for copying files (hence the "ape" in "go-ape")
pkg/furl for reading local files and remote urls in a consistent way

It was initially developed on macOS and then made to work on Windows.

Installing

Install is easy, all you need to do is

go get github.com/pivotal/go-ape

Usage

Once installed, import go-ape in your application

import "github.com/pivotal/go-ape"

Read files

Then start reading files like so:

content, err := furl.Read(filePath, "")

Here filePath can be a path on the local file system (unix OR windows) or a URL.

Copy

You can copy files or directories using:

filecopy.Copy(outputPath, inputPath)

Please see the godoc for more information.

Alternatives

https://github.com/otiai10/copy copies files and directories, but incompatibly to go-ape (replacing the implementation here with otiai10/copy caused numerous test failures).

go-ape's People

Contributors

Stargazers

Watchers

Forkers

fbiville sbawaska glyn jeremyrickard

go-ape's Issues

Why is the package "fileutils"?

Looking at a downstream project, I was very confused about where the fileutils symbol was coming from when the package import was github.com/pivotal/go-ape. The convention in go is for the package name to match the directory name.

If keeping the fileutils package is important, I suggest creating a fileutils directory and moving all of the *.go files into that directory.

Fix formatting

According to the go report, some files need reformatting.

Fix lint warnings

According to go report, there are some lint warnings to fix. Some of these involve providing descriptions for public functions which are undocumented, so this will require a bit of background knowledge or research.

Make isDriveLetter more robust

The function isDriveLetter cannot cope with certain non-Latin drive letters. See https://play.golang.org/p/N_9bQGN-spp for example. Perhaps the function ought to be checking GOOS too to avoid unexpected interactions with genuine URI schemes?

read_test fails on windows

The test fails in CI with the following error:

span>+ Failure [0.000 seconds]‌
Read
D:&#x2F;a&#x2F;1&#x2F;s&#x2F;gopath&#x2F;src&#x2F;github.com&#x2F;pivotal&#x2F;go-ape&#x2F;pkg&#x2F;furl&#x2F;read_test.go:32‌
  when file is a URL
  ‌D:&#x2F;a&#x2F;1&#x2F;s&#x2F;gopath&#x2F;src&#x2F;github.com&#x2F;pivotal&#x2F;go-ape&#x2F;pkg&#x2F;furl&#x2F;read_test.go:45‌
    ‌should read the file content [It]‌
    ‌D:&#x2F;a&#x2F;1&#x2F;s&#x2F;gopath&#x2F;src&#x2F;github.com&#x2F;pivotal&#x2F;go-ape&#x2F;pkg&#x2F;furl&#x2F;read_test.go:52‌

    ‌Unexpected error:‌
        <*errors.errorString | 0xc000276d10>: {
            s: "unsupported scheme in d:///a/1/s/gopath/src/github.com/pivotal/go-ape/pkg/furl/fixtures/file.txt: d",
        }
        unsupported scheme in d:///a/1/s/gopath/src/github.com/pivotal/go-ape/pkg/furl/fixtures/file.txt: d
    occurred‌

    D:/a/1/s/gopath/src/github.com/pivotal/go-ape/pkg/furl/read_test.go:53

full logs: https://dev.azure.com/projectriff/go-ape/_build/results?buildId=266&view=logs&jobId=9894e779-7890-5e48-0b3f-f547f27d36a6&taskId=aa8f1c35-4246-5ea2-2ef5-820136e37a2a&lineStart=80&lineEnd=81&colStart=1&colEnd=1

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.