Skip to content

Commit

Permalink
Update src/textlint-rule-eslint.ts+2
Browse files Browse the repository at this point in the history
  • Loading branch information
@azu
azu committed Dec 30, 2024
1 parent 03328d1 commit 1e9d89b
Show file tree
Hide file tree
Showing 3 changed files with 282 additions and 292 deletions.
282 changes: 147 additions & 135 deletions src/textlint-rule-eslint.ts
View file
Original file line number Diff line number Diff line change
@@ -1,136 +1,148 @@
// LICENSE : MIT
"use strict";
import path from "path";
import type { TextlintRuleContext, TextlintRuleModule } from "@textlint/types"
import type { TextlintRuleContext, TextlintRuleModule } from "@textlint/types";
import { StructuredSource } from "structured-source";
import { ESLint } from "eslint";

const defaultOptions = {
// path to eslint config file
"configFile": null,
// recognize lang of CodeBlock as JavaScript
"langs": ["js", "javascript", "node", "jsx"]
// path to eslint config file
configFile: null,
// recognize lang of CodeBlock as JavaScript
langs: ["js", "javascript", "node", "jsx"]
};
const getConfigBaseDir = (context: TextlintRuleContext & { config?: any }) => {
if (typeof context.getConfigBaseDir === "function") {
return context.getConfigBaseDir();
}
// Fallback that use deprecated `config` value
// https://github.com/textlint/textlint/issues/294
const textlintRcFilePath = context.config ? context.config.configFile : null;
// .textlinrc directory
return textlintRcFilePath ? path.dirname(textlintRcFilePath) : process.cwd();
if (typeof context.getConfigBaseDir === "function") {
return context.getConfigBaseDir();
}
// Fallback that use deprecated `config` value
// https://github.com/textlint/textlint/issues/294
const textlintRcFilePath = context.config ? context.config.configFile : null;
// .textlinrc directory
return textlintRcFilePath ? path.dirname(textlintRcFilePath) : process.cwd();
};

