@definitelytyped/utils - npm Package Compare versions

Comparing version 0.0.22 to 0.0.23-next.0

dist/index.d.ts

@@ -8,2 +8,3 @@ export * from "./assertions";
 export * from "./miscellany";
+export * from "./npm";
 export * from "./process";
@@ -10,0 +11,0 @@ export * from "./progress";

dist/index.js

@@ -13,2 +13,3 @@ "use strict";
 __export(require("./miscellany"));
+__export(require("./npm"));
 __export(require("./process"));
@@ -15,0 +16,0 @@ __export(require("./progress"));

dist/io.d.ts

 /// <reference types="node" />
+import "./types/fstream";
 import { FS } from "./fs";
@@ -30,5 +31,8 @@ export declare function readFile(path: string): Promise<string>;
 export declare function makeHttpRequest(options: FetchOptions): Promise<string>;
-export declare function sleep(seconds: number): Promise<void>;
 export declare function isDirectory(path: string): Promise<boolean>;
 export declare const npmInstallFlags = "--ignore-scripts --no-shrinkwrap --no-package-lock --no-bin-links --no-save";
 export declare function downloadAndExtractFile(url: string): Promise<FS>;
+export declare function gzip(input: NodeJS.ReadableStream): NodeJS.ReadableStream;
+export declare function unGzip(input: NodeJS.ReadableStream): NodeJS.ReadableStream;
+export declare function writeTgz(inputDirectory: string, outFileName: string): Promise<void>;
+export declare function createTgz(dir: string, onError: (error: Error) => void): NodeJS.ReadableStream;

dist/io.js

@@ -13,3 +13,6 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+require("./types/fstream");
 const fs_extra_1 = require("fs-extra");
+const fstream_1 = require("fstream");
+const tar_1 = require("tar");
 const tar_stream_1 = __importDefault(require("tar-stream"));
@@ -124,3 +127,3 @@ const https_1 = __importStar(require("https"));
             }
-            await sleep(1);
+            await miscellany_1.sleep(1);
         }
@@ -161,6 +164,2 @@ return doRequest(options, https_1.request, this.agent);
 }
-async function sleep(seconds) {
-    return new Promise(resolve => setTimeout(resolve, seconds * 1000));
-}
-exports.sleep = sleep;
 async function isDirectory(path) {
@@ -212,2 +211,49 @@ return (await fs_extra_1.stat(path)).isDirectory();
 exports.downloadAndExtractFile = downloadAndExtractFile;
+function gzip(input) {
+    return input.pipe(zlib_1.default.createGzip());
+}
+exports.gzip = gzip;
+function unGzip(input) {
+    const output = zlib_1.default.createGunzip();
+    input.pipe(output);
+    return output;
+}
+exports.unGzip = unGzip;
+function writeTgz(inputDirectory, outFileName) {
+    return new Promise((resolve, reject) => {
+        resolve(streamDone(createTgz(inputDirectory, reject).pipe(fs_extra_1.createWriteStream(outFileName))));
+    });
+}
+exports.writeTgz = writeTgz;
+// To output this for testing:
+// `require("./dist/io").createTgz("./src", err => { throw err }).pipe(fs.createWriteStream("foo.tgz"))`
+function createTgz(dir, onError) {
+    return gzip(createTar(dir, onError));
+}
+exports.createTgz = createTgz;
+function createTar(dir, onError) {
+    const packer = tar_1.Pack({ noProprietary: true, path: dir }).on("error", onError);
+    return fstream_1.Reader({ path: dir, type: "Directory", filter: addDirectoryExecutablePermission })
+        .on("error", onError)
+        .pipe(packer);
+}
+/**
+ * Work around a bug where directories bundled on Windows do not have executable permission when extracted on Linux.
+ * https://github.com/npm/node-tar/issues/7#issuecomment-17572926
+ */
+function addDirectoryExecutablePermission(entry) {
+    if (entry.props.type === "Directory") {
+        entry.props.mode = addExecutePermissionsFromReadPermissions(entry.props.mode);
+    }
+    return true;
+}
+function addExecutePermissionsFromReadPermissions(mode) {
+    // Constant that gives execute permissions to owner, group, and others. "+x"
+    const allExecutePermissions = 0o111;
+    // Moves the bits for read permissions into the place for execute permissions.
+    // In other words, a component will have execute permissions if it has read permissions.
+    const readPermissionsAsExecutePermissions = (mode >>> 2) & allExecutePermissions; // tslint:disable-line no-bitwise
+    // Add these additional execute permissions to the mode.
+    return mode | readPermissionsAsExecutePermissions; // tslint:disable-line no-bitwise
+}
 //# sourceMappingURL=io.js.map

dist/miscellany.d.ts

@@ -6,1 +6,2 @@ export declare function parseJson(text: string): object;
 export declare function unmangleScopedPackage(packageName: string): string | undefined;
+export declare function sleep(seconds: number): Promise<void>;

dist/miscellany.js

@@ -38,2 +38,6 @@ "use strict";
 exports.unmangleScopedPackage = unmangleScopedPackage;
+async function sleep(seconds) {
+    return new Promise(resolve => setTimeout(resolve, seconds * 1000));
+}
+exports.sleep = sleep;
 //# sourceMappingURL=miscellany.js.map

package.json

 {
   "name": "@definitelytyped/utils",
-  "version": "0.0.22",
+  "version": "0.0.23-next.0",
   "description": "Shared utilities for DefinitelyTyped tools",
@@ -25,2 +25,5 @@ "homepage": "https://github.com/DefinitelyTyped/tools#readme",
     "fs-extra": "^8.1.0",
+    "fstream": "^1.0.12",
+    "npm-registry-client": "^8.6.0",
+    "tar": "^2.2.2",
     "tar-stream": "^2.1.0"
@@ -31,2 +34,3 @@ },
     "@types/fs-extra": "^8.1.0",
+    "@types/tar": "^4.0.3",
     "@types/tar-stream": "^2.1.0"
@@ -37,3 +41,3 @@ },
   },
