Permalink
Cannot retrieve contributors at this time
122 lines (105 sloc)
4.09 KB
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
codeql-action/node_modules/eslint/lib/rules/line-comment-position.js
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* @fileoverview Rule to enforce the position of line comments | |
* @author Alberto Rodríguez | |
*/ | |
"use strict"; | |
const astUtils = require("./utils/ast-utils"); | |
//------------------------------------------------------------------------------ | |
// Rule Definition | |
//------------------------------------------------------------------------------ | |
/** @type {import('../shared/types').Rule} */ | |
module.exports = { | |
meta: { | |
type: "layout", | |
docs: { | |
description: "Enforce position of line comments", | |
recommended: false, | |
url: "https://eslint.org/docs/latest/rules/line-comment-position" | |
}, | |
schema: [ | |
{ | |
oneOf: [ | |
{ | |
enum: ["above", "beside"] | |
}, | |
{ | |
type: "object", | |
properties: { | |
position: { | |
enum: ["above", "beside"] | |
}, | |
ignorePattern: { | |
type: "string" | |
}, | |
applyDefaultPatterns: { | |
type: "boolean" | |
}, | |
applyDefaultIgnorePatterns: { | |
type: "boolean" | |
} | |
}, | |
additionalProperties: false | |
} | |
] | |
} | |
], | |
messages: { | |
above: "Expected comment to be above code.", | |
beside: "Expected comment to be beside code." | |
} | |
}, | |
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 || options.position === "above"; | |
ignorePattern = options.ignorePattern; | |
if (Object.prototype.hasOwnProperty.call(options, "applyDefaultIgnorePatterns")) { | |
applyDefaultIgnorePatterns = options.applyDefaultIgnorePatterns; | |
} else { | |
applyDefaultIgnorePatterns = options.applyDefaultPatterns !== false; | |
} | |
} | |
const defaultIgnoreRegExp = astUtils.COMMENTS_IGNORE_PATTERN; | |
const fallThroughRegExp = /^\s*falls?\s?through/u; | |
const customIgnoreRegExp = new RegExp(ignorePattern, "u"); | |
const sourceCode = context.sourceCode; | |
//-------------------------------------------------------------------------- | |
// Public | |
//-------------------------------------------------------------------------- | |
return { | |
Program() { | |
const comments = sourceCode.getAllComments(); | |
comments.filter(token => token.type === "Line").forEach(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, | |
messageId: "above" | |
}); | |
} | |
} else { | |
if (!isOnSameLine) { | |
context.report({ | |
node, | |
messageId: "beside" | |
}); | |
} | |
} | |
}); | |
} | |
}; | |
} | |
}; |