export type Options = {
configFile: string;
langs: string[]
}
const createReporter = ({
fix
}: {
fix: boolean
}): TextlintRuleModule<Options> => {
return (context, options) => {
const { Syntax, RuleError, report, fixer, getSource, locator } = context;
if (!options) {
throw new Error(`Require options: { "configFile": "path/to/.eslintrc" }`);
}
if (!options.configFile) {
throw new Error(`Require options: { "configFile": "path/to/.eslintrc" }`);
}
const availableLang = options.langs || defaultOptions.langs;
const textlintRCDir = getConfigBaseDir(context);
const esLintConfigFilePath = textlintRCDir ? path.resolve(textlintRCDir, options.configFile) : options.configFile;
const engine = new ESLint({
overrideConfigFile: esLintConfigFilePath,
ignore: false,

});
return {
async [Syntax.CodeBlock](node) {
if (!node.lang) {
return;
configFile: string;
langs: string[];
};
const createReporter = ({ fix }: { fix: boolean }): TextlintRuleModule<Options> => {
return (context, options) => {
const { Syntax, RuleError, report, fixer, getSource, locator } = context;
if (!options) {
throw new Error(`Require options: { "configFile": "path/to/.eslintrc" }`);
}
if (availableLang.indexOf(node.lang) === -1) {
return;
if (!options.configFile) {
throw new Error(`Require options: { "configFile": "path/to/.eslintrc" }`);
}
const raw = getSource(node);
const code = getUntrimmedCode(node, raw);
const source = new StructuredSource(code);
const resultLinting = await engine.lintText(code, {
filePath: `test.js`
const availableLang = options.langs || defaultOptions.langs;
const textlintRCDir = getConfigBaseDir(context);
const esLintConfigFilePath = textlintRCDir
? path.resolve(textlintRCDir, options.configFile)
: options.configFile;
const engine = new ESLint({
overrideConfigFile: esLintConfigFilePath,
ignore: false
});
if (resultLinting.length === 0) {
return;
}
resultLinting.forEach(result => {
result.messages.forEach(message => {
/*
return {
async [Syntax.CodeBlock](node) {
if (!node.lang) {
return;
}
if (availableLang.indexOf(node.lang) === -1) {
return;
}
const raw = getSource(node);
const code = getUntrimmedCode(node, raw);
const source = new StructuredSource(code);
const resultLinting = await engine.lintText(code, {
filePath: `test.js`
});
if (resultLinting.length === 0) {
return;
}
resultLinting.forEach((result) => {
result.messages.forEach((message) => {
/*
1. ```js
2. CODE
3. ```
ESLint message line and column start with 1
*/
if (options.ignoreParsingErrors && message.message.includes("Parsing error")) {
return;
}
if (options.ignoreParsingErrors && message.message.includes("Parsing error")) {
return;
}

const prefix = message.ruleId ? `${message.ruleId}: ` : "";
if (message.fix) {
// relative range from node
const fixedRange = message.fix.range;
const fixedText = message.fix.text;
const sourceBlockDiffIndex = (raw !== node.value) ? raw.indexOf(code) : 0;
const fixedWithPadding = [fixedRange[0] + sourceBlockDiffIndex, fixedRange[1] + sourceBlockDiffIndex] as const;
const location = source.rangeToLocation(fixedWithPadding);
const isSamePosition = location.start.line === location.end.line && location.start.column === location.end.column;
report(node, new RuleError(`${prefix}${message.message}`, {
padding: isSamePosition
? locator.at(fixedWithPadding[0])
: locator.range(fixedWithPadding),
fix:
isSamePosition
? fixer.insertTextAfterRange(fixedWithPadding, fixedText)
: fixer.replaceTextRange(fixedWithPadding, fixedText)
}));
} else {
const sourceBlockDiffIndex = (raw !== node.value) ? raw.indexOf(code) : 0;
if (message.endLine !== undefined && message.endColumn !== undefined) {
const range = source.locationToRange({
start: {
line: message.line,
column: message.column
},
end: {
line: message.endLine,
column: message.endColumn
}
const prefix = message.ruleId ? `${message.ruleId}: ` : "";
if (message.fix) {
// relative range from node
const fixedRange = message.fix.range;
const fixedText = message.fix.text;
const sourceBlockDiffIndex = raw !== node.value ? raw.indexOf(code) : 0;
const fixedWithPadding = [
fixedRange[0] + sourceBlockDiffIndex,
fixedRange[1] + sourceBlockDiffIndex
] as const;
const location = source.rangeToLocation(fixedWithPadding);
const isSamePosition =
location.start.line === location.end.line &&
location.start.column === location.end.column;
report(
node,
new RuleError(`${prefix}${message.message}`, {
padding: isSamePosition
? locator.at(fixedWithPadding[0])
: locator.range(fixedWithPadding),
fix: isSamePosition
? fixer.insertTextAfterRange(fixedWithPadding, fixedText)
: fixer.replaceTextRange(fixedWithPadding, fixedText)
})
);
} else {
const sourceBlockDiffIndex = raw !== node.value ? raw.indexOf(code) : 0;
if (message.endLine !== undefined && message.endColumn !== undefined) {
const range = source.locationToRange({
start: {
line: message.line,
column: message.column
},
end: {
line: message.endLine,
column: message.endColumn
}
});
const adjustedRange = [
range[0] + sourceBlockDiffIndex,
range[1] + sourceBlockDiffIndex
] as const;
report(
node,
new RuleError(`${prefix}${message.message}`, {
padding: locator.range(adjustedRange)
})
);
} else {
const index = source.positionToIndex({
line: message.line,
column: message.column
});
const adjustedIndex = index + sourceBlockDiffIndex - 1;
report(
node,
new RuleError(`${prefix}${message.message}`, {
padding: locator.at(adjustedIndex)
})
);
}
}
});
});
const adjustedRange = [range[0] + sourceBlockDiffIndex, range[1] + sourceBlockDiffIndex] as const;
report(node, new RuleError(`${prefix}${message.message}`, {
padding: locator.range(adjustedRange)
}));
} else {
const index = source.positionToIndex({
line: message.line,
column: message.column
});
const adjustedIndex = index + sourceBlockDiffIndex - 1;
report(node, new RuleError(`${prefix}${message.message}`, {
padding: locator.at(adjustedIndex)
}));
}
}

});
});
}
}
};
}
};
};
};

