test: add package compatibility tests using publint

[alexprudhomme]

https://coveord.atlassian.net/browse/KIT-3596

[alexprudhomme]

I was able to make a script with the zx library to test attw as well. In this one, I am testing headless and filtering out the FalseESM errors. Let me know if you think we should add this.

import {$} from 'zx';

interface Problem {
  kind: string;
  resolutionKind?: string;
}

await $({
  nothrow: true,
})`npx attw --pack packages/headless --format json > .attw.json`;
const output = await $`cat .attw.json`;
await $`rm .attw.json`;

const json = JSON.parse(output.stdout);

json.analysis.problems = json.analysis.problems.filter(
  (problem: Problem) => problem.kind !== 'FalseESM'
);

if (!json.analysis.problems || json.analysis.problems.length === 0) {
  console.log('No errors found');
  process.exit(0);
}

if (
  json.analysis.problems.every(
    (problem: Problem) => problem.resolutionKind === 'node10 '
  )
) {
  console.log("Only found node10 or problems, which we don't care about");
  process.exit(0);
}

if (
  json.analysis.problems.every((problem: Problem) => problem.kind === 'warning')
)
  console.log('Errors found');
console.log(json.analysis.problems);
process.exit(1);

[fbeaudoincoveo]

I was able to make a script with the zx library to test attw as well. In this one, I am testing headless and filtering out the FalseESM errors. Let me know if you think we should add this.

@alexprudhomme as discussed in person, I don't think we should run attw checks in our CI until our packages are clean enough that we aren't forced to filter out "false" positives all over the place in the attw report. Hopefully by then the attw CLI will have evolved to be more CI-friendly, or better yet they'll have released an npm library that does what we need.