@poppinss/colors - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

build/index.js

 "use strict";
+/*
+ * @poppinss/colors
+ *
+ * (c) Harminder Virk <[e-mail]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+*/
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -3,0 +11,0 @@ var Kleur_1 = require("./src/Kleur");

build/src/Base.d.ts

@@ -0,2 +1,14 @@
+/**
+ * @poppinss/colors
+ *
+ * (c) Harminder Virk <[e-mail]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { Kleur } from 'kleur';
+/**
+ * Base class extended by [[Kleur]] and [[Stringify]] classes to have
+ * common interface. The API is kept similar to `kleur` package.
+ */
 export declare abstract class Colors implements Kleur {
@@ -3,0 +15,0 @@ protected abstract $transform(transformation: string): this;

build/src/Base.js

 "use strict";
+/**
+ * @poppinss/colors
+ *
+ * (c) Harminder Virk <[e-mail]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Base class extended by [[Kleur]] and [[Stringify]] classes to have
+ * common interface. The API is kept similar to `kleur` package.
+ */
 class Colors {
@@ -4,0 +16,0 @@ black(text) {

build/src/Kleur.d.ts

@@ -0,6 +1,23 @@
+/**
+ * @poppinss/colors
+ *
+ * (c) Harminder Virk <[e-mail]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { Colors } from './Base';
+/**
+ * Exposes the API to print colorful text. The reason we wrap `kleur`
+ * is that, during tests we make use of a mock version of kleur
+ * that makes the testing more reasonable.
+ */
 export declare class Kleur extends Colors {
     private chain;
+    /**
+     * Perform the given transformation. The base class will
+     * invoke this method
+     */
     protected $transform(transformation: string): this;
     protected $transform(transformation: string, text: string | number): string;
 }

build/src/Kleur.js

 "use strict";
+/**
+ * @poppinss/colors
+ *
+ * (c) Harminder Virk <[e-mail]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 var __importDefault = (this && this.__importDefault) || function (mod) {
@@ -8,2 +16,7 @@ return (mod && mod.__esModule) ? mod : { "default": mod };
 const Base_1 = require("./Base");
+/**
+ * Exposes the API to print colorful text. The reason we wrap `kleur`
+ * is that, during tests we make use of a mock version of kleur
+ * that makes the testing more reasonable.
+ */
 class Kleur extends Base_1.Colors {
@@ -10,0 +23,0 @@ constructor() {

build/src/Stringify.d.ts

@@ -0,6 +1,22 @@
+/**
+ * @poppinss/colors
+ *
+ * (c) Harminder Virk <[e-mail]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { Colors } from './Base';
+/**
+ * Stringify class returns a plain string in a format of function
+ * calls. The output is reliable and easy to test.
+ */
 export declare class Stringify extends Colors {
     private chain;
+    /**
+     * Perform the given transformation. The base class will
+     * invoke this method
+     */
     protected $transform(transformation: string): this;
     protected $transform(transformation: string, text: string | number): string;
 }

build/src/Stringify.js

 "use strict";
+/**
+ * @poppinss/colors
+ *
+ * (c) Harminder Virk <[e-mail]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 const Base_1 = require("./Base");
+/**
+ * Stringify class returns a plain string in a format of function
+ * calls. The output is reliable and easy to test.
+ */
 class Stringify extends Base_1.Colors {
@@ -5,0 +17,0 @@ constructor() {

package.json

 {
   "name": "@poppinss/colors",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A wrapper on top of kleur with API to write tests ",
@@ -30,16 +30,16 @@ "main": "build/index.js",
   "devDependencies": {
-    "@adonisjs/mrm-preset": "^2.2.2",
-    "@types/node": "^12.12.21",
+    "@adonisjs/mrm-preset": "^2.2.4",
+    "@types/node": "^13.7.0",
     "commitizen": "^4.0.3",
-    "cz-conventional-changelog": "^3.0.2",
+    "cz-conventional-changelog": "^3.1.0",
     "del-cli": "^3.0.0",
     "doctoc": "^1.4.0",
-    "eslint": "^6.7.2",
-    "eslint-plugin-adonis": "^1.0.4",
-    "husky": "^3.1.0",
+    "eslint": "^6.8.0",
+    "eslint-plugin-adonis": "^1.0.6",
+    "husky": "^4.2.1",
     "japa": "^3.0.1",
-    "mrm": "^2.0.2",
+    "mrm": "^2.0.4",
     "np": "^5.2.1",
-    "ts-node": "^8.5.4",
-    "typescript": "^3.7.3"
+    "ts-node": "^8.6.2",
+    "typescript": "^3.7.5"
   },
@@ -46,0 +46,0 @@ "nyc": {

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

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

14109

increased by21.84%

Lines of code

292

increased by44.55%

No dependency changes