Skip to content

chore(lint): lint JSDoc and run ESLint in npm run lint - #4844

Merged
thetaPC merged 1 commit into
mainfrom
lint-follow-ups
Nov 13, 2026
Merged

thetaPC merged 1 commit into
mainfrom
lint-follow-ups

Conversation

@thetaPC

@thetaPC thetaPC commented Nov 12, 2026

Copy link
Copy Markdown
Contributor

Issue URL: N/A

What is the current behavior?

  • Nothing flags a JSDoc block whose lines lose the leading * or drift out of alignment, like the BestPracticeFigure comment fixed in chore(styles): match Docusaurus' stylesheet layout #4834.
  • ESLint and Prettier run from separate scripts, npm run eslint and npm run lint.
  • DocsCard styles its markup through global Card-* classes declared inside its CSS module.

What is the new behavior?

  • Adds eslint-plugin-jsdoc with check-alignment and require-asterisk-prefix on src, including .ts files. The ejected prism-include-languages.ts is skipped, since its disable comment names a rule from a plugin we don't install.
  • npm run lint runs ESLint, then Prettier. The eslint script and its CI step are removed, so ESLint now runs in the Lint job. CONTRIBUTING points at npm run lint.
  • DocsCard's classes become camelCase module classes, such as styles.header and styles.iconRow. Nothing outside DocsCard used the Card-* names.

Does this introduce a breaking change?

  • Yes
  • No

Other information

npm run lint reports ESLint errors but does not pass --fix, because the JSDoc autofix strips the indentation inside the comment and leaves trailing spaces.

The DocsCard stylesheet compiles to the same rules before and after, once the old class names are mapped to the new ones.

@vercel

vercel Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
ionic-docs Ready Ready Preview Nov 12, 2026 11:47pm UTC

Request Review

@thetaPC thetaPC changed the title chore: lint JSDoc comments, fold ESLint into lint, and use camelCase … chore(lint): lint JSDoc and run ESLint in npm run lint Nov 12, 2026
@thetaPC
thetaPC marked this pull request as ready for review November 12, 2026 23:52
@thetaPC
thetaPC requested a review from a team as a code owner November 12, 2026 23:52

@brandyscarney brandyscarney left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM!

@thetaPC
thetaPC merged commit 851f11b into main Nov 13, 2026
7 checks passed
@thetaPC
thetaPC deleted the lint-follow-ups branch November 13, 2026 15:21

This branch was successfully deployed

1 active deployment
Preview — 334e5039 Deployed Nov 12, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants