formatting

Author: isaacs

.gitignore

@@ -5,6 +5,7 @@
 
 # keep these
 !**/.gitignore
+!/.prettierignore
 !/src
 !/.tshy
 !/.commitlintrc.js

.prettierignore

@@ -0,0 +1,14 @@
+/node_modules
+/LICENSE.md
+/example
+/.github
+/dist
+/.env
+/tap-snapshots
+/.nyc_output
+/coverage
+/benchmark
+/.tap
+/test/fixture
+/test/fixtures
+/.tshy

README.md

@@ -103,7 +103,6 @@ Handlers receive 3 arguments:
 
 - `TAR_ENTRY_INVALID` An indication that a given entry is not a valid tar
   archive entry, and will be skipped. This occurs when:
-
   - a checksum fails,
   - a `linkpath` is missing for a link type, or
   - a `linkpath` is provided for a non-link type.
@@ -115,7 +114,6 @@ Handlers receive 3 arguments:
 - `TAR_ENTRY_ERROR` The entry appears to be a valid tar archive entry, but
   encountered an error which prevented it from being unpacked. This occurs
   when:
-
   - an unrecoverable fs error happens during unpacking,
   - an entry is trying to extract into an excessively deep
     location (by default, limited to 1024 subfolders),
@@ -133,7 +131,6 @@ Handlers receive 3 arguments:
 
 - `TAR_BAD_ARCHIVE` The archive file is totally hosed. This can happen for
   a number of reasons, and always occurs at the end of a parse or extract:
-
   - An entry body was truncated before seeing the full number of bytes.
   - The archive contained only invalid entries, indicating that it is
     likely not an archive, or at least, not an archive this library can

src/header.ts

