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

Added sfcc-ci typings to DefinitelyTyped #60517

Closed
wants to merge 4 commits into from

Conversation

kshehadeh
Copy link

Added sfcc-ci library typings

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.

@typescript-bot
Copy link
Contributor

typescript-bot commented May 25, 2022

@kshehadeh 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 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.

Inactive

This PR has been inactive for 31 days — closed because it wasn't merged for a long time!


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 60517,
  "author": "kshehadeh",
  "headCommitOid": "b8622d1f52b54399f15207c3f204dff9a1b4a536",
  "mergeBaseOid": "c432b1015151bc90947ea2ac3b1a50a86734ad0b",
  "lastPushDate": "2022-05-31T11:31:07.000Z",
  "lastActivityDate": "2022-05-31T20:24:53.000Z",
  "mergeOfferDate": "2022-05-31T20:25:36.000Z",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "sfcc-ci",
      "kind": "add",
      "files": [
        {
          "path": "types/sfcc-ci/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/sfcc-ci/sfcc-ci-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/sfcc-ci/tsconfig.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/sfcc-ci/tslint.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [],
      "addedOwners": [
        "kshehadeh"
      ],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "peterblazejewicz",
      "date": "2022-05-31T20:24:53.000Z",
      "isMaintainer": true
    }
  ],
  "mainBotCommentID": 1137217223,
  "ciResult": "pass"
}

@typescript-bot typescript-bot added The CI failed When GH Actions fails New Definition This PR creates a new definition package. labels May 25, 2022
@typescript-bot typescript-bot added this to Needs Author Action in Old Pull Request Status Board May 25, 2022
@typescript-bot
Copy link
Contributor

typescript-bot commented May 25, 2022

🔔 @kshehadeh — 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
Copy link
Contributor

@kshehadeh 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 May 25, 2022
@typescript-bot typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in Old Pull Request Status Board May 25, 2022
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Action in Old Pull Request Status Board May 25, 2022
@typescript-bot typescript-bot moved this from Needs Maintainer Action to Waiting for Code Reviews in Old Pull Request Status Board May 25, 2022
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Action in Old Pull Request Status Board May 25, 2022
@peterblazejewicz
Copy link
Member

Their README contains types definition for some of those params generated as 'any'. There is not much use of params, of all of them are 'any' in some scenarios.:
https://github.com/SalesforceCommerceCloud/sfcc-ci#code

kshehadeh and others added 3 commits May 31, 2022 07:30
Co-authored-by: Piotr Błażejewicz (Peter Blazejewicz) <peterblazejewicz@users.noreply.github.com>
Co-authored-by: Piotr Błażejewicz (Peter Blazejewicz) <peterblazejewicz@users.noreply.github.com>
Co-authored-by: Piotr Błażejewicz (Peter Blazejewicz) <peterblazejewicz@users.noreply.github.com>
@typescript-bot typescript-bot moved this from Needs Maintainer Action to Waiting for Code Reviews in Old Pull Request Status Board May 31, 2022
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Action in Old Pull Request Status Board May 31, 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?

Copy link
Member

@peterblazejewicz peterblazejewicz left a comment

Choose a reason for hiding this comment

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

LGTM!
@kshehadeh thanks!

@typescript-bot typescript-bot added Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner labels May 31, 2022
@typescript-bot
Copy link
Contributor

@kshehadeh: Everything looks good here. I am ready to merge this PR (at b8622d1) 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! ❤️

@typescript-bot typescript-bot moved this from Needs Maintainer Action to Waiting for Author to Merge in Old Pull Request Status Board May 31, 2022
@typescript-bot typescript-bot added the Unmerged The author did not merge the PR when it was ready. label Jun 11, 2022
@typescript-bot
Copy link
Contributor

Re-ping @kshehadeh / @«anyone?»:

This PR has been ready to merge for over a week, and I haven't seen any requests to merge it. I will close it on Jun 30th (in three weeks) if this doesn't happen.

(If there's no reason to avoid merging it, please do so. Otherwise, if it shouldn't be merged or if it needs more time, please close it or turn it into a draft.)

@typescript-bot typescript-bot removed this from Waiting for Author to Merge in Old Pull Request Status Board Jul 2, 2022
@typescript-bot
Copy link
Contributor

After a month, no one has requested merging the PR 😞. I'm going to assume that the change is not wanted after all, and will therefore close it.

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 Unmerged The author did not merge the PR when it was ready.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants