fix: docs runner readme gen tweaks

tunnckoCore · tunnckoCore · commit 87e32b9ac920 · 2019-10-03T10:08:28.000+03:00
Signed-off-by: Charlike Mike Reagent &lt;opensource@tunnckocore.com&gt;
diff --git a/@tunnckocore/babel-preset/.verb.md b/@tunnckocore/babel-preset/.verb.md
@@ -1,5 +1,7 @@
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 <!-- docks-end -->
diff --git a/@tunnckocore/babel-preset/README.md b/@tunnckocore/babel-preset/README.md
@@ -76,11 +76,11 @@ _We highly recommend to use Yarn when you think to contribute to this project._
 $ yarn add @tunnckocore/babel-preset
 ```
 
-## API
-
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 <!-- docks-end -->
 
diff --git a/@tunnckocore/create-jest-runner/.verb.md b/@tunnckocore/create-jest-runner/.verb.md
@@ -1,5 +1,7 @@
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 <!-- docks-end -->
diff --git a/@tunnckocore/create-jest-runner/README.md b/@tunnckocore/create-jest-runner/README.md
@@ -76,11 +76,11 @@ _We highly recommend to use Yarn when you think to contribute to this project._
 $ yarn add @tunnckocore/create-jest-runner
 ```
 
-## API
-
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 <!-- docks-end -->
 
diff --git a/@tunnckocore/execa/.verb.md b/@tunnckocore/execa/.verb.md
@@ -1,6 +1,8 @@
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 ### [.exec](./src/index.js#L39)
 
diff --git a/@tunnckocore/execa/README.md b/@tunnckocore/execa/README.md
@@ -79,11 +79,11 @@ _We highly recommend to use Yarn when you think to contribute to this project._
 $ yarn add @tunnckocore/execa
 ```
 
-## API
-
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 ### [.exec](./src/index.js#L39)
 
diff --git a/@tunnckocore/jest-runner-babel/.verb.md b/@tunnckocore/jest-runner-babel/.verb.md
@@ -1,5 +1,7 @@
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 <!-- docks-end -->
diff --git a/@tunnckocore/jest-runner-babel/README.md b/@tunnckocore/jest-runner-babel/README.md
@@ -76,11 +76,11 @@ _We highly recommend to use Yarn when you think to contribute to this project._
 $ yarn add @tunnckocore/jest-runner-babel
 ```
 
-## API
-
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 <!-- docks-end -->
 
diff --git a/@tunnckocore/jest-runner-eslint/.verb.md b/@tunnckocore/jest-runner-eslint/.verb.md
@@ -1,5 +1,7 @@
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 <!-- docks-end -->
diff --git a/@tunnckocore/jest-runner-eslint/README.md b/@tunnckocore/jest-runner-eslint/README.md
@@ -76,11 +76,11 @@ _We highly recommend to use Yarn when you think to contribute to this project._
 $ yarn add @tunnckocore/jest-runner-eslint
 ```
 
-## API
-
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 <!-- docks-end -->
 
diff --git a/@tunnckocore/prettier-config/.verb.md b/@tunnckocore/prettier-config/.verb.md
@@ -1,5 +1,7 @@
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 <!-- docks-end -->
diff --git a/@tunnckocore/prettier-config/README.md b/@tunnckocore/prettier-config/README.md
@@ -76,11 +76,11 @@ _We highly recommend to use Yarn when you think to contribute to this project._
 $ yarn add @tunnckocore/prettier-config
 ```
 
-## API
-
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 <!-- docks-end -->
 
diff --git a/@tunnckocore/utils/.verb.md b/@tunnckocore/utils/.verb.md
@@ -1,5 +1,7 @@
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 <!-- docks-end -->
diff --git a/@tunnckocore/utils/README.md b/@tunnckocore/utils/README.md
@@ -76,11 +76,11 @@ _We highly recommend to use Yarn when you think to contribute to this project._
 $ yarn add @tunnckocore/utils
 ```
 
-## API
-
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 <!-- docks-end -->
 
diff --git a/packages/jest-runner-docs/.verb.md b/packages/jest-runner-docs/.verb.md
@@ -1,5 +1,7 @@
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 <!-- docks-end -->
diff --git a/packages/jest-runner-docs/README.md b/packages/jest-runner-docs/README.md
@@ -76,11 +76,11 @@ _We highly recommend to use Yarn when you think to contribute to this project._
 $ yarn add jest-runner-docs
 ```
 
-## API
-
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 <!-- docks-end -->
 
diff --git a/packages/jest-runner-docs/src/runner.js b/packages/jest-runner-docs/src/runner.js
@@ -20,6 +20,7 @@ module.exports = async function jetRunnerDocs({ testPath, config }) {
   const docksConfig = {
     promo: true,
     force: true,
+    includeHeader: true,
     outfile: 'docs/README.md',
     ...conf,
   };
@@ -54,9 +55,10 @@ module.exports = async function jetRunnerDocs({ testPath, config }) {
       ? `_Generated using [${pkgJson.name}@v${pkgJson.version}](${pkgJson.repository})._`
       : '';
 
+    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}`;
 
     if (fs.existsSync(outputFile)) {
       const fileContent = fs.readFileSync(outputFile, 'utf8');
diff --git a/packages/jest-runner-rollup/.verb.md b/packages/jest-runner-rollup/.verb.md
@@ -1,5 +1,48 @@
+## Usage
+
+First, put it in your Jest config
+
+```js
+module.exports = {
+  rootDir: __dirname,
+  displayName: 'bundle',
+  testMatch: [
+    // if there is no extension, it try to autodetect it.
+    '<rootDir>/packages/*/src/index',
+  ],
+  moduleFileExtensions: ['js', 'jsx', 'ts', 'tsx', 'mjs'],
+  runner: 'jest-runner-rollup',
+};
+```
+
+Then, write Rollup config file. It automatically detects your `rollup.config.js`.
+If you want you also can name it `.rolluprc.js`, `jest-runner-rollup.config.js`, or
+put your config in `jest-runner.config.js` (this config file can be used for other jest runners too), like so
+
+```js
+module.exports = {
+  rollup: {
+    plugins: [
+      /*
+      commonjs(),
+      nodeResolve()
+      */
+    ],
+    output: [
+      { preferConst: true, format: 'cjs', exports: 'named' },
+      { preferConst: true, format: 'esm' },
+    ],
+  },
+};
+```
+
+By default, the bundle file will be `dist/<format>/index.js`, even if only one output format is given.
+If you want to change that behavior, you can pass `output.file`.
+
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 <!-- docks-end -->
diff --git a/packages/jest-runner-rollup/README.md b/packages/jest-runner-rollup/README.md
@@ -56,6 +56,7 @@ Project is [semantically](https://semver.org) versioned & automatically released
 ## Table of Contents
 
 - [Install](#install)
+- [Usage](#usage)
 - [API](#api)
 - [Contributing](#contributing)
   - [Guides and Community](#guides-and-community)
@@ -76,11 +77,52 @@ _We highly recommend to use Yarn when you think to contribute to this project._
 $ yarn add jest-runner-rollup
 ```
 
-## API
+## Usage
+
+First, put it in your Jest config
+
+```js
+module.exports = {
+  rootDir: __dirname,
+  displayName: 'bundle',
+  testMatch: [
+    // if there is no extension, it try to autodetect it.
+    '<rootDir>/packages/*/src/index',
+  ],
+  moduleFileExtensions: ['js', 'jsx', 'ts', 'tsx', 'mjs'],
+  runner: 'jest-runner-rollup',
+};
+```
+
+Then, write Rollup config file. It automatically detects your `rollup.config.js`.
+If you want you also can name it `.rolluprc.js`, `jest-runner-rollup.config.js`, or
+put your config in `jest-runner.config.js` (this config file can be used for other jest runners too), like so
+
+```js
+module.exports = {
+  rollup: {
+    plugins: [
+      /*
+      commonjs(),
+      nodeResolve()
+      */
+    ],
+    output: [
+      { preferConst: true, format: 'cjs', exports: 'named' },
+      { preferConst: true, format: 'esm' },
+    ],
+  },
+};
+```
+
+By default, the bundle file will be `dist/<format>/index.js`, even if only one output format is given.
+If you want to change that behavior, you can pass `output.file`.
 
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 <!-- docks-end -->
 
diff --git a/packages/koa-better-body/.verb.md b/packages/koa-better-body/.verb.md
@@ -92,7 +92,9 @@ $ yarn add {%= name %}
 
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 ### [koaBetterBody](./src/index.js#L36)
 
diff --git a/packages/koa-better-body/README.md b/packages/koa-better-body/README.md
@@ -58,6 +58,7 @@ Project is [semantically](https://semver.org) versioned & automatically released
 - [Install](#install)
 - [Features](#features)
 - [API](#api)
+- [API](#api-1)
   - [koaBetterBody](#koabetterbody)
 - [Working with [koa-router][]](#working-with-koa-router)
 - [Options](#options)
@@ -108,7 +109,9 @@ $ yarn add koa-better-body
 
 <!-- docks-start -->
 
-_Generated using [jest-runner-docs@v0.1.1](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
+## API
+
+_Generated using [jest-runner-docs@v0.1.2](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
 
 ### [koaBetterBody](./src/index.js#L36)
 
diff --git a/readme-template.md b/readme-template.md
@@ -67,8 +67,6 @@ _We highly recommend to use Yarn when you think to contribute to this project._
 $ yarn add {%= name %}
 ```
 
-## API
-
 {%= ifExists([process.cwd() + '/.verb.md'], include(process.cwd() + '/.verb.md')) %}
 
 **[back to top](#thetop)**
