Skip to content

Comments

JS Linting: Restructure content on VSCode extensions#29516

Merged
KevinMulhern merged 4 commits intoTheOdinProject:mainfrom
mao-sz:js-linting-structure
May 25, 2025
Merged

JS Linting: Restructure content on VSCode extensions#29516
KevinMulhern merged 4 commits intoTheOdinProject:mainfrom
mao-sz:js-linting-structure

Conversation

@mao-sz
Copy link
Contributor

@mao-sz mao-sz commented Mar 14, 2025

Because

In #27962 I only made small structural changes to make the JS Linting lesson match our lesson style guide, but the contents was largely unchanged.

Quite a few times (before and after), learners have been confused as to whether they should install the npm packages and/or use the VSCode extensions and why. It appears to come from the ESLint and Prettier sections mentioning both then only later does it talk about the need to install npm packages and the extensions being additional IDE integration tools for personal convenience.

The info about extensions can be taken out of the ESLint/Prettier sections so they only talk about the npm packages. At the end, there can be a new IDE extensions section which will hopefully make the lessons' point much clearer and easier to follow.

This PR

  • Removes VSC extension information from the Linting and Formatting sections
  • Rewrites the VSC extension note box as a dedicated lesson level 3 section
  • Fixes and link fragments as appropriate

Issue

Closes #29499

Additional Information

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project curriculum contributing guide
  • The title of this PR follows the location of change: brief description of change format, e.g. Intro to HTML and CSS lesson: Fix link text
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • If this PR addresses an open issue, it is linked in the Issue section
  • If any lesson files are included in this PR, they have been previewed with the Markdown preview tool to ensure it is formatted correctly
  • If any lesson files are included in this PR, they follow the Layout Style Guide

@github-actions github-actions bot added the Content: JavaScript Involves the JavaScript course label Mar 14, 2025
Copy link
Member

@KevinMulhern KevinMulhern left a comment

Choose a reason for hiding this comment

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

Changes look great to me, thanks for doing this @MaoShizhong

@KevinMulhern KevinMulhern merged commit 3d13322 into TheOdinProject:main May 25, 2025
2 checks passed
@mao-sz mao-sz deleted the js-linting-structure branch May 25, 2025 20:41
@mao-sz
Copy link
Contributor Author

mao-sz commented May 25, 2025

Cheers @KevinMulhern

Now that this has been merged, #29533 becomes relevant. Could I bump that issue for someone to have a look at when able to?

@KevinMulhern
Copy link
Member

Absolutely @MaoShizhong, I'm happy to back anything that simplifies the curriculum lol.

@mao-sz
Copy link
Contributor Author

mao-sz commented May 26, 2025

@KevinMulhern just double checking if that's the equivalent of an assignment or something else 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Content: JavaScript Involves the JavaScript course

Projects

None yet

Development

Successfully merging this pull request may close these issues.

JS Linting: Move VSCode extension info to own later section

2 participants