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

dj-stormtrooper · 2023-08-27T08:45:11Z

Summary

Jest already has jest --init wizard which makes initial setup very fancy, but it doesn't have starter-kit wrapper for package managers, like npm init or yarn create

Details in this issue

Test plan

I checked the approach on my own package on yarn, npm, pnpm (see usage in create-jest readme), but I don't have access to create-jest package, so I'm not able to test it completely

But just in case I also checked JS-API of the packed package like this

//index.js
require(`create-jest`)

// package.json
{
...
    "create-jest": "../jest/packages/create-jest/package.tgz",
...
}

// in terminal
node index.js

Also not sure if it's worth to add e2e for this package, please ping me if it is 🙂

netlify · 2023-08-27T08:45:16Z

✅ Deploy Preview for jestjs ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`9e3ddfa`
🔍 Latest deploy log	https://app.netlify.com/sites/jestjs/deploys/64f991f9f02bfc00085d1691
😎 Deploy Preview	https://deploy-preview-14453--jestjs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

mrazauskas · 2023-08-27T09:35:34Z

packages/create-jest/package.json

+    "./bin/create-jest": "./bin/create-jest.js"
+  },
+  "dependencies": {
+    "jest-cli": "workspace:^"


This means that the whole Jest with all its dependencies will be pulled? Or? I would expect the create- package to be a lightweight script. Did I miss something?

Perhaps it makes sense to move the whole logic to the new package and deprecate the --init flag in Jest 30?

This means that the whole Jest with all its dependencies will be pulled? Or? I would expect the create- package to be a lightweight script. Did I miss something?

I was thinking about standardised global wrapper for the initialisation (adapter for npx jest --init). For this purpose whole jest-cli is not necessary indeed.

Perhaps it makes sense to move the whole logic to the new package and deprecate the --init flag in Jest 30?

Sounds fine, or maybe we can reverse the dependencies and use create-jest inside jest-cli to keep the API the same

In this case create-jest would get shipped with jest. I was thinking a new package like @jest/init could be introduced, but that requires major release as well. Other question, is there a need to have the --init command if create-jest gets introduced? By the way, moving the whole --init logic to create-jest would make jest leaner (e.g. only create-jest would ship prompts as dependency, if I didn’t miss something).

One more idea, I think for now it would be fine to copy the code to create-jest and in jest-cli it could be marked with // TODO Remove in Jest 30 comment.

That's right. It can reused, I agree.

To summarize: in addition to this

This PR will move the entirety of the --init command implementation into this new package

jest-cli will then have a dependency on create-jest, and delegate to it when jest --init is called

A separate PR will be prepared for v30 (I'll add it to the milestone so we don't forget) which deprecates --init and removes the dependency

we are also adding [rootPath] to JS and CLI API, right?

we are also adding [rootPath] to JS and CLI API, right?

How do you feel? I find it useful, but can be implemented later.

Yeah, I think that's fine. --init will default to process.cwd(), but I do think it makes sense as part of the API

How do you feel? I find it useful, but can be implemented later.

I also find it useful, makes sense to do it here I think, it's not that hard

…te-jest-package

dj-stormtrooper · 2023-08-30T22:12:58Z

packages/create-jest/src/types.ts

@@ -17,7 +17,7 @@ export type PromptsResults = {
  useTypescript: boolean;
  clearMocks: boolean;
  coverage: boolean;
-  coverageProvider: boolean;
-  environment: boolean;
+  coverageProvider: string;


Sorry for the extra diff, I had to fix tslint errors in this package. jest-cli code was ignored, but new package name ends with jest and it matches the condition in tslint script 😄

I decided to do a good thing and fix the errors instead of excluding the package from the script

dj-stormtrooper · 2023-08-30T22:20:10Z

I'll prepare separate PR with --init deprecation and docs update once this PR is released

mrazauskas

Thanks! Left few quick notes.

Could you add create-jest to this list, please:

jest/package.json

Line 114 in f2c78d0

    
           "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__",

jest-cli is there already, test files did not change, so the typecheck should pass.

packages/create-jest/package.json

mrazauskas · 2023-08-31T03:29:35Z

packages/create-jest/src/runCreate.ts

 import * as fs from 'graceful-fs';
 import prompts = require('prompts');
+import yargs = require('yargs');


Just thinking out loud: it feels too much to ship yargs with this package. I think process.argv[2] would be to do the job. The value will be always string | undefined.

Currently this package is 15.5 kB (unpacked). yargs takes 292 kB (unpacked, without dependencies). That’s what npm gave to me.

Sounds fair, I think keeping this package light is more important than having universal parsing for arguments and --help interface

mrazauskas · 2023-08-31T03:36:40Z

packages/create-jest/src/runCreate.ts

@@ -58,7 +88,7 @@ export default async function init(
    fs.existsSync(path.join(rootDir, getConfigFilename(ext))),
  );

-  if (hasJestProperty || existingJestConfigExt) {
+  if (hasJestProperty || Boolean(existingJestConfigExt)) {


Suggested change

if (hasJestProperty || Boolean(existingJestConfigExt)) {

if (hasJestProperty || existingJestConfigExt != null) {

mrazauskas · 2023-08-31T03:37:02Z

packages/create-jest/src/runCreate.ts

-    ? getConfigFilename(existingJestConfigExt)
-    : path.join(rootDir, getConfigFilename(jestConfigFileExt));
+  const jestConfigPath =
+    typeof existingJestConfigExt !== 'undefined'


Suggested change

typeof existingJestConfigExt !== 'undefined'

existingJestConfigExt != null

mrazauskas · 2023-08-31T03:39:00Z

packages/create-jest/src/runCreate.ts

 ): Promise<void> {
+  rootDir = tryRealpath(rootDir);
  // prerequisite checks
  const projectPackageJsonPath: string = path.join(rootDir, PACKAGE_JSON);


Interesting why ESLint did not catch this:

Suggested change

const projectPackageJsonPath: string = path.join(rootDir, PACKAGE_JSON);

const projectPackageJsonPath = path.join(rootDir, PACKAGE_JSON);

packages/create-jest/src/runCreate.ts

mrazauskas · 2023-08-31T03:42:12Z

packages/create-jest/src/runCreate.ts

 import * as fs from 'graceful-fs';
 import prompts = require('prompts');
+import yargs = require('yargs');
+import {getVersion} from '@jest/core';


Importing @jest/core will ship almost the whole Jest with create-jest. Not sure if that is worth.

mrazauskas · 2023-08-31T03:50:33Z

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

+ * LICENSE file in the root directory of this source tree.
+ */
+
+const importLocal = require('import-local');


Hm.. import-local is not included in dependencies list?

Also not so sure if import-local is needed in this case. It does not make sense installing create-jest locally. To be honest, I don’t understand what import-local does ;D So it can be I missed something.

I'm ok with removing that, local installation indeed seems strange in this case

mrazauskas · 2023-08-31T05:27:11Z

packages/create-jest/src/runCreate.ts

+  try {
+    const argv = await yargs(process.argv.slice(2))
+      .usage('Usage: $0 [rootDir]')
+      .version(getVersion())


If it is decided to keep yargs, this should be create-jest version. It will be used by create-jest --version, or?

Removed yargs to keep package lighter

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

…/jest into feat/create-jest-package

mrazauskas

Thanks! Looks alright for me.

Not very happy to see runCLI() function being exported, but I understand that there are some limitation since --init has to reuse the logic. This can be cleanup up in the future.

mrazauskas · 2023-09-02T04:37:59Z

Just a detail, there is no mention of create-jest in the documentation website.

Hm.. Hard to say where it belongs. Does it make sense to suggest create-jest in the places where the --init flag is mentioned? No sure. Might be better to leave this change for Jest 30 release.

Perhaps for now create-jest could be mentioned in the Jest Platform page? (Also not sure, this is list of tools which can be used outside of Jest. The Getting Started page might be the best place.)

SimenB · 2023-09-02T07:45:12Z

Just a detail, there is no mention of create-jest in the documentation website.

Hm.. Hard to say where it belongs. Does it make sense to suggest create-jest in the places where the --init flag is mentioned? No sure. Might be better to leave this change for Jest 30 release.

Perhaps for now create-jest could be mentioned in the Jest Platform page? (Also not sure, this is list of tools which can be used outside of Jest. The Getting Started page might be the best place.)

"Getting Started" makes the most sense to me

dj-stormtrooper · 2023-09-02T07:50:00Z

Not very happy to see runCLI() function being exported

@mrazauskas I also don't like it, actually we don't need it in jest-init, but if we don't expose it with index.ts then bin/create-jest.js needs to know where the distribution files are stored (which actually might not as bad as exposing unnecessary function to JS API)

So I can remove the export, but in bin executable instead of require('..').runCLI(); it should be this:
require('../build/runCreate').runCLI();

mrazauskas · 2023-09-02T08:25:40Z

packages/create-jest/src/errors.ts

@@ -18,7 +18,7 @@ export class MalformedPackageJsonError extends Error {
  constructor(packageJsonPath: string) {
    super(
      `There is malformed json in ${packageJsonPath}\n` +
-        'Fix it, and then run "jest --init"',
+        'Fix it, and then run "create-jest" again',


Good catch! I'm just not sure if the new suggestion is right. People using --init will see it too, right? Also user does not run create-jest directly. Hm.. Perhaps it's enough to say that the file is malformed?

Sounds good, thanks for the idea!

dj-stormtrooper · 2023-09-02T08:38:38Z

BTW I updated this section in Getting started

mrazauskas · 2023-09-02T08:50:45Z

Does it manage to generate commands for Yarn Classic and Yarn Berry? I'm on mobile and can't remember the details, but the commands are different.

Perhaps npx create-jest is enough for all use cases?

dj-stormtrooper · 2023-09-02T10:32:45Z

Does it manage to generate commands for Yarn Classic and Yarn Berry? I'm on mobile and can't remember the details, but the commands are different.

Perhaps npx create-jest is enough for all use cases?

Seems to be ok, though they don't mention it in docs explicitly:

But I'm ok with any option if package manager initialisers don't look cool to you

mrazauskas · 2023-09-02T12:39:18Z

Right, it works. See: yarnpkg/berry#1138

dj-stormtrooper · 2023-09-04T20:42:52Z

Right, it works. See: yarnpkg/berry#1138

Great!

Do we need to add something else here (except for changelog update)?
I think since all comments are resolved, it is good to go 🙂

mrazauskas

Thanks. I'm happy with everything.

dj-stormtrooper · 2023-09-07T06:50:55Z

I updated the changelog with the new package

SimenB

great stuff, thanks!

packages/create-jest/src/generateConfigFile.ts

mrazauskas · 2023-09-07T07:54:15Z

Reference regarding the CI failures on Node.js 20.6: nodejs/node#49497

cpojer · 2023-09-07T09:44:18Z

Very cool, thanks for building this!

SimenB · 2023-09-12T06:54:16Z

https://github.com/jestjs/jest/releases/tag/v29.7.0

github-actions · 2023-10-13T00:08:26Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

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

30e957f

dj-stormtrooper added 3 commits August 27, 2023 12:47

fix: Updated yarn.lock

5b580b1

feat: Add typescript API

e804edb

fix: Prettier error

546db25

mrazauskas reviewed Aug 27, 2023

View reviewed changes

SimenB linked an issue Aug 29, 2023 that may be closed by this pull request

[Feature]: Add npm init / yarn create initialiser #14432

Closed

dj-stormtrooper added 5 commits August 30, 2023 21:17

Merge branch 'main' of github.com:dj-stormtrooper/jest into feat/crea…

e503b28

…te-jest-package

feat: Move config initialisation logic to create-jest package

0ffab46

fix: Eslint errors

df988bf

feat: Add rootDir to create-jest CLI API

92db787

fix: Typesafe values operators for create-jest package

66384ac

dj-stormtrooper commented Aug 30, 2023

View reviewed changes

dj-stormtrooper added 2 commits August 31, 2023 02:15

fix: Extra diff

e8d2043

fix: Remove redundant file

d160788

dj-stormtrooper requested review from SimenB and mrazauskas August 30, 2023 22:18

mrazauskas reviewed Aug 31, 2023

View reviewed changes

dj-stormtrooper and others added 9 commits August 31, 2023 10:51

Update packages/create-jest/src/runCreate.ts

c9b4ecb

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

fix: Shortcut for nullable values check

b126c72

chore: Add create-jest to typecheck tests configuration

7b366be

fix: Remove unnecessary type declaration

0e9aed8

fix: Remove unnecessary local check

48b3d1d

fix: Remove bin from exports

bbae051

fix: Remove extra CLI interface

0b4ea0f

fix: Restore bin export

8fe5b8d

Merge branch 'feat/create-jest-package' of github.com:dj-stormtrooper…

810fec8

…/jest into feat/create-jest-package

mrazauskas approved these changes Sep 2, 2023

View reviewed changes

fix: New package name in error message

513ad24

docs: Add create-jest usage

dedea5f

mrazauskas reviewed Sep 2, 2023

View reviewed changes

fix: More generic error message for malformed json in create-jest

8ae6c55

mrazauskas approved these changes Sep 5, 2023

View reviewed changes

dj-stormtrooper and others added 2 commits September 7, 2023 10:43

Merge branch 'main' into feat/create-jest-package

8ca2c6a

docs: Add create-jest to the changelog

77adb36

SimenB approved these changes Sep 7, 2023

View reviewed changes

packages/create-jest/src/generateConfigFile.ts Outdated Show resolved Hide resolved

SimenB added 3 commits September 7, 2023 10:14

Update packages/create-jest/src/generateConfigFile.ts

0dcf317

purdy

cc0e430

strict

9e3ddfa

SimenB force-pushed the feat/create-jest-package branch from f24ea7f to 9e3ddfa Compare September 7, 2023 09:03

SimenB merged commit 0b0cf73 into jestjs:main Sep 7, 2023

dj-stormtrooper mentioned this pull request Sep 7, 2023

chore(jest-cli): Deprecation of the --init argument #14490

Merged

ms-bot mentioned this pull request Oct 2, 2023

chore(deps): bump 🧳 jest to ^29.7.0 mobsuccess-devops/github-actions-packagejsonlint#24

Draft

github-actions bot locked as resolved and limited conversation to collaborators Oct 13, 2023

	if (hasJestProperty \|\| Boolean(existingJestConfigExt)) {
	if (hasJestProperty \|\| existingJestConfigExt != null) {

	typeof existingJestConfigExt !== 'undefined'
	existingJestConfigExt != null

	const projectPackageJsonPath: string = path.join(rootDir, PACKAGE_JSON);
	const projectPackageJsonPath = path.join(rootDir, PACKAGE_JSON);

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

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

Conversation

dj-stormtrooper commented Aug 27, 2023 • edited Loading

Summary

Test plan

netlify bot commented Aug 27, 2023 • edited Loading

✅ Deploy Preview for jestjs ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dj-stormtrooper Aug 30, 2023 • edited Loading

Choose a reason for hiding this comment

dj-stormtrooper commented Aug 30, 2023

mrazauskas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mrazauskas Aug 31, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mrazauskas Aug 31, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mrazauskas left a comment

Choose a reason for hiding this comment

mrazauskas commented Sep 2, 2023 • edited Loading

SimenB commented Sep 2, 2023

dj-stormtrooper commented Sep 2, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dj-stormtrooper commented Sep 2, 2023

mrazauskas commented Sep 2, 2023

dj-stormtrooper commented Sep 2, 2023 • edited Loading

mrazauskas commented Sep 2, 2023

dj-stormtrooper commented Sep 4, 2023

mrazauskas left a comment

Choose a reason for hiding this comment

dj-stormtrooper commented Sep 7, 2023

SimenB left a comment

Choose a reason for hiding this comment

mrazauskas commented Sep 7, 2023

cpojer commented Sep 7, 2023

SimenB commented Sep 12, 2023

github-actions bot commented Oct 13, 2023

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

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

dj-stormtrooper commented Aug 27, 2023 •

edited

Loading

netlify bot commented Aug 27, 2023 •

edited

Loading

dj-stormtrooper Aug 30, 2023 •

edited

Loading

mrazauskas Aug 31, 2023 •

edited

Loading

mrazauskas Aug 31, 2023 •

edited

Loading

mrazauskas commented Sep 2, 2023 •

edited

Loading

dj-stormtrooper commented Sep 2, 2023 •

edited

Loading