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

Add type definitions for Enhance https://enhance.dev/ #71725

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

agawley
Copy link

@agawley agawley commented Jan 22, 2025

Please fill in this template.

Select one of these and delete the others:

If adding a new definition:

  • The package does not already provide its own types, or cannot have its .d.ts files generated via --declaration
  • If this is for an npm package, match the name. If not, do not conflict with the name of an npm package.
  • Create it with dts-gen --dt, not by basing it on an existing project.
  • Represents shape of module/library correctly
  • tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

These are basic types for the Enhance project. They are modelled after the types in @enhance/types but with some corrections. I'd like to put them on DefinitelyTyped for consistency and maintainability. I hope to add more types over time -particularly for their @enhance/custom-element package.

@typescript-bot
Copy link
Contributor

typescript-bot commented Jan 22, 2025

@agawley Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 — I'm the local bot who will help you through the process of getting things through.

This is a live comment that I will keep updated.

1 package in this PR

Code Reviews

This PR adds a new definition, so it needs to be reviewed by a DT maintainer before it can be merged.

You can test the changes of this PR in the Playground.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • 🕐 Only a DT maintainer can approve changes when there are new packages added

Once every item on this list is checked, I'll ask you for permission to merge and publish the changes.


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 71725,
  "author": "agawley",
  "headCommitOid": "10894aa4e8d1717516ae8867f3fbaa50e88785ea",
  "mergeBaseOid": "1d976b9454356ea4146621002c270b78b2c4d7cf",
  "lastPushDate": "2025-01-22T17:33:05.000Z",
  "lastActivityDate": "2025-01-22T17:33:05.000Z",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "enhance__enhance",
      "kind": "add",
      "files": [
        {
          "path": "types/enhance__enhance/.eslintrc.json",
          "kind": "package-meta",
          "suspect": "edited"
        },
        {
          "path": "types/enhance__enhance/.npmignore",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/enhance__enhance/enhance__enhance-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/enhance__enhance/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/enhance__enhance/package.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/enhance__enhance/tsconfig.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [],
      "addedOwners": [
        "agawley"
      ],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [],
  "mainBotCommentID": 2607855655,
  "ciResult": "pass"
}

@typescript-bot typescript-bot added New Definition This PR creates a new definition package. Check Config Changes a module config files labels Jan 22, 2025
@typescript-bot
Copy link
Contributor

🔔 @agawley — you're the only owner, but it would still be good if you find someone to review this PR in the next few days, otherwise a maintainer will look at it. (And if you do find someone, maybe even recruit them to be a second owner to make future changes easier...)

@typescript-bot typescript-bot added the The CI failed When GH Actions fails label Jan 22, 2025
@typescript-bot
Copy link
Contributor

@agawley The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds that are failing do not end up on the list of PRs for the DT maintainers to review.

@typescript-bot typescript-bot removed the The CI failed When GH Actions fails label Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Check Config Changes a module config files New Definition This PR creates a new definition package.
Projects
Status: Needs Maintainer Action
Development

Successfully merging this pull request may close these issues.

2 participants