feat: add Typescript type for config (closes #1052)

[JohnCampionJr]

I only added the Config; typing the whole project would only be useful for plugin authors and would be a much larger project.

Sample ts config:

import type { Config } from 'release-it'

export default {
  plugins: {},
  hooks: {},
  git: {
    commit: true,
    tag: true,
    push: true,
  },
  github: {
    release: true,
  },
  npm: {
    publish: true,
  },
} satisfies Config

[webpro]

Thanks @JohnCampionJr! I'm happy to merge it, but is there a way to automate the generation of the types/config.d.ts file?

[JohnCampionJr]

There probably is but I’m not sure how without moving everything to typescript. This is more of a stop-gap.

…

On Sat, Nov 11, 2023 at 7:59 AM Lars Kappert ***@***.***> wrote: Thanks @JohnCampionJr <https://github.com/JohnCampionJr>! I'm happy to merge it, but is there a way to automate the generation of the types/config.d.ts file? — Reply to this email directly, view it on GitHub <#1055 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAILJJBPGJWBI6JOGDD7US3YD5ZCJAVCNFSM6AAAAAA6YFMMGWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMBWHAYTANZUGM> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[ghiscoding]

Would it be possible to also add brief instructions on 1 of the README so it would be easier for discovery. Thanks

[JohnCampionJr]

I've added a bit to the config docs

[webpro]

Could this PR please be rebased from main? I'm seeing unrelated changes too.

[JohnCampionJr]

Looks like you just did that; I don't see any unrelated changes any more either.

[webpro]

And how about adding it to Definitely Typed?

Inspired by JoshuaKGoldberg/release-it-action#29

[northword]

Also, I think that the command line arguments (constructor arguments) could include type declarations as well, since they can affect release-it as well.

example:

https://github.com/northword/zotero-plugin-scaffold/blob/03ca4f76205e6fa4201ec1a2c14e782c1bb216bd/types/release-it.d.ts#L92-L100