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

Kotlin/JS: Fix typo in docs related to running Kotlin/JS project in NodeJS environment #4760

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

seclerp
Copy link
Member

@seclerp seclerp commented Mar 21, 2025

Hi folks, I suppose :jsBrowserDevelopmentRun is not the correct Gradle task name to be used with the NodeJS build target. From the context of the section, I made an assumption that calling :run is the right thing to do :)

@seclerp seclerp requested a review from a team as a code owner March 21, 2025 19:11
@seclerp seclerp changed the title Kotlin/JS: Fix typo in docs related to running Kotlin/JS project Kotlin/JS: Fix typo in docs related to running Kotlin/JS project in NodeJS environment Mar 21, 2025
@AlejandraPedroza
Copy link
Contributor

Hi! @seclerp
Thank you for your contribution! I'm currently checking it with the Kotlin/JS development team to verify this correction. I’ll follow up once I have confirmation.

@JSMonk
Copy link
Member

JSMonk commented Mar 31, 2025

@seclerp, thank you so much for noticing and fixing the typo 🙏
The typo is taking place. However, I checked that the correct task is jsNodeDevelopmentRun(not run)
May I ask you to replace run with jsNodeDevelopmentRun in this MR?

@seclerp
Copy link
Member Author

seclerp commented Mar 31, 2025

Sure! Seems like I made the wrong assumption based on the screenshot that I found below. In Gradle tool window on the right the task is clearly run one. Maybe it's better to re-take it?

image

Also, I found one another place with the typo. I'm a bit confused by the whole "run task" section of "Set up a Kotlin/JS project" page, as it refer to some non-existent "aliases". Is it an artifact from the ancient times?

To run a project, execute the standard lifecycle jsBrowserDevelopmentRun task, or the alias to which it corresponds:

./gradlew jsBrowserDevelopmentRun

@JSMonk
Copy link
Member

JSMonk commented Mar 31, 2025

Thank you for the updates.
And yep, definitely the screenshot should be replaced.
I will add it to this MR if you don't mind.

@JSMonk
Copy link
Member

JSMonk commented Apr 4, 2025

I haven't figured out how to add the updated screenshots to @seclerp branch, so I've just created another branch for it: https://github.com/JetBrains/kotlin-web-site/pull/4790/files
@AlejandraPedroza, could you please merge this branch and the one with the updated screenshots?

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.

3 participants