feat: add badges for gh-actions

README.md

@@ -1,6 +1,7 @@
 # thought 
 
 [![NPM version](https://img.shields.io/npm/v/thought.svg)](https://npmjs.com/package/thought)
+[![Github Actions Status](https://github.com/nknapp/thought/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/nknapp/thought/actions/workflow/ci.yml)
 [![Greenkeeper badge](https://badges.greenkeeper.io/nknapp/thought.svg)](https://greenkeeper.io/)
 
 > A customizable documentation generator for github projects

docs/example-project-3-templates-partials-helpers-preprocessor.md

@@ -14,6 +14,7 @@ The following **partials** exist by default:
 │ ├── <a href="../handlebars/partials/badge/appveyor.md.hbs">appveyor.md.hbs</a>
 │ ├── <a href="../handlebars/partials/badge/codecov.md.hbs">codecov.md.hbs</a>
 │ ├── <a href="../handlebars/partials/badge/coveralls.md.hbs">coveralls.md.hbs</a>
+│ ├── <a href="../handlebars/partials/badge/gh-workflows.md.hbs">gh-workflows.md.hbs</a>
 │ ├── <a href="../handlebars/partials/badge/greenkeeper.md.hbs">greenkeeper.md.hbs</a>
 │ ├── <a href="../handlebars/partials/badge/npm.md.hbs">npm.md.hbs</a>
 │ └── <a href="../handlebars/partials/badge/travis.md.hbs">travis.md.hbs</a>

docs/helpers.md

@@ -2,6 +2,22 @@
 
 The following helpers are built-in for use in templates and partials
 
+## Members
+
+<dl>
+<dt><a href="#helpers">helpers</a></dt>
+<dd><p>Default Handlebars-helpers for Thought</p>
+</dd>
+</dl>
+
+## Functions
+
+<dl>
+<dt><a href="#glob">glob(pattern, options)</a> ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code></dt>
+<dd><p>Resolves files via glob pattern</p>
+</dd>
+</dl>
+
 <a name="helpers"></a>
 
 ## helpers
@@ -337,5 +353,20 @@ to provide array-arguments to other helpers.
 | --- | --- | --- |
 | ...args | <code>\*</code> | a list of arguments |
 
+<a name="glob"></a>
+
+## glob(pattern, options) ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code>
+Resolves files via glob pattern
+
+**Kind**: global function  
+**Returns**: <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> - a list of files  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| pattern | <code>string</code> | the glob |
+| options | <code>object</code> |  |
+| options.hash | <code>object</code> |  |
+| options.hash.root | <code>string</code> | the path to the directory that acts are root dir for this glob-query |
+
 
  

examples/example-project-3-templates-partials-helpers-preprocessor/README.md

@@ -14,6 +14,7 @@ The following partials can be overwritten in `.thought/partials`:
 │ ├── appveyor.md.hbs
 │ ├── codecov.md.hbs
 │ ├── coveralls.md.hbs
+│ ├── gh-workflows.md.hbs
 │ ├── greenkeeper.md.hbs
 │ ├── npm.md.hbs
 │ └── travis.md.hbs

handlebars/helpers/index.js

@@ -8,6 +8,8 @@ const { resolvePackageRoot } = require('../../lib/utils/resolve-package-root')
 const Handlebars = require('handlebars')
 const fs = require('fs-extra')
 const util = require('util')
+const pify = require('pify')
+const _glob = pify(require('glob'))
 
 /**
  * Default Handlebars-helpers for Thought
@@ -31,7 +33,8 @@ module.exports = {
   hasCoveralls,
   hasCodecov,
   hasGreenkeeper,
-  arr
+  arr,
+  glob
 }
 
 /**
@@ -547,3 +550,20 @@ function _relativePathWithinRepository(packageJson, fileRelativeToPackageJson) {
   }
   return fileRelativeToPackageJson
 }
+
+/**
+ * Resolves files via glob pattern
+ *
+ * @param {string} pattern the glob
+ * @param {object} options
+ * @param {object} options.hash
+ * @param {string} options.hash.root the path to the directory that acts are root dir for this glob-query
+ * @returns {Promise<string[]>} a list of files
+ */
+async function glob(pattern, options) {
+  if (options && options.hash && options.hash.root) {
+    return _glob(pattern, { ignore: 'node_modules/', cwd: options.hash.root })
+  } else {
+    return _glob(pattern, { ignore: 'node_modules/' })
+  }
+}

handlebars/partials/badge/gh-workflows.md.hbs

@@ -0,0 +1,3 @@
+{{~#each ( glob '*.yml' root='.github/workflows' ) as |workflowFile| ~}}
+    [![Github Actions Status](https://github.com/{{githubRepo}}/actions/workflows/{{workflowFile}}/badge.svg?branch=master)](https://github.com/{{githubRepo}}/actions/workflows/{{workflowFile}})
+{{/each~}}

handlebars/partials/badges.md.hbs

@@ -1,5 +1,6 @@
 {{>badge/npm.md}}
 {{>badge/travis.md}}
+{{>badge/gh-workflows.md}}
 {{>badge/appveyor.md}}
 {{>badge/coveralls.md}}
 {{>badge/codecov.md}}

test/fixtures/scenarios/with-all-badges/expected/README.md

@@ -2,6 +2,8 @@
 
 [![NPM version](https://img.shields.io/npm/v/simple-project.svg)](https://npmjs.com/package/simple-project)
 [![Travis Build Status](https://travis-ci.org/bootprint/bootprint.svg?branch=master)](https://travis-ci.org/bootprint/bootprint)
+[![Github Actions Status](https://github.com/bootprint/bootprint/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/bootprint/bootprint/actions/workflows/ci.yml)
+[![Github Actions Status](https://github.com/bootprint/bootprint/actions/workflows/deploy.yml/badge.svg?branch=master)](https://github.com/bootprint/bootprint/actions/workflows/deploy.yml)
 [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/bootprint/bootprint?svg=true&branch=master)](https://ci.appveyor.com/project/bootprint/bootprint)
 [![Coverage Status](https://img.shields.io/coveralls/bootprint/bootprint.svg)](https://coveralls.io/r/bootprint/bootprint)
 [![Coverage Status](https://img.shields.io/codecov/bootprint/bootprint.svg)](https://codecov.io/github/bootprint/bootprint)

test/helper-spec.js

@@ -572,4 +572,20 @@ describe('thought-helpers:', function () {
       return expect(helpers.repoWebUrl('git+ssh://git@example.com/nknapp/thought-plugin-jsdoc.git')).to.equal(null)
     })
   })
+
+  describe("The 'glob' helper", function () {
+    it('returns a list of files matching the glob', async function () {
+      expect(await helpers.glob('test/fixtures/dir-tree/**/bFile.txt')).to.deep.equal([
+        'test/fixtures/dir-tree/subdirA/bDir/bFile.txt',
+        'test/fixtures/dir-tree/subdirB/subdirC/bFile.txt'
+      ])
+    })
+
+    it('returns paths starting with root dir', async function () {
+      expect(await helpers.glob('dir-tree/**/bFile.txt', { hash: { root: 'test/fixtures' } })).to.deep.equal([
+        'dir-tree/subdirA/bDir/bFile.txt',
+        'dir-tree/subdirB/subdirC/bFile.txt'
+      ])
+    })
+  })
 })