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 @lambda-lambda-lambda/cli types #69502

Closed
wants to merge 1 commit into from

Conversation

nuxy
Copy link

@nuxy nuxy commented May 2, 2024

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.

@typescript-bot
Copy link
Contributor

typescript-bot commented May 2, 2024

@nuxy 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

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": 69502,
  "author": "nuxy",
  "headCommitOid": "ff4dd4c23389f97fcc4690fb47dd68ae1b4bb4fc",
  "mergeBaseOid": "4354a1088a2881bf6613b98c84d18e614f08705e",
  "lastPushDate": "2024-05-02T20:53:34.000Z",
  "lastActivityDate": "2024-05-06T17:09:41.000Z",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "lambda-lambda-lambda__cli",
      "kind": "add",
      "files": [
        {
          "path": "types/lambda-lambda-lambda__cli/.eslintrc.json",
          "kind": "package-meta",
          "suspect": "edited"
        },
        {
          "path": "types/lambda-lambda-lambda__cli/.npmignore",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/lambda-lambda-lambda__cli/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/lambda-lambda-lambda__cli/lambda-lambda-lambda__cli-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/lambda-lambda-lambda__cli/package.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/lambda-lambda-lambda__cli/tsconfig.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [],
      "addedOwners": [
        "nuxy"
      ],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [],
  "mainBotCommentID": 2091542577,
  "ciResult": "pass"
}

@typescript-bot typescript-bot added New Definition This PR creates a new definition package. Check Config Changes a module config files labels May 2, 2024
@typescript-bot typescript-bot added this to Waiting for Code Reviews in New Pull Request Status Board May 2, 2024
@typescript-bot
Copy link
Contributor

🔔 @nuxy — 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...)

@DangerBotOSS
Copy link

Formatting

The following files are not formatted:

  1. types/lambda-lambda-lambda__cli/lambda-lambda-lambda__cli-tests.ts
  2. types/lambda-lambda-lambda__cli/index.d.ts

Consider running pnpm dprint fmt on these files to make review easier.

Generated by 🚫 dangerJS against ff4dd4c

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

hey, the module repo contains already TS files, what's the status?
https://github.com/lambda-lambda-lambda/cli/blob/master/index.d.ts

[x] The package does not already provide its own types, or cannot have its .d.ts files generated via --declaration

@nuxy
Copy link
Author

nuxy commented May 3, 2024

hey, the module repo contains already TS files, what's the status?

The types in question are to be removed post PR approval/release.

@peterblazejewicz
Copy link
Member

I believe TS/TD team encourages everyone to stick to handbook (your code contains .d.ts? ship it with our code):
https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html#including-declarations-in-your-npm-package
as this is what people in community expect in first place. Why do you want to have those files here?
(sorry, your PR manifest didn't mention anything on those topics)

@nuxy
Copy link
Author

nuxy commented May 7, 2024

Why do you want to have those files here?

The motivation behind this was to expose CLI types to third-party integrated scripts (non NPM) without having to install the main package since it comes with a lot of baggage (e.g. templates, images, etc).

That said, after revaluating my options I'm going to self-host the types in it's own repo.

@nuxy nuxy closed this May 7, 2024
@typescript-bot typescript-bot removed this from Needs Maintainer Action in New Pull Request Status Board May 7, 2024
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
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants