Skip to content

refactor: port ensure to ts #666

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 17 commits into from
Jun 1, 2019
Merged

refactor: port ensure to ts #666

merged 17 commits into from
Jun 1, 2019

Conversation

bendtherules
Copy link
Contributor

Fixes part of #659. This ports @commitlint/ensure src and tests to typescript.

Changes made:

  1. Remove ava config, dependencies and scripts from package.json
  2. Add typescript and jest config, dependencies and scripts instead
  3. Port ensure/* source and test files to ts
  4. In index.test.ts, replace .js wildcards with .ts wildcards
  5. In case.test.ts, added throws TypeError for invalid case name testcase. (Maybe we should move it to a different PR ??)

How Has This Been Tested?

npm test inside @commitlint/ensure

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

bendtherules added 16 commits May 28, 2019 01:03
@bendtherules
fix(ensure): remove rimraf dep and clean script
2c8d3ef
@bendtherules
chore(ensure): add typescript and jest config files
16ba403
@bendtherules
chore(ensure): add jest, typescript, ts-jest devdependencies
088b23a
@bendtherules
refactor(ensure): port enum to ts
b13a4f4
@bendtherules
refactor(ensure): port enum tests to ts
397f614
@bendtherules
refactor(ensure): make first param to enum non-optional and update test
06950e8 
First param to enum (`value`) was earlier optional, which kept the tests easy. But user should be discouraged to use this edge case, so it is now required.

In test, the function is typecasted to allow testing the edge case
@bendtherules
refactor(ensure): port max-length and its tests to ts
f02c432
@bendtherules
refactor(ensure): port max-line-length and its tests to ts
cfd2f66
@bendtherules
refactor(ensure): port min-length and its tests to ts
3e5cf99
@bendtherules
refactor(ensure): port not-empty and its tests to ts
bd091ab
@bendtherules
refactor(ensure): port case and its tests to ts
1377c5c
@bendtherules
refactor(ensure): port index(.js) and its tests to ts
869292e 
Also updated globby to latest, as it has typescript definition files.
@bendtherules
refactor(ensure): add return type to matcher functions
c7855ef
@bendtherules
test(ensure): add test for case matching against invalid case name
c64d8dc
@bendtherules
build(ensure): replace ava config and dependencies with ts
5160683 
1 Remove ava config and deps from package.json 2 Change ava test script with typescript and jest commands
@bendtherules
chore: update yarn lock due to @commitlint/ensure dep changes
df07f01
@bendtherules bendtherules changed the title port @commitlint/ensure to ts port ensure to ts May 28, 2019
@bendtherules bendtherules changed the title port ensure to ts port ensure to ts May 28, 2019
@bendtherules bendtherules mentioned this pull request May 28, 2019
Closed
18 tasks
@marionebl marionebl changed the title port ensure to ts refactor: port ensure to ts May 31, 2019
@marionebl marionebl self-requested a review May 31, 2019 07:47
marionebl
marionebl reviewed May 31, 2019
View reviewed changes
Copy link
Contributor

@marionebl marionebl left a comment

Choose a reason for hiding this comment

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

Awesome work, thank you very much! In the meantime some conflicts cropped up - could you resolve those, then we should be able to get this in. 🚀

@bendtherules
Copy link
Contributor Author

bendtherules commented May 31, 2019 •
edited
Loading

Changed dep "globby": "^9.2.0", as only the newer versions of globby have type definitions (inbuilt).

In ensure, it is used in a test file (now in ts). Without type definitions, ts would mark it as an error by default. We have to either update the package or include a local typedef for this package.

Because of this, right now, different @commitlint packages have diff versions of globby. I am not sure if this is a good practise - should we update it everywhere at once or change each when moving to ts?

@marionebl
Copy link
Contributor

Upgrading to a deviating globby version should be fine as it is only a dev dependency here.

1 similar comment
@marionebl
Copy link
Contributor

Upgrading to a deviating globby version should be fine as it is only a dev dependency here.

@bendtherules
Copy link
Contributor Author

Ok, then things look good now.

@marionebl
Copy link
Contributor

LGTM, thanks for diligent work!

@marionebl marionebl merged commit 4861f74 into conventional-changelog:master Jun 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marionebl marionebl marionebl left review comments

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@bendtherules @marionebl