@4is-cronicle/plugin-tools - npm Package Compare versions

Comparing version 0.1.5 to 0.1.7

dist/index.d.ts

 import { IJobInput, IJobOutput } from './interfaces';
+export * from '@4lch4/logger';
 export { IJobInput, IJobOutput };
 export declare function initJob<P>(): Promise<IJobInput<P>>;
 export declare function endJob(output: IJobOutput): Promise<void>;

dist/index.js

 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.endJob = exports.initJob = void 0;
 const utils_1 = require("./utils");
+__exportStar(require("@4lch4/logger"), exports);
 async function initJob() {
@@ -6,0 +21,0 @@ const ioUtil = new utils_1.IOUtil();

package.json

 {
   "name": "@4is-cronicle/plugin-tools",
   "displayName": "Cronicle Plugin Tools",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "A library of helper functions for new Cronicle Plugins.",
@@ -10,7 +10,8 @@ "main": "dist/index.js",
   "scripts": {
+    "scan": "snyk monitor && snyk code test",
     "build": "tsc",
-    "lint": "prettier -c .",
+    "lint": "npm run pretty && prettier -c .",
     "pretty": "prettier --write .",
-    "prepublishOnly": "npm run lint && npm run build",
-    "test": "echo \"No tests currently available.\""
+    "prepublishOnly": "npm run test && npm run build",
+    "test": "npm run lint && echo 'No actual test files available, previous tasks completed successfully.'"
   },
@@ -35,2 +36,3 @@ "keywords": ["cronicle", "cronicle-tools", "cronicle-plugin"],
     "prettier": "^2.7.1",
+    "snyk": "^1.981.0",
     "ts-node": "^10.9.1",
@@ -40,4 +42,5 @@ "typescript": "^4.7.4"
   "dependencies": {
+    "@4lch4/logger": "^1.9.2",
     "dotenv": "^16.0.1"
   }
 }

README.md

@@ -1,7 +0,53 @@
-![Drone (self-hosted) with branch](https://img.shields.io/drone/build/4lch4/Cronicle-Plugin-Tools/main?server=https%3A%2F%2Fdrone.4lch4.io&style=flat-square) ![NPM](https://img.shields.io/npm/l/@4lch4/cronicle-plugin-tools?style=flat-square) [![Standard-Js](https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square)](https://standardjs.com/)
+[![Drone Build Status][0]][1] [![NPM License][2]][3] [![NPM Version][4]][5] [![Monthly Downloads (NPM)][6]][7] [![Snyk Vulnerabilities for npm package][8]][9]
 
-# Cronicle Tools
+[![code style: prettier][10]][11] [![Discord][12]][13] [![Twitter-Profile][14]][15]
 
-This project is to provide some helper functions to a new NodeJS module that wishes to be a [Cronicle Plugin][0].
+# Cronicle Plugin Tools
 
-[0]: https://github.com/jhuckaby/Cronicle#plugins
+This project is to provide some helper functions to a new NodeJS module that wishes to be a [Cronicle Plugin][16].
+
+## Exported Members
+
+The following list defines/describes the members that are exported by the [@4is-cronicle/plugin-tools][17] package:
+
+- [@4lch4/logger][18]
+  - All exported members of the `@4lch4/logger` library are also exported by `@4is-cronicle/plugin-tools`.
+- Interfaces
+  - [IJobInput][20]
+  - [IJobOutput][21]
+- Top-Level Functions
+  - `initJob`
+    - Initialize a Cronicle job. Returns the job input object read from STDIN.
+    - Returns an object of type [IJobInput][20].
+  - `endJob`
+    - Ends the execution of the job by writing the output to STDOUT using `JSON.stringify()` and then exiting the process using the code provided in `output.code`. The exit code defaults to **0** unless otherwise specified.
+    - Requires a parameter object of type [IJobOutput][21].
+
+[0]: https://img.shields.io/drone/build/4IS-Cronicle/Plugin-Tools/main?server=https%3A%2F%2Fdrone.4lch4.io&style=flat-square
+[1]: https://drone.4lch4.io/4IS-Cronicle/Plugin-Tools
+[2]: https://flat.badgen.net/npm/license/@4is-cronicle/plugin-tools
+[3]: https://npmjs.com/package/@4is-cronicle/plugin-tools
+[4]: https://flat.badgen.net/npm/v/@4is-cronicle/plugin-tools
+[5]: https://npmjs.com/package/@4is-cronicle/plugin-tools
+[6]: https://flat.badgen.net/npm/@4is-cronicle/plugin-tools
+[7]: https://npmjs.com/package/@4is-cronicle/plugin-tools
+[8]: https://img.shields.io/snyk/vulnerabilities/npm/@4is-cronicle/plugin-tools?style=flat-square
+[9]: https://app.snyk.io/org/alcha/project/b6b04336-9e6f-4207-bbd1-7b95e11232ff
+[10]: https://flat.badgen.net/badge/code%20style/prettier/ff69b4
+[11]: https://github.com/prettier/prettier
+[12]: https://flat.badgen.net/discord/online-members/W72x4Ks
+[13]: https://discord.gg/W72x4Ks
+[14]: https://flat.badgen.net/twitter/follow/4lch4
+[15]: https://twitter.com/4lch4
+[16]: https://github.com/jhuckaby/Cronicle#plugins
+[17]: https://npmjs.com/package/@4is-cronicle/plugin-tools
+[18]: https://npmjs.com/package/@4lch4/logger
+
+[19]:
+
+<!-- [0]: https://github.com/jhuckaby/Cronicle#plugins
+[1]: https://npmjs.com/package/@4is-cronicle/plugin-tools
+[2]: https://npmjs.com/package/@4lch4/logger -->
+
+[20]: ./src/interfaces/IJobInput.ts
+[21]: ./src/interfaces/IJobOutput.ts

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

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

27690

increased by99.22%

Number of package files

27

increased by12.5%

Lines of code

199

increased by8.74%

Number of low quality alerts

2

decreased by-33.33%

Number of lines in readme file

54

increased by575%

Worsened metrics

Dependency count

2

increased by100%

Dev dependency count

5

increased by25%

Dependency changes

• + Added@4lch4/logger@^1.9.2

• + Added@4lch4/logger@1.11.0(transitive)

• + Addedansi-colors@4.1.3(transitive)

• + Addedansi-styles@4.3.0(transitive)

• + Addedchalk@4.1.2(transitive)

• + Addedcolor-convert@2.0.1(transitive)

• + Addedcolor-name@1.1.4(transitive)

• + Addeddayjs@1.11.13(transitive)

• + Addedfs-extra@10.1.0(transitive)

• + Addedgraceful-fs@4.2.11(transitive)

• + Addedhas-flag@4.0.0(transitive)

• + Addedjsonfile@6.1.0(transitive)

• + Addedsupports-color@7.2.0(transitive)

• + Addeduniversalify@2.0.1(transitive)