Skip to content

fix: do not convert next-line to line for comments #648

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

Merged
merged 2 commits into from
Jul 25, 2020
Merged

fix: do not convert next-line to line for comments #648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7858ddd
fix: do not convert next-line to line for comments
KingDarBoja Jul 23, 2020
9d708a0
fix: check the comment directive
KingDarBoja Jul 24, 2020
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
42 changes: 23 additions & 19 deletions src/comments/convertFileComments.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,16 @@ export const b = true;
// tslint:enable
export const c = true;

export const d = true; // tslint:disable-line

/* tslint:disable */
export const d = true;
export const e = true;

/* tslint:disable-next-line */
export const e = true;
export const f = true;

/* tslint:enable */
export const f = true;
export const g = true;
`);

// Act
Expand All @@ -74,31 +76,33 @@ export const f = true;
expect(dependencies.fileSystem.writeFile).toHaveBeenCalledWith(
stubFileName,
`
// eslint-disable
/* eslint-disable */
export const a = true;

// eslint-disable-line
// eslint-disable-next-line
export const b = true;

// eslint-enable
/* eslint-enable */
export const c = true;

/* eslint-disable */
export const d = true;
export const d = true; // eslint-disable-line

/* eslint-disable-line */
/* eslint-disable */
export const e = true;

/* eslint-enable */
/* eslint-disable-next-line */
export const f = true;

/* eslint-enable */
export const g = true;
`,
);
});

it("parses rule names when they exist", async () => {
// Arrange
const dependencies = createStubDependencies(`
// tslint:disable:ts-a
/* tslint:disable:ts-a */
export const a = true;

// tslint:disable-next-line: ts-a ts-b
Expand All @@ -112,10 +116,10 @@ export const b = true;
expect(dependencies.fileSystem.writeFile).toHaveBeenCalledWith(
stubFileName,
`
// eslint-disable es-a
/* eslint-disable es-a */
export const a = true;

// eslint-disable-line es-a, es-b1, es-b2
// eslint-disable-next-line es-a, es-b1, es-b2
export const b = true;
`,
);
Expand All @@ -124,7 +128,7 @@ export const b = true;
it("re-uses a rule conversion from cache when it was already converted", async () => {
// Arrange
const dependencies = createStubDependencies(`
// tslint:disable:ts-a
/* tslint:disable:ts-a */
export const a = true;
`);

Expand All @@ -135,7 +139,7 @@ export const a = true;
expect(dependencies.fileSystem.writeFile).toHaveBeenCalledWith(
stubFileName,
`
// eslint-disable es-cached
/* eslint-disable es-cached */
export const a = true;
`,
);
Expand All @@ -144,7 +148,7 @@ export const a = true;
it("ignores comment text when there is no matching converter", async () => {
// Arrange
const dependencies = createStubDependencies(`
// tslint:disable:ts-z
/* tslint:disable:ts-z */
export const a = true;
`);

Expand All @@ -155,7 +159,7 @@ export const a = true;
expect(dependencies.fileSystem.writeFile).toHaveBeenCalledWith(
stubFileName,
`
// eslint-disable
/* eslint-disable */
export const a = true;
`,
);
Expand All @@ -164,7 +168,7 @@ export const a = true;
it("ignores comment text when its matching converter results in an error", async () => {
// Arrange
const dependencies = createStubDependencies(`
// tslint:disable:ts-error
/* tslint:disable:ts-error */
export const a = true;
`);

Expand All @@ -175,7 +179,7 @@ export const a = true;
expect(dependencies.fileSystem.writeFile).toHaveBeenCalledWith(
stubFileName,
`
// eslint-disable
/* eslint-disable */
export const a = true;
`,
);
Expand Down
8 changes: 4 additions & 4 deletions src/comments/replaceFileComments.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ export const replaceFileComments = (
};

for (const comment of [...comments].reverse()) {
const directive = comment.directive
.replace("tslint:", "eslint-")
.replace("next-line", "line");
const directive = comment.directive.replace("tslint:", "eslint-");
const ruleLists = uniqueFromSources(comment.ruleNames.map(getNewRuleLists)).filter(Boolean);
const [left, right] =
comment.commentKind === ts.SyntaxKind.SingleLineCommentTrivia
comment.commentKind === ts.SyntaxKind.SingleLineCommentTrivia &&
comment.directive !== "tslint:disable" &&
comment.directive !== "tslint:enable"
? ["// ", ""]
: ["/* ", " */"];

Expand Down