Skip to content

ci(openapi): Add spell-check CI step and fix existing typos#2187

Merged
vdusek merged 5 commits intomasterfrom
open-api-add-spellcheck
Jan 20, 2026
Merged

ci(openapi): Add spell-check CI step and fix existing typos#2187
vdusek merged 5 commits intomasterfrom
open-api-add-spellcheck

Conversation

@vdusek
Copy link
Contributor

@vdusek vdusek commented Jan 19, 2026

- Configure typos spell checker to only check apify-api/ directory
- Add .typos.toml config to ignore false positives from example IDs
- Verified no actual typos exist in apify-api directory
@vdusek vdusek added this to the 132nd sprint - Tooling team milestone Jan 19, 2026
@vdusek vdusek self-assigned this Jan 19, 2026
@vdusek vdusek added adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. labels Jan 19, 2026
@apify-service-account
Copy link

Preview for this PR was built for commit 7faec0d and is ready at https://pr-2187.preview.docs.apify.com!

@vdusek vdusek marked this pull request as ready for review January 19, 2026 15:21
Copy link
Member

@fnesveda fnesveda left a comment

Choose a reason for hiding this comment

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

Cool 👍 Maybe this should also be discussed with @TC-MO, this is more in his yard.

@fnesveda fnesveda requested a review from TC-MO January 19, 2026 15:29
@vdusek
Copy link
Contributor Author

vdusek commented Jan 19, 2026

Cool 👍 Maybe this should also be discussed with @TC-MO, this is more in his yard.

Sure, I quickly looked at the current CI setup, and it seems that doc content has its own spell-check steps. Because of that, I configured typos to run only on the apify-api directory.

But of course, we can definitely enable typos for the whole repository, if @TC-MO agrees.

Running it across the repo showed a few existing typos, for example:

error: `ommitted` should be `omitted`
   ╭▸ ./sources/academy/platform/expert_scraping_with_apify/apify_api_and_client.md:52:25
   │
52 │     // fields should be ommitted
   ╰╴                        ━━━━━━━━
error: `extenison` should be `extension`
  ╭▸
1 │ ./sources/platform/integrations/images/airtable/airtable_search_apify_extenison.png
  ╰╴                                                                      ━━━━━━━━━
error: `accross` should be `across`
    ╭▸ ./sources/academy/webscraping/scraping_basics_javascript/08_saving_data.md:115:243
    │
115 │ …rom the syntax of JavaScript objects, but people now use it accross programming languages.
    ╰╴                                                             ━━━━━━━
error: `extenison` should be `extension`
   ╭▸ ./sources/platform/integrations/data-storage/airtable/index.md:42:18
   │
42 │ Search for Apify extenison and install it
   ╰╴                 ━━━━━━━━━
error: `programatically` should be `programmatically`
   ╭▸ ./sources/legal/latest/terms/store-publishing-terms-and-conditions.md:88:44
   │
88 │ 3. "**Pay per Event**" which allows you to programatically charge for events in your Actor source code. You need to pre-define the…
   ╰╴                                           ━━━━━━━━━━━━━━━
   error: `Plaftorm` should be `Platform`
   ╭▸ src/components/PlatformCard.jsx:24:7
   │
24 │ const PlaftormCard = ({ title, items }) => {
   ╰╴      ━━━━━━━━
error: `Plaftorm` should be `Platform`
   ╭▸ src/components/PlatformCard.jsx:39:16
   │
39 │ export default PlaftormCard;
   ╰╴               ━━━━━━━━
   
   ...

@TC-MO
Copy link
Contributor

TC-MO commented Jan 20, 2026

I'm fairly certain that we used this already before but retired it for one reason or another (not 100% sure atm). At the same time maybe the tool is better now or we could have better rules in place. I see no harm in setting this up for whole repo and trying it out. Worst case scenario we can revert to having it only work on apify-api

@vdusek vdusek changed the title ci(openapi): Add spell check for apify-api directory ci(openapi): Add spell-check CI step and fix existing typos Jan 20, 2026
@apify-service-account
Copy link

Preview for this PR was built for commit 503c505 and is ready at https://pr-2187.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit 5487f4c and is ready at https://pr-2187.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit 122f204 and is ready at https://pr-2187.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit 57cefe1 and is ready at https://pr-2187.preview.docs.apify.com!

@vdusek vdusek merged commit 4538b38 into master Jan 20, 2026
11 checks passed
@vdusek vdusek deleted the open-api-add-spellcheck branch January 20, 2026 14:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants