Skip to content

Transition.md

Latest commit

 

History

History
51 lines (36 loc) · 2.19 KB

Transition.md

File metadata and controls

51 lines (36 loc) · 2.19 KB

Transition Mode

If you have an existing repository that you'd like to migrate to the files from this template, you can run npx create-typescript-app in it to "migrate" its tooling to this template's.

npx create-typescript-app

The transition script will:

  • Uninstall any known old packages that conflict with this template's tooling
  • Delete configuration files used with those old packages
  • Install any packages needed for this template's tooling
  • Create or rewrite configuration files for the new tooling
  • Run ESLint and Prettier auto-fixers to align formatting and style to the new settings

For example, if the repository previously using Jest for testing:

  • eslint-plugin-jest, jest, and other Jest-related packages will be uninstalled
  • Any Jest config file like jest.config.js will be deleted
  • @vitest/eslint-plugin, vitest, and other Vitest-related packages will be installed
  • A vitest.config.ts file will be created

You'll then need to manually go through the following two steps to set up tooling on GitHub:

  1. Create one token in repository secrets (unless you chose to opt out of releases):
    • ACCESS_TOKEN: A GitHub PAT with repo and workflow permissions
  2. Install two GitHub apps:
    • Codecov (unless you chose to opt out of tests)
    • Renovate (unless you chose to opt out of renovate)

Your repository will then have an approximate copy of this template's tooling ready for you to review! Hooray! 🥳

Warning

Migration will override many files in your repository. You'll want to review each of the changes. There will almost certainly be some incorrect changes you'll need to fix.

CLI Options

You can customize which pieces of tooling are provided and the options they're created with. See CLI.md.

For example, skipping the "This package was templated with..." block:

npx create-typescript-app --exclude-templated-with

See Blocks.md for details on the tooling pieces and which presets they're included in.