feat(create-jest): Add npm init / yarn create initialiser (#14453)

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

Author: dj-stormtrooper

.eslintrc.cjs

@@ -357,7 +357,7 @@ module.exports = {
       files: [
         'scripts/*',
         'packages/*/__benchmarks__/test.js',
-        'packages/jest-cli/src/init/index.ts',
+        'packages/create-jest/src/runCreate.ts',
         'packages/jest-repl/src/cli/runtime-cli.ts',
       ],
       rules: {

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ### Features
 
+- `[create-jest]` Add `npm init` / `yarn create` initialiser for Jest projects ([#14465](https://github.com/jestjs/jest/pull/14453))
+
 ### Fixes
 
 - `[jest-snapshot]` Allow for strings as well as template literals in inline snapshots ([#14465](https://github.com/jestjs/jest/pull/14465))
@@ -13,6 +15,8 @@
 
 ### Chore & Maintenance
 
+- `[jest-cli]` Move internal config initialisation logic to the `create-jest` package ([#14465](https://github.com/jestjs/jest/pull/14453))
+
 ## 29.6.4
 
 ### Fixes

README.md

@@ -131,7 +131,7 @@ If you'd like to learn more about running `jest` through the command line, take
 Based on your project, Jest will ask you a few questions and will create a basic configuration file with a short description for each option:
 
 ```bash
-jest --init
+yarn create jest
 ```
 
 ### Using Babel

docs/GettingStarted.md

@@ -67,8 +67,8 @@ If you'd like to learn more about running `jest` through the command line, take
 
 Based on your project, Jest will ask you a few questions and will create a basic configuration file with a short description for each option:
 
-```bash
-jest --init
+```bash npm2yarn
+npm init jest@latest
 ```
 
 ### Using Babel

package.json

@@ -111,7 +111,7 @@
     "test": "yarn lint && yarn jest",
     "typecheck": "yarn typecheck:examples && yarn typecheck:tests",
     "typecheck:examples": "tsc -p examples/angular --noEmit && tsc -p examples/expect-extend --noEmit && tsc -p examples/typescript --noEmit",
-    "typecheck:tests": "tsc -b packages/{babel-jest,babel-plugin-jest-hoist,diff-sequences,expect,expect-utils,jest-circus,jest-cli,jest-config,jest-console,jest-snapshot,jest-util,jest-validate,jest-watcher,jest-worker,pretty-format}/**/__tests__",
+    "typecheck:tests": "tsc -b packages/{babel-jest,babel-plugin-jest-hoist,create-jest,diff-sequences,expect,expect-utils,jest-circus,jest-cli,jest-config,jest-console,jest-snapshot,jest-util,jest-validate,jest-watcher,jest-worker,pretty-format}/**/__tests__",
     "verify-old-ts": "node ./scripts/verifyOldTs.mjs",
     "verify-pnp": "node ./scripts/verifyPnP.mjs",
     "watch": "yarn build:js && node ./scripts/watch.mjs",

packages/create-jest/.npmignore

@@ -0,0 +1,8 @@
+**/__mocks__/**
+**/__tests__/**
+__typetests__
+src
+tsconfig.json
+tsconfig.tsbuildinfo
+api-extractor.json
+.eslintcache

packages/create-jest/README.md

@@ -0,0 +1,11 @@
+# create-jest
+
+> Getting started with Jest with a single command
+
+```bash
+npm init jest@latest
+# Or for Yarn
+yarn create jest
+# Or for pnpm
+pnpm create jest
+```

packages/create-jest/bin/create-jest.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+require('..').runCLI();

packages/create-jest/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "create-jest",
+  "description": "Create a new Jest project",
+  "version": "29.6.4",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jestjs/jest.git",
+    "directory": "packages/create-jest"
+  },
+  "license": "MIT",
+  "bin": "./bin/create-jest.js",
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./build/index.d.ts",
+      "default": "./build/index.js"
+    },
+    "./package.json": "./package.json",
+    "./bin/create-jest": "./bin/create-jest.js"
+  },
+  "dependencies": {
+    "@jest/types": "workspace:^",
+    "chalk": "^4.0.0",
+    "exit": "^0.1.2",
+    "graceful-fs": "^4.2.9",
+    "jest-config": "workspace:^",
+    "jest-util": "workspace:^",
+    "prompts": "^2.0.1"
+  },
+  "engines": {
+    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/exit": "^0.1.30",
+    "@types/graceful-fs": "^4.1.3",
+    "@types/prompts": "^2.0.1"
+  }
+}