eslint-plugin-ssr-friendly - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

package.json

 {
   "name": "eslint-plugin-ssr-friendly",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "license": "MIT",
@@ -5,0 +5,0 @@ "main": "./src/index.js",

README.md

 # eslint-plugin-ssr-friendly
 
-ESLint plugin that detects incorrect use of DOM globals properties in your code in
-order to properly do Server-Side-Rendering.
+ESLint plugin that detects incorrect use of DOM globals in order to properly do SSR and in general share code between client-side JS and Node.js modules.
 
@@ -6,0 +5,0 @@ [![npm version](https://badge.fury.io/js/eslint-plugin-ssr-friendly.svg)](https://badge.fury.io/js/eslint-plugin-ssr-friendly)

src/index.js

@@ -1,2 +0,2 @@
-const { browser, node } = require("globals");
+const { browser: browserGlobals, node: nodeGlobals } = require("globals");
 const pkg = require("../package.json");
@@ -7,3 +7,3 @@
 const isDOMGlobalName = (name) => {
-  return name in browser && !(name in node);
+  return name in browserGlobals && !(name in nodeGlobals);
 };
@@ -54,6 +54,5 @@
   const node = reference.identifier;
-  const { name } = node;
-  const { parent } = node;
+  const { name, parent } = node;
 
-  // Make sure that `typeof window` is always allowed
+  // Make sure that `typeof MYVAR` is always allowed
   if (parent.type === "UnaryExpression" && parent.operator === "typeof") {
@@ -144,63 +143,43 @@ return;
 
-const rules = {
-  "no-dom-globals-in-module-scope": {
-    meta: {
-      type: "problem",
-      docs: {
-        description: "disallow use of DOM globals in module scope",
-        recommended: true,
+const createRule = (name, description, defaultMessage) => {
+  return {
+    [name]: {
+      meta: {
+        type: "problem",
+        docs: {
+          description,
+          recommended: true,
+        },
+        messages: {
+          defaultMessage,
+        },
       },
-      messages: {
-        defaultMessage:
-          "Use of DOM global '{{name}}' is forbidden in module scope",
-      },
+      create: createFn(name),
     },
-    create: createFn("no-dom-globals-in-module-scope"),
-  },
-  "no-dom-globals-in-constructor": {
-    meta: {
-      type: "problem",
-      docs: {
-        description: "disallow use of DOM globals in class constructors",
-        recommended: true,
-      },
-      messages: {
-        defaultMessage:
-          "Use of DOM global '{{name}}' is forbidden in class constructors, consider moving this to componentDidMount() or equivalent for non React components",
-      },
-    },
-    create: createFn("no-dom-globals-in-constructor"),
-  },
-  "no-dom-globals-in-react-cc-render": {
-    meta: {
-      type: "problem",
-      docs: {
-        description:
-          "disallow use of DOM globals in render() method of a React class-component",
-        recommended: true,
-      },
-      messages: {
-        defaultMessage:
-          "Use of DOM global '{{name}}' is forbidden in render(), consider moving this to componentDidMount()",
-      },
-    },
-    create: createFn("no-dom-globals-in-react-cc-render"),
-  },
-  "no-dom-globals-in-react-fc": {
-    meta: {
-      type: "problem",
-      docs: {
-        description:
-          "disallow use of DOM globals in the render-cycle of a React FC",
-        recommended: true,
-      },
-      messages: {
-        defaultMessage:
-          "Use of DOM global '{{name}}' is forbidden in the render-cycle of a React FC, consider moving this inside useEffect()",
-      },
-    },
-    create: createFn("no-dom-globals-in-react-fc"),
-  },
+  };
 };
 
+const rules = {
+  ...createRule(
+    "no-dom-globals-in-module-scope",
+    "disallow use of DOM globals in module scope",
+    "Use of DOM global '{{name}}' is forbidden in module scope"
+  ),
+  ...createRule(
+    "no-dom-globals-in-constructor",
+    "disallow use of DOM globals in class constructors",
+    "Use of DOM global '{{name}}' is forbidden in class constructors, consider moving this to componentDidMount() or equivalent for non React components"
+  ),
+  ...createRule(
+    "no-dom-globals-in-react-cc-render",
+    "disallow use of DOM glsobals in render() method of a React class-component",
+    "Use of DOM global '{{name}}' is forbidden in render(), consider moving this to componentDidMount()"
+  ),
+  ...createRule(
+    "no-dom-globals-in-react-fc",
+    "disallow use of DOM globals in the render-cycle of a React FC",
+    "Use of DOM global '{{name}}' is forbidden in the render-cycle of a React FC, consider moving this inside useEffect()"
+  ),
+};
+
 module.exports = {
@@ -207,0 +186,0 @@ configs: {

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

Worsened metrics

Total package byte prevSize

10198

decreased by-4.46%

Lines of code

180

decreased by-10.89%

Number of lines in readme file

136

decreased by-0.73%

No dependency changes