npmpackage.info

Gathering detailed insights and metrics for @zentered/issue-forms-body-parser

@zentered/issue-forms-body-parser

GitHub Issue Forms Body Parser Action

2.2.0

MIT

JavaScript

74.87 kB

13,818 4.5

Installations

npm install @zentered/issue-forms-body-parser

Developer Guide

BETA

Typescript

No

Module System

ESM

Min. Node Version

>=18

Node Version

20.9.0

NPM Version

10.1.0 Score

62.7

Supply Chain

97.4

Quality

75.5

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

32

Closed

1

Merged

31

Issues

Open

1

Total

11

Closed

10

Releases

v2.2.0

Published on 11 Nov 2023

v2.1.5

Published on 09 Nov 2023

v2.1.4

Published on 31 Mar 2023

v2.1.3

Published on 30 Mar 2023

v2.1.2

Published on 30 Mar 2023

v2.1.1

Published on 16 Jan 2023

View all 27 releases

Contributors

Unable to fetch Contributors

View all 6 contributors

Languages

JavaScript

JavaScript (100%)

Developer

zentered

Download Statistics

Total Downloads

13,818

Last Day

Last Week

Last Month

110

Last Year

6,899

GitHub Statistics

20 Stars

102 Commits

7 Forks

2 Watching

1 Branches

6 Contributors

Bundle Size

260.25 kB

Minified

74.87 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

2.2.0

Package Id

@zentered/issue-forms-body-parser@2.2.0

Unpacked Size

84.79 kB

Size

20.15 kB

File Count

NPM Version

10.1.0

Node Version

20.9.0

Publised On

11 Nov 2023

Total Downloads

Cumulative downloads

Total Downloads

13,818

Last day

-83.9%

Compared to previous day

Last week

-31.8%

Compared to previous week

Last month

-59.4%

110

Compared to previous month

Last year

56.9%

6,899

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

GitHub Issue Forms Body Parser

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 to create issues with event data 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), calling 3rd party APIs, etc.

Inspired by: Peter Murray's Issue Forms Body Parser with valuable feedback from 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
: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:

1### Event Description
2
3Let's meet for coffee and chat about tech, coding, Cyprus and the newly formed
4CDC (Cyprus Developer Community).
5
6### Location
7
8Cafe Nero Finikoudes, Larnaka
9
10### Date
11
1211.03.2022
13
14### Time
15
1616:00

to structured, usable data:

1{
2  "event-description": {
3    "order": 0,
4    "title": "Event Description",
5    "text": "Let's meet for coffee and chat about tech, coding, Cyprus and the newly formed\nCDC (Cyprus Developer Community)."
6  },
7  "location": {
8    "order": 1,
9    "title": "Location",
10    "text": "Cafe Nero Finikoudes, Larnaka"
11  },
12  "date": {
13    "order": 2,
14    "title": "Date",
15    "text": "11.03.2022",
16    "date": "2022-03-11"
17  },
18  "time": {
19    "order": 3,
20    "title": "Time",
21    "text": "16:00",
22    "time": "16:00"
23  }
24}

See more examples in md test cases and test results.

Parsers

date: checks if the value matches a common date format and returns a formatted date field (in UTC).
time: checks if the value matches a common time format 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

1name: Issue Forms Body Parser
2
3on: issues
4
5jobs:
6  process:
7    runs-on: ubuntu-latest
8    steps:
9      - name: Issue Forms Body Parser
10        id: parse
11        uses: zentered/issue-forms-body-parser@v2.0.0
12      - run: echo ${{ toJSON(steps.parse.outputs.data) }}

You can also provide a custom body input:

1name: Issue Forms Body Parser
2
3on:
4  workflow_dispatch:
5    inputs:
6      issue_number:
7        type: string
8        required: true
9env:
10  GH_TOKEN: ${{ github.token }}
11
12jobs:
13  process:
14    runs-on: ubuntu-latest
15    steps:
16      - name: Fetch the issue
17        id: read_issue_body
18        run:
19          echo "body=$(gh issue view ${{ inputs.issue_number }} --repo ${{
20          github.repo }} --json body --jq '.body')" >> $GITHUB_OUTPUT
21
22      - name: Issue Forms Body Parser
23        id: parse
24        uses: zentered/issue-forms-body-parser@v2.0.0
25        with:
26          body: ${{ steps.read_issue_body.output.body }}
27
28      - run: echo ${{ toJSON(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 to test this Action locally.

npm run build && act issues -e test/issue.json

or run:

npm test

to test the parser.

License

Licensed under MIT.

Here is a list of all the licenses of our production dependencies

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

8

SAST

Determines if the project uses static code analysis.

7

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

1

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 1

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/zentered/issue-forms-body-parser/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/zentered/issue-forms-body-parser/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/zentered/issue-forms-body-parser/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/zentered/issue-forms-body-parser/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/end-to-end-test.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/zentered/issue-forms-body-parser/end-to-end-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/zentered/issue-forms-body-parser/publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/zentered/issue-forms-body-parser/publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/zentered/issue-forms-body-parser/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/zentered/issue-forms-body-parser/test.yml/main?enable=pin
Info: 0 out of 9 GitHub-owned GitHubAction dependencies pinned
Info: 2 out of 2 npmCommand dependencies pinned

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

Score

4.5

/10

Last Scanned on 2025-01-20

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@zentered/issue-forms-body-parser

Installations

Developer Guide

No

ESM

>=18

20.9.0

10.1.0

Score

Pull Requests

0

32

1

31

Issues

1

11

10

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

zentered

Download Statistics

GitHub Statistics

Bundle Size

260.25 kB

74.87 kB

Maintainers

Package Meta Information

Total Downloads

13,818

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

GitHub Issue Forms Body Parser

Features

Parsers

Installation & Usage

GitHub Actions

NPM

Development & Testing

Links

License

10

10

10

10

8

7

1

0

0

0

0

0

0

4.5

/10