-  "gitHead": "4e45286d52827c59b675e6eff0d2e248d8402a2a"
+  "gitHead": "88172254de4e02bd385b77e1d9a9d69f619afa4a"
 }

src/index.ts

@@ -8,2 +8,3 @@ export * from "./assertions";
 export * from "./miscellany";
+export * from "./npm";
 export * from "./process";
@@ -10,0 +11,0 @@ export * from "./progress";

src/io.ts

@@ -0,1 +1,2 @@
+import "./types/fstream";
 import {
@@ -6,4 +7,7 @@ readFile as readFileWithEncoding,
   writeFile as writeFileWithEncoding,
-  writeJson as writeJsonRaw
+  writeJson as writeJsonRaw,
+  createWriteStream
 } from "fs-extra";
+import { FStreamEntry, Reader } from "fstream";
+import { Pack } from "tar";
 import tarStream from "tar-stream";
@@ -15,3 +19,3 @@ import https, { Agent, request } from "https";
 import { StringDecoder } from "string_decoder";
-import { parseJson, withoutStart } from "./miscellany";
+import { parseJson, withoutStart, sleep } from "./miscellany";
 import { FS, Dir, InMemoryFS } from "./fs";
@@ -166,6 +170,2 @@ import { assertDefined } from "./assertions";
 
-export async function sleep(seconds: number): Promise<void> {
-  return new Promise<void>(resolve => setTimeout(resolve, seconds * 1000));
-}
-
 export async function isDirectory(path: string): Promise<boolean> {
@@ -222,1 +222,52 @@ return (await stat(path)).isDirectory();
 }
