Skip to content

Added converter for max-line-length rule #195

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
3 changes: 2 additions & 1 deletion src/rules/converters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import { convertLabelPosition } from "./converters/label-position";
import { convertLinebreakStyle } from "./converters/linebreak-style";
import { convertMaxClassesPerFile } from "./converters/max-classes-per-file";
import { convertMaxFileLineCount } from "./converters/max-file-line-count";
import { convertMaxLineLength } from "./converters/max-line-length";
import { convertMemberOrdering } from "./converters/member-ordering";
import { convertNewlinePerChainedCall } from "./converters/newline-per-chained-call";
import { convertNewParens } from "./converters/new-parens";
Expand Down Expand Up @@ -184,6 +185,7 @@ export const converters = new Map([
["linebreak-style", convertLinebreakStyle],
["max-classes-per-file", convertMaxClassesPerFile],
["max-file-line-count", convertMaxFileLineCount],
["max-line-length", convertMaxLineLength],
["no-consecutive-blank-lines", convertNoConsecutiveBlankLines],
["no-console", convertNoConsole],
["no-empty", convertNoEmpty],
Expand Down Expand Up @@ -216,7 +218,6 @@ export const converters = new Map([
// TSLint core rules:
// ["ban", convertBan], // no-restricted-properties
// ["import-blacklist", convertImportBlacklist], // no-restricted-imports
// ["max-line-length", convertMaxLineLength], // max-len
// ["newline-before-return", convertNewlineBeforeReturn],
// ["no-duplicate-variable", convertNoDuplicateVariable], // no-redeclare
// ["no-shadowed-variable", convertNoShadowedVariable], // no-shadow
Expand Down
43 changes: 43 additions & 0 deletions src/rules/converters/max-line-length.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import { RuleConverter } from "../converter";

export const convertMaxLineLength: RuleConverter = tslintRule => {
return {
rules: [
{
...collectArguments(tslintRule.ruleArguments),
ruleName: "max-len",
},
],
};
};

const collectArguments = (ruleArguments: any[]) => {
if (ruleArguments.length === 0 || ruleArguments[0] === false || ruleArguments.length < 2) {
return undefined;
}

if (ruleArguments.length === 2 && typeof ruleArguments[1] === "number") {
return {
ruleArguments: [
{
code: ruleArguments[1],
},
],
};
}

const argument = ruleArguments[1];

return {
ruleArguments: [
{
...("limit" in argument && { code: argument.limit }),
...("ignore-pattern" in argument && { ignorePattern: argument["ignore-pattern"] }),
...("check-strings" in argument && { ignoreStrings: !argument["check-strings"] }),
...("check-regex" in argument && {
ignoreRegExpLiterals: !argument["check-regex"],
}),
},
],
};
};
194 changes: 194 additions & 0 deletions src/rules/converters/tests/max-line-length.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
import { convertMaxLineLength } from "../max-line-length";

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

expect(result).toEqual({
rules: [
{
ruleName: "max-len",
},
],
});
});

test("conversion with one argument true value", () => {
const result = convertMaxLineLength({
ruleArguments: [true],
});

expect(result).toEqual({
rules: [
{
ruleName: "max-len",
},
],
});
});

test("conversion with two arguments and first is false", () => {
const result = convertMaxLineLength({
ruleArguments: [false, 123],
});

expect(result).toEqual({
rules: [
{
ruleName: "max-len",
},
],
});
});

test("conversion with two arguments and second is number", () => {
const result = convertMaxLineLength({
ruleArguments: [true, 123],
});

expect(result).toEqual({
rules: [
{
ruleArguments: [{ code: 123 }],
ruleName: "max-len",
},
],
});
});

test("conversion with two arguments and second is object", () => {
const result = convertMaxLineLength({
ruleArguments: [
true,
{
limit: 123,
"ignore-pattern": "^import |^export {(.*?)}",
"check-strings": true,
"check-regex": true,
},
],
});

expect(result).toEqual({
rules: [
{
ruleArguments: [
{
code: 123,
ignorePattern: "^import |^export {(.*?)}",
ignoreStrings: false,
ignoreRegExpLiterals: false,
},
],
ruleName: "max-len",
},
],
});
});

test("conversion with check-strings inverting value true to false", () => {
const result = convertMaxLineLength({
ruleArguments: [
true,
{
limit: 123,
"check-strings": true,
},
],
});

expect(result).toEqual({
rules: [
{
ruleArguments: [
{
code: 123,
ignoreStrings: false,
},
],
ruleName: "max-len",
},
],
});
});

test("conversion with check-strings inverting value false to true", () => {
const result = convertMaxLineLength({
ruleArguments: [
true,
{
limit: 123,
"check-strings": false,
},
],
});

expect(result).toEqual({
rules: [
{
ruleArguments: [
{
code: 123,
ignoreStrings: true,
},
],
ruleName: "max-len",
},
],
});
});

test("conversion with check-regex inverting value true to false", () => {
const result = convertMaxLineLength({
ruleArguments: [
true,
{
limit: 123,
"check-regex": true,
},
],
});

expect(result).toEqual({
rules: [
{
ruleArguments: [
{
code: 123,
ignoreRegExpLiterals: false,
},
],
ruleName: "max-len",
},
],
});
});

test("conversion with check-regex inverting value false to true", () => {
const result = convertMaxLineLength({
ruleArguments: [
true,
{
limit: 123,
"check-regex": false,
},
],
});

expect(result).toEqual({
rules: [
{
ruleArguments: [
{
code: 123,
ignoreRegExpLiterals: true,
},
],
ruleName: "max-len",
},
],
});
});
});