Bug 1315558 documentation for the publicSuffix API by rebloor · Pull Request #44401 · mdn/content

rebloor · 2026-06-09T18:08:28Z

Description

Addresses the dev-docs needed requirements of Bug 1315558 "tld service for webextensions", including:

publicSuffix API namespace page, describing the API, its permission requirement ("publicSuffix", silently granted), and its availability limited to background scripts.
publicSuffix.DomainEncoding type page
publicSuffix.isKnownSuffix(), publicSuffix.getKnownSuffix() andpublicSuffix.getDomain() method pages.
"publicSuffix" to the API permissions list in permissions and optional_permissions.
Firefox 153 release note for the API.

Related issues and pull requests

Related BCD changes in mdn/browser-compat-data#29822

github-actions · 2026-06-09T18:10:16Z

Preview URLs (8 pages)

External URLs (8)

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/publicSuffix
Title: publicSuffix

https://publicsuffix.org/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/publicSuffix/DomainEncoding
Title: publicSuffix.DomainEncoding

https://en.wikipedia.org/wiki/IDN_homograph_attack (1 time) (Note! This may be a new URL 👀)
https://en.wikipedia.org/wiki/Punycode (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/publicSuffix/getKnownSuffix
Title: publicSuffix.getKnownSuffix()

https://publicsuffix.org/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/publicSuffix/isKnownSuffix
Title: publicSuffix.isKnownSuffix()

https://publicsuffix.org/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Mozilla/Firefox/Releases/153
Title: Firefox 153 release notes for developers (Nightly)

https://bugzil.la/1315558 (1 time) (Note! This may be a new URL 👀)
https://bugzil.la/1751346 (1 time) (Note! This may be a new URL 👀)
https://publicsuffix.org/ (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2026-06-11 16:50:09)

Rob--W · 2026-06-10T00:29:14Z

