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.

Sign up for GitHub

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

Jump to bottom

Tag syntax code blocks with js-nolint, part 1 #19177

Merged
merged 1 commit into from
Sep 12, 2022
Merged

Tag syntax code blocks with js-nolint, part 1 #19177

merged 1 commit into from
Sep 12, 2022

Conversation

OnkarRuikar
Copy link
Contributor

@OnkarRuikar OnkarRuikar commented Aug 5, 2022 •
edited
Loading

Updating syntax code blocks with the new tag. Refer: mdn/yari#7017

For more variety for testing let me know which files we need to add to the PR.

Edit: The yari PR got merged. The PR series is good to go.

cc:/ @teoli2003, @Josh-Cena

@github-actions github-actions bot added Content:JS JavaScript docs Content:Other Any docs not covered by another "Content:" label Content:WebAPI Web API docs Content:WebExt WebExtensions docs labels Aug 5, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Aug 5, 2022 •
edited
Loading

Preview URLs

Flaws

Note! 8 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/EventTarget/addEventListener
Title: EventTarget.addEventListener()
Flaw count: 2

  • macros:
    • /en-US/docs/Web/API/EventListener redirects to /en-US/docs/Web/API/EventTarget/addEventListener
    • The fourth to sixth parameters of 'EmbedLiveSample' are deprecated

URL: /en-US/docs/Web/API/Window/openDialog
Title: Window.openDialog()
Flaw count: 4

  • macros:
    • /en-US/docs/Web/API/Window/arguments does not exist
  • broken_links:
    • Can't resolve /en-US/docs/Mozilla/Add-ons/Code_snippets/Dialogs_and_Prompts#passing_arguments_and_displaying_a_dialog
    • Can't resolve /en-US/docs/Mozilla/Add-ons/Code_snippets/Dialogs_and_Prompts#passing_arguments_and_displaying_a_dialog
    • Can't resolve /en-US/docs/Archive/Web/Window.importDialog

(this comment was updated 2022-09-12 03:59:37.594486)

@OnkarRuikar OnkarRuikar marked this pull request as ready for review August 9, 2022 03:26
@OnkarRuikar OnkarRuikar requested review from a team as code owners August 9, 2022 03:26
@OnkarRuikar OnkarRuikar requested review from willdurand and sideshowbarker and removed request for a team August 9, 2022 03:26
@rubiesonthesky
Copy link
Contributor

I have marked bunch of code blocks with jssyntax locally. I'm not sure will this be helpful for you but I pushed them to Github and you can save these somewhere if you want. I will keep it there at least some time but I don't promise to keep it available for really long time. :) main...rubiesonthesky:content:jssyntax

@teoli2003
Copy link
Contributor

We are still thinking if the naming jssyntax is good or not. I have an Action Item to think about it and discuss it, but had no time to get to it today. That's why I'm holding this PR.

@sideshowbarker sideshowbarker removed their request for review August 10, 2022 23:50
Elchi3
Elchi3 reviewed Aug 30, 2022
View reviewed changes
Copy link
Member

@Elchi3 Elchi3 left a comment

Choose a reason for hiding this comment

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

The yari PR was merged. Has a decision been made?

@teoli2003
Copy link
Contributor

Yes, we want to change the name from jssyntax to jsnolint. But I need to create the PR and check for the consensus (that I believed we had before already).

@Elchi3 Elchi3 marked this pull request as draft August 30, 2022 11:42
@Elchi3
Copy link
Member

Elchi3 commented Aug 30, 2022

Marking as draft then. This isn't ready yet.

@Josh-Cena
Copy link
Member

Ah interesting. Last time the opinion I gave was ```js nolint, which requires forking the parser. TBH I like jssyntax better—it's more semantic. We can have other nolint languages in the future, which may selectively turn off other checks.

@Josh-Cena
Copy link
Member

The reason I like js nolint is because syntax highlighting is preserved in my editor. Syntax highlighting tremendously reduces the cognitive load to mentally parse the source code.

@teoli2003
Copy link
Contributor

I've opened #7017 for the change. Please mark your approval there so that we can double-check we have a consensus.

Thank you for your patience.

@OnkarRuikar OnkarRuikar changed the title Tag syntax code blocks with jssyntax, part 1 Tag syntax code blocks with js-nolint, part 1 Sep 7, 2022
@OnkarRuikar OnkarRuikar marked this pull request as ready for review September 7, 2022 01:13
@OnkarRuikar
Copy link
Contributor Author

teoli2003
teoli2003 approved these changes Sep 7, 2022
View reviewed changes
Copy link
Contributor

@teoli2003 teoli2003 left a comment

Choose a reason for hiding this comment

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

Let's merge this! We'll see in a few days how it goes. If all looks fine, we'll do this on a large scale.

teoli2003 added a commit that referenced this pull request Sep 13, 2022
@OnkarRuikar @teoli2003
Tag syntax code blocks with js-nolint, part 8 (#20621)
b7556b7 
* Tag syntax code blocks with js-nolint, part 8

Adding to #19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017

* Update files/en-us/web/api/ndefreader/write/index.md

* Update files/en-us/web/api/ndefrecord/ndefrecord/index.md

Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
OnkarRuikar added a commit to OnkarRuikar/content that referenced this pull request Sep 13, 2022
@OnkarRuikar
Tag syntax code blocks with js-nolint, part 16
52b8f17 
Adding to mdn#19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017
OnkarRuikar added a commit to OnkarRuikar/content that referenced this pull request Sep 13, 2022
@OnkarRuikar
Tag syntax code blocks with js-nolint, part 9
4b9c952 
Adding to mdn#19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017
OnkarRuikar added a commit to OnkarRuikar/content that referenced this pull request Sep 13, 2022
@OnkarRuikar
Tag syntax code blocks with js-nolint, part 10
fdfa283 
Adding to mdn#19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017
@OnkarRuikar OnkarRuikar mentioned this pull request Sep 13, 2022
Merged
teoli2003 added a commit that referenced this pull request Sep 13, 2022
@OnkarRuikar @teoli2003
Tag syntax code blocks with js-nolint, part 9 (#20622)
2b8f5d9 
* Tag syntax code blocks with js-nolint, part 9

Adding to #19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017

* Update files/en-us/web/api/ndefrecord/torecords/index.md

* Update files/en-us/web/api/nodelist/entries/index.md

* Update files/en-us/web/api/nodelist/foreach/index.md

* Update files/en-us/web/api/nodelist/keys/index.md

* Update files/en-us/web/api/nodelist/values/index.md

* Update files/en-us/web/api/presentationrequest/start/index.md

* Update files/en-us/web/api/relativeorientationsensor/relativeorientationsensor/index.md

Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
teoli2003 added a commit that referenced this pull request Sep 13, 2022
@OnkarRuikar @teoli2003
Tag syntax code blocks with js-nolint, part 10 (#20632)
16e3988 
* Tag syntax code blocks with js-nolint, part 10

Adding to #19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017

* Update files/en-us/web/api/rtcicetransport/getremoteparameters/index.md

* Update files/en-us/web/api/rtcpeerconnection/addstream/index.md

* Update files/en-us/web/api/rtcpeerconnection/close/index.md

* Update files/en-us/web/api/rtcpeerconnection/getidentityassertion/index.md

* Update files/en-us/web/api/rtcpeerconnection/getreceivers/index.md

* Update files/en-us/web/api/rtcpeerconnection/getsenders/index.md

* Update files/en-us/web/api/rtcpeerconnection/removestream/index.md

* Update files/en-us/web/api/rtcpeerconnection/removetrack/index.md

* Update files/en-us/web/api/rtcrtpsender/replacetrack/index.md

* Update files/en-us/web/api/selection/setbaseandextent/index.md

* Update files/en-us/web/api/serviceworkercontainer/startmessages/index.md

* Update files/en-us/web/api/storagemanager/persist/index.md

* Update files/en-us/web/api/storagemanager/persisted/index.md

Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
teoli2003 added a commit that referenced this pull request Sep 13, 2022
@OnkarRuikar @teoli2003
Tag syntax code blocks with js-nolint, part 11 (#20623)
b9bcca1 
* Tag syntax code blocks with js-nolint, part 11

Adding to #19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017

* Update files/en-us/web/api/svgpoint/index.md

Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
teoli2003 added a commit that referenced this pull request Sep 13, 2022
@OnkarRuikar @teoli2003
Tag syntax code blocks with js-nolint, part 12 (#20624)
c575deb 
* Tag syntax code blocks with js-nolint, part 12

Adding to #19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017

* Update files/en-us/web/api/window/showdirectorypicker/index.md

* Update files/en-us/web/api/webgl_multi_draw/multidrawarraysinstancedwebgl/index.md

* Update files/en-us/web/api/webgl_multi_draw/multidrawarrayswebgl/index.md

* Update files/en-us/web/api/webgl_multi_draw/multidrawelementsinstancedwebgl/index.md

* Update files/en-us/web/api/webgl_multi_draw/multidrawelementswebgl/index.md

* Update files/en-us/web/api/webglrenderingcontext/attachshader/index.md

* Update files/en-us/web/api/webglrenderingcontext/detachshader/index.md

* Update files/en-us/web/api/window/showdirectorypicker/index.md

Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
teoli2003 added a commit that referenced this pull request Sep 13, 2022
@OnkarRuikar @teoli2003
Tag syntax code blocks with js-nolint, part 13 (#20625)
87a9f73 
* Tag syntax code blocks with js-nolint, part 13

Adding to #19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017

* Update files/en-us/web/api/xrwebgllayer/antialias/index.md

* Update files/en-us/web/api/xrwebgllayer/getnativeframebufferscalefactor/index.md

* Update files/en-us/web/api/xrwebgllayer/getnativeframebufferscalefactor/index.md

* Update files/en-us/web/http/proxy_servers_and_tunneling/proxy_auto-configuration_pac_file/index.md

Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
teoli2003 pushed a commit that referenced this pull request Sep 13, 2022
@OnkarRuikar
Tag syntax code blocks with js-nolint, part 14 (#20626)
d6ce8fc 
Adding to #19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017
teoli2003 pushed a commit that referenced this pull request Sep 13, 2022
@OnkarRuikar
Tag syntax code blocks with js-nolint, part 15 (#20627)
ce29091 
Adding to #19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017
teoli2003 pushed a commit that referenced this pull request Sep 13, 2022
@OnkarRuikar
Tag syntax code blocks with js-nolint, part 16 (#20628)
1533276 
Adding to #19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017
OnkarRuikar added a commit to OnkarRuikar/content that referenced this pull request Sep 13, 2022
@OnkarRuikar
Tag example-bad blocks with js-nolint
81b0e53 
Adding to mdn#19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
@OnkarRuikar
Tag syntax code blocks with js-nolint, part 1 (mdn#19177)
dd95176
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
@teoli2003
Fix typo introduced in mdn#19177 (mdn#20580)
609ff7b
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
@OnkarRuikar
Tag syntax code blocks with js-nolint, part 4 (mdn#20617)
e842902 
Adding to mdn#19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
@OnkarRuikar
Tag syntax code blocks with js-nolint, part 5 (mdn#20618)
4dd8f65 
Adding to mdn#19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
@OnkarRuikar @teoli2003
Tag syntax code blocks with js-nolint, part 6 (mdn#20619)
10f3f2f 
* Tag syntax code blocks with js-nolint, part 6

Adding to mdn#19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017

* Update files/en-us/web/api/filereadersync/readasarraybuffer/index.md

* Update files/en-us/web/api/filesystemdirectoryhandle/entries/index.md

Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
@OnkarRuikar @teoli2003
Tag syntax code blocks with js-nolint, part 7 (mdn#20620)
6cf95b2 
* Tag syntax code blocks with js-nolint, part 7

Adding to mdn#19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017

* Update files/en-us/web/api/htmlvideoelement/msstereo3drendermode/index.md

* Update files/en-us/web/api/filesystemfilehandle/createwritable/index.md

* Update files/en-us/web/api/filesystemdirectoryhandle/resolve/index.md

* Update files/en-us/web/api/filesystemdirectoryhandle/values/index.md

* Update files/en-us/web/api/filesystemfilehandle/getfile/index.md

* Update files/en-us/web/api/filesystemhandle/querypermission/index.md

* Update files/en-us/web/api/htmlformelement/reportvalidity/index.md

* Update files/en-us/web/api/filesystemhandle/requestpermission/index.md

* Update files/en-us/web/api/filesystemwritablefilestream/seek/index.md

* Update files/en-us/web/api/filesystemwritablefilestream/truncate/index.md

* Update files/en-us/web/api/htmlcollection/nameditem/index.md

* Update files/en-us/web/api/htmlmediaelement/mscleareffects/index.md

* Update files/en-us/web/api/htmlvideoelement/mssetvideorectangle/index.md

* Update files/en-us/web/api/htmlvideoelement/msstereo3dpackingmode/index.md

Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
@OnkarRuikar @teoli2003
Tag syntax code blocks with js-nolint, part 8 (mdn#20621)
244cafc 
* Tag syntax code blocks with js-nolint, part 8

Adding to mdn#19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017

* Update files/en-us/web/api/ndefreader/write/index.md

* Update files/en-us/web/api/ndefrecord/ndefrecord/index.md

Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
@OnkarRuikar @teoli2003
Tag syntax code blocks with js-nolint, part 9 (mdn#20622)
107540c 
* Tag syntax code blocks with js-nolint, part 9

Adding to mdn#19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017

* Update files/en-us/web/api/ndefrecord/torecords/index.md

* Update files/en-us/web/api/nodelist/entries/index.md

* Update files/en-us/web/api/nodelist/foreach/index.md

* Update files/en-us/web/api/nodelist/keys/index.md

* Update files/en-us/web/api/nodelist/values/index.md

* Update files/en-us/web/api/presentationrequest/start/index.md

* Update files/en-us/web/api/relativeorientationsensor/relativeorientationsensor/index.md

Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
@OnkarRuikar @teoli2003
Tag syntax code blocks with js-nolint, part 10 (mdn#20632)
5f738fe 
* Tag syntax code blocks with js-nolint, part 10

Adding to mdn#19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017

* Update files/en-us/web/api/rtcicetransport/getremoteparameters/index.md

* Update files/en-us/web/api/rtcpeerconnection/addstream/index.md

* Update files/en-us/web/api/rtcpeerconnection/close/index.md

* Update files/en-us/web/api/rtcpeerconnection/getidentityassertion/index.md

* Update files/en-us/web/api/rtcpeerconnection/getreceivers/index.md

* Update files/en-us/web/api/rtcpeerconnection/getsenders/index.md

* Update files/en-us/web/api/rtcpeerconnection/removestream/index.md

* Update files/en-us/web/api/rtcpeerconnection/removetrack/index.md

* Update files/en-us/web/api/rtcrtpsender/replacetrack/index.md

* Update files/en-us/web/api/selection/setbaseandextent/index.md

* Update files/en-us/web/api/serviceworkercontainer/startmessages/index.md

* Update files/en-us/web/api/storagemanager/persist/index.md

* Update files/en-us/web/api/storagemanager/persisted/index.md

Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
@OnkarRuikar @teoli2003
Tag syntax code blocks with js-nolint, part 11 (mdn#20623)
6486c29 
* Tag syntax code blocks with js-nolint, part 11

Adding to mdn#19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017

* Update files/en-us/web/api/svgpoint/index.md

Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
@OnkarRuikar @teoli2003
Tag syntax code blocks with js-nolint, part 12 (mdn#20624)
5a6e7f4 
* Tag syntax code blocks with js-nolint, part 12

Adding to mdn#19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017

* Update files/en-us/web/api/window/showdirectorypicker/index.md

* Update files/en-us/web/api/webgl_multi_draw/multidrawarraysinstancedwebgl/index.md

* Update files/en-us/web/api/webgl_multi_draw/multidrawarrayswebgl/index.md

* Update files/en-us/web/api/webgl_multi_draw/multidrawelementsinstancedwebgl/index.md

* Update files/en-us/web/api/webgl_multi_draw/multidrawelementswebgl/index.md

* Update files/en-us/web/api/webglrenderingcontext/attachshader/index.md

* Update files/en-us/web/api/webglrenderingcontext/detachshader/index.md

* Update files/en-us/web/api/window/showdirectorypicker/index.md

Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
@OnkarRuikar @teoli2003
Tag syntax code blocks with js-nolint, part 13 (mdn#20625)
7e9a33f 
* Tag syntax code blocks with js-nolint, part 13

Adding to mdn#19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017

* Update files/en-us/web/api/xrwebgllayer/antialias/index.md

* Update files/en-us/web/api/xrwebgllayer/getnativeframebufferscalefactor/index.md

* Update files/en-us/web/api/xrwebgllayer/getnativeframebufferscalefactor/index.md

* Update files/en-us/web/http/proxy_servers_and_tunneling/proxy_auto-configuration_pac_file/index.md

Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
@OnkarRuikar
Tag syntax code blocks with js-nolint, part 14 (mdn#20626)
3a5066b 
Adding to mdn#19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
@OnkarRuikar
Tag syntax code blocks with js-nolint, part 15 (mdn#20627)
d8e719c 
Adding to mdn#19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
@OnkarRuikar
Tag syntax code blocks with js-nolint, part 16 (mdn#20628)
673268f 
Adding to mdn#19177

- Updating syntax code blocks with the new tag. Refer: mdn/yari#7017
@OnkarRuikar OnkarRuikar mentioned this pull request Jul 22, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Elchi3 Elchi3 Elchi3 left review comments

@teoli2003 teoli2003 teoli2003 approved these changes

@willdurand willdurand Awaiting requested review from willdurand willdurand is a code owner automatically assigned from mdn/yari-content-mozilla-add-ons

Assignees
No one assigned
Labels
Content:JS JavaScript docs Content:Other Any docs not covered by another "Content:" label Content:WebAPI Web API docs Content:WebExt WebExtensions docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@OnkarRuikar @rubiesonthesky @teoli2003 @Elchi3 @Josh-Cena