Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: reactjs/react-docgen
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: @react-docgen/cli@2.0.2
Choose a base ref
...
head repository: reactjs/react-docgen
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: main
Choose a head ref
Loading
Showing with 10,104 additions and 7,004 deletions.
  1. +5 −0 .changeset/plenty-coins-compare.md
  2. +0 −4 .eslintignore
  3. +0 −67 .eslintrc.cjs
  4. +22 −9 .github/workflows/build.yml
  5. +1 −1 .github/workflows/changesets.yml
  6. +2 −1 .github/workflows/lock.yml
  7. +2 −1 .gitignore
  8. +2 −1 .prettierignore
  9. +1 −1 benchmark/package.json
  10. +0 −15 codecov.yml
  11. +97 −0 eslint.config.mjs
  12. +25 −23 package.json
  13. +95 −1 packages/react-docgen-cli/CHANGELOG.md
  14. +7 −7 packages/react-docgen-cli/package.json
  15. +1 −1 packages/react-docgen-cli/src/utils/importFile.ts
  16. +64 −5 packages/react-docgen/CHANGELOG.md
  17. +2 −2 packages/react-docgen/package.json
  18. +24 −24 packages/react-docgen/src/handlers/__tests__/__snapshots__/codeTypeHandler-test.ts.snap
  19. +46 −46 packages/react-docgen/src/handlers/__tests__/__snapshots__/defaultPropsHandler-test.ts.snap
  20. +1 −1 packages/react-docgen/src/handlers/__tests__/codeTypeHandler-test.ts
  21. +1 −1 packages/react-docgen/src/importer/makeFsImporter.ts
  22. +46 −18 packages/react-docgen/src/main.ts
  23. +3 −3 packages/react-docgen/src/utils/__tests__/__snapshots__/getFlowType-test.ts.snap
  24. +3 −3 packages/react-docgen/src/utils/__tests__/__snapshots__/getMembers-test.ts.snap
  25. +1 −1 packages/react-docgen/src/utils/__tests__/__snapshots__/getNameOrValue-test.ts.snap
  26. +28 −28 packages/react-docgen/src/utils/__tests__/__snapshots__/getPropType-test.ts.snap
  27. +32 −32 packages/react-docgen/src/utils/__tests__/__snapshots__/getTSType-test.ts.snap
  28. +14 −0 packages/react-docgen/src/utils/__tests__/__snapshots__/getTypeFromReactComponent-test.ts.snap
  29. +2 −2 ...eact-docgen/src/utils/__tests__/__snapshots__/resolveFunctionDefinitionToReturnValue-test.ts.snap
  30. +28 −28 packages/react-docgen/src/utils/__tests__/__snapshots__/resolveObjectKeysToArray-test.ts.snap
  31. +2 −2 ...s/react-docgen/src/utils/__tests__/__snapshots__/resolveObjectPatternPropertyToValue-test.ts.snap
  32. +8 −8 packages/react-docgen/src/utils/__tests__/__snapshots__/resolveObjectValuesToArray-test.ts.snap
  33. +21 −0 packages/react-docgen/src/utils/__tests__/getMemberExpressionValuePath-test.ts
  34. +24 −0 packages/react-docgen/src/utils/__tests__/getTypeFromReactComponent-test.ts
  35. +9 −0 packages/react-docgen/src/utils/__tests__/resolveExportDeclaration-test.ts
  36. +1 −1 packages/react-docgen/src/utils/getMemberExpressionValuePath.ts
  37. +0 −1 packages/react-docgen/src/utils/getMembers.ts
  38. +29 −8 packages/react-docgen/src/utils/getTypeFromReactComponent.ts
  39. +5 −5 packages/react-docgen/src/utils/resolveExportDeclaration.ts
  40. +13 −0 packages/react-docgen/tests/integration/__fixtures__/namespace-export.tsx
  41. +47 −29 packages/react-docgen/tests/integration/__snapshots__/integration-test.ts.snap
  42. +0 −11 packages/website/.eslintrc.cjs
  43. +1 −1 packages/website/.nvmrc
  44. +28 −0 packages/website/eslint.config.mjs
  45. +0 −3 packages/website/netlify.toml
  46. +1 −1 packages/website/next-env.d.ts
  47. +4 −2 packages/website/{next.config.js → next.config.mjs}
  48. +18 −19 packages/website/package.json
  49. +1 −1 packages/website/src/components/ContentMissing.tsx
  50. +55 −76 packages/website/src/components/Select.tsx
  51. +1 −0 packages/website/src/components/playground/Panel.tsx
  52. +21 −16 packages/website/src/components/users/User.tsx
  53. +11 −9 packages/website/src/components/users/UserList.tsx
  54. +0 −5 packages/website/src/pages/_app.mdx
  55. +6 −0 packages/website/src/pages/_app.tsx
  56. +31 −0 packages/website/src/pages/_meta.js
  57. +0 −31 packages/website/src/pages/_meta.json
  58. +4 −1 packages/website/src/pages/about.mdx
  59. +7 −0 packages/website/src/pages/docs/_meta.js
  60. +0 −7 packages/website/src/pages/docs/_meta.json
  61. +6 −0 packages/website/src/pages/docs/extending/_meta.js
  62. +0 −6 packages/website/src/pages/docs/extending/_meta.json
  63. +4 −0 packages/website/src/pages/docs/getting-started/_meta.js
  64. +0 −4 packages/website/src/pages/docs/getting-started/_meta.json
  65. +13 −13 packages/website/src/pages/docs/getting-started/cli.mdx
  66. +7 −7 packages/website/src/pages/docs/getting-started/nodejs.mdx
  67. +3 −0 packages/website/src/pages/docs/migrate/_meta.js
  68. +0 −3 packages/website/src/pages/docs/migrate/_meta.json
  69. +7 −0 packages/website/src/pages/docs/reference/_meta.js
  70. +0 −7 packages/website/src/pages/docs/reference/_meta.json
  71. +6 −0 packages/website/src/pages/docs/reference/documentation/_meta.js
  72. +0 −6 packages/website/src/pages/docs/reference/documentation/_meta.json
  73. +12 −0 packages/website/src/pages/docs/reference/handlers/_meta.js
  74. +0 −12 packages/website/src/pages/docs/reference/handlers/_meta.json
  75. +4 −0 packages/website/src/pages/docs/release-notes/_meta.js
  76. +0 −4 packages/website/src/pages/docs/release-notes/_meta.json
  77. +95 −1 packages/website/src/pages/docs/release-notes/cli.mdx
  78. +64 −5 packages/website/src/pages/docs/release-notes/react-docgen.mdx
  79. +4 −0 packages/website/src/pages/index.mdx
  80. +3 −0 packages/website/src/pages/users.mdx
  81. +18 −12 packages/website/src/theme.config.tsx
  82. +0 −42 packages/website/src/utils/usePopper.ts
  83. +8,908 −6,303 pnpm-lock.yaml
  84. +47 −16 renovate.json
