Fix #3092: enforce JavaScript and NodeJS spelling

[DeekshaVarshney123]

Hii @stevepiercy ,

I’ve attempted to fix issue #3092 by adding JavaScript and NodeJS to the Plone Vale accept vocabulary to ensure consistent spelling in the documentation.

Please review and let me know if any changes are required.
Thank you!

[DeekshaVarshney123]

Thanks for the clarification.

I verified the official spelling on the Node.js website and updated the accepted vocabulary accordingly, keeping the list alphabetically sorted.

I also corrected a small number of obvious misspellings of the correct form in the documentation, avoiding code blocks and commands.

[stevepiercy]

@DeekshaVarshney123 OK, next push your changes to this PR. I see none of which you speak.

[DeekshaVarshney123]

Hi @stevepiercy,

I have updated the spelling to 'Node.js' globally across all documentation files, changelogs, and storybook stories as requested. I have also sorted the vocabulary alphabetically in accept.txt and verified that all CI checks (including Vale) are now passing.

Please check if these changes are correct. If everything looks good for Node.js, I will proceed with fixing the 'JavaScript' misspellings in the next step.

Thank you!

[stevepiercy]

All of the 17 items in packages/**/news/ should not appear in this pull request. Only the one that you need to create for this PR should appear. I'm not sure what you did with git or how to resolve this part.

I noticed also that developers misnamed Node.js as either "node" or "Node" in numerous places in the docs, especially the change log. To fix that, please add (?i)node to the reject.txt file and replace them as needed. Note that it's possible that the word "node" is used per the English dictionary definition, in which case those instances should remain as "node". Keep in mind we want to correct the spelling of the product "Node.js" only.

[DeekshaVarshney123]

Hi @stevepiercy,

I've updated the PR. I accidentally included the correct spelling in the reject.txt earlier, but I've fixed it now to only reject NodeJS and (?i)node. I also rebased the branch to clear out the extra news items and updated 'Node' to 'Node.js' where it refers to the product.

Regarding the failing Acceptance Test (24.x), could you please check if it's related to my changes or if it's a flaky test?
Thank you!

[stevepiercy]

Almost all of the changes look good, except for a couple. Please see my comments for details. Thank you!

[stevepiercy]

@DeekshaVarshney123 take a look at the output from running make vale:

• https://github.com/plone/volto/actions/runs/20501588466/job/58909620747?pr=7746#step:8:61

Compare it to the line that the error references:

• https://github.com/plone/volto/pull/7746/files#diff-8ea15a25d044c7930c6e3f0f521299f7b93d2d8196a08ac0e1c4898f73869d5fR166

I think the issue is that the period in Node.js in styles/config/vocabularies/Plone/accept.txt is interpreted as a regular expression, meaning any single character. There's also problems in reject.txt.

Try changing the value in accept.txt to:

Node\.js

And in reject.txt to these lines:

(?i)node\s
node\.
(?i)NodeJS

then run make docs-vale again to see if that reduces the errors significantly?

[DeekshaVarshney123]

Hi @stevepiercy,

thanks for the review. I have updated the files as requested:
Reverts: Changed back to node in the upgrade and add-on guides.
Vocab: Updated accept.txt to Node.js and reject.txt with your regex suggestions.
News Item: Added my handle for credit.

I ran make docs-vale and Node-related errors like "Avoid using Node." still persist. It seems the escaped dot in accept.txt isn't fully resolving the issue in all files. Please let me know how to proceed.

[stevepiercy]

@DeekshaVarshney123 I'm sorry, but I can't spare time to give you explicit instructions for how to resolve the issues. At that point, I'd be doing the work myself, and you wouldn't get credit.

Configuring Vale is tricky, and requires repeated testing until the regular expressions are exactly right. It's especially tricky because we don't want false positives or negatives in the results. I hope that my first attempt to resolve the issues leads you to discover a better resolution.

The best direction I can give you is the following.

• Accept only Node.js as the official spelling.
• Reject any short form or incorrect spelling or capitalization. These include, but are not limited to:
  • node
  • Node
  • NodeJS
  • Node.JS
• Refer to https://6.docs.plone.org/contributing/documentation/authors.html#advanced-vale-usage and https://vale.sh/docs. I'd suggest creating a sample file to play around with that has all spelling variations of Node.js, and using the single file command to speed up testing.