conventional-changelog-unconventional - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

index.js

@@ -73,6 +73,5 @@ 'use strict';
       if (!handled) {
-        debug(`merging "${key}" via deepmerge (or overwrite if not plain object)`);
-        isPlainObject(config[key]) && isPlainObject(val)
-          ? deepObjectAssign(config[key], val)
-          : (config[key] = val);
+        const useDOA = isPlainObject(config[key]) && isPlainObject(val);
+        debug(`merging "${key}" via ${useDOA ? 'deep object assignment' : 'overwrite'}`);
+        useDOA ? deepObjectAssign(config[key], val) : (config[key] = val);
       }
@@ -79,0 +78,0 @@ });

package.json

 {
   "name": "conventional-changelog-unconventional",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Custom CHANGELOG generation and semantic release settings based on conventional-changelog-conventionalcommits",
@@ -21,3 +21,3 @@ "keywords": [
     "/index.js",
-    "/default.js",
+    "/defaults.js",
     "/templates",
@@ -24,0 +24,0 @@ "/LICENSE",

README.md

@@ -24,12 +24,12 @@ <!-- prettier-ignore-start -->
 This is a fork of and drop-in replacement for
-[conventional-changelog-conventionalcommits](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits).
-Along with various bug fixes (regex string mangling, sorting problems, etc),
-what follows are the major differences:
+[conventional-changelog-conventionalcommits](https://www.npmjs.com/package/conventional-changelog-conventionalcommits).
+Along with various bug fixes (regex mangling, sorting problems, etc), what
+follows are the major differences:
 
 ### Updated to use modern JS/TypeScript
 
-This rewrite uses a modern Babel-based build chain, is written in TypeScript, is
+This fork uses a modern Babel-based build chain, is written in TypeScript, is
 fully typed, and supports modern debugging practices.
 
-> This will be true in the next version 😅
+> This will be true in the next minor version 😅
 
@@ -54,12 +54,15 @@ ### A few style tweaks
 
-Requiring and calling
-[conventional-changelog-conventionalcommits](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits)
+Calling
+[conventional-changelog-conventionalcommits](https://www.npmjs.com/package/conventional-changelog-conventionalcommits)
 emits a Promise, making the result impossible to reference in synchronized code
 (babel plugins, semantic-release config files, conventional-X-cli config). This
 fork avoids the pain, allowing one shared configuration to be consumed by
-[`conventional-changelog-core`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core),
-`conventional-changelog-cli` via command line, `semantic-release` via release
-configuration, [`projector`](https://github.com/Xunnamius/projector) and
-[`projector-pipeline`](https://github.com/Xunnamius/projector-pipeline) at
-various points in the CI/CD pipeline, and other sync and async tooling.
+[`conventional-changelog-core`](https://www.npmjs.com/package/conventional-changelog-core),
+[`conventional-changelog-cli`](https://www.npmjs.com/package/conventional-changelog-cli)
+via command line,
+[`semantic-release`](https://www.npmjs.com/package/semantic-release) via release
+configuration, [`projector`](https://www.npmjs.com/package/@xunnamius/projector)
+and
+[`projector-pipeline`](https://www.npmjs.com/package/@xunnamius/projector-pipeline)
+at various points in the CI/CD pipeline, and other sync and async tooling.
 
@@ -70,25 +73,26 @@ > This also means `configOverrides` cannot be a Promise.
 
-With
-[conventional-changelog-conventionalcommits](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits),
-drilling down into the resultant
+When configuring
+[conventional-changelog-conventionalcommits](https://www.npmjs.com/package/conventional-changelog-conventionalcommits),
+drilling down into the
 [config object](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core#config)
 and altering something like
 [`writerOpts.transform`](https://github.com/conventional-changelog-archived-repos/conventional-changelog-writer#transform)
-is difficult, especially if you only want to tweak rather than _completely
-overwrite_ it. This fork makes deep customizations, including extending rather
-than overwriting the default functionality, easier. Just pass your
+is not so easy. This fork allows you to tweak and chain invocations rather than
+_completely overwrite_ these key functions via the various
 [config](https://github.com/conventional-changelog/conventional-changelog-config-spec)
-[overrides](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core#config),
-which will be used to _tweak_ the default configuration (see
-[the exported function itself](https://github.com/Xunnamius/conventional-changelog-unconventional/blob/main/index.js#L8)
-for details).
+[keys](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core#config).
+See
+[the function docs](https://github.com/Xunnamius/conventional-changelog-unconventional/blob/main/index.js#L8)
+for more details.
 
 ### Simpler source organization
 
-Simplified the source code by concentrating default configuration to a
+"Simplified" the source code by concentrating default configuration to a
 [single file](./defaults.js) with the all the configuration knobs easily
 accessible among the topmatter.
 
+---
+
 > For usage examples and related documentation, see the original
-> [conventional-changelog-conventionalcommits](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits)
+> [conventional-changelog-conventionalcommits](https://www.npmjs.com/package/conventional-changelog-conventionalcommits)
 > package.
@@ -95,0 +99,0 @@

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

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

28100

increased by97.86%

Number of package files

9

increased by12.5%

Lines of code

411

increased by433.77%

Number of lines in readme file

142

increased by2.9%

Worsened metrics

Number of low supply chain risk alerts

4

increased by100%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes