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

Documentation Kotlin #325

Merged
merged 6 commits into from
Apr 18, 2024
Merged

Documentation Kotlin #325

merged 6 commits into from
Apr 18, 2024

Conversation

mylinhdao
Copy link
Collaborator

@mylinhdao mylinhdao commented Apr 17, 2024

Documentation Kotlin

Closes #311
Every reviewer are welcome :)

Description

  • Set node engine version to "node": ">=20": we import node-types-config.json with with keyword to define type. This is only supported from Node v20.
  • Add documentation and tests for Kotlin
  • We count object declarations and expressions and companion objects for "classes" metric, because they are anonymous classes ( see Kotlin documentation)

Note: The Kotlin parser has a bug actually and does not parse the functional interface fun interface... correctly. This leads to uncorrect file metric calculation in "classes" and "functions" metric. There is already a PR for this bug, so I will not add any special handling to cover it for now.
I open #324 to solve that.

Definition of Done

A PR is only ready for merge once all the following acceptance criteria are fulfilled:

  • There are automated tests for newly written code and bug fixes
  • All bugs discovered while working on this PR have been submitted as issues (if not already an open issue)
  • Documentation (README.md, UPDATE_GRAMMARS.md) has been updated

Screenshots or gifs

Copy link

github-actions bot commented Apr 17, 2024

Coverage Report

Status Category Percentage Covered / Total
🟢 Lines 94.94% (🎯 90%) 4550 / 4792
🟢 Statements 94.94% (🎯 90%) 4550 / 4792
🟢 Functions 94.78% (🎯 90%) 200 / 211
🟢 Branches 91.82% (🎯 90%) 539 / 587
File Coverage
File Stmts % Branch % Funcs % Lines Uncovered Lines
Changed Files
src/parser/helper/language.ts 96.24% 86.66% 100% 96.24% 178-183, 187-188
Generated in workflow #59

src/parser/helper/language.ts Outdated Show resolved Hide resolved
src/parser/helper/language.ts Outdated Show resolved Hide resolved
docs/Kotlin.md Outdated Show resolved Hide resolved
@mylinhdao mylinhdao merged commit e1ecfc5 into main Apr 18, 2024
2 checks passed
@mylinhdao mylinhdao deleted the docs/311/kotlin branch April 18, 2024 09:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation Kotlin
3 participants