@zentered/issue-forms-body-parser 1.0.0 → 1.1.2

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/.github/workflows/publish.yml

@@ -15,6 +15,7 @@ jobs:
   test:
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

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)