Skip to content

Conversation

lukegalbraithrussell
Copy link
Contributor

Summary

This is a follow up to #2308 . adds the actual reference files by deleting the line in .gitignore

Requirements (place an x in each [ ])

@lukegalbraithrussell lukegalbraithrussell requested a review from a team July 24, 2025 20:28
Copy link

codecov bot commented Jul 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.74%. Comparing base (22117c2) to head (5f37cdf).

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2313   +/-   ##
=======================================
  Coverage   92.74%   92.74%           
=======================================
  Files          38       38           
  Lines       10660    10660           
  Branches      687      687           
=======================================
  Hits         9887     9887           
  Misses        761      761           
  Partials       12       12           
Flag Coverage Δ
cli-hooks 95.23% <ø> (ø)
cli-test 94.74% <ø> (ø)
oauth 77.39% <ø> (ø)
socket-mode 61.87% <ø> (ø)
web-api 97.99% <ø> (ø)
webhook 96.66% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@zimeg zimeg changed the title Docs: adds reference files docs: add generated reference files Jul 24, 2025
@zimeg zimeg added docs M-T: Documentation work only pkg:web-api applies to `@slack/web-api` pkg:rtm-api applies to `@slack/rtm-api` pkg:webhook applies to `@slack/webhook` pkg:logger applies to `@slack/logger` pkg:types applies to `@slack/types` pkg:oauth applies to `@slack/oauth` pkg:socket-mode applies to `@slack/socket-mode` pkg:cli-test applies to `@slack/cli-test` labels Jul 24, 2025
Copy link
Member

@zimeg zimeg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lukegalbraithrussell LGTM! And an incredible thanks for tackling this.

With quick reading this all is so solid but I remain open to follow ups as needed for both jsdoc and file organization alike. For now I think it'd be awesome to ship this 🚢 💨

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👁️‍🗨️ Unrelated to this PR, but this file makes it clear that keeping dependencies at the latest versions is meaningful for reference.

A change landed in @slack/[email protected] that updated this from team_domain_changed to be the expected team_domain_change event and at the moment @slack/web-api uses:

"@slack/types": "^2.9.0",

const SlackProduct: object;
```

Defined in: [utils/constants.ts:52](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/utils/constants.ts#L52)
Copy link
Member

@zimeg zimeg Jul 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👁️‍🗨️ This link might be finding main instead of a specific commit, though I do think we can revisit this for neartime releases!

Edit: Added relevant typedoc configs following 🔍

"gitRevision": "main",
"includeVersion": true,

@lukegalbraithrussell lukegalbraithrussell merged commit b330285 into main Jul 25, 2025
59 checks passed
@lukegalbraithrussell lukegalbraithrussell deleted the docs-luke-adds-reference-files branch July 25, 2025 00:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only pkg:cli-test applies to `@slack/cli-test` pkg:logger applies to `@slack/logger` pkg:oauth applies to `@slack/oauth` pkg:rtm-api applies to `@slack/rtm-api` pkg:socket-mode applies to `@slack/socket-mode` pkg:types applies to `@slack/types` pkg:web-api applies to `@slack/web-api` pkg:webhook applies to `@slack/webhook`
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants