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

content(learn cli): make up to date #7307

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Conversation

AugustinMauroy
Copy link
Member

@AugustinMauroy AugustinMauroy commented Dec 2, 2024

Description

  • Remove external package examples
  • Mention styleText API
  • Using links in latest-v22.x everywhere
  • Add mention of --run
  • Update .env explaining

Validation

  • All provided examples should work fine on v22
  • No typo 😄

Related Issues

No related issues.

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run npm run format to ensure the code follows the style guide.
  • I have run npm run test to check if all tests are passing.
  • I have run npx turbo build to check if the website builds without errors.

Copy link

vercel bot commented Dec 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nodejs-org ✅ Ready (Inspect) Visit Preview Dec 16, 2024 4:47pm

@AugustinMauroy

This comment was marked as outdated.

@AugustinMauroy AugustinMauroy marked this pull request as ready for review December 2, 2024 10:17
@AugustinMauroy AugustinMauroy requested a review from a team as a code owner December 2, 2024 10:17
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 suggestion.

Comments skipped due to low confidence (1)

apps/site/pages/en/learn/command-line/run-nodejs-scripts-from-the-command-line.md:17

  • The angle brackets around the URL are unnecessary. It should be: "shebang".
You can also embed this information into your JavaScript file with a ["shebang"](<https://en.wikipedia.org/wiki/Shebang_(Unix)>) line.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Augustin Mauroy <augustin.mauroy@outlook.fr>

You can try that in the Node.js REPL, and it will print `hi!` in yellow.
> **NOTE**
> This part of the resource is designed with version 22.11 which notes `styleText` as ‘Active development’.
Copy link
Member

@mikeesto mikeesto Dec 2, 2024

Choose a reason for hiding this comment

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

Chalk is extremely popular and styleText is still in development. I don't have a strong opinion - but I feel this change might be premature

Copy link
Member Author

Choose a reason for hiding this comment

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

My idea behind this was to just talk about node and not the rest because the purpose of the learn section is to talk about node and not external packages.

Copy link
Member

Choose a reason for hiding this comment

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

I think the phrasing is odd, shouldn't mention 22.11 specifically, Learn content is always designed with LTS in mind, and it is available in LTS atm.

Copy link
Member

@marco-ippolito marco-ippolito Dec 16, 2024

Choose a reason for hiding this comment

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

There is a PR to mark styleText as stable, so it's fine nodejs/node#56265

Copy link
Member

@ovflowd ovflowd left a comment

Choose a reason for hiding this comment

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

cc @nodejs/tsc for review, but I gave a light pass and 👍

Co-authored-by: Ruy Adorno <ruyadorno@google.com>
Signed-off-by: Augustin Mauroy <augustin.mauroy@outlook.fr>
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.

5 participants