Jack Jackson 892a62f4e5 Add first PR check (#1)
To be followed by tests and `npm run build`, obviously!

Reviewed-on: #1
Co-authored-by: Jack Jackson <scubbojj@gmail.com>
Co-committed-by: Jack Jackson <scubbojj@gmail.com>
2025-03-03 23:00:04 +00:00

100 lines
3.2 KiB
JavaScript

/**
* @fileoverview Rule to check for tabs inside a file
* @author Gyandeep Singh
* @deprecated in ESLint v8.53.0
*/
"use strict";
//------------------------------------------------------------------------------
// Helpers
//------------------------------------------------------------------------------
const tabRegex = /\t+/gu;
const anyNonWhitespaceRegex = /\S/u;
//------------------------------------------------------------------------------
// Public Interface
//------------------------------------------------------------------------------
/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
deprecated: {
message: "Formatting rules are being moved out of ESLint core.",
url: "https://eslint.org/blog/2023/10/deprecating-formatting-rules/",
deprecatedSince: "8.53.0",
availableUntil: "10.0.0",
replacedBy: [
{
message: "ESLint Stylistic now maintains deprecated stylistic core rules.",
url: "https://eslint.style/guide/migration",
plugin: {
name: "@stylistic/eslint-plugin-js",
url: "https://eslint.style/packages/js"
},
rule: {
name: "no-tabs",
url: "https://eslint.style/rules/js/no-tabs"
}
}
]
},
type: "layout",
docs: {
description: "Disallow all tabs",
recommended: false,
url: "https://eslint.org/docs/latest/rules/no-tabs"
},
schema: [{
type: "object",
properties: {
allowIndentationTabs: {
type: "boolean",
default: false
}
},
additionalProperties: false
}],
messages: {
unexpectedTab: "Unexpected tab character."
}
},
create(context) {
const sourceCode = context.sourceCode;
const allowIndentationTabs = context.options && context.options[0] && context.options[0].allowIndentationTabs;
return {
Program(node) {
sourceCode.getLines().forEach((line, index) => {
let match;
while ((match = tabRegex.exec(line)) !== null) {
if (allowIndentationTabs && !anyNonWhitespaceRegex.test(line.slice(0, match.index))) {
continue;
}
context.report({
node,
loc: {
start: {
line: index + 1,
column: match.index
},
end: {
line: index + 1,
column: match.index + match[0].length
}
},
messageId: "unexpectedTab"
});
}
});
}
};
}
};