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 swagger2openapi #63631

Merged
merged 16 commits into from Jan 4, 2023
Merged

add type swagger2openapi #63631

merged 16 commits into from Jan 4, 2023

Conversation

rxliuli
Copy link
Contributor

@rxliuli rxliuli commented Dec 15, 2022

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
  • tslint.json should contain { "extends": "@definitelytyped/dtslint/dt.json" }, and no additional rules.
  • tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: <>
  • If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the header.

If removing a declaration:

  • If a package was never on Definitely Typed, you don't need to do anything. (If you wrote a package and provided types, you don't need to register it with us.)
  • Delete the package's directory.
  • Add it to notNeededPackages.json.

Another package openapi-types depends on, another PR has been raised, ref: microsoft/DefinitelyTyped-tools#578

@typescript-bot
Copy link
Contributor

typescript-bot commented Dec 15, 2022

@rxliuli Thank you for submitting this PR!

This is a live comment which 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

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 63631,
  "author": "rxliuli",
  "headCommitOid": "00b5d9ed45b91c2c8f8c0a8fbc209eb1af1cdf6e",
  "mergeBaseOid": "2ca598a19f41c2294b16d7de4cffe64371267474",
  "lastPushDate": "2023-01-04T07:45:08.000Z",
  "lastActivityDate": "2023-01-04T23:45:30.000Z",
  "mergeOfferDate": "2023-01-04T19:12:05.000Z",
  "mergeRequestDate": "2023-01-04T23:45:30.000Z",
  "mergeRequestUser": "rxliuli",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "swagger2openapi",
      "kind": "add",
      "files": [
        {
          "path": "types/swagger2openapi/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/swagger2openapi/package.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/swagger2openapi/swagger2openapi-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/swagger2openapi/tsconfig.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/swagger2openapi/tslint.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [],
      "addedOwners": [
        "rxliuli"
      ],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "jakebailey",
      "date": "2023-01-04T19:11:17.000Z",
      "isMaintainer": true
    },
    {
      "type": "stale",
      "reviewer": "peterblazejewicz",
      "date": "2022-12-23T20:44:22.000Z",
      "abbrOid": "e3cbc21"
    }
  ],
  "mainBotCommentID": 1352794675,
  "ciResult": "pass"
}

@typescript-bot typescript-bot added the New Definition This PR creates a new definition package. label Dec 15, 2022
@typescript-bot typescript-bot added this to Waiting for Code Reviews in New Pull Request Status Board Dec 15, 2022
@typescript-bot
Copy link
Contributor

🔔 @rxliuli — 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 Dec 15, 2022
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Dec 15, 2022
@typescript-bot
Copy link
Contributor

@rxliuli 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 which 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 Dec 19, 2022
@typescript-bot typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Dec 19, 2022
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Action in New Pull Request Status Board Dec 19, 2022
@peterblazejewicz
Copy link
Member

@rxliuli please remove comments coming directly from a template, there were added to help you write a code only.

@typescript-bot typescript-bot moved this from Needs Maintainer Action to Waiting for Code Reviews in New Pull Request Status Board Dec 20, 2022
@typescript-bot typescript-bot added the The CI failed When GH Actions fails label Dec 20, 2022
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Dec 20, 2022
@typescript-bot
Copy link
Contributor

@rxliuli 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 which 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 Dec 20, 2022
@typescript-bot typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Dec 20, 2022
@typescript-bot typescript-bot added the The CI failed When GH Actions fails label Dec 20, 2022
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Dec 20, 2022
@typescript-bot
Copy link
Contributor

@rxliuli 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 which 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 Dec 20, 2022
@typescript-bot typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Dec 20, 2022
@typescript-bot typescript-bot added the The CI failed When GH Actions fails label Dec 20, 2022
@typescript-bot
Copy link
Contributor

@peterblazejewicz Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Action in New Pull Request Status Board Dec 22, 2022
@peterblazejewicz
Copy link
Member

peterblazejewicz commented Dec 22, 2022

This code will prompt an error @peterblazejewicz

export converter;

image

oh, yes, my bad, I mean: export = converter, module exports symbols directly or trough this container, needs to re-assemble this export:
https://github.com/Mermade/oas-kit/blob/main/packages/swagger2openapi/index.js#L1657-L1666

@rxliuli
Copy link
Contributor Author

rxliuli commented Dec 23, 2022

This code will prompt an error @peterblazejewicz

export converter;

image

oh, yes, my bad, I mean: export = converter, module exports symbols directly or trough this container, needs to re-assemble this export: https://github.com/Mermade/oas-kit/blob/main/packages/swagger2openapi/index.js#L1657-L1666

still error
image

@typescript-bot typescript-bot moved this from Needs Maintainer Action to Waiting for Code Reviews in New Pull Request Status Board Dec 24, 2022
@typescript-bot typescript-bot added the The CI failed When GH Actions fails label Dec 24, 2022
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Dec 24, 2022
@typescript-bot
Copy link
Contributor

@rxliuli 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 which 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 Dec 24, 2022
@typescript-bot typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Dec 24, 2022
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Action in New Pull Request Status Board Dec 24, 2022
@typescript-bot
Copy link
Contributor

@peterblazejewicz Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

@typescript-bot typescript-bot moved this from Needs Maintainer Action to Waiting for Code Reviews in New Pull Request Status Board Jan 4, 2023
@typescript-bot
Copy link
Contributor

@jakebailey, @peterblazejewicz Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Action in New Pull Request Status Board Jan 4, 2023
@typescript-bot typescript-bot added Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner labels Jan 4, 2023
@typescript-bot typescript-bot moved this from Needs Maintainer Action to Waiting for Author to Merge in New Pull Request Status Board Jan 4, 2023
@typescript-bot
Copy link
Contributor

@rxliuli: Everything looks good here. I am ready to merge this PR (at 00b5d9e) on your behalf whenever you think it's ready.

If you'd like that to happen, please post a comment saying:

Ready to merge

and I'll merge this PR almost instantly. Thanks for helping out! ❤️

@rxliuli
Copy link
Contributor Author

rxliuli commented Jan 4, 2023

Ready to merge

@typescript-bot typescript-bot moved this from Waiting for Author to Merge to Recently Merged in New Pull Request Status Board Jan 4, 2023
@typescript-bot typescript-bot merged commit a9f480c into DefinitelyTyped:master Jan 4, 2023
@typescript-bot typescript-bot removed this from Recently Merged in New Pull Request Status Board Feb 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Maintainer Approved New Definition This PR creates a new definition package. Self Merge This PR can now be self-merged by the PR author or an owner
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants