Skip to content

Update formatter to utilize stylelint #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update formatter to utilize stylelint #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9305dc8
Update formatter to utilize stylelint
JackyLei94 Sep 21, 2022
f659c51
fix spacing
JackyLei94 Sep 21, 2022
ef9c277
Update print results todo and typing
JackyLei94 Sep 21, 2022
cd51a5e
Remove print results function
JackyLei94 Sep 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"name": "@lint-todo/eslint-formatter-todo",
"name": "@lint-todo/stylelint-formatter-todo",
"version": "4.0.0",
"description": "An ESLint formatter that can report errors as todos.",
"description": "A Stylelint formatter that can report errors as todos.",
"repository": {
"type": "git",
"url": "git+https://github.com/lint-todo/eslint-formatter-todo.git"
},
"license": "MIT",
"contributors": [
"Steve Calvert <steve.calvert@gmail.com>",
"Renato Iwashima <renatoiwa@gmail.com>"
"Jacky Lei <jackyleichicago@gmail.com>",
"Steve Calvert <steve.calvert@gmail.com>"
],
"main": "lib/index.js",
"types": "lib/index.d.ts",
Expand All @@ -30,6 +30,7 @@
"fs-extra": "^10.0.0",
"has-flag": "^4.0.0",
"strip-ansi": "^6.0.0",
"stylelint": "^14.9.1",
"text-table": "^0.2.0",
"type-fest": "^0.20.2"
},
Expand Down Expand Up @@ -60,7 +61,8 @@
"typescript": "^4.0.3"
},
"peerDependencies": {
"eslint": "^8.4.0"
"eslint": "^8.4.0",
"stylelint": "^14.9.1"
},
"engines": {
"node": ">= 14"
Expand Down Expand Up @@ -91,13 +93,13 @@
"node": "14.20.0"
},
"bugs": {
"url": "https://github.com/lint-todo/eslint-formatter-todo/issues"
"url": "https://github.com/lint-todo/stylelint-formatter-todo/issues"
},
"homepage": "https://github.com/lint-todo/eslint-formatter-todo#readme",
"homepage": "https://github.com/lint-todo/stylelint-formatter-todo#readme",
"directories": {
"lib": "lib"
},
"keywords": [
"eslint"
"stylelint"
]
}
184 changes: 64 additions & 120 deletions src/formatter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,28 @@ import {
generateTodoBatches,
getSeverity,
getTodoConfig,
Severity,
Severity as SeverityIntegers,
TodoConfig,
TodoData,
todoStorageFileExists,
Range,
validateConfig,
WriteTodoOptions,
writeTodos,
writeTodos
} from '@lint-todo/utils';
import { relative, join } from 'path';
import hasFlag from 'has-flag';
import ci from 'ci-info';
import { printResults } from './print-results';
import hasFlag from 'has-flag';
import { join, relative } from 'path';
import { getBaseDir } from './get-base-dir';
import { LintResultWithTodo, Severity, TodoFormatterOptions, TodoWarning } from './types';

import type { ESLint, Linter } from 'eslint';
import type { TodoFormatterOptions } from './types';
const SEVERITY_INT_MAP = {
[-1]: Severity.TODO,
[0]: Severity.OFF,
[1]: Severity.WARNING,
[2]: Severity.ERROR
};

const LINES_PATTERN = /(.*?(?:\r\n?|\n|$))/gm;

export async function formatter(results: ESLint.LintResult[]): Promise<string> {
export async function formatter(results: LintResultWithTodo[]): Promise<string> {
const baseDir = getBaseDir();
const todoConfigResult = validateConfig(baseDir);

Expand All @@ -42,7 +43,7 @@ export async function formatter(results: ESLint.LintResult[]): Promise<string> {
const todoInfo = {
added: 0,
removed: 0,
todoConfig: getTodoConfig(process.cwd(), 'eslint') ?? {},
todoConfig: getTodoConfig(process.cwd(), 'stylelint') ?? {},
};

const formatTodoAs = process.env.FORMAT_TODO_AS;
Expand All @@ -69,10 +70,10 @@ export async function formatter(results: ESLint.LintResult[]): Promise<string> {
);

const optionsForFile: WriteTodoOptions = {
engine: 'eslint',
shouldRemove: (todoDatum: TodoData) => todoDatum.engine === 'eslint',
engine: 'stylelint',
shouldRemove: (todoDatum: TodoData) => todoDatum.engine === 'stylelint',
todoConfig: todoInfo.todoConfig,
filePath: relative(baseDir, fileResults.filePath),
filePath: relative(baseDir, fileResults.source ?? ''),
};

if (updateTodo) {
Expand All @@ -96,17 +97,19 @@ export async function formatter(results: ESLint.LintResult[]): Promise<string> {
});
}

return await printResults(results, {
formatTodoAs,
updateTodo,
includeTodo,
shouldCleanTodos,
todoInfo,
});
// TODO Implement printResults to match string formatter for stylelint
// return await printResults(results, returnValue, {
// formatTodoAs,
// updateTodo,
// includeTodo,
// shouldCleanTodos,
// todoInfo,
// });
return '';
}

function processResults(
results: ESLint.LintResult[],
results: LintResultWithTodo[],
maybeTodos: Set<TodoData>,
options: TodoFormatterOptions
) {
Expand Down Expand Up @@ -138,14 +141,15 @@ function processResults(
*
* @param results ESLint results array
*/
export function updateResults(
results: ESLint.LintResult[],
export function updateResults(
results: LintResultWithTodo[],
existingTodos: Set<TodoData>
): void {
for (const todo of existingTodos) {
const severity: Severity = getSeverity(todo);
const SeverityInteger: SeverityIntegers = getSeverity(todo);
const severity: Severity = SEVERITY_INT_MAP[SeverityInteger];

if (severity === Severity.error) {
if (severity === Severity.ERROR) {
continue;
}

Expand All @@ -155,78 +159,53 @@ export function updateResults(
continue;
}

const message = result.messages.find(
(message) => message === todo.originalLintResult
const warning = result.warnings.find(
(warning) => warning === todo.originalLintResult
);

if (!message) {
if (!warning) {
continue;
}

if (severity === Severity.warn) {
result.warningCount = result.warningCount + 1;

if (message.fix) {
result.fixableWarningCount = result.fixableWarningCount + 1;
result.fixableErrorCount -= 1;
}
} else {
result.todoCount = Number.isInteger(result.todoCount)
? result.todoCount + 1
: 1;

if (message.fix) {
result.fixableTodoCount = Number.isInteger(result.fixableTodoCount)
? result.fixableTodoCount + 1
: 1;
result.fixableErrorCount -= 1;
}
}

message.severity = <Linter.Severity>severity;

result.errorCount -= 1;
warning.severity = <Severity>severity;
}
}

export function buildMaybeTodos(
function buildMaybeTodos(
baseDir: string,
lintResults: ESLint.LintResult[],
lintResults: LintResultWithTodo[],
todoConfig?: TodoConfig,
engine?: string
): Set<TodoData> {
const results = lintResults.filter((result) => result.messages.length > 0);
const results = lintResults.filter((result) => result.warnings.length > 0);

const todoData = results.reduce((converted, lintResult) => {
lintResult.messages.forEach((message: Linter.LintMessage) => {
if (message.severity !== Severity.error) {
lintResult.warnings.forEach((warning) => {
if (warning.severity !== Severity.ERROR) {
return;
}

const range = {
start: {
line: message.line,
column: message.column,
line: warning.line,
column: warning.column,
},
end: {
line: message.endLine ?? message.line,
column: message.endColumn ?? message.column,
line: warning.endLine ?? warning.line,
column: warning.endColumn ?? warning.column,
},
};

const todoDatum = buildTodoDatum(
baseDir,
{
engine: engine ?? 'eslint',
filePath: lintResult.filePath,
ruleId: message.ruleId || '',
engine: engine ?? 'stylelint',
filePath: lintResult.source ?? '',
ruleId: warning.rule ?? '',
range,
source: lintResult.source
? getSourceForRange(
lintResult.source.match(LINES_PATTERN) || [],
range
)
: '',
originalLintResult: message,
// Stylelint does not have source as a part of its warning
source: '',
originalLintResult: warning,
},
todoConfig
);
Expand All @@ -240,67 +219,32 @@ export function buildMaybeTodos(
return todoData;
}

function getSourceForRange(source: string[], range: Range) {
const firstLine = range.start.line - 1;
const lastLine = range.end.line - 1;
let currentLine = firstLine - 1;
const firstColumn = range.start.column - 1;
const lastColumn = range.end.column - 1;
const src = [];
let line;

while (currentLine < lastLine) {
currentLine++;
line = source[currentLine];

if (currentLine === firstLine) {
if (firstLine === lastLine) {
src.push(line.slice(firstColumn, lastColumn));
} else {
src.push(line.slice(firstColumn));
}
} else if (currentLine === lastLine) {
src.push(line.slice(0, lastColumn));
} else {
src.push(line);
}
}

return src.join('');
}

function pushResult(results: ESLint.LintResult[], todo: TodoData) {
function pushResult(results: LintResultWithTodo[], todo: TodoData) {
const resultForFile = findResult(results, todo);

const result: Linter.LintMessage = {
ruleId: 'invalid-todo-violation-rule',
message: `Todo violation passes \`${todo.ruleId}\` rule. Please run with \`CLEAN_TODO=1\` env var to remove this todo from the todo list.`,
severity: 2,
const todoWarning: TodoWarning = {
rule: 'invalid-todo-violation-rule',
text: `Todo violation passes \`${todo.ruleId}\` rule. Please run with \`CLEAN_TODO=1\` env var to remove this todo from the todo list.`,
severity: 'todo',
column: 0,
line: 0,
};

if (resultForFile) {
resultForFile.messages.push(result);
resultForFile.errorCount += 1;
resultForFile.warnings.push(todoWarning);
} else {
results.push({
filePath: join(getBaseDir(), todo.filePath),
messages: [result],
errorCount: 1,
warningCount: 0,
todoCount: 0,
fatalErrorCount: 0,
fixableErrorCount: 0,
fixableWarningCount: 0,
fixableTodoCount: 0,
usedDeprecatedRules: [],
source: join(getBaseDir(), todo.filePath),
warnings: [todoWarning],
deprecations: [],
invalidOptionWarnings: [],
parseErrors: []
});
}
}

function findResult(results: ESLint.LintResult[], todo: TodoData) {
function findResult(results: LintResultWithTodo[], todo: TodoData) {
return results.find(
(result) => relative(getBaseDir(), result.filePath) === todo.filePath
(result) => relative(getBaseDir(), result.source ?? '') === todo.filePath
);
}
Loading