eslint-plugin-jest 1.0.1 → 19.0.1

package/.npmignore

@@ -1 +1,3 @@
-node_modules/
+**/__mocks__/**
+**/__tests__/**
+src

package/README.md

@@ -5,7 +5,7 @@ Eslint plugin for Jest
 ## Installation
 
 ```
-$ yarn install eslint eslint-plugin-jest --dev
+$ yarn add --dev eslint eslint-plugin-jest
 ```
 
 **Note:** If you installed ESLint globally then you must also install `eslint-plugin-jest` globally.
@@ -28,17 +28,50 @@ Then configure the rules you want to use under the rules section.
 ```json
 {
   "rules": {
-    "jest/no-exclusive-tests": 2,
-    "jest/no-identical-title": 2
+    "jest/no-disabled-tests": "warn",
+    "jest/no-focused-tests": "error",
+    "jest/no-identical-title": "error",
+  }
+}
+```
+
+You can also whitelist the environment variables provided by Jest by doing:
+
+```json
+{
+  "env": {
+    "jest/globals": true
   }
 }
 ```
 
 ## Supported Rules
 
-- [no-exclusive-tests](docs/rules/no-exclusive-tests.md) - disallow exclusive tests.
+- [no-disabled-tests](docs/rules/no-disabled-tests.md) - disallow disabled tests.
+- [no-focused-tests](docs/rules/no-focused-tests.md) - disallow focused tests.
 - [no-identical-title](docs/rules/no-identical-title.md) - disallow identical titles.
 
+## Shareable configurations
+
+### Recommended
+
+This plugin exports a recommended configuration that enforces good testing practices.
+
+To enable this configuration use the `extends` property in your `.eslintrc` config file:
+
+```js
+{
+  "extends": ["plugin:jest/recommended"]
+}
+```
+
+See [ESLint documentation](http://eslint.org/docs/user-guide/configuring#extending-configuration-files) for more information about extending configuration files.
+
+The rules enabled in this configuration are:
+
+- [jest/no-disabled-tests](docs/rules/no-disabled-tests.md)
+- [jest/no-focused-tests](docs/rules/no-focused-tests.md)
+- [jest/no-identical-title](docs/rules/no-identical-title.md)
 
 ## Credit
 

package/build/index.js

@@ -0,0 +1,48 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ * 
+ */
+
+'use strict';
+
+module.exports = {
+  configs: {
+    recommended: {
+      rules: {
+        'jest/no-disabled-tests': 'warn',
+        'jest/no-focused-tests': 'error',
+        'jest/no-identical-title': 'error' } } },
+
+
+
+  environments: {
+    globals: {
+      globals: {
+        afterAll: false,
+        afterEach: false,
+        beforeAll: false,
+        beforeEach: false,
+        describe: false,
+        expect: false,
+        fit: false,
+        it: false,
+        jasmine: false,
+        jest: false,
+        pit: false,
+        require: false,
+        test: false,
+        xdescribe: false,
+        xit: false,
+        xtest: false } } },
+
+
+
+  rules: {
+    'no-disabled-tests': require('./rules/no-disabled-tests'),
+    'no-focused-tests': require('./rules/no-focused-tests'),
+    'no-identical-title': require('./rules/no-identical-title') } };

package/build/rules/no-disabled-tests.js

@@ -0,0 +1,64 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ * 
+ */
+'use strict';
+
+
+
+/* $FlowFixMe */
+const testFunctions = Object.assign(Object.create(null), {
+  describe: true,
+  it: true,
+  test: true });
+
+
+const matchesTestFunction = object => object && testFunctions[object.name];
+
+const isCallToSkippedTestFunction = object =>
+object &&
+object.name[0] === 'x' &&
+testFunctions[object.name.substring(1)];
+
+
+const isPropertyNamedSkip = property =>
+property && (property.name === 'skip' || property.value === 'skip');
+
+const isCallToTestSkipFunction = callee =>
+matchesTestFunction(callee.object) && isPropertyNamedSkip(callee.property);
+
+
+module.exports = context => ({
+  CallExpression(node) {
+    const callee = node.callee;
+    if (!callee) {
+      return;
+    }
+
+    if (
+    callee.type === 'MemberExpression' &&
+    isCallToTestSkipFunction(callee))
+    {
+      context.report({
+        message: 'Unexpected disabled test.',
+        node: callee.property });
+
+      return;
+    }
+
+    if (
+    callee.type === 'Identifier' &&
+    isCallToSkippedTestFunction(callee))
+    {
+      context.report({
+        message: 'Unexpected disabled test.',
+        node: callee });
+
+      return;
+    }
+  } });

package/build/rules/no-focused-tests.js