@@ -91,7 +91,8 @@ export class Header implements HeaderData {
     this.uid = ex?.uid ?? gex?.uid ?? decNumber(buf, off + 108, 8)
     this.gid = ex?.gid ?? gex?.gid ?? decNumber(buf, off + 116, 8)
     this.size = ex?.size ?? gex?.size ?? decNumber(buf, off + 124, 12)
-    this.mtime = ex?.mtime ?? gex?.mtime ?? decDate(buf, off + 136, 12)
+    this.mtime =
+      ex?.mtime ?? gex?.mtime ?? decDate(buf, off + 136, 12)
     this.cksum = decNumber(buf, off + 148, 12)
 
     // if we have extended or global extended headers, apply them now
@@ -124,10 +125,14 @@ export class Header implements HeaderData {
       'ustar\u000000'
     ) {
       /* c8 ignore start */
-      this.uname = ex?.uname ?? gex?.uname ?? decString(buf, off + 265, 32)
-      this.gname = ex?.gname ?? gex?.gname ?? decString(buf, off + 297, 32)
-      this.devmaj = ex?.devmaj ?? gex?.devmaj ?? decNumber(buf, off + 329, 8) ?? 0
-      this.devmin = ex?.devmin ?? gex?.devmin ?? decNumber(buf, off + 337, 8) ?? 0
+      this.uname =
+        ex?.uname ?? gex?.uname ?? decString(buf, off + 265, 32)
+      this.gname =
+        ex?.gname ?? gex?.gname ?? decString(buf, off + 297, 32)
+      this.devmaj =
+        ex?.devmaj ?? gex?.devmaj ?? decNumber(buf, off + 329, 8) ?? 0
+      this.devmin =
+        ex?.devmin ?? gex?.devmin ?? decNumber(buf, off + 337, 8) ?? 0
       /* c8 ignore stop */
       if (buf[off + 475] !== 0) {
         // definitely a prefix, definitely >130 chars.
@@ -139,8 +144,10 @@ export class Header implements HeaderData {
           this.path = prefix + '/' + this.path
         }
         /* c8 ignore start */
-        this.atime = ex?.atime ?? gex?.atime ?? decDate(buf, off + 476, 12)
-        this.ctime = ex?.ctime ?? gex?.ctime ?? decDate(buf, off + 488, 12)
+        this.atime =
+          ex?.atime ?? gex?.atime ?? decDate(buf, off + 476, 12)
+        this.ctime =
+          ex?.ctime ?? gex?.ctime ?? decDate(buf, off + 488, 12)
         /* c8 ignore stop */
       }
     }

src/mkdir.ts

@@ -151,15 +151,7 @@ const onmkdir =
             fs.mkdir(
               part,
               mode,
-              onmkdir(
-                part,
-                parts,
-                mode,
-                unlink,
-                cwd,
-                created,
-                cb,
-              ),
+              onmkdir(part, parts, mode, unlink, cwd, created, cb),
             )
           })
         } else if (st.isSymbolicLink()) {
@@ -225,7 +217,9 @@ export const mkdirSync = (dir: string, opt: MkdirOptions) => {
   }
 
   if (preserve) {
-    return done(fs.mkdirSync(dir, { mode, recursive: true }) ?? undefined)
+    return done(
+      fs.mkdirSync(dir, { mode, recursive: true }) ?? undefined,
+    )
   }
 
   const sub = normalizeWindowsPath(path.relative(cwd, dir))

src/options.ts

@@ -126,12 +126,12 @@ export interface TarOptions {
   /**
    * Set to `true` or an object with settings for `zstd.compress()` to
    * create a zstd-compressed archive
-   * 
+   *
    * When extracting, this will cause the archive to be treated as a
    * zstd-compressed file if set to `true` or a ZlibOptions object.
-   * 
+   *
    * If set `false`, then zstd options will not be used.
-   * 
+   *
    * If this, the `gzip`, and `brotli` options are left `undefined`, then tar
    * will attempt to infer the zstd compression status, but can only do so
    * based on the filename. If the filename ends in `.tzst` or `.tar.zst`, and

src/pack.ts

@@ -129,8 +129,15 @@ export class Pack
     this.portable = !!opt.portable
 
     if (opt.gzip || opt.brotli || opt.zstd) {
-      if ((opt.gzip ? 1 : 0) + (opt.brotli ? 1 : 0) + (opt.zstd ? 1 : 0) > 1) {
-        throw new TypeError('gzip, brotli, zstd are mutually exclusive')
+      if (
+        (opt.gzip ? 1 : 0) +
+          (opt.brotli ? 1 : 0) +
+          (opt.zstd ? 1 : 0) >
+        1
+      ) {
+        throw new TypeError(
+          'gzip, brotli, zstd are mutually exclusive',
+        )
       }
       if (opt.gzip) {
         if (typeof opt.gzip !== 'object') {

src/parse.ts

@@ -140,7 +140,7 @@ export class Parser extends EE implements Warner {
     this.brotli =
       !(opt.gzip || opt.zstd) && opt.brotli !== undefined ? opt.brotli
       : isTBR ? undefined
-        : false
+      : false
 
     // zstd has magic bytes to identify it, but we also support explicit options
     // and file extension detection
@@ -150,7 +150,7 @@ export class Parser extends EE implements Warner {
     this.zstd =
       !(opt.gzip || opt.brotli) && opt.zstd !== undefined ? opt.zstd
       : isTZST ? true
-        : undefined
+      : undefined
 
     // have to set this so that streams are ok piping into it
     this.on('end', () => this[CLOSESTREAM]())
@@ -517,10 +517,8 @@ export class Parser extends EE implements Warner {
         const ended = this[ENDED]
         this[ENDED] = false
         this[UNZIP] =
-          this[UNZIP] === undefined ?
-            new Unzip({})
-          : isZstd ?
-            new ZstdDecompress({})
+          this[UNZIP] === undefined ? new Unzip({})
+          : isZstd ? new ZstdDecompress({})
           : new BrotliDecompress({})
         this[UNZIP].on('data', chunk => this[CONSUMECHUNK](chunk))
         this[UNZIP].on('error', er => this.abort(er as Error))

test/extract.ts

@@ -490,7 +490,10 @@ t.test('zstd', async t => {
 
   t.test('succeeds based on magic bytes', async t => {
     // copy the file to a new location with a different extension
-    const unknownExtension = path.resolve(__dirname, 'zstd/example.unknown')
+    const unknownExtension = path.resolve(
+      __dirname,
+      'zstd/example.unknown',
+    )
     fs.copyFileSync(file, unknownExtension)
 
     x({ sync: true, file: unknownExtension, C: dir })

test/header.js

@@ -670,13 +670,16 @@ t.test('gnutar-generated 10gb file size', t => {
   t.end()
 })
 
-t.test('tarmageddon, ensure that Header prioritizes Pax size', async t => {
-  const h = new Header({
-    path: 'file.txt',
-    size: 0,
-  })
-  h.encode()
-  t.equal(h.size, 0, 'size is zero in raw ustar header')
-  const hPax = new Header(h.block, 0, { size: 123 })
-  t.equal(hPax.size, 123, 'if size is set in pax, takes priority')
-})
+t.test(
+  'tarmageddon, ensure that Header prioritizes Pax size',
+  async t => {
+    const h = new Header({
+      path: 'file.txt',
+      size: 0,
+    })
+    h.encode()
+    t.equal(h.size, 0, 'size is zero in raw ustar header')
+    const hPax = new Header(h.block, 0, { size: 123 })
+    t.equal(hPax.size, 123, 'if size is set in pax, takes priority')
+  },
+)