buildstamp - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

CHANGELOG.md

@@ -0,1 +1,9 @@
+## [1.0.1](https://github.com/qiwi/buildstamp/compare/v1.0.0...v1.0.1) (2020-09-18)
+
+
+### Bug Fixes
+
+* **executor:** set default value of env in execute ([555faf9](https://github.com/qiwi/buildstamp/commit/555faf952c99cc7ee9e44de62789853460b4fc63))
+* **README.md:** updated cli args description ([8812bac](https://github.com/qiwi/buildstamp/commit/8812bac8585ffef909b80e443861c0ce475f7dd0))
+
 # 1.0.0 (2020-09-05)
@@ -2,0 +10,0 @@

flow-typed/index.flow.js

@@ -134,3 +134,3 @@ /**
   >[];
-  declare export var execute: (options: TStampOptions, env: TEnv) => TStamp;
+  declare export var execute: (options: TStampOptions, env?: TEnv) => TStamp;
 }
@@ -152,3 +152,3 @@
       options: $PropertyType<$Exports<"./interfaces">, "TStampOptions">,
-      env: { [key: string]: any, ... }
+      env?: { [key: string]: any, ... }
     ) => $PropertyType<$Exports<"./interfaces">, "TStamp">,
@@ -155,0 +155,0 @@ ...

package.json

 {
   "name": "buildstamp",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "private": false,
@@ -5,0 +5,0 @@ "publishConfig": {

README.md

@@ -28,11 +28,11 @@ # buildstamp
 
-| Option              | Description                          | Default                                |
-|:--------------------|:-------------------------------------|:---------------------------------------|
-| --out.path          | path to generated file               | output is not written to a file        |
-| --out.jsonSeparator | one of tab/space/double-space        | tab                                    |
-| --git               | add git data to output               | output doesn't contain git data        |
-| --docker.imageTag   | docker image tag                     | output doesn't contain git docker info |
-| --date.format       | iso or instant                       | output doesn't contain date            |
-| --date.value        | any valid input for Date constructor | current timestamp                      |
-| --cwd               | working directory                    | process.cwd()                          |
+| Option              | Description                                             | Default                                |
+|:--------------------|:--------------------------------------------------------|:---------------------------------------|
+| --out.path          | path to generated file                                  | output is not written to a file        |
+| --out.jsonSeparator | one of `tab`, `space`, `double-space`                   | `tab`                                  |
+| --git               | add git data to output                                  | git data is omitted                    |
+| --docker.imageTag   | docker image tag, will be added to output, if exists    | docker info is omitted                 |
+| --date.format       | add date to output, one of `iso` or `instant`           | date is omitted                        |
+| --date.value        | any valid input for Date constructor                    | `Date.now()`                           |
+| --cwd               | working directory                                       | `process.cwd()`                        |
 
@@ -39,0 +39,0 @@ ## API

target/es5/executor.d.ts

 import { TStamp, TEnv, TStampOptions } from './interfaces';
 export declare const chunks: import("./interfaces").TStampChunk[];
-export declare const execute: (options: TStampOptions, env: TEnv) => TStamp;
+export declare const execute: (options: TStampOptions, env?: TEnv) => TStamp;

target/es5/executor.js

@@ -19,3 +19,4 @@ "use strict";
 exports.execute = function (options, env) {
+    if (env === void 0) { env = process.env; }
     return exports.chunks.reduce(function (ctx, chunk) { return chunk(ctx, env); }, { options: options, stamp: {} }).stamp;
 };

target/es5/index.d.ts

@@ -5,4 +5,4 @@ import { execute } from './executor';
 declare const _default: {
-    execute: (options: import("./interfaces").TStampOptions, env: Record<string, any>) => import("./interfaces").TStamp;
+    execute: (options: import("./interfaces").TStampOptions, env?: Record<string, any>) => import("./interfaces").TStamp;
 };
 export default _default;

target/es6/executor.d.ts

 import { TStamp, TEnv, TStampOptions } from './interfaces';
 export declare const chunks: import("./interfaces").TStampChunk[];
-export declare const execute: (options: TStampOptions, env: TEnv) => TStamp;
+export declare const execute: (options: TStampOptions, env?: TEnv) => TStamp;

target/es6/executor.js

@@ -15,2 +15,2 @@ import { normalizeChunk } from './chunks/normalize';
 ];
-export const execute = (options, env) => chunks.reduce((ctx, chunk) => chunk(ctx, env), { options, stamp: {} }).stamp;
+export const execute = (options, env = process.env) => chunks.reduce((ctx, chunk) => chunk(ctx, env), { options, stamp: {} }).stamp;

target/es6/index.d.ts

@@ -5,4 +5,4 @@ import { execute } from './executor';
 declare const _default: {
-    execute: (options: import("./interfaces").TStampOptions, env: Record<string, any>) => import("./interfaces").TStamp;
+    execute: (options: import("./interfaces").TStampOptions, env?: Record<string, any>) => import("./interfaces").TStamp;
 };
 export default _default;

target/ts/executor.ts

@@ -20,4 +20,4 @@ import { normalizeChunk } from './chunks/normalize'
   options: TStampOptions,
-  env: TEnv
+  env: TEnv = process.env
 ): TStamp =>
   chunks.reduce((ctx, chunk) => chunk(ctx, env), { options, stamp: {} }).stamp

typings/index.d.ts

@@ -91,3 +91,3 @@ declare module 'buildstamp/target/es5/interfaces' {
 	export const chunks: import("./interfaces").TStampChunk[];
-	export const execute: (options: TStampOptions, env: TEnv) => TStamp;
+	export const execute: (options: TStampOptions, env?: TEnv) => TStamp;
 }
@@ -102,3 +102,3 @@ declare module 'buildstamp/target/es5/cli' {
 	export { execute }; const _default: {
-	    execute: (options: import("./interfaces").TStampOptions, env: Record<string, any>) => import("./interfaces").TStamp;
+	    execute: (options: import("./interfaces").TStampOptions, env?: Record<string, any>) => import("./interfaces").TStamp;
 	};
@@ -105,0 +105,0 @@ export default _default;

No alert changes

Improved metrics

Total package byte prevSize

46982

increased by1.39%

Lines of code

1141

increased by0.09%

Worsened metrics

Number of low supply chain risk alerts

10

increased by25%

No dependency changes