+
+```js
+console.log(
+  browser.publicSuffix.getDomain("192.0.2.1", { allowIPAddress: true }),


Trailing comma in the function parameters are syntactically allowed in JS, but I think that they may cause confusion. Let's drop them from all examples here.

I still see trailing commas in the diff.

So you do, but hopefully not now.

I think the local linting is adding the back - trying again.

github-actions · 2026-06-10T16:39:59Z

This pull request has merge conflicts that must be resolved before it can be merged.

Co-authored-by: Rob Wu <rob@robwu.nl> Co-authored-by: rebloor <git@sherpa.co.nz>

Removed explicit mention of error message content Tidied up glossary references

github-actions · 2026-06-11T00:13:07Z

+
+```js
+console.log(
+  browser.publicSuffix.getDomain("192.0.2.1", { allowIPAddress: true })


[mdn-linter] _{reported by reviewdog 🐶}

Suggested change

browser.publicSuffix.getDomain("192.0.2.1", { allowIPAddress: true })

browser.publicSuffix.getDomain("192.0.2.1", { allowIPAddress: true }),

github-actions · 2026-06-11T00:13:07Z

+  browser.publicSuffix.getDomain("192.0.2.1", { allowIPAddress: true })
+); // "192.0.2.1"
+console.log(
+  browser.publicSuffix.getDomain("[2001:db8::1]", { allowIPAddress: true })


[mdn-linter] _{reported by reviewdog 🐶}

Suggested change

browser.publicSuffix.getDomain("[2001:db8::1]", { allowIPAddress: true })

browser.publicSuffix.getDomain("[2001:db8::1]", { allowIPAddress: true }),

github-actions · 2026-06-11T00:13:07Z

+
+```js
+console.log(
+  browser.publicSuffix.getDomain("co.uk", { allowPlainSuffix: true })


[mdn-linter] _{reported by reviewdog 🐶}

Suggested change

browser.publicSuffix.getDomain("co.uk", { allowPlainSuffix: true })

browser.publicSuffix.getDomain("co.uk", { allowPlainSuffix: true }),

github-actions · 2026-06-11T00:13:07Z

+    allowUnknownSuffix: true
+  })


[mdn-linter] _{reported by reviewdog 🐶}

Suggested change

allowUnknownSuffix: true

})

allowUnknownSuffix: true,

}),

github-actions · 2026-06-11T00:13:07Z

+  })
+); // "mydevice.local"
+console.log(
+  browser.publicSuffix.getDomain("host.intranet", { allowUnknownSuffix: true })


[mdn-linter] _{reported by reviewdog 🐶}

Suggested change

browser.publicSuffix.getDomain("host.intranet", { allowUnknownSuffix: true })

browser.publicSuffix.getDomain("host.intranet", { allowUnknownSuffix: true }),

github-actions · 2026-06-11T00:13:07Z

+    encoding: "display"
+  })


[mdn-linter] _{reported by reviewdog 🐶}

Suggested change

encoding: "display"

})

encoding: "display",

}),

github-actions · 2026-06-11T00:13:07Z

+    encoding: "display"
+  })


[mdn-linter] _{reported by reviewdog 🐶}

Suggested change

encoding: "display"

})

encoding: "display",

}),

Rob--W

Could we somehow suppress the linter, so that autofix will not reapply the commas?

github-actions · 2026-06-11T16:43:38Z

This pull request has merge conflicts that must be resolved before it can be merged.

rebloor · 2026-06-11T16:57:55Z

Could we somehow suppress the linter, so that autofix will not reapply the commas?

@Rob--W A failing linter doesn't block merging, so this is merged without the commas.

Rob--W · 2026-06-11T17:13:53Z

Could we somehow suppress the linter, so that autofix will not reapply the commas?

@Rob--W A failing linter doesn't block merging, so this is merged without the commas.

Wouldn't the commas return if someone were to update the article in the future? As you noticed, the linting issue was autofixed. Unless an exception is added somehow, the commas will return eventually.

Rob--W · 2026-06-11T17:46:50Z

FYI to fix it is is probably helpful to know where it is coming from.

mdn/content relies on prettier to format the code, and does not set any rules other than: https://github.com/mdn/content/blob/bfaf90116752cffcff6098be4d40f843b8e9f6ee/.prettierrc.json

Notably, the trailingComma option is not set and uses the default: https://prettier.io/docs/options#trailing-commas

To fix it, you could put  before the code block

or if that does not capture the desired part (I think it should!),  and .

These comments are documented at https://prettier.io/docs/ignore/

Bug 1315558 documentation for the publicSuffix API

2a891f5

rebloor requested review from Rob--W and bacharakis June 9, 2026 18:08

rebloor self-assigned this Jun 9, 2026

rebloor requested review from a team as code owners June 9, 2026 18:08

rebloor added the Content:WebExt WebExtensions docs label Jun 9, 2026

rebloor requested review from dipikabh and removed request for a team June 9, 2026 18:08

github-actions Bot added Content:Firefox Content in the Mozilla/Firefox subtree size/m [PR only] 51-500 LoC changed labels Jun 9, 2026

Rob--W reviewed Jun 10, 2026

View reviewed changes

github-actions Bot added the merge conflicts 🚧 [PR only] label Jun 10, 2026

Merge branch 'main' into Bug-1315558-tld-service-for-webextensions

8ddc2c9

github-actions Bot removed the merge conflicts 🚧 [PR only] label Jun 10, 2026

rebloor and others added 2 commits June 11, 2026 05:06

Apply suggestions from @Rob--W

e744b2f

Co-authored-by: Rob Wu <rob@robwu.nl> Co-authored-by: rebloor <git@sherpa.co.nz>

Remove potentially confusing training commas from examples

0df3584

Removed explicit mention of error message content Tidied up glossary references

rebloor requested a review from Rob--W June 10, 2026 17:32

Rob--W reviewed Jun 11, 2026

View reviewed changes

Comment thread files/en-us/mozilla/add-ons/webextensions/api/publicsuffix/index.md Outdated

rebloor added 2 commits June 11, 2026 12:07

Remove trailing commas

821e12c

Remove trailing commas

8ef45a9

github-actions Bot reviewed Jun 11, 2026

View reviewed changes

rebloor requested a review from Rob--W June 11, 2026 00:13

drop mention of background scripts-only

b2f00c5

Rob--W approved these changes Jun 11, 2026

View reviewed changes

github-actions Bot added the merge conflicts 🚧 [PR only] label Jun 11, 2026

Merge branch 'main' into Bug-1315558-tld-service-for-webextensions

623696b

github-actions Bot removed the merge conflicts 🚧 [PR only] label Jun 11, 2026

rebloor merged commit 5054fb7 into mdn:main Jun 11, 2026
8 of 9 checks passed

rebloor deleted the Bug-1315558-tld-service-for-webextensions branch June 11, 2026 16:55

Rob--W mentioned this pull request Jun 11, 2026

"prettier-ignore" comments visible in MDN docs #44417

Closed

This was referenced Jun 17, 2026

Suppress prettier on code examples where trailing commas could be confusing #44499

Closed

Simplify publicSuffix code examples #44569

Merged

	browser.publicSuffix.getDomain("192.0.2.1", { allowIPAddress: true })
	browser.publicSuffix.getDomain("192.0.2.1", { allowIPAddress: true }),

	browser.publicSuffix.getDomain("[2001:db8::1]", { allowIPAddress: true })
	browser.publicSuffix.getDomain("[2001:db8::1]", { allowIPAddress: true }),

	browser.publicSuffix.getDomain("co.uk", { allowPlainSuffix: true })
	browser.publicSuffix.getDomain("co.uk", { allowPlainSuffix: true }),

	browser.publicSuffix.getDomain("host.intranet", { allowUnknownSuffix: true })
	browser.publicSuffix.getDomain("host.intranet", { allowUnknownSuffix: true }),

Uh oh!

Conversation

rebloor commented Jun 9, 2026

Description

Related issues and pull requests

Uh oh!

github-actions Bot commented Jun 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Rob--W Jun 10, 2026

Choose a reason for hiding this comment

Uh oh!

rebloor Jun 10, 2026

Choose a reason for hiding this comment

Uh oh!

Rob--W Jun 10, 2026

Choose a reason for hiding this comment

Uh oh!

rebloor Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

rebloor Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

rebloor Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Jun 10, 2026

Uh oh!

Uh oh!

github-actions Bot Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

Rob--W left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jun 11, 2026

Uh oh!

Uh oh!

rebloor commented Jun 11, 2026

Uh oh!

Rob--W commented Jun 11, 2026

Uh oh!

Rob--W commented Jun 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented Jun 9, 2026 •

edited

Loading