0.0.2

Author: ⚙︎ Greg

.gitignore

@@ -0,0 +1,224 @@
+/.vs/
+.vscode
+/.paket/
+/packages/
+/paket-files/
+
+#################
+## Eclipse
+#################
+
+*.pydevproject
+.project
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.classpath
+.settings/
+.loadpath
+
+# External tool builders
+.externalToolBuilders/
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# CDT-specific
+.cproject
+
+# PDT-specific
+.buildpath
+
+
+#################
+## Visual Studio
+#################
+
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+
+# User-specific files
+*.suo
+*.user
+*.sln.docstates
+
+# Build results
+
+[Dd]ebug/
+[Rr]elease/
+x64/
+build/
+[Bb]in/
+[Oo]bj/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+*_i.c
+*_p.c
+*.ilk
+*.meta
+*.obj
+*.pch
+*.pdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*.log
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.log
+*.scc
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opensdf
+*.sdf
+*.cachefile
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# NCrunch
+*.ncrunch*
+.*crunch*.local.xml
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.Publish.xml
+*.pubxml
+*.publishproj
+
+# NuGet Packages Directory
+## TODO: If you have NuGet Package Restore enabled, uncomment the next line
+#packages/
+
+# Windows Azure Build Output
+csx
+*.build.csdef
+
+# Windows Store app package directory
+AppPackages/
+
+# Others
+sql/
+*.Cache
+ClientBin/
+[Ss]tyle[Cc]op.*
+~$*
+*~
+*.dbmdl
+*.[Pp]ublish.xml
+*.pfx
+*.publishsettings
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file to a newer
+# Visual Studio version. Backup files are not needed, because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+
+# SQL Server files
+App_Data/*.mdf
+App_Data/*.ldf
+
+#############
+## Windows detritus
+#############
+
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Mac crap
+.DS_Store
+
+
+#############
+## Python
+#############
+
+*.py[cod]
+
+# Packages
+*.egg
+*.egg-info
+dist/
+build/
+eggs/
+parts/
+var/
+sdist/
+develop-eggs/
+.installed.cfg
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+
+#Translations
+*.mo
+
+#Mr Developer
+.mr.developer.cfg
+
+.fake

README.md

@@ -1,2 +1,123 @@
 # FsShell
 List of Shell-like commands for use in F#.
+
+## Caveat
+These commands are NOT intended for projects with a long life. It is recommended that this only be used in the FSI or for short fire-and-forget utilities. As I eat my own dog food and become more proficient in idiomatic F#, some things might change.
+
+## Usage
+```F#
+#r "nuget:FsShell"
+open FsShell
+man "";;
+
+System
+  cd        Change directory
+  pwd       Print working directory
+  mkdir     Make directory
+  mv        Move file
+  cp        Copy file
+  ls        List
+  ll        List with details (fullname * size * FileInfo)
+  find      Find files
+  find_p    Find folders
+Output
+  stdout    Output to STDOUT
+  stderr    Output to STDERR
+  write     Output to a file
+  append    Append to a file
+  tee       Output to a file and passthrough
+  tee_a     Append to a file and passthrough
+  cat       Read a list of files consecutively
+Data Manipulation
+  NOTE: these will create seq<string list> that aren't friendly with other commands
+  cut       Split lines at tabs
+  cut_d     Split lines at delimeter
+  cut_c     Cut character range options
+  cut_c2    Cut character ranges
+  cutx      Splits CSV into columns
+Data Flow
+  grep      Filter lines to include
+  grep_i    Filter lines to include, case insensitive
+  egrep     Filter lines to include with regex
+  egrep_i   Filter lines to include with regex, case insensitive
+  grep_n    Filter lines to exclude
+  grep_in   Filter lines to exclude, case insensitive
+  egrep_n   Filter lines to exclude with regex
+  egrep_in  Filter lines to exclude with regex, case insensitive
+  head_n    First count lines
+  head      First 10 lines
+  tail_n    Last count lines, or skip first count of lines
+  tail      Last 10 lines
+Miscellaneous
+  man       This
+```
+
+[All functions are in FsShell.fs](src/FsShell/FsShell.fs)
+
+## Examples
+
+### Manipulating Folders
+```F#
+> mkdir "test_fsshell";;
+val it: string = "/Users/gregh/Projects/test_fsshell"
+
+> cd "test_fsshell";;
+val it: string = "/Users/gregh/Projects/test_fsshell"
+
+> pwd ();;
+val it: string = "/Users/gregh/Projects/test_fsshell"
+```
+
+### Manipulating Files
+```F#
+> // write to output lines to files
+- // newlines are added and stripped automatically
+- seq {
+-     "My First Line"
+-     "My Second Line"
+- }
+- |> write "file1.txt"
+- ;;
+val it: unit = ()
+
+> // cat and grep
+- cat [ "file1.txt" ]
+- |> grep_i "second"
+- |> write "file2.txt"
+- ;;
+val it: unit = ()
+
+> cat [ "file1.txt"; "file2.txt" ];;
+val it: seq<string> =
+  seq ["My First Line"; "My Second Line"; "My Second Line"]
+```
+
+### Manipulating Data
+```F#
+> seq { "A\tB"; "C\tD" } |> write "file1.txt";;
+val it: unit = ()
+
+> cat [ "file1.txt" ]
+- |> cut
+- ;;
+val it: seq<string list> = seq [["A"; "B"]; ["C"; "D"]]
+> // also available is cut_d to split on a provided delimiter
+- // cut_c and cut_c2 to get specific character ranges
+
+> // cutx for handling CSV data files
+- cat [ "./datafile.csv" ]
+- |> cutx
+- ;;
+val it: seq<string array> =
+  seq
+    [[|"Column 1"; "Column 2"; "Column 3"|];
+     [|"Val 1-1"; "Val 2-1"; "Val 3-1"|];
+     [|"Val 1-2"; "Val 2-2"; "Val 3-2"|];
+     [|"Val 1-3"; "Val 2-3"; "Val 3-3"|]]
+```
+
+## Miscellaneous
+
+### "Why no rm and rmdir?"
+
+I could see this going badly, quickly. Maybe I'll change my mind later, but after implementing it, I felt it was too dangerous.

src/FsShell.Testing/Command/CatTests.fs

@@ -0,0 +1,24 @@
+module SpiralOSS.FsShell.Testing.Command.CatTests
+
+open Xunit
+open System.Linq
+open SpiralOSS.FsShell.Testing.Infrastructure
+open SpiralOSS.FsShell.Command.Cat
+
+[<Fact>]
+let ``Test Cat 1 File`` () =
+    use tempFile = new Utility.AutoDeletingTempFile ()
+    tempFile.write Utility.sampleTextSeq
+    let expect = Utility.sampleTextSeq
+    let actual = cat System.Text.Encoding.UTF8 [ tempFile.filename ]
+    Assert.True(expect.SequenceEqual(actual));
+
+[<Fact>]
+let ``Test Cat 2 Files`` () =
+    use tempFile1 = new Utility.AutoDeletingTempFile ()
+    use tempFile2 = new Utility.AutoDeletingTempFile ()
+    tempFile1.write Utility.sampleTextSeq
+    tempFile2.write Utility.sampleTextSeq
+    let expect = seq { yield! Utility.sampleTextSeq; yield! Utility.sampleTextSeq }
+    let actual = cat System.Text.Encoding.UTF8 [ tempFile1.filename; tempFile2.filename ]
+    Assert.True(expect.SequenceEqual(actual));

src/FsShell.Testing/Command/CdTests.fs

@@ -0,0 +1,11 @@
+module SpiralOSS.FsShell.Testing.Command.CdTests
+
+open Xunit
+open System.IO
+open SpiralOSS.FsShell.Command.Cd
+
+[<Fact>]
+let ``Test Cd`` () =
+    let expected = Path.GetDirectoryName (Directory.GetCurrentDirectory ())
+    let actual = cd ".."
+    Assert.Equal(expected, actual)