@zentered/issue-forms-body-parser 1.1.0 → 1.1.3

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,36 @@
+name: Bug report
+description: Create a report to help us improve
+title: Bug report
+labels: ['bug']
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: To reproduce
+      description: Steps to reproduce the behavior
+      placeholder: >
+        1. Go to ...\n 2. Click on ...\n 3. Scroll down to ...\n 4. See error
+    validations:
+      required: false
+  - type: textarea
+    id: expectation
+    attributes:
+      label: Expected behaviour
+      description:
+        A clear and concise description of what you expected to happen.
+    validations:
+      required: false
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.
+    validations:
+      required: false

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

package/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,38 @@
+name: Feature request
+description: Suggest an idea for this project
+title: Feature request
+labels: ['enhancement']
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Is your feature request related to a problem? Please describe.
+      description:
+        A clear and concise description of what the problem is. Ex. Im always
+        frustrated when [...]
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you would like
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: false
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you have considered
+      description:
+        A clear and concise description of any alternative solutions or features
+        you have considered.
+    validations:
+      required: false
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description:
+        Add any other context or screenshots about the feature request here.
+    validations:
+      required: false

package/.github/workflows/end-to-end-test.yml

@@ -0,0 +1,13 @@
+name: e2e test
+
+on: issues
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Issue Forms Body Parser
+        id: parse
+        uses: ./
+      - run: echo "${{ toJSON(steps.parse.outputs.data) }}"

package/README.md

