slackapi / slackapi/bolt-js

Test utility for validating blocks

Open
#1,652 17 comments 15 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

auto-triage-skip discussion
Dominant language
TypeScript
Stars
2.9k
Forks
445
Avg merge
1d 3h
Merged PRs (30d)
28

Description

Description

It would be very convenient if this library including a utility for validating blocks. Inside of our tests, we could produce blocks and run them through this utility, which would return true if the block is valid or false otherwise. Currently, blocks are a bit brittle in that changes to block structure can produce errors which can only be debugged interactively through a dummy Slack channel. I don't know what this would involve, but it would be a great feature.

What type of issue is this? (place an x in one of the [ ])
  • bug
  • enhancement (feature request)
  • question
  • documentation related
  • example code related
  • testing related
  • discussion
Requirements (place an x in each of the [ ])
  • I've read and understood the Contributing guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've searched for any related issues and avoided creating a duplicate issue.

What you expected to happen

Actual result:

What actually happened

Attachments:

Logs, screenshots, screencast, sample project, funny gif, etc.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points, so first review the surrounding discussion and locate the library's existing block-related code. Define what makes a produced block valid and how the utility should report failures; done means tests can use it to receive true or false without relying on a dummy Slack channel.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.