Handle non @types imports from tsconfig compilerOptions.types

[walkerburgin]

The TypeScript docs for compilerOptions.types make it sound like compilerOptions.types only applies to @types packages, but in practice it can also be used to include types from non @types in the global scope. For example, cypress recommends this in their docs:

{
  "compilerOptions": {
    "target": "es5",
    "lib": ["es5", "dom"],
    "types": ["cypress", "node"]
  },
  "include": ["**/*.ts"]
}

From what I can tell, if you don't specify compilerOptions.types, TypeScript will not automatically include types from a visible non @types package like cypress (describe, beforeEach, etc). But you can include non @types packages in compilerOptions.types to allow list them into the global scope.

---

Changes are visible to end-users: yes

• Searched for relevant documentation and updated as needed: yes
• Breaking change (forces users to change their own code or config): yes
• Suggested release notes appear below: yes/no

Test plan

I updated the existing test case for compilerOptions.types.

• Covered by existing test cases
• New test cases added

[CLAassistant]

All committers have signed the CLA.

[jbedard]

Why drop the ignored ones?

[walkerburgin]

I think it was originally just a mistake on my part.

Looking at it again, I'm not sure if these should be silently ignored or if they should fail. They're essentially unknown dependencies, right?

[jbedard]

Yeah, basically unknown dependencies.

I'd prefer keeping them to ensure we aren't changing existing behaviour. We can debate if it should error or silently ignore another time.

[walkerburgin]

Cool, I think I misunderstood the original intent of including them. I didn't realize they were being explicitly ignored (# gazelle:js_ignore_imports) 🤦‍♂️. It makes sense that they'd be ignored in that case.

I updated the PR to put them back, but needed to update gazelle/js/tests/tsconfig_deps/types/BUILD.in to ignore the original, non @types version of the import. That's still a small behavior change, but it feels right to me?

[jbedard]

This has been merged into the internal repo and will be synced back to this repo soon.

[walkerburgin]

👍 thanks!