@zentered/issue-forms-body-parser 1.0.0

package/.eslintignore

@@ -0,0 +1,3 @@
+dist/
+coverage/
+test/

package/.eslintrc.json

@@ -0,0 +1,15 @@
+{
+  "env": {
+    "es2021": true,
+    "node": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:node/recommended",
+    "plugin:json/recommended"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 2021,
+    "sourceType": "module"
+  }
+}

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: '/'
+    schedule:
+      interval: 'monthly'

package/.github/workflows/publish.yml

@@ -0,0 +1,24 @@
+name: Publish
+
+permissions:
+  contents: write
+  deployments: write
+  issues: read
+  pull-requests: write
+
+on:
+  push:
+    branches:
+      - 'main'
+
+jobs:
+  test:
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: npm ci
+      - run: npm test
+      - run: npm run release
+      - run: npx semantic-release

package/.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: Test
+
+on:
+  pull_request:
+    branches:
+      - '**'
+      - '!main'
+  push:
+    branches:
+      - '**'
+      - '!main'
+
+jobs:
+  test:
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - run: npm ci
+      - run: npm run lint
+      - run: npm test

package/.husky/commit-msg

@@ -0,0 +1 @@
+npx commitlint --edit $1

package/.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

package/.prettierrc

@@ -0,0 +1,6 @@
+{
+  "singleQuote": true,
+  "semi": false,
+  "trailingComma": "none",
+  "proseWrap": "always"
+}

package/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# How to contribute
+
+We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.
+
+## Code reviews
+
+All submissions require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests.
+
+## Style Guide
+
+This project provides a prettier configuration. All submitted PRs will be required to conform to this style guide before being merged.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Zentered OÜ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,114 @@
+# GitHub Issue Forms Body Parser
+
+![Test](https://github.com/zentered/issue-forms-body-parser/workflows/Test/badge.svg)
+![Release](https://github.com/zentered/issue-forms-body-parser/workflows/Publish/badge.svg)
+![Semantic Release](https://github.com/zentered/issue-forms-body-parser/workflows/Semantic%20Release/badge.svg)
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
+[![zentered.co](https://img.shields.io/badge/%3E-zentered.co-blue.svg?style=flat)](https://zentered.co)
+
+[Issue Forms](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms)
+is a great way to structure GitHub Issues to an expected format, and to make it
+easier to capture information from the user. Unfortunately, the schema only
+defined the input of the data, not the output. So the markdown body needs to be
+parsed to extract the information in a structured way and to make further
+processing easier.
+
+We use this Action at the
+[Cyprus Developer Community](https://github.com/cyprus-developer-community) to
+[create issues with event data](https://github.com/cyprus-developer-community/events/issues/new?assignees=&labels=Event+%3Asparkles%3A&template=event.yml&title=Event+Title)
+for upcoming meetups etc. The parser extracts the information from the issues
+and provides structured data to create calendar entries (ie `.ics` files for
+[calendar subscriptions with GitEvents](https://github.com/gitevents/ics)),
+calling 3rd party APIs, etc.
+
+\_Inspired by:
+[Peter Murray's Issue Forms Body Parser](https://github.com/peter-murray/issue-forms-body-parser)
+with valuable feedback from [Steffen](https://gist.github.com/steffen)\_
+
+## Features
+
+- :white_check_mark: parse question/answer format into title/text as JSON
+- :white_check_mark: parse line items and "tasks" with separate `checked`
+  attributes
+- :white_check_mark: slugify title to id to find data
+- :white_check_mark: parse dates and times into separate `date` and `time`
+  fields
+- :negative_squared_cross_mark: no tokens/input required
+- :negative_squared_cross_mark: zero configuration
+
+Transforms markdown from GitHub Issue Forms:
+
+```markdown
+### Event Description
+
+Let's meet for coffee and chat about tech, coding, Cyprus and the newly formed
+CDC (Cyprus Developer Community).
+
+### Location
+
+Cafe Nero Finikoudes, Larnaka
+
+### Date
+
+11.03.2022
+
+### Time
+
+16:00
+```
+
+to structured, usable data:
+
+```json
+[
+  {
+    "id": "event-description",
+    "title": "Event Description",
+    "text": "Let's meet for coffee and chat about tech, coding, Cyprus and the newly formed\nCDC (Cyprus Developer Community).\n"
+  },
+  {
+    "id": "location",
+    "title": "Location",
+    "text": "Cafe Nero Finikoudes, Larnaka\n"
+  },
+  {
+    "id": "date",
+    "title": "Date",
+    "text": "11.03.2022\n",
+    "date": "2022-03-11T00:00:00.000Z"
+  },
+  { "id": "time", "title": "Time", "text": "16:00\n", "time": "16:00" }
+]
+```
+
+See more examples in [md test cases](./test/test-issue-1.md) and
+[test results](./test/parse-issue-test.md]).
+
+## Installation & Usage
+
+```yml
+name: Issue Forms Body Parser
+
+on: issues
+
+jobs:
+  process:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Issue Forms Body Parser
+        id: parse
+        uses: zentered/issue-forms-body-parser@1.0.0
+      - run: echo "${{ JSON.stringify(steps.parse.outputs.data) }}"
+```
+
+## Links
+
+- [Creating issue forms](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms)
+- [Syntax for GitHub's form schema](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema)
+
+## License
+
+Licensed under [MIT](./LICENSE).
+
+Here is a list of all the licenses of our
+[production dependencies](./dist/licenses.txt)

package/action.yml

@@ -0,0 +1,15 @@
+name: GitHub Issue Forms Body Parser
+author: PatrickHeneise
+description:
+  'Issue Forms is a great way to structure GitHub Issues to an expected format,
+  and to make it easier to capture information.'
+branding:
+  color: blue
+  icon: chevron-right
+outputs:
+  data:
+    description:
+      The extracted payload data from the issue body labels in JSON encoded form
+runs:
+  main: dist/index.js
+  using: node16

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@zentered/issue-forms-body-parser",
+  "version": "1.0.0",
+  "private": false,
+  "description": "Tech Events meet Issue Ops",
+  "keywords": [
+    "issues",
+    "forms",
+    "issue ops",
+    "github",
+    "action"
+  ],
+  "homepage": "https://zentered.co/",
+  "bugs": {
+    "url": "https://github.com/zentered/issue-forms-body-parser/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zentered/issue-forms-body-parser.git"
+  },
+  "license": "MIT",
+  "author": "Patrick Heneise <patrick@zentered.co> (https://zentered.co)",
+  "contributors": [
+    {
+      "name": "Patrick Heneise",
+      "url": "https://zentered.co",
+      "author": true
+    }
+  ],
+  "type": "module",
+  "main": "src/parse.js",
+  "scripts": {
+    "build": "ncc build src/index.js -o dist --license licenses.txt",
+    "release": "run-s lint test build",
+    "lint": "eslint .",
+    "license-checker": "license-checker --production --onlyAllow=\"MIT;ISC;BSD-3-Clause;BSD-2-Clause;Apache-2.0\"",
+    "test": "tap --node-arg=--experimental-json-modules --test-env=GITHUB_REPOSITORY=zentered/issue-forms-body-parser-test -J test/*.test.js",
+    "test:report": "tap --test-env=GITHUB_REPOSITORY=zentered/issue-forms-body-parser-test -J test/*.test.js --cov",
+    "_postinstall": "husky install",
+    "prepublishOnly": "pinst --disable",
+    "postpublish": "pinst --enable"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "lint-staged": {
+    "*.{js,json,md}": [
+      "prettier --write"
+    ],
+    "*.{js}": [
+      "eslint --cache --fix"
+    ]
+  },
+  "dependencies": {
+    "@actions/core": "^1.6.0",
+    "@actions/github": "^5.0.0",
+    "@sindresorhus/slugify": "^2.1.0",
+    "date-fns": "^2.28.0",
+    "date-fns-tz": "^1.3.0",
+    "remark-gfm": "^3.0.1",
+    "remark-parse": "^10.0.1",
+    "remark-stringify": "^10.0.2",
+    "unified": "^10.1.2"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^16.2.1",
+    "@vercel/ncc": "^0.33.3",
+    "commitlint": "^16.2.3",
+    "eslint": "^8.11.0",
+    "eslint-plugin-json": "^3.1.0",
+    "eslint-plugin-node": "^11.1.0",
+    "husky": "^7.0.4",
+    "license-checker": "^25.0.1",
+    "npm-run-all": "^4.1.5",
+    "pinst": "^3.0.0",
+    "prettier": "^2.6.0",
+    "tap": "^16.0.0"
+  },
+  "release": {
+    "branches": [
+      "main"
+    ]
+  }
+}

package/src/index.js

@@ -0,0 +1,21 @@
+import github from '@actions/github'
+import core from '@actions/core'
+import parse from './parse.js'
+
+async function run() {
+  core.info('Parsing issue body ...')
+
+  try {
+    const parsedContent = await parse(github.context.payload.issue.body)
+
+    if (parsedContent !== undefined) {
+      core.setOutput('payload', parsedContent)
+    } else {
+      core.setFailed(`There was no valid payload found in the issue.`)
+    }
+  } catch (err) {
+    core.setFailed(err)
+  }
+}
+
+run()

package/src/parse.js

@@ -0,0 +1,123 @@
+'use strict'
+
+import { unified } from 'unified'
+import remarkParse from 'remark-parse'
+import remarkGfm from 'remark-gfm'
+import slugify from '@sindresorhus/slugify'
+import remarkStringify from 'remark-stringify'
+import { parse, isMatch } from 'date-fns'
+// if the system time is not UTC, we need to convert it to UTC
+import { zonedTimeToUtc, formatInTimeZone } from 'date-fns-tz/esm'
+const loc = 'UTC'
+
+const commonDateFormats = [
+  'yyyy-MM-dd',
+  'dd/MM/yyyy',
+  'dd/MM/yy',
+  'dd-MM-yyyy',
+  'dd-MM-yy',
+  'dd.MM.yyyy',
+  'dd.MM.yy'
+]
+
+const commonTimeFormats = ['HH:mm', 'hh:mm a', 'hh:mm A']
+
+function parseDate(text) {
+  const match = commonDateFormats.map((format) => {
+    return isMatch(text, format)
+  })
+  if (match.indexOf(true) > -1) {
+    return zonedTimeToUtc(
+      parse(text, commonDateFormats[match.indexOf(true)], new Date()),
+      loc
+    ).toJSON()
+  } else {
+    return null
+  }
+}
+
+function parseTime(text) {
+  const match = commonTimeFormats.map((format) => {
+    return isMatch(text, format)
+  })
+  if (match.indexOf(true) > -1) {
+    const time = zonedTimeToUtc(
+      parse(text, commonTimeFormats[match.indexOf(true)], new Date()),
+      loc
+    )
+    console.log(time)
+    return formatInTimeZone(time, loc, 'HH:mm')
+  } else {
+    return null
+  }
+}
+
+function parseList(list) {
+  return list.children
+    .map((item) => {
+      const listItem = {}
+      if (item.type === 'list') {
+        return parseList(list)
+      } else if (item.type === 'listItem') {
+        listItem.checked = item.checked
+        return item.children
+          .map((child) => {
+            if (child.type === 'paragraph') {
+              listItem.text = child.children
+                .map((c) => {
+                  if (c.type === 'link') {
+                    return c.children[0].value
+                  } else {
+                    return c.value
+                  }
+                })
+                .filter((x) => !!x)
+                .join('')
+              return listItem
+            }
+          })
+          .filter((x) => !!x)
+      }
+    })
+    .filter((x) => !!x)
+}
+
+export default async function parseMD(body) {
+  const tokens = await unified().use(remarkParse).use(remarkGfm).parse(body)
+  if (!tokens) {
+    return []
+  }
+
+  const r = []
+  for (let idx = 0; idx < tokens.children.length; idx = idx + 2) {
+    const current = tokens.children[idx]
+    const hasNext = idx + 1 < tokens.children.length
+
+    const obj = {}
+    if (current.type === 'heading') {
+      obj.id = slugify(current.children[0].value)
+      obj.title = current.children[0].value
+      if (hasNext) {
+        const next = tokens.children[idx + 1]
+        if (next.type === 'list') {
+          obj.list = parseList(next).flat()
+        }
+        obj.text = await unified()
+          .use(remarkGfm)
+          .use(remarkStringify)
+          .stringify(next)
+        const date = parseDate(obj.text)
+        const time = parseTime(obj.text)
+        if (date) {
+          obj.date = date
+        }
+        if (time) {
+          obj.time = time
+        }
+      }
+    }
+    r.push(obj)
+  }
+
+  return r
+}

package/test/parse-issue.test.js

@@ -0,0 +1,92 @@
+'use strict'
+
+import t from 'tap'
+import fn from '../src/parse.js'
+import { readFile } from 'fs/promises'
+import { join } from 'path'
+
+const test = t.test
+
+test('parse(md) should parse GitHub Issue Form data into useful, structured data', async (t) => {
+  const expected = [
+    {
+      id: 'event-description',
+      title: 'Event Description',
+      text: "Let's meet for coffee and chat about tech, coding, Cyprus and the newly formed\nCDC (Cyprus Developer Community).\n"
+    },
+    {
+      id: 'location',
+      title: 'Location',
+      text: '[Cafe Nero Finikoudes, Larnaka](https://goo.gl/maps/Bzjxdeat3BSdsUSVA)\n'
+    },
+    {
+      id: 'date',
+      title: 'Date',
+      text: '11.03.2022\n',
+      date: '2022-03-11T00:00:00.000Z'
+    },
+    { id: 'time', title: 'Time', text: '16:00\n', time: '16:00' },
+    { id: 'duration', title: 'Duration', text: '2h\n' },
+    {
+      id: 'list-item-checked',
+      title: 'List Item Checked',
+      list: [
+        {
+          checked: true,
+          text: "I agree to follow this project's\nCode of Conduct"
+        }
+      ],
+      text: "*   [x] I agree to follow this project's\n    [Code of Conduct](https://berlincodeofconduct.org)\n"
+    },
+    {
+      id: 'list-item-unchecked',
+      title: 'List Item Unchecked',
+      list: [
+        {
+          checked: false,
+          text: "I agree to follow this project's\nCode of Conduct"
+        }
+      ],
+      text: "*   [ ] I agree to follow this project's\n    [Code of Conduct](https://berlincodeofconduct.org)\n"
+    },
+    {
+      id: 'mixed-task-list',
+      title: 'Mixed Task List',
+      list: [
+        { checked: true, text: 'checked' },
+        { checked: false, text: 'unchecked' },
+        { checked: true, text: 'checked 2' },
+        { checked: true, text: 'checked 3' },
+        { checked: false, text: 'unchecked 2' }
+      ],
+      text: '*   [x] checked\n*   [ ] unchecked\n*   [x] checked 2\n*   [x] checked 3\n*   [ ] unchecked 2\n'
+    },
+    {
+      id: 'complex-list',
+      title: 'Complex List',
+      list: [
+        { checked: null, text: 'one' },
+        { checked: null, text: 'two' }
+      ],
+      text: '*   one\n*   two\n    *   three\n    *   four\n        1.  five\n        2.  six\n'
+    },
+    {
+      id: 'repositories',
+      title: 'Repositories',
+      text: '```csv\nhttps://example.com/repository-1\nhttps://example.com/repository-2\n```\n'
+    },
+    {
+      id: 'visibility',
+      title: 'Visibility',
+      text: 'Internal\n'
+    }
+  ]
+
+  const md = await readFile(
+    join(process.cwd(), 'test', 'test-issue-1.md'),
+    'utf8'
+  )
+  const actual = await fn(md)
+  // console.log(JSON.stringify(actual, null, 0))
+  t.deepEqual(actual, expected)
+})

package/test/test-issue-1.md

@@ -0,0 +1,58 @@
+### Event Description
+
+Let's meet for coffee and chat about tech, coding, Cyprus and the newly formed
+CDC (Cyprus Developer Community).
+
+### Location
+
+[Cafe Nero Finikoudes, Larnaka](https://goo.gl/maps/Bzjxdeat3BSdsUSVA)
+
+### Date
+
+11.03.2022
+
+### Time
+
+16:00
+
+### Duration
+
+2h
+
+### List Item Checked
+
+- [x] I agree to follow this project's
+      [Code of Conduct](https://berlincodeofconduct.org)
+
+### List Item Unchecked
+
+- [ ] I agree to follow this project's
+      [Code of Conduct](https://berlincodeofconduct.org)
+
+### Mixed Task List
+
+- [x] checked
+- [ ] unchecked
+- [x] checked 2
+- [x] checked 3
+- [ ] unchecked 2
+
+### Complex List
+
+- one
+- two
+  - three
+  - four
+    1. five
+    2. six
+
+### Repositories
+
+```csv
+https://example.com/repository-1
+https://example.com/repository-2
+```
+
+### Visibility
+
+Internal