@naturalcycles/nodejs-lib 13.33.0 → 13.34.0

package/dist/util/buildInfo.util.js

@@ -7,10 +7,10 @@ const git2_1 = require("./git2");
 function generateBuildInfo(opt = {}) {
     const now = js_lib_1.localTime.orNow(opt.overrideTimestamp);
     const ts = now.unix;
-    const rev = git2_1.git2.gitCurrentCommitSha();
-    const branchName = git2_1.git2.gitCurrentBranchName();
-    const repoName = git2_1.git2.gitCurrentRepoName();
-    const tsCommit = git2_1.git2.gitCurrentCommitTimestamp();
+    const rev = git2_1.git2.getCurrentCommitSha();
+    const branchName = git2_1.git2.getCurrentBranchName();
+    const repoName = git2_1.git2.getCurrentRepoName();
+    const tsCommit = git2_1.git2.getCurrentCommitTimestamp();
     const ver = [now.toStringCompact(), repoName, branchName, rev].join('_');
     let { APP_ENV: env } = process.env;
     if (!env) {

package/dist/util/exec2.d.ts

@@ -140,6 +140,11 @@ export interface SpawnOptions {
     name?: string;
     cwd?: string;
     env?: AnyObject;
+    /**
+     * Defaults to false for security reasons.
+     * Set to true to pass `process.env` to the spawned process.
+     */
+    passProcessEnv?: boolean;
 }
 export interface ExecOptions {
     /**
@@ -163,5 +168,10 @@ export interface ExecOptions {
     cwd?: string;
     timeout?: NumberOfMilliseconds;
     env?: AnyObject;
+    /**
+     * Defaults to false for security reasons.
+     * Set to true to pass `process.env` to the spawned process.
+     */
+    passProcessEnv?: boolean;
 }
 export {};

package/dist/util/exec2.js

@@ -57,8 +57,10 @@ class Exec2 {
             const p = node_child_process_1.default.spawn(cmd, opt.args || [], {
                 shell,
                 cwd,
-                env,
-                // ...process.env, // not passing by default for security reasons
+                env: {
+                    ...env,
+                    ...(opt.passProcessEnv ? process.env : {}),
+                },
             });
             p.stdout.on('data', data => {
                 if (collectOutputWhileRunning) {
@@ -115,8 +117,10 @@ class Exec2 {
             stdio: 'inherit',
             shell,
             cwd,
-            env,
-            // ...process.env, // not passing by default for security reasons
+            env: {
+                ...env,
+                ...(opt.passProcessEnv ? process.env : {}),
+            },
         });
         this.logFinish(cmd, opt, started);
         if (r.error) {
@@ -153,8 +157,10 @@ class Exec2 {
                 // shell: undefined,
                 cwd,
                 timeout,
-                env,
-                // ...process.env, // not passing by default for security reasons
+                env: {
+                    ...env,
+                    ...(opt.passProcessEnv ? process.env : {}),
+                },
             })
                 .trim();
         }
@@ -192,7 +198,13 @@ class Exec2 {
     logFinish(cmd, opt, started) {
         if (!opt.logFinish && !opt.log)
             return;
-        console.log([(0, colors_1.white)(opt.name || cmd), (0, colors_1.dimGrey)('took ' + (0, js_lib_1._since)(started))].join(' '));
+        console.log([
+            (0, colors_1.white)(opt.name || cmd),
+            ...((!opt.name && opt.args) || []),
+            (0, colors_1.dimGrey)('took ' + (0, js_lib_1._since)(started)),
+        ]
+            .filter(Boolean)
+            .join(' '));
     }
 }
 exports.exec2 = new Exec2();

package/dist/util/git2.d.ts

@@ -5,21 +5,21 @@ import type { UnixTimestampNumber } from '@naturalcycles/js-lib';
 declare class Git2 {
     getLastGitCommitMsg(): string;
     commitMessageToTitleMessage(msg: string): string;
-    gitHasUncommittedChanges(): boolean;
+    hasUncommittedChanges(): boolean;
     /**
      * Returns true if there were changes
      */
-    gitCommitAll(msg: string): boolean;
+    commitAll(msg: string): boolean;
     /**
      * @returns true if there are not pushed commits.
      */
-    gitIsAhead(): boolean;
-    gitPull(): void;
-    gitPush(): void;
-    gitCurrentCommitSha(full?: boolean): string;
-    gitCurrentCommitTimestamp(): UnixTimestampNumber;
-    gitCurrentBranchName(): string;
-    gitCurrentRepoName(): string;
+    isAhead(): boolean;
+    pull(): void;
+    push(): void;
+    getCurrentCommitSha(full?: boolean): string;
+    getCurrentCommitTimestamp(): UnixTimestampNumber;
+    getCurrentBranchName(): string;
+    getCurrentRepoName(): string;
 }
 export declare const git2: Git2;
 export {};

package/dist/util/git2.js

@@ -18,7 +18,7 @@ class Git2 {
         const [preTitle, title] = firstLine.split(': ');
         return title || preTitle;
     }
-    gitHasUncommittedChanges() {
+    hasUncommittedChanges() {
         // git diff-index --quiet HEAD -- || echo "untracked"
         try {
             node_child_process_1.default.execSync('git diff-index --quiet HEAD --', {
@@ -33,7 +33,7 @@ class Git2 {
     /**
      * Returns true if there were changes
      */
-    gitCommitAll(msg) {
+    commitAll(msg) {
         // git commit -a -m "style(lint-all): $GIT_MSG" || true
         const cmd = `git commit -a --no-verify -m "${msg}"`;
         // const cmd = `git`
@@ -52,14 +52,14 @@ class Git2 {
     /**
      * @returns true if there are not pushed commits.
      */
-    gitIsAhead() {
+    isAhead() {
         // ahead=`git rev-list HEAD --not --remotes | wc -l | awk '{print $1}'`
         const cmd = `git rev-list HEAD --not --remotes | wc -l | awk '{print $1}'`;
         const stdout = exec2_1.exec2.exec(cmd);
         // console.log(`gitIsAhead: ${stdout}`)
         return Number(stdout) > 0;
     }
-    gitPull() {
+    pull() {
         const cmd = 'git pull';
         try {
             node_child_process_1.default.execSync(cmd, {
@@ -68,26 +68,26 @@ class Git2 {
         }
         catch { }
     }
-    gitPush() {
+    push() {
         // git push --set-upstream origin $CIRCLE_BRANCH && echo "pushed, exiting" && exit 0
         let cmd = 'git push';
-        const branchName = this.gitCurrentBranchName();
+        const branchName = this.getCurrentBranchName();
         if (branchName) {
             cmd += ` --set-upstream origin ${branchName}`;
         }
         exec2_1.exec2.spawn(cmd, { logStart: true });
     }
-    gitCurrentCommitSha(full = false) {
+    getCurrentCommitSha(full = false) {
         const sha = exec2_1.exec2.exec('git rev-parse HEAD');
         return full ? sha : sha.slice(0, 7);
     }
-    gitCurrentCommitTimestamp() {
+    getCurrentCommitTimestamp() {
         return Number(exec2_1.exec2.exec('git log -1 --format=%ct'));
     }
-    gitCurrentBranchName() {
+    getCurrentBranchName() {
         return exec2_1.exec2.exec('git rev-parse --abbrev-ref HEAD');
     }
-    gitCurrentRepoName() {
+    getCurrentRepoName() {
         const originUrl = exec2_1.exec2.exec('git config --get remote.origin.url');
         return node_path_1.default.basename(originUrl, '.git');
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/nodejs-lib",
-  "version": "13.33.0",
+  "version": "13.34.0",
   "scripts": {
     "prepare": "husky",
     "build": "dev-lib build",

package/src/util/buildInfo.util.ts

@@ -19,10 +19,10 @@ export function generateBuildInfo(opt: GenerateBuildInfoOptions = {}): BuildInfo
   const now = localTime.orNow(opt.overrideTimestamp)
   const ts = now.unix
 
-  const rev = git2.gitCurrentCommitSha()
-  const branchName = git2.gitCurrentBranchName()
-  const repoName = git2.gitCurrentRepoName()
-  const tsCommit = git2.gitCurrentCommitTimestamp()
+  const rev = git2.getCurrentCommitSha()
+  const branchName = git2.getCurrentBranchName()
+  const repoName = git2.getCurrentRepoName()
+  const tsCommit = git2.getCurrentCommitTimestamp()
 
   const ver = [now.toStringCompact(), repoName, branchName, rev].join('_')
 

package/src/util/exec2.ts

@@ -68,8 +68,10 @@ class Exec2 {
       const p = cp.spawn(cmd, opt.args || [], {
         shell,
         cwd,
-        env,
-        // ...process.env, // not passing by default for security reasons
+        env: {
+          ...env,
+          ...(opt.passProcessEnv ? process.env : {}),
+        },
       })
 
       p.stdout.on('data', data => {
@@ -130,8 +132,10 @@ class Exec2 {
       stdio: 'inherit',
       shell,
       cwd,
-      env,
-      // ...process.env, // not passing by default for security reasons
+      env: {
+        ...env,
+        ...(opt.passProcessEnv ? process.env : {}),
+      },
     })
 
     this.logFinish(cmd, opt, started)
@@ -172,8 +176,10 @@ class Exec2 {
           // shell: undefined,
           cwd,
           timeout,
-          env,
-          // ...process.env, // not passing by default for security reasons
+          env: {
+            ...env,
+            ...(opt.passProcessEnv ? process.env : {}),
+          },
         })
         .trim()
     } catch (err) {
@@ -218,7 +224,15 @@ class Exec2 {
   ): void {
     if (!opt.logFinish && !opt.log) return
 
-    console.log([white(opt.name || cmd), dimGrey('took ' + _since(started))].join(' '))
+    console.log(
+      [
+        white(opt.name || cmd),
+        ...((!opt.name && (opt as SpawnOptions).args) || []),
+        dimGrey('took ' + _since(started)),
+      ]
+        .filter(Boolean)
+        .join(' '),
+    )
   }
 }
 
@@ -297,6 +311,11 @@ export interface SpawnOptions {
   cwd?: string
 
   env?: AnyObject
+  /**
+   * Defaults to false for security reasons.
+   * Set to true to pass `process.env` to the spawned process.
+   */
+  passProcessEnv?: boolean
 }
 
 export interface ExecOptions {
@@ -323,4 +342,9 @@ export interface ExecOptions {
   timeout?: NumberOfMilliseconds
 
   env?: AnyObject
+  /**
+   * Defaults to false for security reasons.
+   * Set to true to pass `process.env` to the spawned process.
+   */
+  passProcessEnv?: boolean
 }

package/src/util/git2.ts

@@ -18,7 +18,7 @@ class Git2 {
     return title || preTitle!
   }
 
-  gitHasUncommittedChanges(): boolean {
+  hasUncommittedChanges(): boolean {
     // git diff-index --quiet HEAD -- || echo "untracked"
     try {
       cp.execSync('git diff-index --quiet HEAD --', {
@@ -33,7 +33,7 @@ class Git2 {
   /**
    * Returns true if there were changes
    */
-  gitCommitAll(msg: string): boolean {
+  commitAll(msg: string): boolean {
     // git commit -a -m "style(lint-all): $GIT_MSG" || true
     const cmd = `git commit -a --no-verify -m "${msg}"`
     // const cmd = `git`
@@ -53,7 +53,7 @@ class Git2 {
   /**
    * @returns true if there are not pushed commits.
    */
-  gitIsAhead(): boolean {
+  isAhead(): boolean {
     // ahead=`git rev-list HEAD --not --remotes | wc -l | awk '{print $1}'`
     const cmd = `git rev-list HEAD --not --remotes | wc -l | awk '{print $1}'`
     const stdout = exec2.exec(cmd)
@@ -61,7 +61,7 @@ class Git2 {
     return Number(stdout) > 0
   }
 
-  gitPull(): void {
+  pull(): void {
     const cmd = 'git pull'
     try {
       cp.execSync(cmd, {
@@ -70,11 +70,11 @@ class Git2 {
     } catch {}
   }
 
-  gitPush(): void {
+  push(): void {
     // git push --set-upstream origin $CIRCLE_BRANCH && echo "pushed, exiting" && exit 0
     let cmd = 'git push'
 
-    const branchName = this.gitCurrentBranchName()
+    const branchName = this.getCurrentBranchName()
 
     if (branchName) {
       cmd += ` --set-upstream origin ${branchName}`
@@ -83,20 +83,20 @@ class Git2 {
     exec2.spawn(cmd, { logStart: true })
   }
 
-  gitCurrentCommitSha(full = false): string {
+  getCurrentCommitSha(full = false): string {
     const sha = exec2.exec('git rev-parse HEAD')
     return full ? sha : sha.slice(0, 7)
   }
 
-  gitCurrentCommitTimestamp(): UnixTimestampNumber {
+  getCurrentCommitTimestamp(): UnixTimestampNumber {
     return Number(exec2.exec('git log -1 --format=%ct'))
   }
 
-  gitCurrentBranchName(): string {
+  getCurrentBranchName(): string {
     return exec2.exec('git rev-parse --abbrev-ref HEAD')
   }
 
-  gitCurrentRepoName(): string {
+  getCurrentRepoName(): string {
     const originUrl = exec2.exec('git config --get remote.origin.url')
     return path.basename(originUrl, '.git')
   }