/**
* [Markdown] get actual code value from CodeBlock node
Expand All @@ -139,36 +151,36 @@ const createReporter = ({
* @returns {string}
*/
function getUntrimmedCode(node: any, raw: string) {
if (node.type !== "CodeBlock") {
return node.value
}
// Space indented CodeBlock that has not lang
if (!node.lang) {
return node.value;
}
if (node.type !== "CodeBlock") {
return node.value;
}
// Space indented CodeBlock that has not lang
if (!node.lang) {
return node.value;
}

// If it is not markdown codeBlock, just use node.value
if (!(raw.startsWith("```") && raw.endsWith("```"))) {
if (node.value.endsWith("\n")) {
return node.value
// If it is not markdown codeBlock, just use node.value
if (!(raw.startsWith("```") && raw.endsWith("```"))) {
if (node.value.endsWith("\n")) {
return node.value;
}
return node.value + "\n";
}
return node.value + "\n";
}
// Markdown(remark) specific hack
// https://github.com/wooorm/remark/issues/207#issuecomment-244620590
const lines = raw.split("\n");
// code lines without the first line and the last line
const codeLines = lines.slice(1, lines.length - 1);
// add last new line
// \n```
return codeLines.join("\n") + "\n";
// Markdown(remark) specific hack
// https://github.com/wooorm/remark/issues/207#issuecomment-244620590
const lines = raw.split("\n");
// code lines without the first line and the last line
const codeLines = lines.slice(1, lines.length - 1);
// add last new line
// \n```
return codeLines.join("\n") + "\n";
}

export default {
linter: createReporter({
fix: false
}),
fixer: createReporter({
fix: true
})
linter: createReporter({
fix: false
}),
fixer: createReporter({
fix: true
})
};
46 changes: 27 additions & 19 deletions test/fixtures/style.eslintconfig.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,43 @@
module.exports = {
rules: {
"eol-last": ["error", "always"],
"indent": ["error", 4, {
"SwitchCase": 1
}],
"quotes": ["error", "double"],
indent: [
"error",
4,
{
SwitchCase: 1
}
],
quotes: ["error", "double"],
"key-spacing": "error",
"no-dupe-keys": "error",
"keyword-spacing": "error",
"linebreak-style": ["error", "unix"],
"rest-spread-spacing": "error",
"semi": ["error", "always"],
semi: ["error", "always"],
"semi-spacing": "error",
"space-before-blocks": "error",
"space-before-function-paren": ["error", "never"],
"space-in-parens": "error",
"space-infix-ops": "error",
"space-unary-ops": "error",
"spaced-comment": ["error", "always", {
"exceptions": ["-", "="],
"markers": [
"eslint",
"eslint-env",
"eslint-disable",
"eslint-enable",
"eslint-disable-line",
"eslint-disable-next-line",
"exported",
"globals",
"istanbul"
]
}]
"spaced-comment": [
"error",
"always",
{
exceptions: ["-", "="],
markers: [
"eslint",
"eslint-env",
"eslint-disable",
"eslint-enable",
"eslint-disable-line",
"eslint-disable-next-line",
"exported",
"globals",
"istanbul"
]
}
]
}
};
Loading

0 comments on commit 1e9d89b

Please sign in to comment.