@@ -27,6 +27,8 @@ with valuable feedback from [Steffen](https://gist.github.com/steffen)\_
 
 ## Features
 
+- :white_check_mark: npm version available
+  `npm i @zentered/issue-forms-body-parser`
 - :white_check_mark: parse question/answer format into title/text as JSON
 - :white_check_mark: parse line items and "tasks" with separate `checked`
   attributes
@@ -86,6 +88,8 @@ See more examples in [md test cases](./test/test-issue-1.md) and
 
 ## Installation & Usage
 
+### GitHub Actions
+
 ```yml
 name: Issue Forms Body Parser
 
@@ -101,6 +105,34 @@ jobs:
       - run: echo "${{ JSON.stringify(steps.parse.outputs.data) }}"
 ```
 
+### NPM
+
+The parser is available as a standalone library:
+
+```
+    npm i @zentered/issue-forms-body-parser
+    # OR yarn add @zentered/issue-forms-body-parser
+```
+
+Usage:
+
+```
+import bodyParser from '@zentered/issue-forms-body-parser'
+const issueData = await bodyParser(issue.body)
+```
+
+## Development & Testing
+
+You can use [act](https://github.com/nektos/act) to test this Action locally.
+
+`npm run build && act issue -e test/issue.json`
+
+or run:
+
+`npm test`
+
+to test the parser.
+
 ## 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)

package/dist/index.js

@@ -51888,9 +51888,25 @@ function getDateTimeFormat(timeZone) {
   return dtfCache[timeZone]
 }
 
+;// CONCATENATED MODULE: ./node_modules/date-fns-tz/esm/_lib/newDateUTC/index.js
+/**
+ * Use instead of `new Date(Date.UTC(...))` to support years below 100 which doesn't work
+ * otherwise due to the nature of the
+ * [`Date` constructor](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#interpretation_of_two-digit_years.
+ *
+ * For `Date.UTC(...)`, use `newDateUTC(...).getTime()`.
+ */
+function newDateUTC(fullYear, month, day, hour, minute, second, millisecond) {
+  var utcDate = new Date(0)
+  utcDate.setUTCFullYear(fullYear, month, day)
+  utcDate.setUTCHours(hour, minute, second, millisecond)
+  return utcDate
+}
+
 ;// CONCATENATED MODULE: ./node_modules/date-fns-tz/esm/_lib/tzParseTimezone/index.js
 
 
+
 var MILLISECONDS_IN_HOUR = 3600000
 var MILLISECONDS_IN_MINUTE = 60000
 
@@ -51961,23 +51977,30 @@ function tzParseTimezone(timezoneString, date, isUtcDate) {
 }
 
 function toUtcDate(date) {
-  return new Date(
-    Date.UTC(
-      date.getFullYear(),
-      date.getMonth(),
-      date.getDate(),
-      date.getHours(),
-      date.getMinutes(),
-      date.getSeconds(),
-      date.getMilliseconds()
-    )
+  return newDateUTC(
+    date.getFullYear(),
+    date.getMonth(),
+    date.getDate(),
+    date.getHours(),
+    date.getMinutes(),
+    date.getSeconds(),
+    date.getMilliseconds()
   )
 }
 
 function calcOffset(date, timezoneString) {
   var tokens = tzTokenizeDate(date, timezoneString)
 
-  var asUTC = Date.UTC(tokens[0], tokens[1] - 1, tokens[2], tokens[3] % 24, tokens[4], tokens[5])
+  // ms dropped because it's not provided by tzTokenizeDate
+  var asUTC = newDateUTC(
+    tokens[0],
+    tokens[1] - 1,
+    tokens[2],
+    tokens[3] % 24,
+    tokens[4],
+    tokens[5],
+    0
+  ).getTime()
 
   var asTS = date.getTime()
   var over = asTS % 1000
@@ -52013,10 +52036,7 @@ function fixOffset(date, offset, timezoneString) {
 }
 
 function validateTimezone(hours, minutes) {
-  return (
-    (hours === 12 && (minutes == null || minutes === 0)) ||
-    (-11 <= hours && hours <= 11 && (minutes == null || (0 <= minutes && minutes < 59)))
-  )
+  return -23 <= hours && hours <= 23 && (minutes == null || (0 <= minutes && minutes <= 59))
 }
 
 var validIANATimezoneCache = {}
@@ -52497,6 +52517,7 @@ function validateTime(hours, minutes, seconds) {
 
 
 
+
 /**
  * @name zonedTimeToUtc
  * @category Time Zone Helpers
@@ -52530,7 +52551,7 @@ function zonedTimeToUtc(date, timeZone, options) {
 
   var d = toDate(date, options)
 
-  var utc = Date.UTC(
+  var utc = newDateUTC(
     d.getFullYear(),
     d.getMonth(),
     d.getDate(),
@@ -52538,7 +52559,7 @@ function zonedTimeToUtc(date, timeZone, options) {
     d.getMinutes(),
     d.getSeconds(),
     d.getMilliseconds()
-  )
+  ).getTime()
 
   var offsetMilliseconds = tzParseTimezone(timeZone, new Date(utc))
 
@@ -52705,7 +52726,7 @@ function formatTimezone(offset, dirtyDelimeter) {
   var sign = offset > 0 ? '-' : '+'
   var absOffset = Math.abs(offset)
   var hours = addLeadingZeros(Math.floor(absOffset / 60), 2)
-  var minutes = addLeadingZeros(absOffset % 60, 2)
+  var minutes = addLeadingZeros(Math.floor(absOffset % 60), 2)
   return sign + hours + delimeter + minutes
 }
 
@@ -53252,10 +53273,12 @@ async function parseMD(body) {
     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
+      // issue-form answers start with a h3 heading, ignore everything else
+      const obj = {
+        id: slugify(current.children[0].value),
+        title: current.children[0].value
+      }
       if (hasNext) {
         const next = tokens.children[idx + 1]
         if (next.type === 'list') {
@@ -53274,8 +53297,8 @@ async function parseMD(body) {
           obj.time = time
         }
       }
+      r.push(obj)
     }
-    r.push(obj)
   }
 
   return r
@@ -53293,7 +53316,7 @@ async function run() {
     const parsedContent = await parseMD(github.context.payload.issue.body)
 
     if (parsedContent !== undefined) {
-      core.setOutput('payload', parsedContent)
+      core.setOutput('data', parsedContent)
     } else {
       core.setFailed(`There was no valid payload found in the issue.`)
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zentered/issue-forms-body-parser",
-  "version": "1.1.0",
+  "version": "1.1.3",
   "private": false,
   "description": "Parser for GitHub Issue Form body, also available as GitHub Action",
   "keywords": [
@@ -49,16 +49,16 @@
     "*.{js,json,md}": [
       "prettier --write"
     ],
-    "*.{js}": [
+    "*.js": [
       "eslint --cache --fix"
     ]
   },
   "dependencies": {
     "@actions/core": "^1.6.0",
-    "@actions/github": "^5.0.0",
+    "@actions/github": "^5.0.1",
     "@sindresorhus/slugify": "^2.1.0",
     "date-fns": "^2.28.0",
-    "date-fns-tz": "^1.3.0",
+    "date-fns-tz": "^1.3.3",
     "remark-gfm": "^3.0.1",
     "remark-parse": "^10.0.1",
     "remark-stringify": "^10.0.2",
@@ -68,15 +68,15 @@
     "@commitlint/config-conventional": "^16.2.1",
     "@vercel/ncc": "^0.33.3",
     "commitlint": "^16.2.3",
-    "eslint": "^8.11.0",
+    "eslint": "^8.12.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"
+    "prettier": "^2.6.2",
+    "tap": "^16.0.1"
   },
   "release": {
     "branches": [

package/src/index.js

@@ -9,7 +9,7 @@ async function run() {
     const parsedContent = await parse(github.context.payload.issue.body)
 
     if (parsedContent !== undefined) {
-      core.setOutput('payload', parsedContent)
+      core.setOutput('data', parsedContent)
     } else {
       core.setFailed(`There was no valid payload found in the issue.`)
     }

package/src/parse.js

@@ -92,10 +92,12 @@ export default async function parseMD(body) {
     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
+      // issue-form answers start with a h3 heading, ignore everything else
+      const obj = {
+        id: slugify(current.children[0].value),
+        title: current.children[0].value
+      }
       if (hasNext) {
         const next = tokens.children[idx + 1]
         if (next.type === 'list') {
@@ -114,8 +116,8 @@ export default async function parseMD(body) {
           obj.time = time
         }
       }
+      r.push(obj)
     }
-    r.push(obj)
   }
 
   return r

package/test/issue.json

@@ -0,0 +1,6 @@
+{
+  "action": "opened",
+  "issue": {
+    "body": "### List Item Checked\n\n*   [x] I agree to follow this project's\n    [Code of Conduct](https://berlincodeofconduct.org)\n"
+  }
+}

package/test/parse-issue.test.js

@@ -90,3 +90,15 @@ test('parse(md) should parse GitHub Issue Form data into useful, structured data
   // console.log(JSON.stringify(actual, null, 0))
   t.deepEqual(actual, expected)
 })
+
+test('parse(md) return nothing', async (t) => {
+  const expected = []
+
+  const md = await readFile(
+    join(process.cwd(), 'test', 'test-issue-2.md'),
+    'utf8'
+  )
+  const actual = await fn(md)
+  // console.log(JSON.stringify(actual, null, 0))
+  t.deepEqual(actual, expected)
+})

package/test/test-issue-2.md

@@ -0,0 +1,10 @@
+---
+startDate: 10.03.2022
+startTime: 10.00
+duration: 1h
+location: online
+---
+
+Let's chat about tech, coding and Cyprus.
+
+https://discord.gg/qA7wHjbs?event=948887583507755048

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,24 +0,0 @@
----
-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

@@ -1,19 +0,0 @@
----
-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.