conventional-changelog-atom - npm Package Compare versions

Comparing version 3.0.0 to 4.0.0

index.js

 'use strict'
-const conventionalChangelog = require('./conventional-changelog')
-const parserOpts = require('./parser-opts')
-const recommendedBumpOpts = require('./conventional-recommended-bump')
-const writerOpts = require('./writer-opts')
 
-module.exports = presetOpts
+const { createParserOpts } = require('./parserOpts')
+const { createWriterOpts } = require('./writerOpts')
+const { createConventionalChangelogOpts } = require('./conventionalChangelog')
+const { createConventionalRecommendedBumpOpts } = require('./conventionalRecommendedBump')
 
-function presetOpts (cb) {
-  Promise.all([conventionalChangelog, parserOpts, recommendedBumpOpts, writerOpts])
-    .then(([conventionalChangelog, parserOpts, recommendedBumpOpts, writerOpts]) => {
-      cb(null, {
-        conventionalChangelog,
-        parserOpts,
-        recommendedBumpOpts,
-        writerOpts
-      })
-    })
+async function createPreset () {
+  const parserOpts = createParserOpts()
+  const writerOpts = await createWriterOpts()
+  const recommendedBumpOpts = createConventionalRecommendedBumpOpts(parserOpts)
+  const conventionalChangelog = createConventionalChangelogOpts(parserOpts, writerOpts)
+
+  return {
+    parserOpts,
+    writerOpts,
+    recommendedBumpOpts,
+    conventionalChangelog
+  }
 }
+
+module.exports = createPreset

package.json

 {
   "name": "conventional-changelog-atom",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "conventional-changelog atom preset",
@@ -17,11 +17,11 @@ "main": "index.js",
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "license": "ISC",
   "files": [
-    "conventional-changelog.js",
-    "conventional-recommended-bump.js",
+    "conventionalChangelog.js",
+    "conventionalRecommendedBump.js",
     "index.js",
-    "parser-opts.js",
-    "writer-opts.js",
+    "parserOpts.js",
+    "writerOpts.js",
     "templates"
@@ -32,6 +32,3 @@ ],
   },
-  "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-atom#readme",
-  "scripts": {
-    "test-windows": "echo 'make work on windows'"
-  }
+  "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-atom#readme"
 }

README.md

@@ -1,7 +0,39 @@
-#  [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage Status][coverage-image]][coverage-url]
+# conventional-changelog-atom
 
-> [conventional-changelog](https://github.com/ajoslin/conventional-changelog) [atom](https://github.com/atom/atom) preset
+[![NPM version][npm]][npm-url]
+[![Node version][node]][node-url]
+[![Dependencies status][deps]][deps-url]
+[![Build status][build]][build-url]
+[![Coverage status][coverage]][coverage-url]
 
+[npm]: https://img.shields.io/npm/v/conventional-changelog-atom.svg
+[npm-url]: https://npmjs.com/package/conventional-changelog-atom
+
+[node]: https://img.shields.io/node/v/conventional-changelog-atom.svg
+[node-url]: https://nodejs.org
+
+[deps]: https://img.shields.io/librariesio/release/npm/conventional-changelog-atom
+[deps-url]: https://libraries.io/npm/conventional-changelog-atom/tree
+
+[build]: https://img.shields.io/github/actions/workflow/status/conventional-changelog/conventional-changelog/ci.yaml?branch=master
+[build-url]: https://github.com/conventional-changelog/conventional-changelog/actions
+
+[coverage]: https://coveralls.io/repos/github/conventional-changelog/conventional-changelog/badge.svg?branch=master
+[coverage-url]: https://coveralls.io/github/conventional-changelog/conventional-changelog?branch=master
+
+[conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) [atom](https://github.com/atom/atom) preset.
+
 **Issues with the convention itself should be reported on the Atom issue tracker.**
 
+## Install
+
+```bash
+# yarn
+yarn add -D conventional-changelog-atom
+# pnpm
+pnpm add -D conventional-changelog-atom
+# npm
+npm i -D conventional-changelog-atom
+```
+
 ## Atom Convention
@@ -33,10 +65,1 @@
 Based on https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages
-
-[npm-image]: https://badge.fury.io/js/conventional-changelog-atom.svg
-[npm-url]: https://npmjs.org/package/conventional-changelog-atom
-[travis-image]: https://travis-ci.org/stevemao/conventional-changelog-atom.svg?branch=master
-[travis-url]: https://travis-ci.org/stevemao/conventional-changelog-atom
-[daviddm-image]: https://david-dm.org/stevemao/conventional-changelog-atom.svg?theme=shields.io
-[daviddm-url]: https://david-dm.org/stevemao/conventional-changelog-atom
-[coverage-image]: https://coveralls.io/repos/github/conventional-changelog/conventional-changelog/badge.svg?branch=master
-[coverage-url]: https://coveralls.io/github/conventional-changelog/conventional-changelog?branch=master

New alerts

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

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

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8685

increased by8.05%

Lines of code

101

increased by7.45%

Number of lines in readme file

65

increased by54.76%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

No dependency changes