@@ -0,0 +1,64 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ * 
+ */
+'use strict';
+
+
+
+/* $FlowFixMe */
+const testFunctions = Object.assign(Object.create(null), {
+  describe: true,
+  it: true,
+  test: true });
+
+
+const matchesTestFunction = object => object && testFunctions[object.name];
+
+const isCallToFocusedTestFunction = object =>
+object &&
+object.name[0] === 'f' &&
+testFunctions[object.name.substring(1)];
+
+
+const isPropertyNamedOnly = property =>
+property && (property.name === 'only' || property.value === 'only');
+
+const isCallToTestOnlyFunction = callee =>
+matchesTestFunction(callee.object) && isPropertyNamedOnly(callee.property);
+
+
+module.exports = context => ({
+  CallExpression(node) {
+    const callee = node.callee;
+    if (!callee) {
+      return;
+    }
+
+    if (
+    callee.type === 'MemberExpression' &&
+    isCallToTestOnlyFunction(callee))
+    {
+      context.report({
+        message: 'Unexpected focused test.',
+        node: callee.property });
+
+      return;
+    }
+
+    if (
+    callee.type === 'Identifier' &&
+    isCallToFocusedTestFunction(callee))
+    {
+      context.report({
+        message: 'Unexpected focused test.',
+        node: callee });
+
+      return;
+    }
+  } });

package/build/rules/no-identical-title.js

@@ -0,0 +1,115 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ * 
+ */
+'use strict';
+
+
+
+/* $FlowFixMe */
+const describeAliases = Object.assign(Object.create(null), {
+  'describe': true,
+  'describe.only': true,
+  'describe.skip': true,
+  'fdescribe': true,
+  'xdescribe': true });
+
+
+/* $FlowFixMe */
+const testCaseNames = Object.assign(Object.create(null), {
+  'fit': true,
+  'it': true,
+  'it.only': true,
+  'it.skip': true,
+  'test': true,
+  'test.only': true,
+  'test.skip': true,
+  'xit': true,
+  'xtest': true });
+
+
+const getNodeName = node => {
+  if (node.type === 'MemberExpression') {
+    return node.object.name + '.' + node.property.name;
+  }
+  return node.name;
+};
+
+const isDescribe = node =>
+node &&
+node.type === 'CallExpression' &&
+describeAliases[getNodeName(node.callee)];
+
+
+const isTestCase = node =>
+node &&
+node.type === 'CallExpression' &&
+testCaseNames[getNodeName(node.callee)];
+
+
+const newDescribeContext = () => ({
+  describeTitles: [],
+  testTitles: [] });
+
+
+const handleTestCaseTitles = (context, titles, node, title) => {
+  if (isTestCase(node)) {
+    if (titles.indexOf(title) !== -1) {
+      context.report({
+        message: 'Test title is used multiple times in the same test suite.',
+        node });
+
+    }
+    titles.push(title);
+  }
+};
+
+const handleTestSuiteTitles = (context, titles, node, title) => {
+  if (!isDescribe(node)) {
+    return;
+  }
+  if (titles.indexOf(title) !== -1) {
+    context.report({
+      message: 'Test suite title is used multiple times.',
+      node });
+
+  }
+  titles.push(title);
+};
+
+const isFirstArgLiteral = node =>
+node.arguments &&
+node.arguments[0] &&
+node.arguments[0].type === 'Literal';
+
+
+module.exports = context => {
+  const contexts = [
+  newDescribeContext()];
+
+  return {
+    CallExpression(node) {
+      const currentLayer = contexts[contexts.length - 1];
+      if (isDescribe(node)) {
+        contexts.push(newDescribeContext());
+      }
+      if (!isFirstArgLiteral(node)) {
+        return;
+      }
+
+      const title = node.arguments[0].value;
+      handleTestCaseTitles(context, currentLayer.testTitles, node, title);
+      handleTestSuiteTitles(context, currentLayer.describeTitles, node, title);
+    },
+    'CallExpression:exit'(node) {
+      if (isDescribe(node)) {
+        contexts.pop();
+      }
+    } };
+
+};

package/docs/rules/no-disabled-tests.md

@@ -0,0 +1,33 @@
+# Disallow Disabled Tests (no-disabled-tests)
+
+Jest has a feature that allows you to skip tests by appending `.skip` or prepending `x` to a test-suite or a test-case.
+Sometimes tests are skipped as part of a debugging process and aren't intended to be committed. This rule reminds you to remove .skip or the x prefix from your tests.
+
+## Rule Details
+
+This rule looks for every `describe.skip`, `it.skip`, `test.skip`, `xdescribe`, `xit` and `xtest` occurrences within the source code.
+
+The following patterns are considered warnings:
+
+```js
+describe.skip("foo", function () {});
+it.skip("foo", function () {});
+describe["skip"]("bar", function () {});
+it["skip"]("bar", function () {});
+test.skip("foo", function () {});
+test["skip"]("bar", function () {});
+xdescribe("foo", function () {});
+xit("foo", function () {});
+xtest("bar", function () {});
+```
+
+These patterns would not be considered warnings:
+
+```js
+describe("foo", function () {});
+it("foo", function () {});
+describe.only("bar", function () {});
+it.only("bar", function () {});
+test("foo", function () {});
+test.only("bar", function () {});
+```

package/docs/rules/{no-exclusive-tests.md → no-focused-tests.md}

