Commitlint: Port to TypeScript

[marionebl]

In order to improve commitlint stability and maintainability we'll port all packages to TypeScript.

• For now copy @commitlint/format/tsconfig.json
• Move unit tests to jest in the process. Use @commitlint/format/jest.config.js
• See @commitlint/format/package.json for required deps

When all packages are ported we can move to a centralized jest/ts setup

Overview

ToDo

Phase - 1 Done

• [x] @commitlint/ensure (@bendtherules | #666)
• [x] @commitlint/execute-rule (@marionebl | #660)
• [x] @commitlint/is-ignored (@marionebl | #675)
• [x] @commitlint/message (@byCedric | #765)
• [x] @commitlint/parse (@byCedric | #764)
• [x] @commitlint/resolve-extends (@marionebl | #664)
• [x] @commitlint/to-lines (@bendtherules | #677)
• [x] @commitlint/top-level (@byCedric | #679)

Phase - 2 Done

• [x] @commitlint/load (@byCedric | #786)
• [x] @commitlint/read (@marionebl + @kenn-chen, #922)
• [x] @commitlint/rules (@byCedric + @armano2 | #785)
• [x] @commitlint/lint (@byCedric | #908)
• [x] @commitlint/format (@marionebl | #660)
• [x] @commitlint/core (@armano2 | #961 )

Phase - 3

• [x] @commitlint/prompt (@byCedric)
• [x] @commitlint/prompt-cli (@byCedric)
• [x] @commitlint/cli (@armano2 | #978)
• [x] @commitlint/travis-cli (@armano2 | #990)

[rajatvijay]

@marionebl would love to contribute. Any pointers to get started?

[byCedric]

@rajatvijay @marionebl @escapedcat It might be a good idea to create the tree visualisation you were talking about Mario. I'll take a swing at that to give us (and others like Rajat - thanks for pitching in 😄 ❤️) an overview/idea of the priorities. Will have one tomorrow!

[marionebl]

Hey, thanks for your offer to help! I added a dependency tree to the description of this issue. I think it makes sense to start with the leafs of the tree, so

• [ ] @commitlint/message
• [ ] @commitlint/ensure
• [ ] @commitlint/to-lines

are good candidates

[byCedric]

So just to confirm and get everyone on the same page, based on the graph I would imagine a priority like this right?

Phase - 1

• @commitlint/ensure
• @commitlint/execute-rule
• @commitlint/is-ignored
• @commitlint/message
• @commitlint/parse
• @commitlint/resolve-extends
• @commitlint/to-lines
• @commitlint/top-level

Phase - 2

• @commitlint/load
• @commitlint/read
• @commitlint/rules
• @commitlint/lint
• @commitlint/format

Phase - 3

• @commitlint/prompt
• @commitlint/prompt-cli
• @commitlint/cli
• @commitlint/travis-cli
• @commitlint/core

[bendtherules]

Thanks for listing down the order. This is quite helpful.

I would like to pickup @commitlint/ensure, to start with. Branch: https://github.com/bendtherules/commitlint/tree/build-ensure-ts-port

Edit: Added PR #666

[rajatvijay]

Awesome @marionebl and @byCedric

I would like to pick up @commitlint/message, to start with.

[marionebl]

I updated the issue description with the phases by @byCedric (good idea!)

[byCedric]

Awesome! I see it's picking up some pace, thanks all! I'll pitch in this week in getting something that's still open. I'll add my name to the thing before picking it up ofc. 😄

[byCedric]

Hi guys, I'm getting some time free again 😄 That means I can push this port a bit further. I want to start on the rules, but that requires both parse and message (I think).

@marionebl How far was the @commitlint/parse port? And @rajatvijay did you had some time to work on the @commitlint/message port?

No worries if you didn't get to it yet 😄

[marionebl]

@marionebl How far was the @commitlint/parse port?

I'll have another look at it tomorrow haven't done actual coding yet, wouldn't object if you took it up though.

[bendtherules]

I was looking at @commitlint/read and found these external dependencies which dont seem to have typing (haven't checked definitelytyped) - git-raw-commits, @marionebl/sander.

How do we plan to proceed with this?

1. Keep them as it is. Use any for their usage in our code.
2. Keep them as it is. Mock up reqd type definitions for them in our codebase
3. Ask them (or contribute there) to change. Use some fallback plan for now and later switch to them.

[marionebl]

1. Keep them as it is. Use any for their usage in our code.

Is fine for now

[kenn-chen]

@marionebl @byCedric Hey guys, I want to contribute to this issue. It seems that you have proceeded to phrase2. is there anything I can start with, like @commitlint/lint
or @commitlint/format, or some phrase3 items?

[byCedric]

Hi @kenn-chen! Thanks for your offer to help in this refractor ♥️ definitely appreciated! If you want, you can try @commitlint/read. I didn't started yet (and forgot to remove my name) because both load and rules were kind of "intensive". I don't think read is blocked or using any of these two, but I might be wrong.

Again, thanks 😁♥️

[kenn-chen]

Hi @byCedric , I create a PR here https://github.com/conventional-changelog/commitlint/pull/816. Could you help review it? Thanks.

[armano2]

@marionebl it seems that @commitlint/core is in phase 2 and 3

[marionebl]

@marionebl it seems that @commitlint/core is in phase 2 and 3

Removed it from Phase 3

[armano2]

i started porting @commitlint/cli, and i should commit first draft tomorrow

[armano2]

@commitlint/travis-cli (blocked by @commitlint/cli)

travis-cli is using cli only in maner of executing it and it's not type dependency of cli (at least current implementation)

[armano2]

@commitlint/travis-cli #990

[armano2]

@commitlint/prompt #2371 - already merged