Sync with Prettier

foesmm · Mar 15, 2018 · 750c1fb · 750c1fb
1 parent 359a604
commit 750c1fb
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 55 deletions.
diff --git a/FORMATS.md b/FORMATS.md
@@ -2,48 +2,48 @@
 
 ## Accessing Archives
 
-- Archive classes allow random access to a seekable stream.
-- Reader classes allow forward-only reading on a stream.
-- Writer classes allow forward-only Writing on a stream.
+* Archive classes allow random access to a seekable stream.
+* Reader classes allow forward-only reading on a stream.
+* Writer classes allow forward-only Writing on a stream.
 
 ## Supported Format Table
 
-| Archive Format | Compression Format(s) | Compress/Decompress | Archive API | Reader API | Writer API |
-| --- | --- | --- | --- | --- | --- |
-| Rar | Rar | Decompress (1) | RarArchive | RarReader | N/A |
-| Zip (2) | None, DEFLATE, Deflate64, BZip2, LZMA/LZMA2, PPMd | Both | ZipArchive | ZipReader | ZipWriter |
-| Tar | None | Both | TarArchive | TarReader | TarWriter (3)  |
-| Tar.GZip | DEFLATE | Both | TarArchive | TarReader | TarWriter (3)  |
-| Tar.BZip2 | BZip2 | Both | TarArchive | TarReader | TarWriter (3)  |
-| Tar.LZip | LZMA | Both | TarArchive | TarReader | TarWriter (3)  |
-| Tar.XZ | LZMA2 | Decompress | TarArchive | TarReader | TarWriter (3)  |
-| GZip (single file) | DEFLATE | Both | GZipArchive | GZipReader | GZipWriter |
-| 7Zip (4) | LZMA, LZMA2, BZip2, PPMd, BCJ, BCJ2, Deflate | Decompress | SevenZipArchive | N/A | N/A |
-| LZip (single file) (5) | LZip (LZMA) | Both | LZipArchive | LZipReader | LZipWriter |
-
- 1. SOLID Rars are only supported in the RarReader API.
- 2. Zip format supports pkware and WinzipAES encryption.  However, encrypted LZMA is not supported.  Zip64 reading/writing is supported but only with seekable streams as the Zip spec doesn't support Zip64 data in post data descriptors.  Deflate64 is only supported for reading.
- 3. The Tar format requires a file size in the header.  If no size is specified to the TarWriter and the stream is not seekable, then an exception will be thrown.
- 4. The 7Zip format doesn't allow for reading as a forward-only stream so 7Zip is only supported through the Archive API
- 5. LZip has no support for extra data like the file name or timestamp.  There is a default filename used when looking at the entry Key on the archive.
+| Archive Format         | Compression Format(s)                             | Compress/Decompress | Archive API     | Reader API | Writer API    |
+| ---------------------- | ------------------------------------------------- | ------------------- | --------------- | ---------- | ------------- |
+| Rar                    | Rar                                               | Decompress (1)      | RarArchive      | RarReader  | N/A           |
+| Zip (2)                | None, DEFLATE, Deflate64, BZip2, LZMA/LZMA2, PPMd | Both                | ZipArchive      | ZipReader  | ZipWriter     |
+| Tar                    | None                                              | Both                | TarArchive      | TarReader  | TarWriter (3) |
+| Tar.GZip               | DEFLATE                                           | Both                | TarArchive      | TarReader  | TarWriter (3) |
+| Tar.BZip2              | BZip2                                             | Both                | TarArchive      | TarReader  | TarWriter (3) |
+| Tar.LZip               | LZMA                                              | Both                | TarArchive      | TarReader  | TarWriter (3) |
+| Tar.XZ                 | LZMA2                                             | Decompress          | TarArchive      | TarReader  | TarWriter (3) |
+| GZip (single file)     | DEFLATE                                           | Both                | GZipArchive     | GZipReader | GZipWriter    |
+| 7Zip (4)               | LZMA, LZMA2, BZip2, PPMd, BCJ, BCJ2, Deflate      | Decompress          | SevenZipArchive | N/A        | N/A           |
+| LZip (single file) (5) | LZip (LZMA)                                       | Both                | LZipArchive     | LZipReader | LZipWriter    |
+
+1. SOLID Rars are only supported in the RarReader API.
+2. Zip format supports pkware and WinzipAES encryption. However, encrypted LZMA is not supported. Zip64 reading/writing is supported but only with seekable streams as the Zip spec doesn't support Zip64 data in post data descriptors. Deflate64 is only supported for reading.
+3. The Tar format requires a file size in the header. If no size is specified to the TarWriter and the stream is not seekable, then an exception will be thrown.
+4. The 7Zip format doesn't allow for reading as a forward-only stream so 7Zip is only supported through the Archive API
+5. LZip has no support for extra data like the file name or timestamp. There is a default filename used when looking at the entry Key on the archive.
 
 ## Compression Streams
 
