Types: split single index.ts file into files based on function/category #1656
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
filmaj
added
semver:patch
area:typescript
srajiang
reviewed
Aug 31, 2023
| export type KnownBlock = ImageBlock | ContextBlock | ActionsBlock | DividerBlock | | ||
| SectionBlock | InputBlock | FileBlock | HeaderBlock | VideoBlock; | ||
|
|
||
| export interface ActionsBlock extends Block { |
There was a problem hiding this comment.
Seems worth it to adding additional annotation to more easily find the documentation link while we're at it?
Fine to punt to the later TODO moment referenced in the comments above as well.
Suggested change
| export interface ActionsBlock extends Block { | |
| // Reference: https://api.slack.com/reference/block-kit/blocks#actions | |
| export interface ActionsBlock extends Block { |
There was a problem hiding this comment.
Yes exactly, I will be doing exactly these kind of changes in the next pull request 😄 I didn't want to add more additional lines in this specific PR as the diff would be too confusing given the movement of code across files. I think that in the next PR, though, these kinds of documentation additions you suggest would be clearer and easier to review.
| @@ -0,0 +1,38 @@ | |||
| /** | |||
There was a problem hiding this comment.
Nice that we'll just be able to poof this file when major version bump comes along 🧹 !
Co-authored-by: Sarah Jiang <[email protected]>
Co-authored-by: Sarah Jiang <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This is purely a text-movement PR; no changes (other than a few comments at the top of certain files) from the base.
I'm mainly looking for feedback on the organization of the files. If you have feedback on directory structure or file names, let me know!