eslint-plugin-jest-formatting 0.1.0 → 1.2.0

package/.eslintrc

@@ -4,14 +4,14 @@
     "sourceType": "module"
   },
   "plugins": ["jest-formatting", "jest"],
-  "rules": {
-    "jest-formatting/padding-before-test-blocks": 2,
-    "jest-formatting/padding-before-describe-blocks": 2
-  },
   "env": {
     "jest/globals": true
   },
-  "extends": ["airbnb-base", "plugin:prettier/recommended"],
+  "extends": [
+    "airbnb-base",
+    "plugin:prettier/recommended",
+    "plugin:jest-formatting/recommended"
+  ],
   "overrides": [
     {
       "files": ["**.*"],

package/CHANGELOG.md

@@ -1,20 +1,42 @@
 # Changelog
 
+## v1.1.0 - August 14, 2019
+
+### Changed
+
+- Removed `padding-around-expect-groups` from the "recommended" set of rules.
+
+### Added
+
+- Exposes "strict" rules for eslint `extends`. This preset is equivalent to version `1.0.0`'s "recommended" preset.
+
+## v1.0.0 - August 12, 2019
+
+### Added
+
+- Exposes "recommended" rules for eslint `extends`
+
+- Improve documentation
+
+### Deprecated
+
+- The `padding-before-all` rule has been deprecated
+
 ## v0.1.0 - July 20, 2019
 
 ### Rules Added
 
-- padding-before-all
+- `padding-before-all`
 
-- padding-before-after-all-blocks
+- `padding-before-after-all-blocks`
 
-- padding-before-after-each-blocks
+- `padding-before-after-each-blocks`
 
-- padding-before-before-all-blocks
+- `padding-before-before-all-blocks`
 
-- padding-before-before-each-blocks
+- `padding-before-before-each-blocks`
 
-- padding-before-expect-statements
+- `padding-before-expect-statements`
 
 ### Other
 

package/README.md

@@ -1,6 +1,8 @@
 [![CircleCI](https://circleci.com/gh/dangreenisrael/eslint-plugin-jest-formatting/tree/master.svg?style=svg)](https://circleci.com/gh/dangreenisrael/eslint-plugin-jest-formatting/tree/master)
 ![npm monthly downloads](https://img.shields.io/npm/dm/eslint-plugin-jest-formatting.svg)
 
+**_Note: The master version may not be the version deployed to npm. Please treat https://www.npmjs.com/package/eslint-plugin-jest-formatting as the cannonical source for docs._**
+
 # eslint-plugin-jest-formatting
 
 This project aims to provide formatting rules (auto-fixable where possible) to ensure consistency and readability in jest test suites.
@@ -12,7 +14,7 @@ Like this plugin? [Say thanks with a ⭐️](https://github.com/dangreenisrael/e
 You'll first need to install [ESLint](http://eslint.org):
 
 ```
-$ yarn add eslint -dev
+$ yarn add eslint --dev
 ```
 
 Next, install `eslint-plugin-jest-formatting`:
@@ -38,30 +40,48 @@ Then configure the rules you want to use under the rules section.
 ```json
 {
   "rules": {
-    "jest-formatting/padding-before-all": 2
+    "jest-formatting/padding-around-describe-blocks": 2,
+    "jest-formatting/padding-around-test-blocks": 2
   }
 }
 ```
 
 _or_
 
+You can use our "recommended" settings which enables most of the rules for you
+
 ```json
 {
-  "rules": {
-    "jest-formatting/padding-before-describe-blocks": 2,
-    "jest-formatting/padding-before-test-blocks": 2
-  }
+  "extends": ["plugin:jest-formatting/recommended"]
+}
+```
+
+We also support a "strict" settings which enabled all of the rules for you
+
+```json
+{
+  "extends": ["plugin:jest-formatting/strict"]
 }
 ```
 
 ## Rule Documentation
 
-- [padding-before-all](docs/rules/padding-before-all.md)
+- [padding-around-after-all-blocks](docs/rules/padding-around-after-all-blocks.md)
+- [padding-around-after-each-blocks](docs/rules/padding-around-after-each-blocks.md)
+- [padding-around-before-all-blocks](docs/rules/padding-around-before-all-blocks.md)
+- [padding-around-before-each-blocks](docs/rules/padding-around-before-each-blocks.md)
+- [padding-around-expect-groups](docs/rules/padding-around-expect-groups.md)
+- [padding-around-describe-blocks](docs/rules/padding-around-describe-blocks.md)
+- [padding-around-test-blocks](docs/rules/padding-around-test-blocks.md)
+- [padding-around-all](docs/rules/padding-around-all.md)
 
-- [padding-before-after-all-blocks](docs/rules/padding-before-after-all-blocks.md)
+### Deprecated
+
+- [padding-before-all](docs/rules/padding-before-all.md)
+- [padding-before-before-each-blocks](docs/rules/padding-before-before-each-blocks.md)
 - [padding-before-after-each-blocks](docs/rules/padding-before-after-each-blocks.md)
 - [padding-before-before-all-blocks](docs/rules/padding-before-before-all-blocks.md)
-- [padding-before-before-each-blocks](docs/rules/padding-before-before-each-blocks.md)
+- [padding-before-after-all-blocks](docs/rules/padding-before-after-all-blocks.md)
 - [padding-before-describe-blocks](docs/rules/padding-before-describe-blocks.md)
 - [padding-before-expect-statements](docs/rules/padding-before-expect-statements.md)
 - [padding-before-test-blocks](docs/rules/padding-before-test-blocks.md)

package/docs/rules/padding-around-after-all-blocks.md

@@ -0,0 +1,25 @@
+# padding-around-after-all-blocks
+
+## Rule Details
+
+This rule enforces a line of padding before _and_ after 1 or more `afterAll` statements.
+
+Note that it doesn't add/enforce a padding line if it's the last statement in its scope.
+
+Examples of **incorrect** code for this rule:
+
+```js
+const someText = 'abc';
+afterAll(() => {});
+describe('someText', () => {});
+```
+
+Examples of **correct** code for this rule:
+
+```js
+const someText = 'abc';
+
+afterAll(() => {});
+
+describe('someText', () => {});
+```

package/docs/rules/padding-around-after-each-blocks.md

@@ -0,0 +1,29 @@
+# padding-around-after-each-blocks
+
+## Rule Details
+
+This rule enforces a line of padding before _and_ after 1 or more `afterEach` statements.
+
+Note that it doesn't add/enforce a padding line if it's the last statement in its scope.
+
+Examples of **incorrect** code for this rule:
+
+```js
+const something = 123;
+afterEach(() => {
+  // more stuff
+});
+describe('foo', () => {});
+```
+
+Examples of **correct** code for this rule:
+
+```js
+const something = 123;
+
+afterEach(() => {
+  // more stuff
+});
+
+describe('foo', () => {});
+```

package/docs/rules/padding-around-all.md

@@ -0,0 +1,13 @@
+# padding-around-all
+
+## Rule Details
+
+This is a meta rule that simply enables all of the following rules:
+
+- [padding-around-after-all-blocks](padding-around-after-all-blocks.md)
+- [padding-around-after-each-blocks](padding-around-after-each-blocks.md)
+- [padding-around-before-all-blocks](padding-around-before-all-blocks.md)
+- [padding-around-before-each-blocks](padding-around-before-each-blocks.md)
+- [padding-around-expect-groups](padding-around-expect-groups.md)
+- [padding-around-describe-blocks](padding-around-describe-blocks.md)
+- [padding-around-test-blocks](padding-around-test-blocks.md)

package/docs/rules/padding-around-before-all-blocks.md

@@ -0,0 +1,29 @@
+# padding-around-before-all-blocks
+
+## Rule Details
+
+This rule enforces a line of padding before _and_ after `beforeAll` statements.
+
+Note that it doesn't add/enforce a padding line if it's the last statement in its scope.
+
+Examples of **incorrect** code for this rule:
+
+```js
+const something = 123;
+beforeAll(() => {
+  // more stuff
+});
+describe('foo', () => {});
+```
+
+Examples of **correct** code for this rule:
+
+```js
+const something = 123;
+
+beforeAll(() => {
+  // more stuff
+});
+
+describe('foo', () => {});
+```

package/docs/rules/padding-around-before-each-blocks.md

@@ -0,0 +1,29 @@
+# padding-around-before-each-blocks
+
+## Rule Details
+
+This rule enforces a line of padding before _and_ after 1 or more `beforeEach` statements
+
+Note that it doesn't add/enforce a padding line if it's the last statement in its scope
+
+Examples of **incorrect** code for this rule:
+
+```js
+const something = 123;
+beforeEach(() => {
+  // more stuff
+});
+describe('foo', () => {});
+```
+
+Examples of **correct** code for this rule:
+
+```js
+const something = 123;
+
+beforeEach(() => {
+  // more stuff
+});
+
+describe('foo', () => {});
+```

package/docs/rules/padding-around-describe-blocks.md

@@ -0,0 +1,33 @@
+# padding-around-describe-blocks
+
+## Rule Details
+
+This rule enforces a line of padding before _and_ after 1 or more `beforeEach` statements
+
+Note that it doesn't add/enforce a padding line if it's the last statement in its scope
+
+Examples of **incorrect** code for this rule:
+
+```js
+const thing = 123;
+describe('foo', () => {
+  // stuff
+});
+describe('bar', () => {
+  // more stuff
+});
+```
+
+Examples of **correct** code for this rule:
+
+```js
+const thing = 123;
+
+describe('foo', () => {
+  // stuff
+});
+
+describe('bar', () => {
+  // more stuff
+});
+```

package/docs/rules/padding-around-expect-groups.md

@@ -0,0 +1,35 @@
+# padding-around-expect-groups
+
+## Rule Details
+
+This rule enforces a line of padding before _and_ after 1 or more `expect` statements
+
+Note that it doesn't add/enforce a padding line if it's the last statement in its scope and
+it doesn't add/enforce padding between two or more adjacent `expect` statements.
+
+Examples of **incorrect** code for this rule:
+
+```js
+test('thing one', () => {
+  let abc = 123;
+  expect(abc).toEqual(123);
+  expect(123).toEqual(abc);
+  abc = 456;
+  expect(abc).toEqual(456);
+});
+```
+
+Examples of **correct** code for this rule:
+
+```js
+test('thing one', () => {
+  let abc = 123;
+
+  expect(abc).toEqual(123);
+  expect(123).toEqual(abc);
+
+  abc = 456;
+
+  expect(abc).toEqual(456);
+});
+```

package/docs/rules/padding-around-test-blocks.md

@@ -0,0 +1,39 @@
+# padding-around-test-blocks
+
+## Rule Details
+
+This rule enforces a line of padding before _and_ after 1 or more `test`/`it` statements
+
+Note that it doesn't add/enforce a padding line if it's the last statement in its scope
+
+Examples of **incorrect** code for this rule:
+
+```js
+const thing = 123;
+test('foo', () => {});
+test('bar', () => {});
+```
+
+```js
+const thing = 123;
+it('foo', () => {});
+it('bar', () => {});
+```
+
+Examples of **correct** code for this rule:
+
+```js
+const thing = 123;
+
+test('foo', () => {});
+
+test('bar', () => {});
+```
+
+```js
+const thing = 123;
+
+it('foo', () => {});
+
+it('bar', () => {});
+```

package/lib/ast-utils.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTokenASemicolon = (token) => token.value === ';' && token.type === 'Punctuator';
+exports.areTokensOnSameLine = (left, right) => left.loc.end.line === right.loc.start.line;
+const STATEMENT_LIST_PARENTS = new Set([
+    'Program',
+    'BlockStatement',
+    'SwitchCase',
+    'SwitchStatement',
+]);
+exports.isValidParent = (parentType) => {
+    return STATEMENT_LIST_PARENTS.has(parentType);
+};
+exports.getActualLastToken = (sourceCode, node) => {
+    const semiToken = sourceCode.getLastToken(node);
+    const prevToken = sourceCode.getTokenBefore(semiToken);
+    const nextToken = sourceCode.getTokenAfter(semiToken);
+    const isSemicolonLessStyle = Boolean(prevToken &&
+        nextToken &&
+        prevToken.range[0] >= node.range[0] &&
+        exports.isTokenASemicolon(semiToken) &&
+        semiToken.loc.start.line !== prevToken.loc.end.line &&
+        semiToken.loc.end.line === nextToken.loc.start.line);
+    return isSemicolonLessStyle ? prevToken : semiToken;
+};
+exports.getPaddingLineSequences = (prevNode, nextNode, sourceCode) => {
+    const pairs = [];
+    const includeComments = true;
+    let prevToken = exports.getActualLastToken(sourceCode, prevNode);
+    if (nextNode.loc.start.line - prevToken.loc.end.line >= 2) {
+        do {
+            const token = sourceCode.getTokenAfter(prevToken, { includeComments });
+            if (token.loc.start.line - prevToken.loc.end.line >= 2) {
+                pairs.push([prevToken, token]);
+            }
+            prevToken = token;
+        } while (prevToken.range[0] < nextNode.range[0]);
+    }
+    return pairs;
+};