react-router icon indicating copy to clipboard operation
react-router copied to clipboard

Fix re-exports RemixRouter type

Open evgeniy28 opened this issue 3 years ago • 4 comments

What version are you using?

tsconfig

base.json:

{
  "$schema": "https://json.schemastore.org/tsconfig",
  "display": "Default",
  "compilerOptions": {
    "composite": false,
    "declaration": true,
    "declarationMap": true,
    "esModuleInterop": true,
    "forceConsistentCasingInFileNames": true,
    "inlineSources": false,
    "isolatedModules": true,
    "moduleResolution": "node",
    "noUnusedLocals": true,
    "noUnusedParameters": true,
    "preserveWatchOutput": true,
    "skipLibCheck": true,
    "strict": true,
    "noFallthroughCasesInSwitch": true
  },
  "exclude": ["node_modules"]
}

react-app.json:

{
  "$schema": "https://json.schemastore.org/tsconfig",
  "display": "Create React App",
  "extends": "./base.json",
  "compilerOptions": {
    "allowSyntheticDefaultImports": true,
    "noEmit": true,
    "lib": ["dom", "dom.iterable", "esnext"],
    "target": "ES2017",
    "module": "ESNext",
    "jsx": "react-jsx"
  },
  "include": ["src", "tests"],
  "exclude": ["node_modules"]
}

router.ts:

import {createBrowserRouter} from 'react-router-dom'

import App from './App'

const router = createBrowserRouter([
  {
    path: '/',
    element: <App />,
  },
])

export default router

VSCode shows error: Screenshot 2022-10-15 at 19 47 59

The inferred type of 'router' cannot be named without a reference to '.pnpm/@[email protected]/node_modules/@remix-run/router'. This is likely not portable. A type annotation is necessary.ts(2742)

Fix this error

by patching the exports to the react-router-dom package: Screenshot 2022-10-15 at 20 04 20

evgeniy28 avatar Oct 15 '22 17:10 evgeniy28

⚠️ No Changeset found

Latest commit: 9bd95ccb97cc08d2308f62f20bab819ef26540ed

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

changeset-bot[bot] avatar Oct 15 '22 17:10 changeset-bot[bot]

Hi @evgeniy28,

Welcome, and thank you for contributing to React Router!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at [email protected].

Thanks!

- The Remix team

remix-cla-bot[bot] avatar Oct 15 '22 17:10 remix-cla-bot[bot]

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

remix-cla-bot[bot] avatar Oct 15 '22 17:10 remix-cla-bot[bot]

There is a suggestion elsewhere this may be caused by not having React imported: https://github.com/yarnpkg/berry/issues/227#issuecomment-500300375

I'm not able to get this to fail in the TS playground, so I think this either might be the missing import or something with your build setup.

timdorr avatar Oct 16 '22 15:10 timdorr

There is a suggestion elsewhere this may be caused by not having React imported: yarnpkg/berry#227 (comment)

I'm not able to get this to fail in the TS playground, so I think this either might be the missing import or something with your build setup.

I understand what happened.

It helped me fix error: tsconfig.json

- "declaration": true,
- "declarationMap": true
+ "declaration": false,
+ "declarationMap": false

evgeniy28 avatar Oct 20 '22 19:10 evgeniy28