Current Dev State

static/js/ketcher2/node_modules/eslint/lib/rules/line-comment-position.js

@@ -0,0 +1,111 @@
+/**
+ * @fileoverview Rule to enforce the position of line comments
+ * @author Alberto Rodríguez
+ */
+"use strict";
+
+const astUtils = require("../ast-utils");
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+module.exports = {
+    meta: {
+        docs: {
+            description: "enforce position of line comments",
+            category: "Stylistic Issues",
+            recommended: false
+        },
+
+        schema: [
+            {
+                oneOf: [
+                    {
+                        enum: ["above", "beside"]
+                    },
+                    {
+                        type: "object",
+                        properties: {
+                            position: {
+                                enum: ["above", "beside"]
+                            },
+                            ignorePattern: {
+                                type: "string"
+                            },
+                            applyDefaultPatterns: {
+                                type: "boolean"
+                            },
+                            applyDefaultIgnorePatterns: {
+                                type: "boolean"
+                            }
+                        },
+                        additionalProperties: false
+                    }
+                ]
+            }
+        ]
+    },
+
+    create(context) {
+        const options = context.options[0];
+
+        let above,
+            ignorePattern,
+            applyDefaultIgnorePatterns = true;
+
+        if (!options || typeof options === "string") {
+            above = !options || options === "above";
+
+        } else {
+            above = options.position === "above";
+            ignorePattern = options.ignorePattern;
+
+            if (options.hasOwnProperty("applyDefaultIgnorePatterns")) {
+                applyDefaultIgnorePatterns = options.applyDefaultIgnorePatterns !== false;
+            } else {
+                applyDefaultIgnorePatterns = options.applyDefaultPatterns !== false;
+            }
+        }
+
+        const defaultIgnoreRegExp = astUtils.COMMENTS_IGNORE_PATTERN;
+        const fallThroughRegExp = /^\s*falls?\s?through/;
+        const customIgnoreRegExp = new RegExp(ignorePattern);
+        const sourceCode = context.getSourceCode();
+
+        //--------------------------------------------------------------------------
+        // Public
+        //--------------------------------------------------------------------------
+
+        return {
+            LineComment(node) {
+                if (applyDefaultIgnorePatterns && (defaultIgnoreRegExp.test(node.value) || fallThroughRegExp.test(node.value))) {
+                    return;
+                }
+
+                if (ignorePattern && customIgnoreRegExp.test(node.value)) {
+                    return;
+                }
+
+                const previous = sourceCode.getTokenBefore(node, { includeComments: true });
+                const isOnSameLine = previous && previous.loc.end.line === node.loc.start.line;
+
+                if (above) {
+                    if (isOnSameLine) {
+                        context.report({
+                            node,
+                            message: "Expected comment to be above code."
+                        });
+                    }
+                } else {
+                    if (!isOnSameLine) {
+                        context.report({
+                            node,
+                            message: "Expected comment to be beside code."
+                        });
+                    }
+                }
+            }
+        };
+    }
+};