chore: migrated shared-fixtures to ast-spec

[JoshuaKGoldberg]

PR Checklist

• Addresses an existing open issue: fixes Repo: move shared-fixtures tests to ast-spec fixtures #6065
• That issue was marked as accepting prs
• Steps in Contributing were taken

Overview

Migrates all the old shared-fixtures fixtures into the new ast-spec fixtures. Within that they're given the same folder name as their old fixture path.

It would be better long-term to split these fixtures up as described in #6065:

Each fixture should only cover one hyper-targeted, specific case to keep things easy to debug and review.

...but there are ~375 of them, and I'd rather get them into ast-spec sooner. This way they'll be easier to split up later! If this PR is approved I can file a followup issue & find-and-replace the // TODO comments in fixtures to refer to it.

Most of the work in this PR was done in two steps:

1. 327aa0c29: Ran yarn tsx tools/migrate-fixtures.ts to create unsorted-fixtures from the old shared-fixtures
2. bec1fe800: Deleted shared-fixtures altogether

tools/migrate-fixtures.ts

import * as cp from "node:child_process";
import { existsSync, promises as fs } from "node:fs";
import { tmpdir } from "node:os";
import path from "node:path";
import { promisify } from "node:util";

import glob from "glob";

const exec = promisify(cp.exec);

const newFixturesDir = "packages/ast-spec/src/unsorted-fixtures";

const oldFixtures = glob.sync("packages/shared-fixtures/fixtures/**/*.ts");

async function main(): Promise<void> {
  // Make sure the new fixtures directory exists, and has no prior contents
  if (existsSync(newFixturesDir)) {
    await fs.rm(newFixturesDir, { recursive: true });
  }

  await fs.mkdir(newFixturesDir, {
    recursive: true,
  });

  // Copy each of the old fixtures into the new fixtures directory
  for (const fixture of oldFixtures) {
    const [oldFileName, group] = fixture.split("/").reverse();
    const fixtureName = oldFileName.split(".")[0];
    const fixtureDirectory = path.join(
      newFixturesDir,
      group,
      "fixtures",
      fixtureName
    );

    await fs.mkdir(fixtureDirectory, { recursive: true });
    await fs.writeFile(
      path.join(fixtureDirectory, "fixture.ts"),
      await fs.readFile(fixture)
    );
  }

  // Run Jest on ast-spec to find new fixtures with syntax errors
  const tempFile = path.join(tmpdir(), "temp.json");
  try {
    await exec(`jest /fixtures --json > ${tempFile}`, {
      cwd: "packages/ast-spec",
    });
  } catch {
    /* expected */
  }
  const jestOutput = JSON.parse((await fs.readFile(tempFile)).toString()) as {
    testResults: {
      assertionResults: { ancestorTitles: string[]; status: string }[];
    }[];
  };
  await fs.rm(tempFile);

  // Filter & deduplicate messages from those failing tests
  const failingFixtures = Array.from(
    new Set(
      jestOutput.testResults[0]
        .filter(
          (assertion) =>
            assertion.ancestorTitles.includes("unsorted-fixtures") &&
            assertion.status !== "passed"
        )
        .map((assertion) => assertion.ancestorTitles.slice(2).join("/"))
    )
  );

  // For each failing fixture, move it to an _error_ directory
  for (const failingFixture of failingFixtures) {
    const failingFixtureDirectory = path.join(
      newFixturesDir,
      failingFixture.replace("/", "/fixtures/")
    );

    const newErrorFixtureDirectory = path.join(
      failingFixtureDirectory.replace("/fixtures/", "/fixtures/_error_/")
    );
    await fs.mkdir(newErrorFixtureDirectory, {
      recursive: true,
    });
    await fs.rename(
      path.join(failingFixtureDirectory, "fixture.ts"),
      path.join(newErrorFixtureDirectory, "fixture.ts")
    );
    await fs.rm(path.join(failingFixtureDirectory, "snapshots"), {
      recursive: true,
    });
  }

  // Re-run Jest to update snapshots a second time
  await exec(`jest /fixtures`, {
    cwd: "packages/ast-spec",
  });
}

