summaryrefslogtreecommitdiffstats
path: root/docs/code-quality/lint/linters/eslint-plugin-mozilla/rules/no-browser-refs-in-toolkit.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/code-quality/lint/linters/eslint-plugin-mozilla/rules/no-browser-refs-in-toolkit.rst')
-rw-r--r--docs/code-quality/lint/linters/eslint-plugin-mozilla/rules/no-browser-refs-in-toolkit.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/code-quality/lint/linters/eslint-plugin-mozilla/rules/no-browser-refs-in-toolkit.rst b/docs/code-quality/lint/linters/eslint-plugin-mozilla/rules/no-browser-refs-in-toolkit.rst
new file mode 100644
index 0000000000..9f2501ba23
--- /dev/null
+++ b/docs/code-quality/lint/linters/eslint-plugin-mozilla/rules/no-browser-refs-in-toolkit.rst
@@ -0,0 +1,24 @@
+no-browser-refs-in-toolkit
+==========================
+
+Rejects for using any code from ``browser/`` (Desktop Firefox) inside
+``toolkit``, as ``toolkit`` is for code shared with other Gecko consumers
+like Firefox on Android, Thunderbird, etc.
+
+Examples of incorrect code for this rule:
+-----------------------------------------
+
+.. code-block:: js
+
+ "chrome://browser/content/browser.xhtml"
+ "resource:///modules/BrowserWindowTracker.sys.mjs"
+ "browser/browser.ftl"
+
+Examples of correct code for this rule:
+---------------------------------------
+
+.. code-block:: js
+
+ "chrome://global/content/aboutAbout.html"
+ "resource://gre/modules/AppConstants.sys.mjs"
+ "toolkit/global/aboutFoo.ftl"