Fix some test failures on Windows

Co-authored-by: Aaron Huntley <[email protected]>
Co-authored-by: Brian Hasden <[email protected]>
Co-authored-by: Umang Vanjara <[email protected]>

Author: 4 people

.circleci/config.yml

@@ -1,13 +1,26 @@
-version: 2
+version: 2.1
+orbs:
+  windows: circleci/[email protected]
+
 jobs:
   test:
     docker:
       - image: circleci/golang:1.17
     steps:
       - checkout
       - run: go test ./...
+  test-windows:
+    executor:
+      name: windows/default
+    steps:
+      - checkout
+      - attach_workspace:
+          at: script
+      - run: go test
+
 workflows:
   version: 2
   test:
     jobs:
       - test
+      - test-windows

.gitattributes

@@ -0,0 +1,6 @@
+# Treat all files in this repo as binary, with no git magic updating line
+# endings. Windows users contributing to the project will need to use a modern
+# version of git and editors capable of LF line endings.
+#
+# See https://github.com/golang/go/issues/9281
+* -text

.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 examples/cat/cat
 examples/grep/grep
 examples/cat2/cat2

CONTRIBUTING.md

@@ -122,8 +122,6 @@ This is easy in Go. Just use `gofmt`. End of.
 
 Your code should also pass `golint` and `go vet` without errors (and if you want to run other linters too, that would be excellent). Very, very occasionally there are situations where `golint` incorrectly detects a problem, and the workaround is awkward or annoying. In that situation, comment on the PR and we'll work out how best to handle it.
 
-For ease of finding things, and to satisfy the tidy-minded, functions and methods are in alphabetical order within each file. Source functions are in `sources.go`, filter methods in `filters.go`, and sink methods in `sinks.go`. The `Pipe` type itself and its 'internal' methods (such as `SetError()`) are in `pipes.go`.
-
 # Documentation
 
 It doesn't matter if you write the greatest piece of code in the history of the world, if no one knows it exists, or how to use it.
@@ -146,7 +144,7 @@ This is the _whole_ user manual for your code. It will be included in the autoge
 
 ## Update the README
 
-Any change to the `script` API should also be accompanied by an update to the README. If you add a new method, add it in the appropriate place (sources, filters, or sinks), in its correct order alphabetically, and with a suitable (brief) description.
+Any change to the `script` API should also be accompanied by an update to the README. If you add a new method, add it to the appropriate table (sources, filters, or sinks), and if it's the equivalent of a command Unix command, add it to the table of Unix equivalents too.
 
 # Writing pipe operations
 

README.md

@@ -4,7 +4,7 @@
 import "github.com/bitfield/script"
 ```
 
-[!['Excited gopher](img/magic.png)](https://bitfieldconsulting.com/golang/scripting)
+[![Magical gopher logo](img/magic.png)](https://bitfieldconsulting.com/golang/scripting)
 
 # What is `script`?