sportnak / mocha-sidebar

Mocha side bar viewer that allows you to run Mocha tests from side bar menu and view results can run each level hierarchy from all tests to a single test(and each describer of course)

Mocha Side Bar

Mocha side bar is the most complete extension for mocha testing based on not maintained mocha extension and supports all of its features and much more

Love this extension? Star us and rate us!

mocha side bar already supports this features

• see all tests in vscode side bar menu
• git lens for running/debbuging directly form the code
• decorations which shows test stauts(pass/fail/not run) from code
• run tests for each level hierarchy from all tests to a single test(and each describer of course)
• debug tests for each level hierarchy from all tests to a single test(and each describer of course)
• auto run tests on file save
• see tests results directly on the code
• run/debug results directly from the code
• see test errors as decoration

not supported yet

• split tests into files separation for the top level hierarchy

feel free to propose new features

Contributors:

• Maty Zisserman
• Yehiyam Livneh

Contributions

Love this extension? Star us and rate us!

Want to make this extension even more awesome? Send us your wish.

Hate how it is working? File an issue to us.

Usage via command Palette

To run Mocha tests:

• Bring up Command Palette (F1, or Ctrl+Shift+P on Windows and Linux, or Shift+CMD+P on OSX)
• Type or select "Mocha: Run all tests" You can run tests by:
• All tests in the workspace
• All or failed tests in last run
• Tests that match a Regular Expression
• Tests that the current cursor position (or the current file)
• One test that you pick from a list

Fit yourself

No one shoe could fit everyone. You may need to turn some switches on to fit your project. Please file us an issue if you think there is a better way to fit you and the others.

Configuring Mocha options

Under File > Preferences > Workspace Settings, you can configure Mocha options, e.g. run in "tdd" mode, detect/ignore leaks, etc.

//-------- Mocha options --------

// Mocha: Options to run Mocha
"mocha.options": {},

// Mocha: Glob to search for test files
"mocha.files.glob": "test/**/*.js",

// Mocha: Globs to ignore when searching for test files
"mocha.files.ignore": [
  "**/.git/**/*",
  "**/node_modules/**/*"
],

//Mocha: run tests on each save
"mocha.runTestsOnSave": {
    "default": "false",
    },

// Mocha: Environment variables to run your tests
"mocha.env": {},

// Mocha: Options to pass to node executable
"mocha.node_options": [],

// Mocha: Subdirectory in the Workspace where run mocha from
"mocha.subfolder": "",

// Mocha: List of files to require before running mocha
"mocha.requires": [],

//Mocha: this option allows you to enable/disable lens decorations and set update threshold "
  "mocha.sideBarOptions": {
          "default": {
            "lens": true, // -> enable/disable lens
            "decoration": true, // -> enable/disable decoration
            "autoUpdateTime": 2000 // -> set timeout between each decorations and lens updates during test writing 
            "showDebugTestStatus": true //-> an option to disable running mocha twice in order to see status on the sidebar
          }
        }
//Mocha: set other mocha path then the built-in one only path to mocha package ../node_modules/mocha  "
 "mocha.path": {
          "default": "",
          "description": "Mocha: set other mocha path then the built-in one for example ../node_modules/mocha (only path to the package)",
          "type": "string"
        },

   "mocha.logVerbose": {
          "default": false,
          "description": "Mocha: mocha package path then the sideBar installed one for example ../node_modules/mocha",
          "type": "boolean"
        },

Q&A

• question - mocha side bar not run on my pc ?
  answer

  • step1 - verify that there is no other mocha runner extension on your pc
  • step2 - try reinstall your vscode

• question - can't run ts-node compiler
  answer

  • step1 - verify that your configuration correct

  "mocha.options": {
  "compilers": {
      "ts": "ts-node/register"
    }
  },
  "mocha.requires": [
      "ts-node/register"
  ],

  • step2 - try to install typescript package locally (not with -g)
    - question - can't run babel-register compiler
    answer - verify that your configuration correct

  "mocha.options": {
  "compilers": {
       "js": "babel-register"
    }
  },
  "mocha.requires": [
      "babel-register"
  ],

• question - all tests not working

  answer - verify that there is no describe or test with the name "test" (should be fix soon)

  if for some reason something is not working for you create issue file us

Setting a keyboard shortcut

To quickly run tests, you can create a keyboard shortcut under File > Preferences > Keyboard Shortcuts. For example, the following JSON will run all tests with CTRL+K followed by R key.

{
  "key": "ctrl+k r",
  "command": "mocha.runAllTests"
}

Following commands are also supported:

Command	Title
mocha.runAllTests	Mocha: Run all tests
mocha.runFailedTests	Mocha: Run failed tests
mocha.runLastSetAgain	Mocha: Run last set again
mocha.runTestAtCursor	Mocha: Run tests matching the current cursor position or the current active file
mocha.runTestsByPattern	Mocha: Run tests matching a pattern
mocha.selectAndRunTest	Mocha: Select and run a test

How it works

By default, this extensions will discover tests by searching for test/**/*.js under your workspace.

Because your tests may requires a newer version of Node.js than the one powering Visual Studio Code, thus, this extension will attempt to find your installed Node.js and use it for your tests. It will search for the installed Node.js as indicated by environmental variable PATH. You can find the logic here.

When the test is being run, we will add NODE_PATH to point to your workspace node_modules folder to help resolving external modules.

When you ask to run the test under cursor position, the extension will parse the current file and look for matching tests or suites. If the file contains tests or suites defined using template strings or via dynamic generation, the regular expression (.+) will be used as a placeholder in order to have a better matching without having to evaluate the file twice. This implies that more tests than expected might be run.