jest-runner-docs - npm Package Compare versions

Comparing version 0.1.2 to 0.1.3

CHANGELOG.md

@@ -6,2 +6,15 @@ # Change Log
 
+## [0.1.3](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs/compare/jest-runner-docs@0.1.2...jest-runner-docs@0.1.3) (2019-10-13)
+
+
+### Bug Fixes
+
+* docs runner readme gen tweaks ([87e32b9](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs/commit/87e32b9))
+* remove version from the "promo" part, regen docs ([f0dd7ef](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs/commit/f0dd7ef))
+* update readmes, build koa-better-body ([698c8d8](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs/commit/698c8d8))
+
+
+
+
+
 ## [0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs/compare/jest-runner-docs@0.1.1...jest-runner-docs@0.1.2) (2019-10-03)
@@ -8,0 +21,0 @@

package.json

 {
   "name": "jest-runner-docs",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "WIP",
@@ -36,4 +36,4 @@ "repository": "https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs",
   "dependencies": {
-    "@tunnckocore/create-jest-runner": "^0.7.1",
-    "@tunnckocore/utils": "^0.9.1",
+    "@tunnckocore/create-jest-runner": "^0.7.2",
+    "@tunnckocore/utils": "^0.9.2",
     "cosmiconfig": "^5.2.1",
@@ -64,3 +64,3 @@ "parse-comments": "^1.0.0"
   },
-  "gitHead": "fb81e73cd49bd6d50bb4484ae0d3b9d2fa3b28e7"
+  "gitHead": "d5087dfe0008b37985ae1c395c4cc2bdf2879807"
 }

README.md

@@ -44,3 +44,2 @@ # jest-runner-docs [![npm version][npmv-img]][npmv-url] [![License][license-img]][license-url]
 | For any questions about Open Source, partnerships and sponsoring | ![tunnckocore_opensource][tunnckocore_opensource] |
-| Curited interesting news, announcements, articles, and thoughts  | ![tunnckocore_newsletter][tunnckocore_newsletter] |
 
@@ -62,6 +61,6 @@ <!-- Logo when needed:
 - [Contributing](#contributing)
-  - [Guides and Community](#guides-and-community)
-  - [Support the project](#support-the-project)
-  - [OPEN Open Source](#open-open-source)
-  - [Wonderful Contributors](#wonderful-contributors)
+  * [Guides and Community](#guides-and-community)
+  * [Support the project](#support-the-project)
+  * [OPEN Open Source](#open-open-source)
+  * [Wonderful Contributors](#wonderful-contributors)
 - [License](#license)
@@ -81,8 +80,7 @@
 
+<!-- docks-start -->
 ## API
 
-<!-- docks-start -->
+_Generated using [jest-runner-docs](https://npmjs.com/package/jest-runner-docs)._
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
-
 <!-- docks-end -->
@@ -151,2 +149,3 @@
 [npmv-img]: https://badgen.net/npm/v/jest-runner-docs?icon=npm
+
 [nodejs-img]: https://badgen.net/npm/node/jest-runner-docs
@@ -180,5 +179,7 @@
 [last-commit-url]: https://github.com/tunnckoCore/opensource/commits/master
+
 [downloads-weekly-img]: https://badgen.net/npm/dw/jest-runner-docs?icon=npm
 [downloads-monthly-img]: https://badgen.net/npm/dm/jest-runner-docs?icon=npm
 [downloads-total-img]: https://badgen.net/npm/dt/jest-runner-docs?icon=npm
+
 [renovateapp-url]: https://renovatebot.com
@@ -221,1 +222,2 @@ [renovateapp-img]: https://badgen.net/badge/renovate/enabled/green
 [tunnckocore_newsletter]: https://badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/newsletter/tunnckocore?label&color=5199FF&icon=https://svgshare.com/i/Dt6.svg
+

src/runner.js

@@ -23,2 +23,3 @@ /* eslint-disable max-statements */
     force: true,
+    includeHeader: true,
     outfile: 'docs/README.md',
@@ -55,8 +56,9 @@ ...conf,
     const promo = docksConfig.promo
-      ? `_Generated using [${pkgJson.name}@v${pkgJson.version}](${pkgJson.repository})._`
+      ? `_Generated using [${pkgJson.name}](https://npmjs.com/package/jest-runner-docs)._`
       : '';
 
+    const header = docksConfig.includeHeader ? '## API\n\n' : '';
     const docksStart = '<!-- docks-start -->';
     const docksEnd = '<!-- docks-end -->';
-    const contents = `${docksStart}\n${promo}${apidocsContent}\n\n${docksEnd}`;
+    const contents = `${docksStart}\n${header}${promo}${apidocsContent}\n\n${docksEnd}`;
 
@@ -63,0 +65,0 @@ if (fs.existsSync(outputFile)) {

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

21512

increased by2.72%

Lines of code

185

increased by1.09%

Number of lines in readme file

218

increased by0.93%

Dependency changes

• Updated@tunnckocore/create-jest-runner@^0.7.2

• Updated@tunnckocore/utils@^0.9.2