+
+export function gzip(input: NodeJS.ReadableStream): NodeJS.ReadableStream {
+  return input.pipe(zlib.createGzip());
+}
+
+export function unGzip(input: NodeJS.ReadableStream): NodeJS.ReadableStream {
+  const output = zlib.createGunzip();
+  input.pipe(output);
+  return output;
+}
+
+export function writeTgz(inputDirectory: string, outFileName: string): Promise<void> {
+  return new Promise<void>((resolve, reject) => {
+    resolve(streamDone(createTgz(inputDirectory, reject).pipe(createWriteStream(outFileName))));
+  });
+}
+
+// To output this for testing:
+// `require("./dist/io").createTgz("./src", err => { throw err }).pipe(fs.createWriteStream("foo.tgz"))`
+export function createTgz(dir: string, onError: (error: Error) => void): NodeJS.ReadableStream {
+  return gzip(createTar(dir, onError));
+}
+
+function createTar(dir: string, onError: (error: Error) => void): NodeJS.ReadableStream {
+  const packer = Pack({ noProprietary: true, path: dir }).on("error", onError);
+
+  return Reader({ path: dir, type: "Directory", filter: addDirectoryExecutablePermission })
+    .on("error", onError)
+    .pipe(packer);
+}
+
+/**
+ * Work around a bug where directories bundled on Windows do not have executable permission when extracted on Linux.
+ * https://github.com/npm/node-tar/issues/7#issuecomment-17572926
+ */
+function addDirectoryExecutablePermission(entry: FStreamEntry): boolean {
+  if (entry.props.type === "Directory") {
+    entry.props.mode = addExecutePermissionsFromReadPermissions(entry.props.mode);
+  }
+  return true;
+}
+
+function addExecutePermissionsFromReadPermissions(mode: number): number {
+  // Constant that gives execute permissions to owner, group, and others. "+x"
+  const allExecutePermissions = 0o111;
+  // Moves the bits for read permissions into the place for execute permissions.
+  // In other words, a component will have execute permissions if it has read permissions.
+  const readPermissionsAsExecutePermissions = (mode >>> 2) & allExecutePermissions; // tslint:disable-line no-bitwise
+  // Add these additional execute permissions to the mode.
+  return mode | readPermissionsAsExecutePermissions; // tslint:disable-line no-bitwise
+}

src/miscellany.ts

@@ -32,1 +32,5 @@ import crypto from "crypto";
 }
+
+export async function sleep(seconds: number): Promise<void> {
+  return new Promise<void>(resolve => setTimeout(resolve, seconds * 1000));
+}

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

291567

increased by16.32%

Number of package files

71

increased by20.34%

Lines of code

4061

increased by21.51%

Worsened metrics

Dependency count

7

increased by75%

Dev dependency count

4

increased by33.33%

Number of low supply chain risk alerts

6

increased by50%

Dependency changes

• + Addedfstream@^1.0.12

• + Addednpm-registry-client@^8.6.0

• + Addedtar@^2.2.2

• + Addedajv@6.12.6(transitive)

• + Addedansi-regex@2.1.1(transitive)

• + Addedaproba@1.2.0(transitive)

• + Addedare-we-there-yet@1.1.7(transitive)

• + Addedasn1@0.2.6(transitive)

• + Addedassert-plus@1.0.0(transitive)

• + Addedasynckit@0.4.0(transitive)

• + Addedaws-sign2@0.7.0(transitive)

• + Addedaws4@1.13.2(transitive)

• + Addedbalanced-match@1.0.2(transitive)

• + Addedbcrypt-pbkdf@1.0.2(transitive)

• + Addedblock-stream@0.0.9(transitive)

• + Addedbrace-expansion@1.1.11(transitive)

• + Addedbuffer-from@1.1.2(transitive)

• + Addedbuiltins@1.0.3(transitive)

• + Addedcaseless@0.12.0(transitive)

• + Addedcode-point-at@1.1.0(transitive)

• + Addedcombined-stream@1.0.8(transitive)

• + Addedconcat-map@0.0.1(transitive)

• + Addedconcat-stream@1.6.2(transitive)

• + Addedconsole-control-strings@1.1.0(transitive)

• + Addedcore-util-is@1.0.21.0.3(transitive)

• + Addeddashdash@1.14.1(transitive)

• + Addeddelayed-stream@1.0.0(transitive)

• + Addeddelegates@1.0.0(transitive)

• + Addedecc-jsbn@0.1.2(transitive)

• + Addedextend@3.0.2(transitive)

• + Addedextsprintf@1.3.0(transitive)

• + Addedfast-deep-equal@3.1.3(transitive)

• + Addedfast-json-stable-stringify@2.1.0(transitive)

• + Addedforever-agent@0.6.1(transitive)

