Skip to content

added no-trailing-whitespace converter and unit tests #196

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.

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

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions src/rules/converters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ import { convertNoStringLiteral } from "./converters/no-string-literal";
import { convertNoStringThrow } from "./converters/no-string-throw";
import { convertNoSwitchCaseFallThrough } from "./converters/no-switch-case-fall-through";
import { convertNoThisAssignment } from "./converters/no-this-assignment";
import { convertNoTrailingWhitespace } from "./converters/no-trailing-whitespace";
import { convertNoUnboundMethod } from "./converters/no-unbound-method";
import { convertNoUnnecessaryClass } from "./converters/no-unnecessary-class";
import { convertNoUnnecessaryInitializer } from "./converters/no-unnecessary-initializer";
Expand Down Expand Up @@ -155,6 +156,7 @@ export const converters = new Map([
["no-string-literal", convertNoStringLiteral],
["no-string-throw", convertNoStringThrow],
["no-switch-case-fall-through", convertNoSwitchCaseFallThrough],
["no-trailing-whitespace", convertNoTrailingWhitespace],
["no-this-assignment", convertNoThisAssignment],
["no-unbound-method", convertNoUnboundMethod],
["no-unnecessary-class", convertNoUnnecessaryClass],
Expand Down
32 changes: 32 additions & 0 deletions src/rules/converters/no-trailing-whitespace.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
import { RuleConverter } from "../converter";

export const convertNoTrailingWhitespace: RuleConverter = tslintRule => {
const ruleArguments: { [eslintOption in "ignoreComments" | "skipBlankLines"]?: true }[] = [];
const notices: string[] = [];

if (tslintRule.ruleArguments.includes("ignore-comments")) {
ruleArguments.push({ ignoreComments: true });
}

if (tslintRule.ruleArguments.includes("ignore-blank-lines")) {
ruleArguments.push({ skipBlankLines: true });
}

if (tslintRule.ruleArguments.includes("ignore-template-strings")) {
notices.push("ESLint does not support ignoring template strings.");
}

if (tslintRule.ruleArguments.includes("ignore-jsdoc")) {
notices.push("ESLint does not support ignoring JSDoc.");
}

return {
rules: [
{
...(notices.length > 0 && { notices }),
...(ruleArguments.length > 0 && { ruleArguments }),
ruleName: "no-trailing-spaces",
},
],
};
};
101 changes: 101 additions & 0 deletions src/rules/converters/tests/no-trailing-whitespace.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
import { convertNoTrailingWhitespace } from "../no-trailing-whitespace";

describe(convertNoTrailingWhitespace, () => {
test("conversion without arguments", () => {
const result = convertNoTrailingWhitespace({
ruleArguments: [],
});

expect(result).toEqual({
rules: [
{
ruleName: "no-trailing-spaces",
},
],
});
});

test("conversion with ignore-template-strings argument", () => {
const result = convertNoTrailingWhitespace({
ruleArguments: ["ignore-template-strings"],
});

expect(result).toEqual({
rules: [
{
notices: ["ESLint does not support ignoring template strings."],
ruleName: "no-trailing-spaces",
},
],
});
});

test("conversion with ignore-comments argument", () => {
const result = convertNoTrailingWhitespace({
ruleArguments: ["ignore-comments"],
});

expect(result).toEqual({
rules: [
{
ruleArguments: [{ ignoreComments: true }],
ruleName: "no-trailing-spaces",
},
],
});
});

test("conversion with ignore-jsdoc argument", () => {
const result = convertNoTrailingWhitespace({
ruleArguments: ["ignore-jsdoc"],
});

expect(result).toEqual({
rules: [
{
notices: ["ESLint does not support ignoring JSDoc."],
ruleName: "no-trailing-spaces",
},
],
});
});

test("conversion with ignore-blank-lines argument", () => {
const result = convertNoTrailingWhitespace({
ruleArguments: ["ignore-blank-lines"],
});

expect(result).toEqual({
rules: [
{
ruleArguments: [{ skipBlankLines: true }],
ruleName: "no-trailing-spaces",
},
],
});
});

test("conversion with all arguments", () => {
const result = convertNoTrailingWhitespace({
ruleArguments: [
"ignore-template-strings",
"ignore-comments",
"ignore-jsdoc",
"ignore-blank-lines",
],
});

expect(result).toEqual({
rules: [
{
notices: [
"ESLint does not support ignoring template strings.",
"ESLint does not support ignoring JSDoc.",
],
ruleArguments: [{ ignoreComments: true }, { skipBlankLines: true }],
ruleName: "no-trailing-spaces",
},
],
});
});
});