Skip to content
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

fix: wider compat TS types and CI checks to ensure correct type defs #6855

Merged
merged 14 commits into from Feb 10, 2021

Commits on Feb 10, 2021

  1. fix: wider compat TS types and CI checks to ensure correct type defs

    This PR improves our TS types further to make sure they are usable in a
    TS environment where ES Modules are the target output. Our use of
    `export =` is problematic this environment as TypeScript does not allow
    `export =` to be used and it errors.
    
    The fix for the type issues to avoid `export =` is to instead define the
    functions that you gain access to when you import Puppeteer as top level
    functions in our `types.d.ts` file. We can do this by declaring them
    explicitly in `src/node.ts`. These are then rolled into `lib/types.d.ts`
    at build time. The downside to this is that we have to keep those
    declarations in sync with the Puppeteer API; should we add a new method
    to the `Puppeteer` class, we must add it to the `nodes.ts` declarations.
    However, this could easily be automated by a small script that walks the
    AST and generates these. I will do that in a follow-up PR, but I
    consider this low risk given how rarely the very top level API of
    Puppeteer changes. The nice thing about this approach is we no longer
    need our script that hacks on changes to `lib/types.d.ts`.
    
    To avoid yet more releases to fix issues in one particular TS
    environment, this PR also includes a suite of example setups that we
    test on each CI run. Each sample folder contains `good.ts`, which should
    have no TS errors, and `bad.ts`, which should have some errors. The test
    first packs Puppeteer into a tar, and then installs it from that tar
    into each project. This should replicate how the published package
    behaves when it is installed. We then check that we get no errors on
    `good.ts`, and the expected errors on `bad.ts`.
    
    We have a variety of test projects that cover both TS and JS source
    code, and CJS and ESM imports and outputs.
    jackfranklin committed Feb 10, 2021
    Copy the full SHA
    d55bb76 View commit details
    Browse the repository at this point in the history
  2. Copy the full SHA
    0225b91 View commit details
    Browse the repository at this point in the history
  3. fix: name of tar file

    jackfranklin committed Feb 10, 2021
    Copy the full SHA
    a74c12e View commit details
    Browse the repository at this point in the history
  4. fix: log result

    jackfranklin committed Feb 10, 2021
    Copy the full SHA
    15638f1 View commit details
    Browse the repository at this point in the history
  5. fix: debugging failures

    jackfranklin committed Feb 10, 2021
    Copy the full SHA
    6ab6504 View commit details
    Browse the repository at this point in the history
  6. fix: tsconfig issues

    jackfranklin committed Feb 10, 2021
    Copy the full SHA
    bdd5616 View commit details
    Browse the repository at this point in the history
  7. Copy the full SHA
    cba064e View commit details
    Browse the repository at this point in the history
  8. fix: module resolution

    jackfranklin committed Feb 10, 2021
    Copy the full SHA
    cc5df4f View commit details
    Browse the repository at this point in the history
  9. Copy the full SHA
    0d4b73f View commit details
    Browse the repository at this point in the history
  10. Copy the full SHA
    eb52762 View commit details
    Browse the repository at this point in the history
  11. chore: review comments

    jackfranklin committed Feb 10, 2021
    Copy the full SHA
    ba42ea8 View commit details
    Browse the repository at this point in the history
  12. chore: escape spaces

    jackfranklin committed Feb 10, 2021
    Copy the full SHA
    44a93e2 View commit details
    Browse the repository at this point in the history
  13. chore: swap to spawn

    jackfranklin committed Feb 10, 2021
    Copy the full SHA
    986a1db View commit details
    Browse the repository at this point in the history
  14. chore: spawnSync better

    jackfranklin committed Feb 10, 2021
    Copy the full SHA
    37ca85b View commit details
    Browse the repository at this point in the history