5 changes: 5 additions & 0 deletions .changeset/plenty-coins-compare.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@react-docgen/cli": patch
---

update dependency debug to v4.4.1
4 changes: 0 additions & 4 deletions .eslintignore

This file was deleted.

67 changes: 0 additions & 67 deletions .eslintrc.cjs

This file was deleted.

31 changes: 22 additions & 9 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -10,19 +10,19 @@ on:
permissions: {}

env:
NODE_VERSION: 18
NODE_VERSION: 22

jobs:
tests:
strategy:
matrix:
node: ['16.14.0', '18', '20']
node: ['20.9.0', '22', '23']
os: ['ubuntu']
include:
- os: macos
node: '20'
node: '22'
- os: windows
node: '20'
node: '22'

name: Tests (Node.js v${{ matrix.node }}, ${{ matrix.os }})
runs-on: ${{ matrix.os }}-latest
@@ -32,7 +32,7 @@ jobs:
uses: actions/checkout@v4

- name: Install pnpm
uses: pnpm/action-setup@v2
uses: pnpm/action-setup@v4

- name: Setup Node.js
uses: actions/setup-node@v4
@@ -51,9 +51,22 @@ jobs:
if: '${{ matrix.node != env.NODE_VERSION }}'
run: pnpm test

- name: Upload coverage to Codecov
- name: Upload coverage
if: '${{ matrix.node == env.NODE_VERSION }}'
uses: codecov/codecov-action@v3
uses: coverallsapp/github-action@v2
with:
parallel: true
flag-name: test-${{ matrix.os }}

finish:
needs: tests
if: ${{ always() }}
runs-on: ubuntu-latest
steps:
- name: Close parallel build
uses: coverallsapp/github-action@v2
with:
parallel-finished: true

lint:
name: Lint
@@ -64,7 +77,7 @@ jobs:
uses: actions/checkout@v4

- name: Install pnpm
uses: pnpm/action-setup@v2
uses: pnpm/action-setup@v4

- name: Setup Node.js
uses: actions/setup-node@v4
@@ -87,7 +100,7 @@ jobs:
uses: actions/checkout@v4

- name: Install pnpm
uses: pnpm/action-setup@v2
uses: pnpm/action-setup@v4

- name: Setup Node.js
uses: actions/setup-node@v4
2 changes: 1 addition & 1 deletion .github/workflows/changesets.yml
Original file line number Diff line number Diff line change
@@ -22,7 +22,7 @@ jobs:
persist-credentials: false

- name: Install pnpm
uses: pnpm/action-setup@v2
uses: pnpm/action-setup@v4

- name: Setup Node.js
uses: actions/setup-node@v4
3 changes: 2 additions & 1 deletion .github/workflows/lock.yml
Original file line number Diff line number Diff line change
@@ -8,6 +8,7 @@ on:
permissions:
issues: write
pull-requests: write
discussions: write

