@userfrosting/ts-log-adapter-gulplog - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

CHANGELOG.md

@@ -10,2 +10,8 @@ # Changelog
 
+## [0.3.0] - 2021-04-03
+
+### Changed
+- Removed `esm` loader in favour of native ESM support.
+- Raised minimum NodeJS version from 10 to 12.17.0.
+
 ## [0.2.0] - 2020-04-23
@@ -12,0 +18,0 @@

cspell.json

@@ -8,3 +8,5 @@ {
         "userfrosting",
-        "gulplog"
+        "gulplog",
+        "Lando",
+        "PNPM"
     ],
@@ -15,3 +17,5 @@ "ignoreWords": [
         "codecov",
-        "gulpfile"
+        "gulpfile",
+        "automerged",
+        "lcovonly"
     ],
@@ -21,2 +25,3 @@ "ignorePaths": [
         "package-lock.json",
+        "pnpm-lock.yaml",
         "api-extractor.json",
@@ -23,0 +28,0 @@ "docs/api/",

dist/main.d.ts

@@ -0,0 +0,0 @@ /**

dist/main.js

@@ -5,3 +5,3 @@ /**
  */
-import * as GulpLog from "gulplog";
+import GulpLog from "gulplog";
 function log(prefix, logFn, message, args) {
@@ -8,0 +8,0 @@ // Handle args

docs/api/ts-log-adapter-gulplog.gulploglogger._constructor_.md

@@ -19,3 +19,3 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 |  --- | --- | --- |
-|  prefix | <code>string</code> | Optionally annotate logs with a prefix such as the package name to identify log source. |
+|  prefix | string | Optionally annotate logs with a prefix such as the package name to identify log source. |
 

docs/api/ts-log-adapter-gulplog.gulploglogger.md

@@ -14,2 +14,3 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 ```
+<b>Implements:</b> Logger
 
@@ -26,7 +27,7 @@ ## Constructors
 |  --- | --- | --- | --- |
-|  [debug](./ts-log-adapter-gulplog.gulploglogger.debug.md) |  | <code>(message?: any, ...optionalParams: any[]) =&gt; void</code> |  |
-|  [error](./ts-log-adapter-gulplog.gulploglogger.error.md) |  | <code>(message?: any, ...optionalParams: any[]) =&gt; void</code> |  |
-|  [info](./ts-log-adapter-gulplog.gulploglogger.info.md) |  | <code>(message?: any, ...optionalParams: any[]) =&gt; void</code> |  |
-|  [trace](./ts-log-adapter-gulplog.gulploglogger.trace.md) |  | <code>(message?: any, ...optionalParams: any[]) =&gt; void</code> |  |
-|  [warn](./ts-log-adapter-gulplog.gulploglogger.warn.md) |  | <code>(message?: any, ...optionalParams: any[]) =&gt; void</code> |  |
+|  [debug](./ts-log-adapter-gulplog.gulploglogger.debug.md) |  | (message?: any, ...optionalParams: any\[\]) =&gt; void |  |
+|  [error](./ts-log-adapter-gulplog.gulploglogger.error.md) |  | (message?: any, ...optionalParams: any\[\]) =&gt; void |  |
+|  [info](./ts-log-adapter-gulplog.gulploglogger.info.md) |  | (message?: any, ...optionalParams: any\[\]) =&gt; void |  |
+|  [trace](./ts-log-adapter-gulplog.gulploglogger.trace.md) |  | (message?: any, ...optionalParams: any\[\]) =&gt; void |  |
+|  [warn](./ts-log-adapter-gulplog.gulploglogger.warn.md) |  | (message?: any, ...optionalParams: any\[\]) =&gt; void |  |
 

package.json

 {
     "name": "@userfrosting/ts-log-adapter-gulplog",
-    "version": "0.2.0",
+    "version": "0.3.0",
     "description": "An adapter for the ts-log interface that pushes logging to gulplog with optional arguments JSON encoded.",
     "funding": "https://opencollective.com/userfrosting",
-    "type": "commonjs",
-    "main": "./dist/index.js",
-    "exports": {
-        "require": "./dist/index.js",
-        "import": "./dist/main.js"
-    },
+    "type": "module",
+    "exports": "./dist/main.js",
     "types": "./dist/main.d.ts",
     "scripts": {
-        "aeCheck": "api-extractor run",
-        "aeUpdate": "api-extractor run --local",
-        "purgeDocs": "del-cli ./docs/api/",
-        "adUpdate": "npm run purgeDocs && api-documenter markdown -i ./temp -o ./docs/api",
-        "build": "is-ci && npm run build:release || npm run build:dev",
-        "build:dev": "tsc && npm run aeUpdate && npm run adUpdate",
-        "build:release": "tsc && npm run aeCheck",
-        "pretest": "npm run build",
-        "test": "is-ci && ava || nyc --reporter=text ava",
-        "prepublishOnly": "npm run build:release && npm run test",
-        "version": "changelog-updater && git add CHANGELOG.md",
-        "postversion": "git push && git push --tags"
+        "compile": "rm -rf ./dist && tsc",
+        "pretest": "npm run compile && api-extractor run --local",
+        "test": "c8 --all --reporter=text --reporter=lcovonly ava",
+        "prepublishOnly": "npm run compile",
+        "preversion": "npm test",
+        "version": "npm run version:apiDocRefresh && npm run version:changelogBump",
+        "postversion": "git push && git push --tags",
+        "version:changelogBump": "changelog-updater && git add CHANGELOG.md",
+        "version:apiDocRefresh": "api-extractor run && api-documenter markdown -i ./temp -o ./docs/api && git add ./docs/api/*",
+        "prepare": "is-npm || npm i --package-lock-only",
+        "release-readiness": "npm run release-readiness:cspell && npm run release-readiness:api-changes",
+        "release-readiness:cspell": "cspell 'src/**' 'dist/**' 'docs/**' '*'",
+        "release-readiness:api-changes": "npm run compile && api-extractor run"
     },
@@ -42,20 +39,19 @@ "author": "Jordan Mele <[e-mail]> (https://djmm.me/)",
     "dependencies": {
-        "esm": "^3.2.25",
         "gulplog": "1.0.0",
-        "ts-log": "^2.1.4"
+        "ts-log": "^2.2.3"
     },
     "devDependencies": {
-        "@microsoft/api-documenter": "^7.7.18",
-        "@microsoft/api-extractor": "^7.7.13",
-        "@types/node": "^13.13.1",
-        "ava": "^3.7.1",
-        "changelog-updater": "^1.1.0",
-        "del-cli": "^3.0.0",
+        "@microsoft/api-documenter": "^7.12.16",
+        "@microsoft/api-extractor": "^7.13.2",
+        "@types/node": "^14.14.37",
+        "ava": "^3.15.0",
+        "c8": "^7.7.0",
+        "changelog-updater": "^2.0.2",
+        "cspell": "^5.3.10",
         "glogg": "^1.0.2",
-        "is-ci": "^2.0.0",
-        "nyc": "^15.0.1",
-        "typescript": "^3.8.3"
+        "is-npm-cli": "^1.0.0",
+        "typescript": "^4.2.3"
     },
     "engines": {
-        "node": ">=10.0.0"
+        "node": ">=12.17.0"
     },
@@ -65,7 +61,4 @@ "ava": {
             "dist/**/*.test.js"
-        ],
-        "require": [
-            "esm"
         ]
     }
 }

README.md

@@ -6,3 +6,2 @@ # ts-log-adapter-gulplog
 | master | [![Continuous Integration](https://github.com/userfrosting/ts-log-adapter-gulplog/workflows/Continuous%20Integration/badge.svg?branch=master)](https://github.com/userfrosting/ts-log-adapter-gulplog/actions?query=branch:master+workflow:"Continuous+Integration") [![codecov](https://codecov.io/gh/userfrosting/ts-log-adapter-gulplog/branch/master/graph/badge.svg)](https://codecov.io/gh/userfrosting/ts-log-adapter-gulplog/branch/master) |
-| develop | [![Continuous Integration](https://github.com/userfrosting/ts-log-adapter-gulplog/workflows/Continuous%20Integration/badge.svg?branch=develop)](https://github.com/userfrosting/ts-log-adapter-gulplog/actions?query=branch:develop+workflow:"Continuous+Integration") [![codecov](https://codecov.io/gh/userfrosting/ts-log-adapter-gulplog/branch/develop/graph/badge.svg)](https://codecov.io/gh/userfrosting/ts-log-adapter-gulplog/branch/develop) |
 
@@ -22,3 +21,3 @@ An adapter for the ts-log interface that pushes logging to gulplog.
 ```js
-// gulpfile.esm.js
+// gulpfile.mjs
 import { GulpLogLogger } from "@userfrosting/ts-log-adapter-gulplog";
@@ -73,20 +72,10 @@ import { src, dest } from "gulp";
 
-API documentation is regenerated for every release using [API Extractor](https://www.npmjs.com/package/@microsoft/api-extractor) and [API Documenter](https://www.npmjs.com/package/@microsoft/api-documenter).
-The results reside in [docs/api](./docs/api/index.md).
+See [docs/api](./docs/api/index.md).
 
-## History
+## License
 
-The bulk of this adapter's logic came from build scripts in UserFrosting 4.2.
+[MIT](LICENSE)
 
-## Release process
+## Contributing
 
-Generally speaking, all releases should first traverse through `alpha`, `beta`, and `rc` (release candidate) to catch missed bugs and gather feedback as appropriate. Aside from this however, there are a few steps that **MUST** always be done.
-
-1. Make sure [`CHANGELOG.md`](./CHANGELOG.md) is up to date.
-2. Update version via `npm` like `npm version 3.0.0` or `npm version patch`.
-3. `npm publish`.
-4. Create release on GitHub from tag made by `npm version`.
-
-## License
-
-[MIT](LICENSE)
+See [CONTRIBUTING.md](./CONTRIBUTING.md).

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

115129

increased by454.2%

Dependency count

2

decreased by-33.33%

Is type module

Yes

Worsened metrics

Number of package files

20

decreased by-13.04%

Lines of code

129

decreased by-22.75%

Number of lines in readme file

79

decreased by-12.22%

Dependency changes

• - Removedesm@^3.2.25

• - Removedesm@3.2.25(transitive)

• Updatedts-log@^2.2.3