shaunstanislauslau / majestic Goto Github PK

Majestic is a GUI for Jest

• ✅ Run all the tests or a single file
• ⏱ Toggle watch mode
• 📸 Update snapshots
• ❌ Examine test failures as they happen
• ⏲ Console.log() to the UI for debugging
• 🔍 Search tests
• 💎 Works with flow and typescript projects
• 📦 Works with Create react app

Majestic supports Jest 20 and above

Get started

Run majestic via npx in a project directory

cd ./my-jest-project # go into a project with Jest
npx majestic # execute majestic

or install Majestic globally via Yarn and run majestic

yarn global add majestic # install majestic globally
cd ./my-jest-project # go into a project with Jest
majestic # execute majestic

or install Majestic globally via Npm and run majestic

npm install majestic -g # install majestic globally
cd ./my-jest-project # go into a project with Jest
majestic # execute majestic

Running as an app

Running with the --app flag will launch Majestic as a chrome app.

Optional configuration

You can configure Majestic by adding majestic key to package.json.

// package.json
{
    "majestic": {
        // if majestic fails to find the Jest package, you can provide it here. Should be relative to the package.json
        jestScriptPath: "../node_modules/jest/bin/jest.js",
        // if you want to pass additional arguments to jest, do it here
        args: [],
        // environment variables to pass to the process
        env: {}
    }
}

Arguments

--port - Will use this port if available, else Majestic will pick another free port.

--debug - Will output extra debug info to console. Helps with debugging.

--version - Will print the version of Majestic and will exit

Contribute

Have a look at the contribution guide.

License

MIT

Contributors

Thanks goes to these wonderful people (emoji key):

Duncan Beevers 💻

This project follows the all-contributors specification. Contributions of any kind welcome!