Release v0.4.4

README.md

@@ -7,8 +7,8 @@ FS-Nextra
 [![npm](https://img.shields.io/npm/dt/fs-nextra.svg?maxAge=3600)](https://www.npmjs.com/package/fs-nextra)
 
 [![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/bdistin/fs-nextra.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/bdistin/fs-nextra/context:javascript)
-[![Coverage Status](https://coveralls.io/repos/github/bdistin/fs-nextra/badge.svg?branch=master)](https://coveralls.io/github/bdistin/fs-nextra?branch=master)
-[![travis-ci](https://travis-ci.com/bdistin/fs-nextra.svg?branch=master)](https://travis-ci.com/bdistin/fs-nextra)
+[![Coverage](https://img.shields.io/azure-devops/coverage/aodude/fs-nextra/1/master.svg)](https://dev.azure.com/aodude/fs-nextra/_build/latest?definitionId=1&branchName=master)
+[![Build Status](https://aodude.visualstudio.com/fs-nextra/_apis/build/status/bdistin.fs-nextra?branchName=master)](https://aodude.visualstudio.com/fs-nextra/_build/latest?definitionId=1&branchName=master)
 
 [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=bdistin/fs-nextra)](https://dependabot.com)
 [![david](https://david-dm.org/bdistin/fs-nextra.svg)](https://david-dm.org/bdistin/fs-nextra)
@@ -35,4 +35,4 @@ License
 
 Licensed under MIT
 
-Copyright (c) 2017 [BDISTIN](https://github.com/bdistin)
+Copyright (c) 2017-2019 [BDISTIN](https://github.com/bdistin)

azure-pipelines.yml

@@ -0,0 +1,37 @@
+resources:
+  repositories:
+    - repository: templates
+      type: github
+      name: dirigeants/pipelines
+      endpoint: bdistin
+
+trigger:
+- master
+
+jobs:
+  - template: lint.yml@templates
+
+  - template: scripts/.azure-test-template.yml
+    parameters:
+      name: Linux
+      vmImage: 'ubuntu-16.04'
+
+  - template: scripts/.azure-test-template.yml
+    parameters:
+      name: Mac
+      vmImage: 'macOS-10.13'
+
+  - template: scripts/.azure-test-template.yml
+    parameters:
+      name: Windows
+      vmImage: 'vs2017-win2016'
+
+  - template: docs.yml@templates
+    parameters:
+      ghRef: 'github.com/bdistin/fs-nextra'
+      targetBranch: 'gh-pages'
+      masterOnly: 'true'
+      dependsOn:
+        - Linux
+        - Mac
+        - Windows

package.json

@@ -1,16 +1,17 @@
 {
   "name": "fs-nextra",
-  "version": "0.4.3",
+  "version": "0.4.4",
   "description": "Node.js native fs promises with next-generation extra methods.",
   "main": "dist/index.js",
   "scripts": {
+    "prepublishOnly": "yarn build",
     "build": "tsc",
     "test": "yarn build && ava test/*.ts",
     "test:lint": "tslint '{test,src}/**/*.ts'",
-    "test:coverage": "yarn coverage && nyc check-coverage --lines 60 --functions 60 --branches 60",
+    "test:coverage": "yarn coverage && nyc check-coverage --lines 90 --functions 90 --branches 90",
     "coverage": "npx nyc npm test",
-    "coveralls": "npx nyc report --reporter=text-lcov | npx coveralls",
-    "docs": "typedoc --mode file --out ./docs/ ./src/",
+    "coverage:azure": "npx nyc report --reporter=cobertura --reporter=html",
+    "docs": "typedoc --mode file --out ./dist/ ./src/",
     "lint": "tslint --fix '{test,src}/**/*.ts'"
   },
   "keywords": [
@@ -35,14 +36,13 @@
     "node": ">=10.1.0"
   },
   "devDependencies": {
-    "@types/node": "^10.1.3",
+    "@types/node": "^11.11.0",
     "ava": "^1.0.1",
-    "coveralls": "^3.0.2",
     "eslint": "^5.2.0",
-    "eslint-config-klasa": "github:dirigeants/klasa-lint",
+    "eslint-config-klasa": "dirigeants/klasa-lint",
     "nyc": "^13.0.1",
+    "ts-node": "^8.0.3",
     "tslint": "^5.7.0",
-    "ts-node": "8.0.2",
     "typedoc": "^0.14.2",
     "typescript": "^3.0.1"
   },

scripts/.azure-test-template.yml

@@ -0,0 +1,32 @@
+parameters:
+  name: ''
+  vmImage: ''
+
+jobs:
+- job: ${{ parameters.name }}
+  dependsOn: Lint
+  condition: succeeded()
+  pool: 
+    vmImage: ${{ parameters.vmImage }}
+  strategy:
+    matrix:
+      Node 10:
+        nodeVersion: '10.x'
+      Node 11:
+        nodeVersion: '11.x'
+  steps:
+    - task: NodeTool@0
+      inputs:
+        versionSpec: $(nodeVersion)
+      displayName: 'Install Node.js'
+    - script: 'yarn'
+      displayName: 'Install Dependencies'
+    - script: 'yarn run test:coverage'
+      displayName: 'Run Tests'
+    - script: 'yarn run coverage:azure'
+      displayName: 'Generate Reports'
+    - task: PublishCodeCoverageResults@1
+      inputs:
+        codeCoverageTool: 'cobertura'
+        summaryFileLocation: $(System.DefaultWorkingDirectory)/coverage/cobertura-coverage.xml
+        reportDirectory: $(System.DefaultWorkingDirectory)/coverage

src/index.ts

@@ -21,6 +21,10 @@ export { default as ensureLink } from './nextra/createLink';
 export { default as ensureLinkAtomic } from './nextra/createLinkAtomic';
 export { default as ensureSymlink } from './nextra/createSymlink';
 export { default as ensureSymlinkAtomic } from './nextra/createSymlinkAtomic';
+export { default as gunzip } from './nextra/gunzip';
+export { default as gunzipAtomic } from './nextra/gunzipAtomic';
+export { default as gzip } from './nextra/gzip';
+export { default as gzipAtomic } from './nextra/gzip';
 export { default as linkAtomic } from './nextra/linkAtomic';
 export { default as mkdirp } from './nextra/mkdirs';
 export { default as mkdirs } from './nextra/mkdirs';
@@ -37,6 +41,10 @@ export { default as readJson } from './nextra/readJSON';
 export { default as remove } from './nextra/remove';
 export { default as scan } from './nextra/scan';
 export { default as symlinkAtomic } from './nextra/symlinkAtomic';
+export { default as targz } from './nextra/targz';
+export { default as targzAtomic } from './nextra/targzAtomic';
+export { default as unTargz } from './nextra/unTargz';
+export { default as unTargzAtomic } from './nextra/unTargzAtomic';
 export { default as writeFileAtomic } from './nextra/writeFileAtomic';
 export { default as writeJSON } from './nextra/writeJSON';
 export { default as writeJSONAtomic } from './nextra/writeJSONAtomic';

src/nextra/copy.ts

@@ -1,6 +1,6 @@
 import { resolve, dirname, join, basename } from 'path';
 
-import { replaceEsc, isSrcKid } from '../util';
+import { replaceEsc, isSrcKid } from '../utils/util';
 import { access, readlink, mkdir, symlink, copyFile, lstat, stat, chmod, readdir, Stats } from '../fs';
 
 import mkdirs from './mkdirs';

src/nextra/copyFileAtomic.ts

@@ -1,4 +1,4 @@
-import { tempFile } from '../util';
+import { tempFile } from '../utils/util';
 import { copyFile } from '../fs';
 
 import move from './move';

src/nextra/gunzip.ts

@@ -0,0 +1,23 @@
+import { createGunzip } from 'zlib';
+
+import { createWriteStream, createReadStream } from '../fs';
+import { pipelinePromise } from '../utils/util';
+import gunzipAtomic from './gunzipAtomic';
+
+/**
+ * Un-Gzips a file
+ * @function gunzip
+ * @memberof fsn/nextra
+ * @param fileName The filename of the output file
+ * @param inputFile The filepath of the archive
+ * @param atomic If the unzip file should be created atomically
+ */
+export default async function gzip(fileName: string, inputFile: string, atomic: boolean = false): Promise<void> {
+	if (atomic) return gunzipAtomic(fileName, inputFile);
+
+	return pipelinePromise(
+		createReadStream(inputFile),
+		createGunzip(),
+		createWriteStream(fileName)
+	);
+}

src/nextra/gunzipAtomic.ts

@@ -0,0 +1,16 @@
+import gunzip from './gunzip';
+import move from './move';
+import { tempFile } from '../utils/util';
+
+/**
+ * Un-Gzips a file atomically.
+ * @function gunzipAtomic
+ * @memberof fsn/nextra
+ * @param fileName The filename of the output file
+ * @param inputFile The filepath of the archive
+ */
+export default async function gzipAtomic(fileName: string, inputFile: string): Promise<void> {
+	const tempPath = tempFile();
+	await gunzip(tempPath, inputFile);
+	return move(tempPath, fileName, { overwrite: true });
+}

src/nextra/gzip.ts

@@ -0,0 +1,23 @@
+import { createGzip } from 'zlib';
+
+import { createWriteStream, createReadStream } from '../fs';
+import { pipelinePromise } from '../utils/util';
+import gzipAtomic from './gzipAtomic';
+
+/**
+ * Gzips a file
+ * @function gzip
+ * @memberof fsn/nextra
+ * @param fileName The filename of the archive
+ * @param inputFile The filepath of the input file
+ * @param atomic If the gzip file should be created
+ */
+export default async function gzip(fileName: string, inputFile: string, atomic: boolean = false): Promise<void> {
+	if (atomic) return gzipAtomic(fileName, inputFile);
+
+	return pipelinePromise(
+		createReadStream(inputFile),
+		createGzip(),
+		createWriteStream(fileName)
+	);
+}

src/nextra/gzipAtomic.ts

@@ -0,0 +1,16 @@
+import gzip from './gzip';
+import move from './move';
+import { tempFile } from '../utils/util';
+
+/**
+ * Gzips a file atomically.
+ * @function gzipAtomic
+ * @memberof fsn/nextra
+ * @param fileName The filename of the archive
+ * @param inputFile The filepath of the input file
+ */
+export default async function gzipAtomic(fileName: string, inputFile: string): Promise<void> {
+	const tempPath = tempFile();
+	await gzip(tempPath, inputFile);
+	return move(tempPath, fileName, { overwrite: true });
+}

src/nextra/linkAtomic.ts

@@ -1,4 +1,4 @@
-import { tempFile } from '../util';
+import { tempFile } from '../utils/util';
 import { link } from '../fs';
 
 import move from './move';

src/nextra/mkdirs.ts

@@ -1,6 +1,6 @@
 import { resolve, dirname, normalize, sep } from 'path';
 
-import { isWindows } from '../util';
+import { isWindows } from '../utils/util';
 import { stat, mkdir } from '../fs';
 
 /**

src/nextra/move.ts

@@ -1,6 +1,6 @@
 import { resolve, dirname } from 'path';
 
-import { isSrcKid } from '../util';
+import { isSrcKid } from '../utils/util';
 import { access, rename, stat } from '../fs';
 
 import remove from './remove';

src/nextra/remove.ts

@@ -1,6 +1,6 @@
 import { join } from 'path';
 
-import { isWindows, setTimeoutPromise } from '../util';
+import { isWindows, setTimeoutPromise } from '../utils/util';
 import { lstat, unlink, rmdir, chmod, readdir } from '../fs';
 
 /**

src/nextra/symlinkAtomic.ts

@@ -1,4 +1,4 @@
-import { tempFile } from '../util';
+import { tempFile } from '../utils/util';
 import { symlink } from '../fs';
 import { SymLinkType } from './createSymlink';