from-joyride

Rewrites the react-joyride imports plus both the legacy <Joyride> JSX form and the modern useJoyride() hook form. Joyride's step shape ({ target, content }) already matches Tour Kit, so step lists carry over unchanged.

Run

npx tour-kit-migrate --from joyride --dry-run ./src
npx tour-kit-migrate --from joyride ./src

What it changes

What it does NOT handle

• Joyride-only props (callback, run, stepIndex, showProgress, showSkipButton, continuous, disableBeacon, …) are preserved next to the output with a // TODO: linking to the matching anchor in the React Joyride migration guide. For example continuous is the default in Tour Kit and can be dropped, while run maps to calling useTour().start().
• Step.styles / Step.tooltipComponent — custom tooltip rendering ports to <TourCard> children, not a prop.
• useJoyride control wiring. The hook is swapped for useTour(), but registering the tour at a <TourProvider> ancestor is left as a // TODO:.

Example

Before:

import Joyride from 'react-joyride'

function App() {
  return (
    <Joyride
      steps={[
        { target: '.step-1', content: 'Welcome!' },
        { target: '.step-2', content: 'Next up.' },
      ]}
      run
      continuous
    />
  )
}

After codemod:

import { TourProvider } from '@tour-kit/react'

function App() {
  return (
    <TourProvider
      tours={[
        {
          id: 'migrated-tour',
          steps: [
            { target: '.step-1', content: 'Welcome!' },
            { target: '.step-2', content: 'Next up.' },
          ],
        },
      ]}
      // TODO: `run` had no direct prop — call useTour().start() to begin.
      // /docs/migration/joyride#run
      // TODO: `continuous` is the Tour Kit default — drop it.
      // /docs/migration/joyride#continuous
    />
  )
}

See also

• Migration guide: React Joyride → Tour Kit — the per-anchor hand-port reference for everything the codemod leaves as a TODO.
• <TourProvider> — where the migrated tours array is registered.
• useTour — the replacement for useJoyride().
• Quick start — wire the migrated tour into a working app.