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

Remove global import of 'DOM' type definitions. This is polluting customers environments by polluting the global type namespace. #323

Merged
merged 2 commits into from
Feb 5, 2025

Conversation

cleve-fauna
Copy link
Contributor

@cleve-fauna cleve-fauna commented Feb 5, 2025

Description

We are exporting the entire DOM lib as a library. Don't do that.
A recent commit added package-lock.json. We don't need that. Remove it.

Motivation and context

This breaks customer build environments as it pollutes the global type namespace.

How was the change tested?

I built with and without the changes here. You can see in the build the Triple-Slash-Directive used to be present but is no longer. Furthermore the linter I added throws in the original, but succeeds now.

Screenshots (if appropriate):

Before:

Screenshot 2025-02-05 at 10 11 27 AM

After:

Screenshot 2025-02-05 at 10 13 01 AM

Change types

    • Bug fix (non-breaking change that fixes an issue)
    • New feature (non-breaking change that adds functionality)
    • Breaking change (backwards-incompatible fix or feature)

Checklist:

    • My code follows the code style of this project.
    • My change requires a change to Fauna documentation.
    • My change requires a change to the README, and I have updated it accordingly.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Out of Scope

The linter needs attention in general. It needs to move onto the latest version of eslint. Will work on that separately.

@cleve-fauna cleve-fauna requested a review from a team February 5, 2025 16:49
@cleve-fauna cleve-fauna marked this pull request as ready for review February 5, 2025 16:49
ptpaterson
ptpaterson previously approved these changes Feb 5, 2025
Copy link
Contributor

@ptpaterson ptpaterson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

rules: {
"@typescript-eslint/no-explicit-any": ["off"],
"tsdoc/syntax": "error",
"@typescript-eslint/triple-slash-reference": [
"error",
{ lib: "never", path: "never", types: "never" },
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good idea

@cleve-fauna cleve-fauna merged commit 27e9b09 into main Feb 5, 2025
7 checks passed
@cleve-fauna cleve-fauna deleted the main_fixBuildIssues branch February 5, 2025 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants