create-codeverse-test

Zero-config CLI that scaffolds a new automated-testing project with Jest from CodeVerse's official template. Run one command, answer two questions, and get a project that is ready for you to write unit tests, mocks and tests for code with external dependencies — with dependencies installed and the folder opened in VS Code.

It does not run your tests, lint your code, or set up CI. Its only job is to create the starting project so you can begin writing tests immediately.

Quick start

npx create-codeverse-test@latest

No global install required.

What the command does

When you run it, the CLI:

1. Asks two questions in an interactive wizard:

   • Project name — lowercase letters, digits and hyphens only (no spaces, cannot start or end with a hyphen, max 214 characters). This becomes the new folder name and the name field in the generated package.json.
   • Test type — Unit or Dependencies (see Test types).

2. Creates a new folder named after your project, inside the current directory, and copies the template into it. If a folder with that name already exists, the CLI stops with an error.

3. Adds mock/dependency examples — only if you picked Dependencies — by merging extra files over the base template (this replaces tests/nome-do-script.test.js with a version that also contains a mocks section).

4. Updates package.json in the generated project, setting its name to your project name.

5. Installs dependencies inside the new folder:

   • always: npm install -D jest@latest jest-html-reporters@latest
   • Dependencies only: npm install axios@latest

   If the install fails, the CLI keeps going and tells you the exact command to run manually.

6. Removes the .git folder that came from the template, so you start with a clean history.

7. Opens the project in VS Code by running code .. If the code command is not on your PATH, it prints the project path so you can open it yourself.

8. Prints the next steps (how to open the integrated terminal and run npm test).

Your tests are never run automatically — you run npm test when the project is ready.

Test types

| Type | Extra install | What changes | | --------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Unit | — | Plain template: just Jest and JavaScript (ES Modules). For testing functions, classes, scenarios, negative cases, boundary values and business rules. | | Dependencies | axios@latest | Adds a describe('Mocks com jest.fn()') block to tests/nome-do-script.test.js covering mockReturnValue, mockResolvedValue, mockRejectedValue, toHaveBeenCalled, toHaveBeenCalledTimes and toHaveBeenCalledWith. Axios is included as the HTTP client for those scenarios (real or mocked API). |

What the generated project contains

• Jest and jest-html-reporters — always the latest version at scaffold time.
• JavaScript with ES Modules ("type": "module", run through --experimental-vm-modules).
• src/nome-do-seu-script.js — a sample function for you to replace.
• tests/nome-do-script.test.js — a teaching suite covering the core matchers (toBe, toEqual, toContain, toBeTruthy, toBeFalsy, toHaveLength, toBeCloseTo), plus the mocks block when you chose Dependencies.
• jest.reporters.config.mjs — Jest config that adds the HTML reporter.
• .gitignore — ignores node_modules/, generated reports and coverage, logs, .env files and editor/OS files.

Scripts in the generated project

| Script | Command | Purpose | | ----------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | npm test | Jest with --runInBand --verbose | Runs the whole suite, one test at a time, with per-test output. | | npm run report | npm test -- --coverage --json --outputFile=coverage/relatorio.json | Runs the suite with coverage and writes a JSON report to coverage/relatorio.json. | | npm run dashboard | npm test -- --config jest.reporters.config.mjs | Runs the suite and generates an HTML report at _html-report/index.html (opens automatically). |

Requirements

• Node.js >= 18.17
• npm
• VS Code with the code command on your PATH — optional; if missing, the CLI just prints the project path for you to open manually.

License

MIT © CodeVerse