main()
  .then(() => console.log("Done."))
  .catch((error) => {
    throw error;
  });

[typescript-eslint]

Thanks for the PR, @JoshuaKGoldberg!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

---

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 05446b1. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 47 targets

• Node 14 - nx test typescript-estree --coverage=false
• Node 18 - nx test typescript-estree
• Node 14 - nx test ast-spec --coverage=false
• nx run-many --target=lint --parallel
• Node 14 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx test visitor-keys --coverage=false
• Node 14 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx test eslint-plugin --coverage=false
• Node 14 - nx test eslint-plugin-internal --coverage=false
• Node 14 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx test type-utils --coverage=false
• Node 14 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx run-many --target=build --parallel --exclude website
• nx run-many --target=build --parallel --exclude website
• Node 14 - nx test scope-manager --coverage=false
• Node 14 - nx test utils --coverage=false
• Node 14 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx test parser --coverage=false
• Node 14 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx test eslint-plugin-tslint --coverage=false
• Node 14 - nx run-many --target=build --parallel --exclude website
• nx run-many --target=build --parallel --exclude website
• Node 18 - nx test type-utils
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 18 - nx test visitor-keys
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 18 - nx test utils
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 18 - nx test scope-manager
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 18 - nx test parser
• Node 18 - nx run-many --target=build --parallel --exclude website
• nx run-many --target=typecheck --parallel
• Node 18 - nx test ast-spec
• Node 18 - nx test eslint-plugin-internal
• Node 18 - nx test eslint-plugin-tslint
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 18 - nx test eslint-plugin
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 18 - nx run-many --target=build --parallel --exclude website
• nx run-many --target=build --parallel --exclude website
• nx run-many --target=build --parallel --exclude website
• nx run-many --target=build --parallel --exclude website

---

Sent with 💌 from NxCloud.

[netlify]

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	05446b1
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/63e55bb1e7f2da0008d8233e
😎 Deploy Preview	https://deploy-preview-6436--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[codecov]

Codecov Report

Merging #6436 (05446b1) into main (a9cb860) will decrease coverage by 0.87%.
The diff coverage is n/a.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6436      +/-   ##
==========================================
- Coverage   91.53%   90.66%   -0.87%     
==========================================
  Files         371      371              
  Lines       12662    12662              
  Branches     3721     3721              
==========================================
- Hits        11590    11480     -110     
- Misses        754      845      +91     
- Partials      318      337      +19     

Flag	Coverage Δ
unittest	90.66% <ø> (-0.87%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
packages/typescript-estree/src/convert-comments.ts	57.14% <0.00%> (-42.86%)	⬇️
packages/typescript-estree/src/convert.ts	85.67% <0.00%> (-11.46%)	⬇️
packages/typescript-estree/src/node-utils.ts	83.51% <0.00%> (-7.45%)	⬇️
...escript-estree/src/semantic-or-syntactic-errors.ts	80.00% <0.00%> (-6.67%)	⬇️
...pt-estree/src/parseSettings/createParseSettings.ts	95.00% <0.00%> (-2.50%)	⬇️

[bradzacher]

Let's do this:

1. move this out of the src folder to a new folder called like legacy-fixtures
2. remove the todo comments and add info to the readme about how to add fixtures and what not to do.

Eg

The legacy-fixtures folder contains all of the old fixtures from our previous testing framework. No new fixtures should be added to this folder, and instead we should be attempting to migrate and remove cases wherever possible.

insert steps #6065?

After that I think we're in a good spot to land this?

[bradzacher]

We'll also want to make sure these fixtures are automatically re-tested using the test tooling, so you'll need to update the test to include them

[JoshuaKGoldberg]

Hmm, would you be upset if I moved legacy-fixtures to within src/? That way I don't have to keep these logic changes for two test directories...

[bradzacher]

ah yeah I guess the test isn't built to be relative to anything other than the src folder.
feel free to drop it in there then.

[bradzacher]

yas