react-ui-org / react-ui / 34754572403

61%

push

github

Migrate the library to TypeScript (#394)

Convert all components, providers, helpers and the library entry from
JSX with `prop-types` to TypeScript (`strict: true`) while keeping the
runtime behaviour and the public exports unchanged.

* Every component gets a co-located `<Component>.types.ts` with its
  `Props` type (extending the matching `*HTMLAttributes`) and the JSDoc
  descriptions copied from `propTypes`; context values, provider props and
  helper types live in `.types.ts` files too. Shared unions (`Color`,
  `Priority`, `Size`, `Layout`, `ValidationState`, `Breakpoint`,
  `LabelPosition`) live in `src/types`.
* `defaultProps` are replaced by default values in the parameter
  destructuring (react-docgen reads them for the documentation);
  `propTypes` are kept for runtime validation. Plain function components
  are annotated as `React.FunctionComponent` so `propTypes` do not leak
  into the declarations, and `withGlobalProps` is generic in props and
  ref element (`never` for components that do not forward a ref).
* Toolchain: TypeScript 7 (`@typescript/native`) type-checks and emits
  declarations, TypeScript 6 stays installed as `typescript` for tools
  that need the compiler API (typescript-eslint); Babel
  (`@babel/preset-typescript`) transpiles for webpack and Jest, which
  replaces `ts-jest` and the second Jest config. `eslint-plugin-deprecation`
  and `eslint-plugin-typescript-sort-keys` are replaced by
  `@typescript-eslint/no-deprecated` and `eslint-plugin-perfectionist`
  because they do not support TypeScript 6.
* Build emits `dist/types/**` and bundles them with `dts-bundle-generator`
  into the published `dist/react-ui.d.ts` referenced by `types`; package
  contents are defined by a `files` allowlist instead of `.npmignore`.
* Stories use the real component props (`StoryProps` helper for props the
  story defaults), `npm run typecheck` is part of `npm run lint`, and the
  contributing rules and docs describe the TypeScript setup.

129 of 242 branches covered (53.31%)

Branch coverage included in aggregate %.

71 of 78 new or added lines in 21 files covered. (91.03%)

161 of 232 relevant lines covered (69.4%)

8.14 hits per line