concurrency:
group: lock
@@ -18,4 +19,4 @@ jobs:
steps:
- uses: dessant/lock-threads@v5
with:
log-output: true
log-output: true
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -4,4 +4,5 @@ dist/
!**/__fixtures__/**/node_modules/*
.idea/
coverage/
.nx/cache
.nx/cache
.nx/workspace-data
3 changes: 2 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -2,4 +2,5 @@ benchmark/suites/
**/__fixtures__/
**/dist/
**/node_modules
/.nx/cache
/.nx/cache
/.nx/workspace-data
2 changes: 1 addition & 1 deletion benchmark/package.json
Original file line number Diff line number Diff line change
@@ -12,7 +12,7 @@
"dependencies": {
"benchmark": "2.1.4",
"cli-table": "0.3.11",
"fast-glob": "3.3.2",
"fast-glob": "3.3.3",
"microtime": "3.1.1",
"react-docgen5": "npm:react-docgen@5.4.3",
"react-docgen6": "npm:react-docgen@6.0.0"
15 changes: 0 additions & 15 deletions codecov.yml

This file was deleted.

97 changes: 97 additions & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
import { globalIgnores } from 'eslint/config';
import globals from 'globals';
import js from '@eslint/js';
import prettierRecommended from 'eslint-plugin-prettier/recommended';
import tseslint from 'typescript-eslint';

export default tseslint.config([
globalIgnores([
'benchmark/suites/',
'**/__fixtures__/',
'**/dist/',
'**/.nx/',
'**/coverage',
'**/node_modules',
]),
js.configs.recommended,
{
files: ['**/*.js', '**/*.mjs', '**/*.cjs', '**/*.ts', '**/*.tsx'],
languageOptions: {
globals: {
...globals.node,
},

ecmaVersion: 2022,
sourceType: 'module',
},

rules: {
'no-shadow': 'error',
'no-var': 'error',

'padding-line-between-statements': [
'error',
{
blankLine: 'always',
prev: '*',
next: 'return',
},
{
blankLine: 'always',
prev: ['const', 'let', 'var'],
next: '*',
},
{
blankLine: 'any',
prev: ['const', 'let', 'var'],
next: ['const', 'let', 'var'],
},
{
blankLine: 'never',
prev: ['import'],
next: ['import'],
},
],

'prefer-const': 'error',
},
},
{
files: ['**/*.cjs'],

languageOptions: {
ecmaVersion: 2022,
sourceType: 'script',
},

rules: {
strict: ['error', 'global'],
},
},
{
files: ['**/*.ts', '**/*.tsx'],

extends: [
tseslint.configs.recommended,
tseslint.configs.strict,
tseslint.configs.stylistic,
],

rules: {
'no-shadow': 'off',
'@typescript-eslint/no-shadow': 'error',

'@typescript-eslint/array-type': [
'error',
{
default: 'array-simple',
},
],

'@typescript-eslint/consistent-type-imports': 'error',
'@typescript-eslint/no-non-null-assertion': 'off',
'@typescript-eslint/sort-type-constituents': 'error',
},
},
prettierRecommended,
]);
48 changes: 25 additions & 23 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"private": true,
"engines": {
"node": ">=16.13.0",
"pnpm": ">=8.7.5"
"node": "^20.9.0 || >=22",
"pnpm": ">=10.6.2"
},
"scripts": {
"build": "nx run-many --target=build --exclude='@react-docgen-internal/*'",
"lint": "eslint . --ext .js,.cjs,.mjs,.ts,.tsx --report-unused-disable-directives --max-warnings=0",
"fix": "eslint . --ext .js,.cjs,.mjs,.ts,.tsx --fix --report-unused-disable-directives --max-warnings=0",
"lint": "eslint . --flag unstable_config_lookup_from_file --report-unused-disable-directives --max-warnings=0",
"fix": "eslint . --flag unstable_config_lookup_from_file --fix --report-unused-disable-directives --max-warnings=0",
"test": "nx run-many --target=test --exclude='@react-docgen-internal/*' --output-style=stream",
"copy:changelog:react-docgen": "cp ./packages/react-docgen/CHANGELOG.md ./packages/website/src/pages/docs/release-notes/react-docgen.mdx",
"copy:changelog:cli": "cp ./packages/react-docgen-cli/CHANGELOG.md ./packages/website/src/pages/docs/release-notes/cli.mdx",
@@ -16,25 +16,27 @@
},
"license": "MIT",
"devDependencies": {
"@changesets/changelog-github": "0.5.0",
"@changesets/cli": "2.27.1",
"@types/node": "14.18.63",
"@typescript-eslint/eslint-plugin": "6.18.0",
"@typescript-eslint/parser": "6.18.0",
"@vitest/coverage-v8": "0.34.6",
"cpy": "10.1.0",
"eslint": "8.56.0",
"eslint-config-next": "14.0.4",
"eslint-config-prettier": "9.1.0",
"eslint-plugin-prettier": "5.1.2",
"execa": "7.2.0",
"nx": "17.2.8",
"prettier": "3.1.1",
"prettier-plugin-tailwindcss": "0.5.11",
"rimraf": "5.0.5",
"@changesets/changelog-github": "0.5.1",
"@changesets/cli": "2.29.5",
"@eslint/eslintrc": "3.3.1",
"@eslint/js": "9.29.0",
"@types/node": "20.19.1",
"@vitest/coverage-v8": "3.2.4",
"cpy": "11.1.0",
"eslint": "9.29.0",
"eslint-config-next": "15.3.4",
"eslint-config-prettier": "10.1.5",
"eslint-plugin-prettier": "5.5.1",
"execa": "9.6.0",
"globals": "16.2.0",
"nx": "20.8.2",
"prettier": "3.6.1",
"prettier-plugin-tailwindcss": "0.6.13",
"rimraf": "6.0.1",
"tempy": "3.1.0",
"typescript": "5.3.3",
"vitest": "0.34.6"
"typescript": "5.8.3",
"typescript-eslint": "8.35.0",
"vitest": "3.2.4"
},
"packageManager": "pnpm@8.14.0"
"packageManager": "pnpm@10.12.3"
}
Loading