add types for spinnies

[benjamincburns]

Please fill in this template.

• Use a meaningful title for the pull request. Include the name of the package modified.
• Test the change in your own code. (Compile and run.)
• Add or edit tests to reflect the change.
• Follow the advice from the readme.
• Avoid common mistakes.
• Run npm test <package to test>.

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.

[typescript-bot]

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

• spinnies (new!) — on npm, on unpkg
  • 1 added owner: ✎@benjamincburns

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": 59503,
  "author": "benjamincburns",
  "headCommitOid": "e0b046f80c8cfc81f1a24e2cd339eb7c051cbc33",
  "mergeBaseOid": "d6d658846c9659deea6898e60f687159f463b2dd",
  "lastPushDate": "2022-03-30T02:01:09.000Z",
  "lastActivityDate": "2022-03-31T00:39:49.000Z",
  "mergeOfferDate": "2022-03-30T20:59:50.000Z",
  "mergeRequestDate": "2022-03-31T00:39:49.000Z",
  "mergeRequestUser": "benjamincburns",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "spinnies",
      "kind": "add",
      "files": [
        {
          "path": "types/spinnies/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/spinnies/spinnies-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/spinnies/tsconfig.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/spinnies/tslint.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [],
      "addedOwners": [
        "benjamincburns"
      ],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "peterblazejewicz",
      "date": "2022-03-30T20:59:11.000Z",
      "isMaintainer": true
    },
    {
      "type": "stale",
      "reviewer": "kerolloz",
      "date": "2022-03-28T05:22:00.000Z",
      "abbrOid": "0aae6d3"
    }
  ],
  "mainBotCommentID": 1080095439,
  "ciResult": "pass"
}

[typescript-bot]

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

[peterblazejewicz]

1. for TS 4.4 better interop you could write optional properties to support exact optional property types syntax when consumed by client code:

status?: SpinnerStatus | undefined;

https://devblogs.microsoft.com/typescript/announcing-typescript-4-4/#exact-optional-property-types

2. the package uses chalk. Chalk is whitelisted on DDT, so you can reuse types from chalk by adding a depdency for external types:

{
    "private": true,
    "dependencies": {
        "chalk": "^2.4.2"
    }
}

https://github.com/DefinitelyTyped/DefinitelyTyped#packagejson

[benjamincburns]

1. for TS 4.4 better interop you could write optional properties to support exact optional property types syntax when consumed by client code:

status?: SpinnerStatus | undefined;

@peterblazejewicz I'm not sure I understand your recommended change here. I don't think it's a valid/desirable use case to assign undefined to an optional field of Options or SpinnerOptions.

If anything, it's probably more correct for me to rewrite both interfaces as having no optional fields, but change all method signatures that accept those two types as arguments to accepting Partial<SpinnerOptions> or Partial<Options>. This is because Spinnies fills in all missing fields with defaults (or in the case of SpinnerOptions, values from the instance-level Options) internally prior to using/assigning/returning Options or SpinnerOptions.

[benjamincburns]

3. the package uses chalk. Chalk is whitelisted on DDT, so you can reuse types from chalk by adding a depdency for external types:

{
    "private": true,
    "dependencies": {
        "chalk": "^2.4.2"
    }
}

Unfortunately chalk@2.4.2 doesn't expose a string literal union type like the ForegroundColor type in chalk@5.0.1. Instead I'll pull the allowlist of color literals from the spinnies source and make a union type from that.

[typescript-bot]

@peterblazejewicz, @kerolloz 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?

[peterblazejewicz]

LGTM!
@benjamincburns thx!

[typescript-bot]

@benjamincburns: Everything looks good here. I am ready to merge this PR (at e0b046f) 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]

@kerolloz 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?

[benjamincburns]

Ready to merge