Merge pull request #2 from jarxorg/fs2-to-wfs

Rename package fs2 to wfs

Author: mojatter

README.md

@@ -1,9 +1,9 @@
-# fs2
+# wfs
 
-[![PkgGoDev](https://pkg.go.dev/badge/github.com/jarxorg/fs2)](https://pkg.go.dev/github.com/jarxorg/fs2)
-[![Report Card](https://goreportcard.com/badge/github.com/jarxorg/fs2)](https://goreportcard.com/report/github.com/jarxorg/fs2)
+[![PkgGoDev](https://pkg.go.dev/badge/github.com/jarxorg/wfs)](https://pkg.go.dev/github.com/jarxorg/wfs)
+[![Report Card](https://goreportcard.com/badge/github.com/jarxorg/wfs)](https://goreportcard.com/report/github.com/jarxorg/wfs)
 
-Package fs2 provides writable [io/fs](https://pkg.go.dev/io/fs).FS interfaces.
+Package wfs provides writable [io/fs](https://pkg.go.dev/io/fs).FS interfaces.
 
 ```go
 // WriterFile is a file that provides an implementation fs.File and io.Writer.
@@ -32,8 +32,8 @@ type RemoveFileFS interface {
 
 This is one of the solutions to an [issue](https://github.com/golang/go/issues/45757) of github.com/golango/go.
 
-The following packages are an implementation of fs2.
+The following packages are an implementation of wfs.
 
-- [osfs](https://pkg.go.dev/github.com/jarxorg/fs2/osfs)
-- [memfs](https://pkg.go.dev/github.com/jarxorg/fs2/memfs)
+- [osfs](https://pkg.go.dev/github.com/jarxorg/wfs/osfs)
+- [memfs](https://pkg.go.dev/github.com/jarxorg/wfs/memfs)
 - [s3fs](https://github.com/jarxorg/s3fs)

fs.go

@@ -1,4 +1,4 @@
-package fs2
+package wfs
 
 import (
 	"errors"

fs_test.go

@@ -1,4 +1,4 @@
-package fs2
+package wfs
 
 import (
 	"errors"

fsdelegator.go

@@ -1,4 +1,4 @@
-package fs2
+package wfs
 
 import (
 	"io/fs"

fsdelegator_test.go

@@ -1,4 +1,4 @@
-package fs2
+package wfs
 
 import (
 	"errors"

go.mod

@@ -1,3 +1,3 @@
-module github.com/jarxorg/fs2
+module github.com/jarxorg/wfs
 
 go 1.16

memfs/example_test.go

@@ -5,8 +5,8 @@ import (
 	"io/fs"
 	"log"
 
-	"github.com/jarxorg/fs2"
-	"github.com/jarxorg/fs2/memfs"
+	"github.com/jarxorg/wfs"
+	"github.com/jarxorg/wfs/memfs"
 )
 
 func ExampleNew() {
@@ -15,7 +15,7 @@ func ExampleNew() {
 
 	fsys := memfs.New()
 	var err error
-	_, err = fs2.WriteFile(fsys, name, content, fs.ModePerm)
+	_, err = wfs.WriteFile(fsys, name, content, fs.ModePerm)
 	if err != nil {
 		log.Fatal(err)
 	}

memfs/memfs.go

@@ -10,7 +10,7 @@ import (
 	"sync"
 	"syscall"
 
-	"github.com/jarxorg/fs2"
+	"github.com/jarxorg/wfs"
 )
 
 // MemFS represents an in-memory filesystem.
@@ -28,8 +28,8 @@ var (
 	_ fs.ReadFileFS    = (*MemFS)(nil)
 	_ fs.StatFS        = (*MemFS)(nil)
 	_ fs.SubFS         = (*MemFS)(nil)
-	_ fs2.WriteFileFS  = (*MemFS)(nil)
-	_ fs2.RemoveFileFS = (*MemFS)(nil)
+	_ wfs.WriteFileFS  = (*MemFS)(nil)
+	_ wfs.RemoveFileFS = (*MemFS)(nil)
 )
 
 // New returns a new MemFS.
@@ -216,7 +216,7 @@ func (fsys *MemFS) MkdirAll(dir string, mode fs.FileMode) error {
 }
 
 // CreateFile creates the named file.
-func (fsys *MemFS) CreateFile(name string, mode fs.FileMode) (fs2.WriterFile, error) {
+func (fsys *MemFS) CreateFile(name string, mode fs.FileMode) (wfs.WriterFile, error) {
 	fsys.mutex.Lock()
 	defer fsys.mutex.Unlock()
 
@@ -271,7 +271,7 @@ func (fsys *MemFS) RemoveAll(path string) error {
 }
 
 // MemFile represents an in-memory file.
-// MemFile implements fs.File, fs.ReadDirFile and fs2.WriterFile.
+// MemFile implements fs.File, fs.ReadDirFile and wfs.WriterFile.
 type MemFile struct {
 	fsys       *MemFS
 	name       string
@@ -286,7 +286,7 @@ type MemFile struct {
 var (
 	_ fs.File        = (*MemFile)(nil)
 	_ fs.ReadDirFile = (*MemFile)(nil)
-	_ fs2.WriterFile = (*MemFile)(nil)
+	_ wfs.WriterFile = (*MemFile)(nil)
 )
 
 // Read reads bytes from this file.

memfs/memfs_test.go

@@ -10,13 +10,13 @@ import (
 	"testing"
 	"testing/fstest"
 
-	"github.com/jarxorg/fs2"
-	"github.com/jarxorg/fs2/fstest2"
+	"github.com/jarxorg/wfs"
+	"github.com/jarxorg/wfs/wfstest"
 )
 
 func newMemFSTest(t *testing.T) *MemFS {
 	fsys := New()
-	err := fs2.CopyFS(fsys, os.DirFS("../osfs/testdata"), ".")
+	err := wfs.CopyFS(fsys, os.DirFS("../osfs/testdata"), ".")
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -36,8 +36,8 @@ func TestWriteFileFS(t *testing.T) {
 	if err := fsys.mkdirAll(tmpdir, fs.ModePerm); err != nil {
 		t.Fatal(err)
 	}
-	if err := fstest2.TestWriteFileFS(fsys, tmpdir); err != nil {
-		t.Errorf(`Error fs2/fstest2: %+v`, err)
+	if err := wfstest.TestWriteFileFS(fsys, tmpdir); err != nil {
+		t.Errorf(`Error wfs/wfstest: %+v`, err)
 	}
 }
 

osfs/example_test.go

@@ -7,8 +7,8 @@ import (
 	"log"
 	"os"
 
-	"github.com/jarxorg/fs2"
-	"github.com/jarxorg/fs2/osfs"
+	"github.com/jarxorg/wfs"
+	"github.com/jarxorg/wfs/osfs"
 )
 
 func ExampleDirFS() {
@@ -22,7 +22,7 @@ func ExampleDirFS() {
 	content := []byte(`Hello`)
 
 	fsys := osfs.DirFS(tmpDir)
-	_, err = fs2.WriteFile(fsys, name, content, fs.ModePerm)
+	_, err = wfs.WriteFile(fsys, name, content, fs.ModePerm)
 	if err != nil {
 		log.Fatal(err)
 	}