-For those who want to directly compress/decompress bits.  The single file formats are represented here as well.  However, BZip2, LZip and XZ have no metadata (GZip has a little) so using them without something like a Tar file makes little sense.
+For those who want to directly compress/decompress bits. The single file formats are represented here as well. However, BZip2, LZip and XZ have no metadata (GZip has a little) so using them without something like a Tar file makes little sense.
 
-| Compressor | Compress/Decompress |
-| --- | --- |
-| BZip2Stream | Both |
-| GZipStream | Both |
-| DeflateStream | Both |
-| Deflate64Stream | Decompress |
-| LZMAStream | Both |
-| PPMdStream | Both |
-| ADCStream | Decompress |
-| LZipStream | Both |
-| XZStream | Decompress |
+| Compressor      | Compress/Decompress |
+| --------------- | ------------------- |
+| BZip2Stream     | Both                |
+| GZipStream      | Both                |
+| DeflateStream   | Both                |
+| Deflate64Stream | Decompress          |
+| LZMAStream      | Both                |
+| PPMdStream      | Both                |
+| ADCStream       | Decompress          |
+| LZipStream      | Both                |
+| XZStream        | Decompress          |
 
-## Archive Formats vs Compression 
+## Archive Formats vs Compression
 
 Sometimes the terminology gets mixed.
 
@@ -53,9 +53,8 @@ DEFLATE, LZMA are pure compression algorithms
 
 ### Formats
 
-Formats like Zip, 7Zip, Rar are archive formats only.  They use other compression methods (e.g. DEFLATE, LZMA, etc.) or propriatory (e.g RAR)
+Formats like Zip, 7Zip, Rar are archive formats only. They use other compression methods (e.g. DEFLATE, LZMA, etc.) or propriatory (e.g RAR)
 
 ### Overlap
 
-GZip, BZip2 and LZip are single file archival formats.  The overlap in the API happens because Tar uses the single file formats as "compression" methods and the API tries to hide this a bit.
-
+GZip, BZip2 and LZip are single file archival formats. The overlap in the API happens because Tar uses the single file formats as "compression" methods and the API tries to hide this a bit.
diff --git a/README.md b/README.md
@@ -2,34 +2,35 @@
 
 SharpCompress is a compression library in pure C# for .NET 3.5, 4.5, .NET Standard 1.0, 1.3 that can unrar, un7zip, unzip, untar unbzip2 and ungzip with forward-only reading and file random access APIs. Write support for zip/tar/bzip2/gzip are implemented.
 
-The major feature is support for non-seekable streams so large files can be processed on the fly (i.e. download stream). 
+The major feature is support for non-seekable streams so large files can be processed on the fly (i.e. download stream).
 
