feat: collect fiddles (#158)

* bump debug module

* feat: add collect fiddles script

* add printing

* refactor

* test find on ci

* update README

Author: bahmutov

.github/workflows/ci.yml

@@ -8,8 +8,19 @@ jobs:
       n: 3
       command: npm test
 
+  test-collect:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+      - uses: bahmutov/npm-install@v1
+      - name: Print fiddles 🖨️
+        run: node bin/collect-fiddles -p cypress/e2e/many-fiddles.md
+    env:
+      # we do not need to install Cypress to run this test
+      CYPRESS_INSTALL_BINARY: 0
+
   release:
-    needs: 'test'
+    needs: ['test', 'test-collect']
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout 🛎

.gitignore

@@ -2,3 +2,4 @@ node_modules/
 cypress/videos
 cypress/screenshots
 cypress/e2e/*.js
+out.json

README.md

@@ -215,6 +215,19 @@ npx export-fiddle <path/to/md> --before-each <url>
 npx export-fiddle <path/to/md> --before <url>
 ```
 
+## Find fiddles
+
+You can find fiddles in Markdown files using a blog pattern
+
+```
+# find fiddles in file A.md
+$ npx collect-fiddles cypress/e2e/A.md
+# print found fiddles in two files
+$ npx collect-fiddles --print cypress/e2e/A.md cypress/e2e/B.md
+# save found fiddles into a JSON file
+$ npx collect-fiddles --filename out.json 'cypress/e2e/**/*.md'
+```
+
 ## Examples
 
 See the presentation [Using End-to-end Tests as Documentation](https://slides.com/bahmutov/tests-are-docs)

bin/collect-fiddles.js

@@ -0,0 +1,54 @@
+#!/usr/bin/env node
+// @ts-check
+
+const debug = require('debug')('cypress-markdown-preprocessor')
+const fs = require('fs')
+const arg = require('arg')
+const globby = require('globby')
+const { collectFiddles } = require('../src/collect-utils')
+
+const args = arg(
+  {
+    '--print': Boolean, // to STDOUT
+    '--filename': String, // output filename
+    // aliases
+    '-p': '--print',
+    '-f': '--filename',
+  },
+  { argv: process.argv },
+)
+debug('arguments %o', args)
+
+// remove "node" and the script name from the list of arguments
+const markdownPattern = args._.slice(2)
+const sourceFiles = globby.sync(markdownPattern)
+debug('source files')
+debug(sourceFiles)
+
+if (!sourceFiles.length) {
+  console.error('Could not find any Markdown files')
+  process.exit(1)
+}
+
+console.log(
+  'Searching for fiddles in %d Markdown file(s)',
+  sourceFiles.length,
+)
+
+const fiddles = collectFiddles(sourceFiles)
+
+console.log(
+  'found %d fiddle(s) across %d Markdown file(s)',
+  fiddles.length,
+  sourceFiles.length,
+)
+
+if (args['--print']) {
+  console.log(fiddles)
+}
+
+if (args['--filename']) {
+  const text = JSON.stringify(fiddles, null, 2) + '\n'
+  fs.writeFileSync(args['--filename'], text)
+  console.log('write fiddles to JSON file %s', args['--filename'])
+}

cypress/e2e/many-fiddles.md

@@ -0,0 +1,27 @@
+# Many fiddles
+
+## Section 1
+
+<!-- fiddle A / title a -->
+
+```js
+
+```
+
+<!-- fiddle-end -->
+
+<!-- fiddle A / title b -->
+
+```js
+
+```
+
+<!-- fiddle-end -->
+
+<!-- fiddle A / B / inner -->
+
+```js
+
+```
+
+<!-- fiddle-end -->