• + Addedform-data@2.3.3(transitive)

• + Addedfs.realpath@1.0.0(transitive)

• + Addedfstream@1.0.12(transitive)

• + Addedfunction-bind@1.1.2(transitive)

• + Addedgauge@2.7.4(transitive)

• + Addedgetpass@0.1.7(transitive)

• + Addedglob@7.2.3(transitive)

• + Addedhar-schema@2.0.0(transitive)

• + Addedhar-validator@5.1.5(transitive)

• + Addedhas-unicode@2.0.1(transitive)

• + Addedhasown@2.0.2(transitive)

• + Addedhosted-git-info@2.8.9(transitive)

• + Addedhttp-signature@1.2.0(transitive)

• + Addedinflight@1.0.6(transitive)

• + Addedis-core-module@2.15.1(transitive)

• + Addedis-fullwidth-code-point@1.0.0(transitive)

• + Addedis-typedarray@1.0.0(transitive)

• + Addedisarray@1.0.0(transitive)

• + Addedisstream@0.1.2(transitive)

• + Addedjsbn@0.1.1(transitive)

• + Addedjson-schema@0.4.0(transitive)

• + Addedjson-schema-traverse@0.4.1(transitive)

• + Addedjson-stringify-safe@5.0.1(transitive)

• + Addedjsprim@1.4.2(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addedminimatch@3.1.2(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedmkdirp@0.5.6(transitive)

• + Addednormalize-package-data@2.5.0(transitive)

• + Addednpm-package-arg@6.1.1(transitive)

• + Addednpm-registry-client@8.6.0(transitive)

• + Addednpmlog@4.1.2(transitive)

• + Addednumber-is-nan@1.0.1(transitive)

• + Addedoauth-sign@0.9.0(transitive)

• + Addedobject-assign@4.1.1(transitive)

• + Addedos-homedir@1.0.2(transitive)

• + Addedos-tmpdir@1.0.2(transitive)

• + Addedosenv@0.1.5(transitive)

• + Addedpath-is-absolute@1.0.1(transitive)

• + Addedpath-parse@1.0.7(transitive)

• + Addedperformance-now@2.1.0(transitive)

• + Addedprocess-nextick-args@2.0.1(transitive)

• + Addedpsl@1.9.0(transitive)

• + Addedpunycode@2.3.1(transitive)

• + Addedqs@6.5.3(transitive)

• + Addedreadable-stream@2.3.8(transitive)

• + Addedrequest@2.88.2(transitive)

• + Addedresolve@1.22.8(transitive)

• + Addedretry@0.10.1(transitive)

• + Addedrimraf@2.7.1(transitive)

• + Addedsafe-buffer@5.1.2(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsemver@5.7.2(transitive)

• + Addedset-blocking@2.0.0(transitive)

• + Addedsignal-exit@3.0.7(transitive)

• + Addedslide@1.1.6(transitive)

• + Addedspdx-correct@3.2.0(transitive)

• + Addedspdx-exceptions@2.5.0(transitive)

• + Addedspdx-expression-parse@3.0.1(transitive)

• + Addedspdx-license-ids@3.0.20(transitive)

• + Addedsshpk@1.18.0(transitive)

• + Addedssri@5.3.0(transitive)

• + Addedstring-width@1.0.2(transitive)

• + Addedstring_decoder@1.1.1(transitive)

• + Addedstrip-ansi@3.0.1(transitive)

• + Addedsupports-preserve-symlinks-flag@1.0.0(transitive)

• + Addedtar@2.2.2(transitive)

• + Addedtough-cookie@2.5.0(transitive)

• + Addedtunnel-agent@0.6.0(transitive)

• + Addedtweetnacl@0.14.5(transitive)

• + Addedtypedarray@0.0.6(transitive)

• + Addeduri-js@4.4.1(transitive)

• + Addeduuid@3.4.0(transitive)

• + Addedvalidate-npm-package-license@3.0.4(transitive)

• + Addedvalidate-npm-package-name@3.0.0(transitive)

• + Addedverror@1.10.0(transitive)

• + Addedwide-align@1.1.5(transitive)

• - Removedstring_decoder@1.3.0(transitive)