-AppVeyor Build - 
+AppVeyor Build -
 [![Build status](https://ci.appveyor.com/api/projects/status/voxg971oemmvxh1e/branch/master?svg=true)](https://ci.appveyor.com/project/adamhathcock/sharpcompress/branch/master)
 
-Circle CI Build - 
+Circle CI Build -
 [![CircleCI](https://circleci.com/gh/adamhathcock/sharpcompress.svg?style=svg)](https://circleci.com/gh/adamhathcock/sharpcompress)
 
 ## Need Help?
+
 Post Issues on Github!
 
 Check the [Supported Formats](FORMATS.md) and [Basic Usage.](USAGE.md)
 
 ## Recommended Formats
 
-In general, I recommend GZip (Deflate)/BZip2 (BZip)/LZip (LZMA) as the simplicity of the formats lend to better long term archival as well as the streamability.  Tar is often used in conjunction for multiple files in a single archive (e.g. `.tar.gz`)
+In general, I recommend GZip (Deflate)/BZip2 (BZip)/LZip (LZMA) as the simplicity of the formats lend to better long term archival as well as the streamability. Tar is often used in conjunction for multiple files in a single archive (e.g. `.tar.gz`)
 
-Zip is okay, but it's a very hap-hazard format and the variation in headers and implementations makes it hard to get correct.  Uses Deflate by default but supports a lot of compression methods.
+Zip is okay, but it's a very hap-hazard format and the variation in headers and implementations makes it hard to get correct. Uses Deflate by default but supports a lot of compression methods.
 
-RAR is not recommended as it's a propriatory format and the compression is closed source.  Use Tar/LZip for LZMA
+RAR is not recommended as it's a propriatory format and the compression is closed source. Use Tar/LZip for LZMA
 
-7Zip and XZ both are overly complicated.  7Zip does not support streamable formats.  XZ has known holes explained here: (http://www.nongnu.org/lzip/xz_inadequate.html)  Use Tar/LZip for LZMA compression instead.
+7Zip and XZ both are overly complicated. 7Zip does not support streamable formats. XZ has known holes explained here: (http://www.nongnu.org/lzip/xz_inadequate.html) Use Tar/LZip for LZMA compression instead.
 
 ## A Simple Request
 
 Hi everyone. I hope you're using SharpCompress and finding it useful. Please give me feedback on what you'd like to see changed especially as far as usability goes. New feature suggestions are always welcome as well. I would also like to know what projects SharpCompress is being used in. I like seeing how it is used to give me ideas for future versions. Thanks!
 
-Please do not email me directly to ask for help.  If you think there is a real issue, please report it here.
+Please do not email me directly to ask for help. If you think there is a real issue, please report it here.
 
 ## Want to contribute?
 
@@ -54,9 +55,9 @@ I'm always looking for help or ideas. Please submit code or email with ideas. Un
 
 ### Version 0.17.0
 
-* New - Full LZip support!  Can read and write LZip files and Tars inside LZip files.  [Make LZip a first class citizen. #241](https://github.com/adamhathcock/sharpcompress/issues/241)
-* New - XZ read support!  Can read XZ files and Tars inside XZ files.  [XZ in SharpCompress #91](https://github.com/adamhathcock/sharpcompress/issues/94)
-* Fix - [Regression - zip file writing on seekable streams always assumed stream start was 0.  Introduced with Zip64 writing.](https://github.com/adamhathcock/sharpcompress/issues/244)
+* New - Full LZip support! Can read and write LZip files and Tars inside LZip files. [Make LZip a first class citizen. #241](https://github.com/adamhathcock/sharpcompress/issues/241)
+* New - XZ read support! Can read XZ files and Tars inside XZ files. [XZ in SharpCompress #91](https://github.com/adamhathcock/sharpcompress/issues/94)
+* Fix - [Regression - zip file writing on seekable streams always assumed stream start was 0. Introduced with Zip64 writing.](https://github.com/adamhathcock/sharpcompress/issues/244)
 * Fix - [Zip files with post-data descriptors can be properly skipped via decompression](https://github.com/adamhathcock/sharpcompress/issues/162)
 
 ### Version 0.16.2
@@ -136,7 +137,7 @@ I'm always looking for help or ideas. Please submit code or email with ideas. Un
 ### Version 0.11.6
 
 * Bug fix for global header in Tar
-* Writers now have a leaveOpen `bool` overload.  They won't close streams if not-requested to.
+* Writers now have a leaveOpen `bool` overload. They won't close streams if not-requested to.
 
 ### Version 0.11.5
 
@@ -155,7 +156,7 @@ I'm always looking for help or ideas. Please submit code or email with ideas. Un
 
 ### Version 0.11
 
-* Been over a year, contains mainly fixes from contributors!  
+* Been over a year, contains mainly fixes from contributors!
 * Possible breaking change: ArchiveEncoding is UTF8 by default now.
 * TAR supports writing long names using longlink
 * RAR Protect Header added

diff --git a/USAGE.md b/USAGE.md
@@ -1,7 +1,8 @@
 # SharpCompress Usage
 
 ## Stream Rules
-When dealing with Streams, the rule should be that you don't close a stream you didn't create.  This, in effect, should mean you should always put a Stream in a using block to dispose it.
+
+When dealing with Streams, the rule should be that you don't close a stream you didn't create. This, in effect, should mean you should always put a Stream in a using block to dispose it.
 
 However, the .NET Framework often has classes that will dispose streams by default to make things "easy" like the following:
 
@@ -12,7 +13,7 @@ using (var reader = new StreamReader(File.Open("foo")))
 }
 ```
 
-In this example, reader should get disposed.  However, stream rules should say the the `FileStream` created by `File.Open` should remain open.  However, the .NET Framework closes it for you by default unless you override the constructor.  In general, you should be writing Stream code like this:
+In this example, reader should get disposed. However, stream rules should say the the `FileStream` created by `File.Open` should remain open. However, the .NET Framework closes it for you by default unless you override the constructor. In general, you should be writing Stream code like this:
 
 ```C#
 using (var fileStream = File.Open("foo"))
@@ -25,7 +26,7 @@ using (var reader = new StreamReader(fileStream))
 To deal with the "correct" rules as well as the expectations of users, I've decided on this:
 
 * When writing, leave streams open.
-* When reading, close streams 
+* When reading, close streams
 
 To be explicit though, consider always using the overloads that use `ReaderOptions` or `WriterOptions` and explicitly set `LeaveStreamOpen` the way you want.
 
@@ -43,11 +44,9 @@ using (var archive = ZipArchive.Create())
 }
 ```
 
-
 ### Create Zip Archive from all files in a directory and save in memory
 
 ```C#
-
 var memoryStream = new MemoryStream();
 using (var archive = ZipArchive.Create())
 {