@@ -1,6 +1,6 @@
-# Disallow Exclusive Tests (no-exclusive-tests)
+# Disallow Focused Tests (no-focused-tests)
 
-Jest has a feature that allows you to run tests exclusively by appending `.only` or prepending `f` to a test-suite or a test-case.
+Jest has a feature that allows you to focus tests by appending `.only` or prepending `f` to a test-suite or a test-case.
 This feature is really helpful to debug a failing test, so you don’t have to execute all of your tests.
 After you have fixed your test and before committing the changes you have to remove `.only` to ensure all tests are executed on your build system.
 

package/package.json

@@ -1,31 +1,24 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "1.0.1",
+  "version": "19.0.1",
   "description": "Eslint rules for Jest",
   "keywords": [
     "eslint",
     "eslintplugin",
     "eslint-plugin"
   ],
-  "author": "Jonathan Kim",
-  "main": "lib/index.js",
-  "scripts": {
-    "preinstall": "if [[ $npm_execpath != *'yarn.js'* ]]; then echo 'ERROR: Use yarn to install dependencies: `npm install -g yarn && yarn` (https://yarnpkg.com)' && exit 1; fi",
-    "test": "jest"
+  "author": {
+    "name": "Jonathan Kim",
+    "email": "hello@jkimbo.com",
+    "url": "jkimbo.com"
   },
-  "dependencies": {},
-  "devDependencies": {
-    "eslint": "^3.9.0",
-    "eslint-config-airbnb-base": "^9.0.0",
-    "eslint-plugin-import": "^2.1.0",
-    "jest": "^16.0.2"
-  },
-  "engines": {
-    "node": ">=0.10.0"
-  },
-  "license": "ISC",
   "repository": {
     "type": "git",
-    "url": "https://github.com/jkimbo/eslint-plugin-jest.git"
-  }
+    "url": "https://github.com/facebook/jest.git"
+  },
+  "main": "build/index.js",
+  "peerDependencies": {
+    "eslint": ">=3.6"
+  },
+  "license": "BSD-3-Clause"
 }

package/.eslintrc

@@ -1,28 +0,0 @@
-{
-  "env": {
-    "node": true
-  },
-
-  "parserOptions": {
-    ecmaVersion: 2016,
-    sourceType: 'commonjs',
-  },
-
-  "extends": "airbnb-base",
-
-  "rules": {
-    "comma-dangle": 0,
-    "func-names": 0,
-    "lines-around-directive": 0,
-    "no-var": 0,
-    "object-shorthand": 0,
-    "prefer-template": 0,
-    "space-before-function-paren": 0,
-    "vars-on-top": 0,
-
-    "import/no-extraneous-dependencies": ["error", {
-      devDependencies: true,
-      optionalDependencies: false,
-    }],
-  }
-}

package/lib/index.js

@@ -1,11 +0,0 @@
-/* eslint-disable global-require */
-/**
- * @fileoverview Eslint plugin for Jest
- * @author Jonathan Kim
- */
-'use strict';
-
-module.exports.rules = {
-  'no-exclusive-tests': require('./rules/no-exclusive-tests'),
-  'no-identical-title': require('./rules/no-identical-title'),
-};

package/lib/rules/__tests__/no-exclusive-tests.js

@@ -1,55 +0,0 @@
-'use strict';
-
-var RuleTester = require('eslint').RuleTester;
-var rules = require('../../').rules;
-
-var ruleTester = new RuleTester();
-var expectedErrorMessage = 'Unexpected exclusive test.';
-
-ruleTester.run('no-exclusive-tests', rules['no-exclusive-tests'], {
-  valid: [
-    'describe()',
-    'it()',
-    'describe.skip()',
-    'it.skip()',
-    'test()',
-    'test.skip()',
-    'var appliedOnly = describe.only; appliedOnly.apply(describe)',
-    'var calledOnly = it.only; calledOnly.call(it)',
-  ],
-
-  invalid: [
-    {
-      code: 'describe.only()',
-      errors: [{ message: expectedErrorMessage, column: 10, line: 1 }]
-    },
-    {
-      code: 'describe["only"]()',
-      errors: [{ message: expectedErrorMessage, column: 10, line: 1 }]
-    },
-    {
-      code: 'it.only()',
-      errors: [{ message: expectedErrorMessage, column: 4, line: 1 }]
-    },
-    {
-      code: 'it["only"]()',
-      errors: [{ message: expectedErrorMessage, column: 4, line: 1 }]
-    },
-    {
-      code: 'test.only()',
-      errors: [{ message: expectedErrorMessage, column: 6, line: 1 }]
-    },
-    {
-      code: 'test["only"]()',
-      errors: [{ message: expectedErrorMessage, column: 6, line: 1 }]
-    },
-    {
-      code: 'fdescribe()',
-      errors: [{ message: expectedErrorMessage, column: 1, line: 1 }]
-    },
-    {
-      code: 'fit()',
-      errors: [{ message: expectedErrorMessage, column: 1, line: 1 }]
-    },
-  ]
-});