Added convertFileComments API

[JoshuaKGoldberg]

PR Checklist

• Addresses an existing issue: fixes Also export comment converter Node APIs #820
• That issue was marked as status: accepting prs

Overview

Adds a synchronous single-file-use function to convert a file's contents as a string into its ESLint equivalent.

import { convertFileComments } from "tslint-to-eslint-config";

// "// eslint-disable-next-line"
const newContents = convertFileComments({
    fileContent: "// tslint:disable-next-line",
    filePath: "a.ts",
});

[JoshuaKGoldberg]

@JamesHenry this is published under v2.0.0-beta4 now, if you want to try it out. Is this the kind of API you're looking for?

I'd recommend using both ruleCommentsCache (for a small perf boost) and ruleEquivalents (for rule accuracy per arguments).

[JamesHenry]

Ooh I missed this tip and just used your snippet in the description, I'll look at adding them in

[JamesHenry]

Thanks so much for the super fast turnaround! On the face of it this is exactly what I need. It's getting late here but I'll definitely incorporate this into the PR this week, thanks again!

[JamesHenry]

Hmm just installing beta4 and running a build/link with lerna is blowing up

I see the install affected TS versions in my yarn.lock file

I wonder if that could be related...

[JamesHenry]

Confirmed also happens with beta3, but not when restoring to beta2 which is where I was before

[JoshuaKGoldberg]

Oh you know what, I probably neglected to remove .d.ts files left over from old file names, manually published locally, and now they're checked into npm. Glorious. This is why we should have automated package publishing 😄 .

Published a beta5. If that still has the .d.ts cruft you can delete them locally (I'd also suggest changing your tsc settings to not pick up on those orphan node_modules/ files).

[JamesHenry]

This seems to be working great for my use-case! Thanks again