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

package/README.md

@@ -77,7 +77,7 @@ to structured, usable data:
     "id": "date",
     "title": "Date",
     "text": "11.03.2022\n",
-    "date": "2022-03-11T00:00:00.000Z"
+    "date": "2022-03-11"
   },
   { "id": "time", "title": "Time", "text": "16:00\n", "time": "16:00" }
 ]
@@ -86,6 +86,14 @@ to structured, usable data:
 See more examples in [md test cases](./test/test-issue-1.md) and
 [test results](./test/parse-issue-test.md]).
 
+### Parsers
+
+- `date`: checks if the value matches a [common date format](https://github.com/zentered/issue-forms-body-parser/blob/main/src/parse.js#L14) and returns a formatted `date` field (in UTC).
+- `time`: checks if the value matches a [common time format](https://github.com/zentered/issue-forms-body-parser/blob/main/src/parse.js#L24) and returns a formatted `time` field.
+- `lists`: automatically returns lists as arrays
+- `duration`: currently only the format `XXhYYm` is supported as duration, ie. `1h30m` returns a `duration` object with `hours` and `minutes`.
+
+
 ## Installation & Usage
 
 ### GitHub Actions
@@ -101,7 +109,7 @@ jobs:
     steps:
       - name: Issue Forms Body Parser
         id: parse
-        uses: zentered/issue-forms-body-parser@1.0.0
+        uses: zentered/issue-forms-body-parser@v1.2.0
       - run: echo "${{ JSON.stringify(steps.parse.outputs.data) }}"
 ```
 

package/dist/index.js

@@ -51789,6 +51789,22 @@ function remarkStringify(options) {
 
 // EXTERNAL MODULE: ./node_modules/date-fns/index.js
 var date_fns = __nccwpck_require__(3314);
+;// CONCATENATED MODULE: ./node_modules/strip-final-newline/index.js
+function stripFinalNewline(input) {
+	const LF = typeof input === 'string' ? '\n' : '\n'.charCodeAt();
+	const CR = typeof input === 'string' ? '\r' : '\r'.charCodeAt();
+
+	if (input[input.length - 1] === LF) {
+		input = input.slice(0, -1);
+	}
+
+	if (input[input.length - 1] === CR) {
+		input = input.slice(0, -1);
+	}
+
+	return input;
+}
+
 // EXTERNAL MODULE: ./node_modules/date-fns/_lib/cloneObject/index.js
 var cloneObject = __nccwpck_require__(7934);
 // EXTERNAL MODULE: ./node_modules/date-fns/_lib/toInteger/index.js
@@ -53187,6 +53203,8 @@ function formatInTimeZone(date, timeZone, formatStr, options) {
 
 
 
+
+
 // if the system time is not UTC, we need to convert it to UTC
 
 const loc = 'UTC'
@@ -53201,17 +53219,30 @@ const commonDateFormats = [
   'dd.MM.yy'
 ]
 
-const commonTimeFormats = ['HH:mm', 'hh:mm a', 'hh:mm A']
+const commonTimeFormats = ['HH:mm', 'HH.mm', 'hh:mm a', 'hh:mm A']
+
+function parseDuration(text) {
+  const duration = {
+    hours: 0,
+    minutes: 0
+  }
+
+  const pieces = text.replace('m', '').split('h')
+  duration.hours = parseInt(pieces[0]) ? parseInt(pieces[0]) : 0
+  duration.minutes = parseInt(pieces[1]) ? parseInt(pieces[1]) : 0
+  return duration
+}
 
 function parse_parseDate(text) {
   const match = commonDateFormats.map((format) => {
     return (0,date_fns.isMatch)(text, format)
   })
   if (match.indexOf(true) > -1) {
-    return zonedTimeToUtc(
+    const date = zonedTimeToUtc(
       (0,date_fns.parse)(text, commonDateFormats[match.indexOf(true)], new Date()),
       loc
     ).toJSON()
+    return date.split('T')[0]
   } else {
     return null
   }
@@ -53284,10 +53315,11 @@ async function parseMD(body) {
         if (next.type === 'list') {
           obj.list = parseList(next).flat()
         }
-        obj.text = await unified()
+        const text = await unified()
           .use(remarkGfm)
           .use(remark_stringify)
           .stringify(next)
+        obj.text = stripFinalNewline(text)
         const date = parse_parseDate(obj.text)
         const time = parse_parseTime(obj.text)
         if (date) {
@@ -53296,6 +53328,9 @@ async function parseMD(body) {
         if (time) {
           obj.time = time
         }
+        if (obj.id === 'duration') {
+          obj.duration = parseDuration(obj.text)
+        }
       }
       r.push(obj)
     }

package/dist/licenses.txt

@@ -1429,6 +1429,19 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
 
+strip-final-newline
+MIT
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+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.
+
+
 tr46
 MIT
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zentered/issue-forms-body-parser",
-  "version": "1.1.3",
+  "version": "1.2.1",
   "private": false,
   "description": "Parser for GitHub Issue Form body, also available as GitHub Action",
   "keywords": [
@@ -62,6 +62,7 @@
     "remark-gfm": "^3.0.1",
     "remark-parse": "^10.0.1",
     "remark-stringify": "^10.0.2",
+    "strip-final-newline": "^3.0.0",
     "unified": "^10.1.2"
   },
   "devDependencies": {

package/src/parse.js

@@ -6,6 +6,8 @@ import remarkGfm from 'remark-gfm'
 import slugify from '@sindresorhus/slugify'
 import remarkStringify from 'remark-stringify'
 import { parse, isMatch } from 'date-fns'
+import stripFinalNewline from 'strip-final-newline'
+
 // 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'
@@ -20,17 +22,30 @@ const commonDateFormats = [
   'dd.MM.yy'
 ]
 
-const commonTimeFormats = ['HH:mm', 'hh:mm a', 'hh:mm A']
+const commonTimeFormats = ['HH:mm', 'HH.mm', 'hh:mm a', 'hh:mm A']
+
+function parseDuration(text) {
+  const duration = {
+    hours: 0,
+    minutes: 0
+  }
+
+  const pieces = text.replace('m', '').split('h')
+  duration.hours = parseInt(pieces[0]) ? parseInt(pieces[0]) : 0
+  duration.minutes = parseInt(pieces[1]) ? parseInt(pieces[1]) : 0
+  return duration
+}
 
 function parseDate(text) {
   const match = commonDateFormats.map((format) => {
     return isMatch(text, format)
   })
   if (match.indexOf(true) > -1) {
-    return zonedTimeToUtc(
+    const date = zonedTimeToUtc(
       parse(text, commonDateFormats[match.indexOf(true)], new Date()),
       loc
     ).toJSON()
+    return date.split('T')[0]
   } else {
     return null
   }
@@ -103,10 +118,11 @@ export default async function parseMD(body) {
         if (next.type === 'list') {
           obj.list = parseList(next).flat()
         }
-        obj.text = await unified()
+        const text = await unified()
           .use(remarkGfm)
           .use(remarkStringify)
           .stringify(next)
+        obj.text = stripFinalNewline(text)
         const date = parseDate(obj.text)
         const time = parseTime(obj.text)
         if (date) {
@@ -115,6 +131,9 @@ export default async function parseMD(body) {
         if (time) {
           obj.time = time
         }
+        if (obj.id === 'duration') {
+          obj.duration = parseDuration(obj.text)
+        }
       }
       r.push(obj)
     }

package/test/parse-issue.test.js

@@ -12,21 +12,26 @@ test('parse(md) should parse GitHub Issue Form data into useful, structured data
     {
       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"
+      text: "Let's meet for coffee and chat about tech, coding, Cyprus and the newly formed\nCDC (Cyprus Developer Community)."
     },
     {
       id: 'location',
       title: 'Location',
-      text: '[Cafe Nero Finikoudes, Larnaka](https://goo.gl/maps/Bzjxdeat3BSdsUSVA)\n'
+      text: '[Cafe Nero Finikoudes, Larnaka](https://goo.gl/maps/Bzjxdeat3BSdsUSVA)'
     },
     {
       id: 'date',
       title: 'Date',
-      text: '11.03.2022\n',
-      date: '2022-03-11T00:00:00.000Z'
+      text: '11.03.2022',
+      date: '2022-03-11'
+    },
+    { id: 'time', title: 'Time', text: '16:00', time: '16:00' },
+    {
+      id: 'duration',
+      title: 'Duration',
+      text: '2h',
+      duration: { hours: 2, minutes: 0 }
     },
-    { 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',
@@ -36,7 +41,7 @@ test('parse(md) should parse GitHub Issue Form data into useful, structured data
           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"
+      text: "*   [x] I agree to follow this project's\n    [Code of Conduct](https://berlincodeofconduct.org)"
     },
     {
       id: 'list-item-unchecked',
@@ -47,7 +52,7 @@ test('parse(md) should parse GitHub Issue Form data into useful, structured data
           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"
+      text: "*   [ ] I agree to follow this project's\n    [Code of Conduct](https://berlincodeofconduct.org)"
     },
     {
       id: 'mixed-task-list',
@@ -59,7 +64,7 @@ test('parse(md) should parse GitHub Issue Form data into useful, structured data
         { 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'
+      text: '*   [x] checked\n*   [ ] unchecked\n*   [x] checked 2\n*   [x] checked 3\n*   [ ] unchecked 2'
     },
     {
       id: 'complex-list',
@@ -68,17 +73,17 @@ test('parse(md) should parse GitHub Issue Form data into useful, structured data
         { checked: null, text: 'one' },
         { checked: null, text: 'two' }
       ],
-      text: '*   one\n*   two\n    *   three\n    *   four\n        1.  five\n        2.  six\n'
+      text: '*   one\n*   two\n    *   three\n    *   four\n        1.  five\n        2.  six'
     },
     {
       id: 'repositories',
       title: 'Repositories',
-      text: '```csv\nhttps://example.com/repository-1\nhttps://example.com/repository-2\n```\n'
+      text: '```csv\nhttps://example.com/repository-1\nhttps://example.com/repository-2\n```'
     },
     {
       id: 'visibility',
       title: 'Visibility',
-      text: 'Internal\n'
+      text: 'Internal'
     }
   ]