#1577 Add "--exclude" Option #3210

alexbainter · 2018-01-18T03:16:38Z

Description of the Change

Adds option --exclude to exclude matched files.
For example, this will match any files ending with "*.spec.js" unless they're inside the "node_modules" directory:

mocha "**/*.spec.js" --exclude "node_modules/**"

This required a small change to bin/mocha.js. As the file arguments are evaluated by mocha, they are checked against the pattern(s) provided by --exclude. Any files matching any of the patterns in --exclude are ignored.

I used minimatch to check the filenames against the patterns. This is the same library used by glob.

As noted in #1577, this isn't strictly necessary. mocha "./{,!(node_modules)/**/}*.spec.js" would have the same effect as above. However, the --exclude option is easier for users who don't speak glob.

Why should this be in core?

Situations like the above example are common. Other tools (like Karma) include this behavior as core functionality.

Benefits

This is easier for users to understand how to exclude specific files or patterns, giving them more granular control over which files are used for testing without having to use complex glob patterns.

Possible Drawbacks

This is probably less performant than using glob patterns, and it's yet another option to support.
(If there is a more performant approach for implementing this behavior I'd be happy to change my code).

Applicable issues

Resolves #1577.
Enhancement.

jsf-clabot · 2018-01-18T03:16:39Z

All committers have signed the CLA.

coveralls · 2018-01-18T03:23:56Z

Coverage increased (+0.05%) to 90.018% when pulling db0d1fd on metalex9:master into 2fe2d01 on mochajs:master.

boneskull

👍 Thanks for this! Great work.

Can you please address these changes?

--exclude should allow itself to be specified multiple times instead of expecting a comma-delimited value
ensure no unnecessary work is being done to check the type of newFiles on L500
move the filter on L503 to chain on the call to utils.lookupFiles() on L489
rename fixtures to have extension .fixture.js
see if you can use runMocha() instead of directInvoke() in options.spec.js

boneskull · 2018-01-19T07:35:30Z

bin/_mocha

@@ -205,7 +206,8 @@ program
  .option('--allow-uncaught', 'enable uncaught errors to propagate')
  .option('--forbid-only', 'causes test marked with only to fail the suite')
  .option('--forbid-pending', 'causes pending tests and test marked with skip to fail the suite')
-  .option('--file <file>', 'include a file to be ran during the suite', collect, []);
+  .option('--file <file>', 'include a file to be ran during the suite', collect, [])
+  .option('--exclude <files>', 'comma-delimited list of files or glob patterns to ignore', list, []);


I would prefer this works like --file above, where it can be provided multiple times.

boneskull · 2018-01-19T17:45:57Z

bin/_mocha

+    if (typeof newFiles === 'string') {
+      newFiles = [newFiles];
+    }
+    newFiles = newFiles.filter(fileName => program.exclude.every(pattern => !minimatch(fileName, pattern)));


you may be able to just chain this (.filter and everything after) to L489.

boneskull · 2018-01-19T17:46:29Z

test/integration/fixtures/options/exclude/fail.spec.js

@@ -0,0 +1,7 @@
+'use strict';


fixture files should all have the extension .fixture.js

boneskull · 2018-01-19T17:50:13Z

test/integration/options.spec.js

+     * Calls handleResult with the result
+     */
+    function runExcludeTest (args, handleResult, done) {
+      directInvoke(args, function (error, result) {


unless there's a Good Reason to use directInvoke(), please use runMocha() instead

boneskull · 2018-01-19T17:51:17Z

bin/_mocha

@@ -494,6 +496,13 @@ args.forEach(arg => {
    throw err;
  }

+  if (typeof newFiles !== 'undefined') {


I don't think newFiles will be anything other than an Array of strings, will it?

newFiles is the result of utils.lookupFiles which can return an array of strings, a string, or undefined.

coveralls · 2018-01-20T04:02:08Z

Coverage increased (+0.05%) to 90.018% when pulling d17863b on metalex9:master into 2fe2d01 on mochajs:master.

alexbainter · 2018-01-20T04:02:13Z

Changes made:

--exclude should allow itself to be specified multiple times instead of expecting a comma-delimited value
rename fixtures to have extension .fixture.js
use runMocha() instead of directInvoke() in options.spec.js

Regarding these two:

ensure no unnecessary work is being done to check the type of newFiles on L500
move the filter on L503 to chain on the call to utils.lookupFiles() on L489

newFiles is returned from utils.lookupFiles. If you look at the definition for lookupFiles in lib/utils.js L477, it looks to me like it could technically return an array of strings (L488, L523), a string (L495), or undefined (L499). Perhaps the documentation for that function needs to be updated?

Thanks for looking at this!

boneskull · 2018-04-01T04:41:53Z

This looks good. Not worried about conflicting with --file, as that doesn't accept a glob.

joaovieira · 2018-04-09T08:57:28Z

@boneskull any idea on when v5.1.0 is gonna be released? This option comes in handy :)

* Add --exclude as option. * Add tests for --exclude option. * Implement --exclude. * Update --exclude description. * Remove old exclude fixture. * Add new exclude fixture. * Fix tests for --exclude option. * Add name to package.contributors. * Filter new files before they're added. * Allow multiple --exclude flags rather than using a comma-delimited list. * Use .fixture extension for exclude fixtures. * Use runMochaJSON (run) instead of of directInvoke.

alexbainter added 9 commits January 17, 2018 17:50

Add --exclude as option.

95aad4f

Add tests for --exclude option.

4dbc972

Implement --exclude.

0790b1c

Update --exclude description.

0316b2d

Remove old exclude fixture.

64684b8

Add new exclude fixture.

9d0aa7f

Fix tests for --exclude option.

87b8ef3

Add name to package.contributors.

5c9547b

Filter new files before they're added.

db0d1fd

alexbainter changed the title ~~#1577 --exclude Option~~ #1577 Add "--exclude" Option Jan 18, 2018

boneskull suggested changes Jan 19, 2018

View reviewed changes

boneskull added semver-minor implementation requires increase of "minor" version number; "features" type: feature enhancement proposal labels Jan 19, 2018

alexbainter added 3 commits January 19, 2018 21:17

Allow multiple --exclude flags rather than using a comma-delimited list.

88a98ad

Use .fixture extension for exclude fixtures.

aa307f8

Use runMochaJSON (run) instead of of directInvoke.

d17863b

boneskull approved these changes Apr 1, 2018

View reviewed changes

boneskull added the area: node.js command-line-or-Node.js-specific label Apr 1, 2018

boneskull merged commit 8e740c5 into mochajs:master Apr 1, 2018

boneskull added this to the v5.1.0 milestone Apr 1, 2018

yujiosaka mentioned this pull request Apr 7, 2018

Separately run redis cache test yujiosaka/headless-chrome-crawler#205

Merged

joaovieira mentioned this pull request Apr 9, 2018

Fix browser tests (Karma + Webpack setup). react-dates/react-dates#1109

Merged

dependencies bot mentioned this pull request Apr 13, 2018

Update 2 dependencies from npm JetBrains/ring-ui#216

Merged

renovate bot mentioned this pull request Apr 17, 2018

Update dependency mocha to v5 Urigo/tortilla#64

Merged

This was referenced Nov 1, 2018

Update dependency mocha to v5 justinbarry/augur-copy#93

Merged

chore(deps): update dependency mocha to v5 mike-north/ember-qunit-decorators#37

Merged

chore(deps): update dependency @types/mocha to v5 mike-north/jsonapi-typescript#15

Merged

This was referenced Nov 9, 2018

chore(deps): update dependency mocha to v5 mike-works/techcheck-server#15

Merged

chore(deps): update dependency mocha to v5 - autoclosed typed-ember/ember-cli-tslint#29

Closed

Update dependency mocha to v5 hairyhenderson/nursery_alert#17

Merged

This was referenced Nov 19, 2018

fix(deps): update dependency @types/mocha to v5 - autoclosed stefanwalther/boilerplate-typescript-rest-docker#18

Closed

chore(deps): update dependency mocha to v5 JLHwung/tianzige#37

Merged

This was referenced Dec 1, 2018

chore(deps): update dependency mocha to v5 - autoclosed stefanwalther/qix-graphql#66

Closed

Update dependency mocha to v5 softbrix/stureby-index#4

Merged

Update dependency mocha to v5 Automattic/jetpack#10877

Merged

This was referenced Dec 23, 2018

Update dependency mocha to v5 - autoclosed mateodelnorte/microsvc-slave#7

Closed

chore(deps): update dependency mocha to v5 status-board/status-board-cli#175

Closed

This was referenced Mar 14, 2020

[Snyk] Upgrade mocha from 5.0.5 to 5.2.0 postmanlabs/raml1-to-postman#28

Closed

[Snyk] Upgrade mocha from 5.0.3 to 5.2.0 postmanlabs/postman-code-generators#214

Closed

[Snyk] Upgrade mocha from 5.0.1 to 5.2.0 postmanlabs/postman-sandbox#530

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#1577 Add "--exclude" Option #3210

#1577 Add "--exclude" Option #3210

alexbainter commented Jan 18, 2018 •

edited

jsf-clabot commented Jan 18, 2018 •

edited

coveralls commented Jan 18, 2018

boneskull left a comment

boneskull Jan 19, 2018

boneskull Jan 19, 2018

boneskull Jan 19, 2018

boneskull Jan 19, 2018

boneskull Jan 19, 2018

alexbainter Jan 20, 2018 •

edited

coveralls commented Jan 20, 2018

alexbainter commented Jan 20, 2018

boneskull commented Apr 1, 2018

joaovieira commented Apr 9, 2018

#1577 Add "--exclude" Option #3210

#1577 Add "--exclude" Option #3210

Conversation

alexbainter commented Jan 18, 2018 • edited

Description of the Change

Why should this be in core?

Benefits

Possible Drawbacks

Applicable issues

jsf-clabot commented Jan 18, 2018 • edited

coveralls commented Jan 18, 2018

boneskull left a comment

Choose a reason for hiding this comment

boneskull Jan 19, 2018

Choose a reason for hiding this comment

boneskull Jan 19, 2018

Choose a reason for hiding this comment

boneskull Jan 19, 2018

Choose a reason for hiding this comment

boneskull Jan 19, 2018

Choose a reason for hiding this comment

boneskull Jan 19, 2018

Choose a reason for hiding this comment

alexbainter Jan 20, 2018 • edited

Choose a reason for hiding this comment

coveralls commented Jan 20, 2018

alexbainter commented Jan 20, 2018

boneskull commented Apr 1, 2018

joaovieira commented Apr 9, 2018

alexbainter commented Jan 18, 2018 •

edited

jsf-clabot commented Jan 18, 2018 •

edited

alexbainter Jan 20, 2018 •

edited