eslint-plugin-jest-formatting - npm Package Compare versions

Comparing version 0.1.0 to 1.0.0

lib/index.js

@@ -5,2 +5,26 @@ "use strict";
 exports.rules = {
+    'padding-around-after-all-blocks': utils_1.makeRule([
+        { blankLine: 'always', prev: '*', next: 'afterAll' },
+        { blankLine: 'always', prev: 'afterAll', next: '*' },
+    ]),
+    'padding-around-after-each-blocks': utils_1.makeRule([
+        { blankLine: 'always', prev: '*', next: 'afterEach' },
+        { blankLine: 'always', prev: 'afterEach', next: '*' },
+    ]),
+    'padding-around-before-all-blocks': utils_1.makeRule([
+        { blankLine: 'always', prev: '*', next: 'beforeAll' },
+        { blankLine: 'always', prev: 'beforeAll', next: '*' },
+    ]),
+    'padding-around-before-each-blocks': utils_1.makeRule([
+        { blankLine: 'always', prev: '*', next: 'beforeEach' },
+        { blankLine: 'always', prev: 'beforeEach', next: '*' },
+    ]),
+    'padding-around-describe-blocks': utils_1.makeRule([
+        { blankLine: 'always', prev: '*', next: 'describe' },
+        { blankLine: 'always', prev: 'describe', next: '*' },
+    ]),
+    'padding-around-test-blocks': utils_1.makeRule([
+        { blankLine: 'always', prev: '*', next: ['test', 'it'] },
+        { blankLine: 'always', prev: ['test', 'it'], next: '*' },
+    ]),
     'padding-before-after-all-blocks': utils_1.makeRule([
@@ -25,2 +49,7 @@ { blankLine: 'always', prev: '*', next: 'afterAll' },
     ]),
+    'padding-around-expect-groups': utils_1.makeRule([
+        { blankLine: 'always', prev: '*', next: 'expect' },
+        { blankLine: 'always', prev: 'expect', next: '*' },
+        { blankLine: 'any', prev: 'expect', next: 'expect' },
+    ]),
     'padding-before-test-blocks': utils_1.makeRule([
@@ -47,1 +76,15 @@ { blankLine: 'always', prev: '*', next: ['test', 'it'] },
 };
+exports.configs = {
+    recommended: {
+        plugins: ['jest-formatting'],
+        rules: {
+            'jest-formatting/padding-around-after-all-blocks': 2,
+            'jest-formatting/padding-around-after-each-blocks': 2,
+            'jest-formatting/padding-around-before-all-blocks': 2,
+            'jest-formatting/padding-around-before-each-blocks': 2,
+            'jest-formatting/padding-around-expect-groups': 2,
+            'jest-formatting/padding-around-describe-blocks': 2,
+            'jest-formatting/padding-around-test-blocks': 2,
+        },
+    },
+};

package.json

 {
   "name": "eslint-plugin-jest-formatting",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "Formatting rules for jest tests",
@@ -10,3 +10,5 @@ "keywords": [
     "jest",
-    "format"
+    "format",
+    "formatting",
+    "padding"
   ],
@@ -13,0 +15,0 @@ "author": "Dan Green-Leipciger",

README.md

 [![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
@@ -41,3 +43,4 @@
   "rules": {
-    "jest-formatting/padding-before-all": 2
+    "jest-formatting/padding-around-describe-blocks": 2,
+    "jest-formatting/padding-around-test-blocks": 2
   }
@@ -49,8 +52,7 @@ }
 
+You can use our recommeneded settings which enables all 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"]
 }
@@ -61,10 +63,19 @@ ```
 
+- [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)
+
+### Deprecated
+
 - [padding-before-all](docs/rules/padding-before-all.md)
-
-- [padding-before-after-all-blocks](docs/rules/padding-before-after-all-blocks.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)

src/index.ts

@@ -13,2 +13,27 @@ /**
 export const rules = {
+  'padding-around-after-all-blocks': makeRule([
+    { blankLine: 'always', prev: '*', next: 'afterAll' },
+    { blankLine: 'always', prev: 'afterAll', next: '*' },
+  ]),
+  'padding-around-after-each-blocks': makeRule([
+    { blankLine: 'always', prev: '*', next: 'afterEach' },
+    { blankLine: 'always', prev: 'afterEach', next: '*' },
+  ]),
+  'padding-around-before-all-blocks': makeRule([
+    { blankLine: 'always', prev: '*', next: 'beforeAll' },
+    { blankLine: 'always', prev: 'beforeAll', next: '*' },
+  ]),
+  'padding-around-before-each-blocks': makeRule([
+    { blankLine: 'always', prev: '*', next: 'beforeEach' },
+    { blankLine: 'always', prev: 'beforeEach', next: '*' },
+  ]),
+  'padding-around-describe-blocks': makeRule([
+    { blankLine: 'always', prev: '*', next: 'describe' },
+    { blankLine: 'always', prev: 'describe', next: '*' },
+  ]),
+  'padding-around-test-blocks': makeRule([
+    { blankLine: 'always', prev: '*', next: ['test', 'it'] },
+    { blankLine: 'always', prev: ['test', 'it'], next: '*' },
+  ]),
+  // Deprecated
   'padding-before-after-all-blocks': makeRule([
@@ -33,2 +58,7 @@ { blankLine: 'always', prev: '*', next: 'afterAll' },
   ]),
+  'padding-around-expect-groups': makeRule([
+    { blankLine: 'always', prev: '*', next: 'expect' },
+    { blankLine: 'always', prev: 'expect', next: '*' },
+    { blankLine: 'any', prev: 'expect', next: 'expect' },
+  ]),
   'padding-before-test-blocks': makeRule([
@@ -55,1 +85,16 @@ { blankLine: 'always', prev: '*', next: ['test', 'it'] },
 };
+
+export const configs = {
+  recommended: {
+    plugins: ['jest-formatting'],
+    rules: {
+      'jest-formatting/padding-around-after-all-blocks': 2,
+      'jest-formatting/padding-around-after-each-blocks': 2,
+      'jest-formatting/padding-around-before-all-blocks': 2,
+      'jest-formatting/padding-around-before-each-blocks': 2,
+      'jest-formatting/padding-around-expect-groups': 2,
+      'jest-formatting/padding-around-describe-blocks': 2,
+      'jest-formatting/padding-around-test-blocks': 2,
+    },
+  },
+};

tests/dogfood.spec.js

@@ -0,1 +1,9 @@
+beforeAll(() => {});
+
+beforeEach(() => {});
+
+afterAll(() => {});
+
+afterEach(() => {});
+
 describe('no padding on top', () => {
@@ -6,11 +14,18 @@ it('has no padding above', () => {
 
+  expect(true);
+  expect(1);
+
   it('has padding above', () => {
     expect(true);
   });
+
+  it('also has padding above but not below', () => {
+    expect(true);
+  });
 });
 
 describe('padding above', () => {
-  it('has no padding above', () => {
+  it('has no padding above or below', () => {
     expect(true);
   });
 });

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

251867

increased by12.34%

Number of package files

52

increased by36.84%

Lines of code

2357

increased by66.22%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

79

increased by16.18%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes