moz-fluent-linter 0.4.4__tar.gz → 0.4.6__tar.gz

{moz-fluent-linter-0.4.4/src/moz_fluent_linter.egg-info → moz_fluent_linter-0.4.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: moz-fluent-linter
-Version: 0.4.4
+Version: 0.4.6
 Summary: Linter package used to check Fluent files
 Home-page: https://github.com/mozilla-l10n/moz-fluent-linter
 Author: Francesco Lodolo
@@ -14,7 +14,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: Localization
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
-License-File: LICENSE.md
+License-File: LICENSE
 Requires-Dist: fluent.syntax<0.19,>=0.18.0
 Requires-Dist: pyyaml
 Requires-Dist: six
@@ -41,7 +41,7 @@ Using [pre-commit](https://pre-commit.com/), add this to the `.pre-commit-config
 ```yaml
 repos:
   - repo: https://github.com/mozilla-l10n/moz-fluent-linter
-    rev: v0.4.4
+    rev: v0.4.6
     hooks:
       - id: fluent_linter
         files: \.ftl$

{moz-fluent-linter-0.4.4 → moz_fluent_linter-0.4.6}/README.md

@@ -20,7 +20,7 @@ Using [pre-commit](https://pre-commit.com/), add this to the `.pre-commit-config
 ```yaml
 repos:
   - repo: https://github.com/mozilla-l10n/moz-fluent-linter
-    rev: v0.4.4
+    rev: v0.4.6
     hooks:
       - id: fluent_linter
         files: \.ftl$

{moz-fluent-linter-0.4.4 → moz_fluent_linter-0.4.6}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = moz-fluent-linter
-version = 0.4.4
+version = 0.4.6
 author = Francesco Lodolo
 author_email = flod@mozilla.com
 description = Linter package used to check Fluent files

moz_fluent_linter-0.4.6/src/fluent_linter/__init__.py

@@ -0,0 +1 @@
+version = "0.4.6"

{moz-fluent-linter-0.4.4 → moz_fluent_linter-0.4.6}/src/fluent_linter/linter.py

@@ -136,27 +136,51 @@ class Linter(visitor.Visitor):
         html_stripper.feed("".join(parts))
         cleaned_str = html_stripper.get_data()
 
+        message_id = node.id.name
+
+        # Check brand names here, so it's possible to also look for combination
+        # of text and terms.
+        if message_id is not None and not self.exclude_message(
+            "CO01", message_id, self.path
+        ):
+            found_brands = []
+            for brand in self.brand_names:
+                if brand == re.escape(brand):
+                    brand_re = re.compile(r"\b" + brand + r"\b")
+                else:
+                    brand_re = re.compile(brand)
+                if brand_re.search(cleaned_str):
+                    found_brands.append(brand)
+            if found_brands:
+                self.add_error(
+                    node,
+                    message_id,
+                    "CO01",
+                    "Strings should use the corresponding terms instead of"
+                    f" hard-coded brand names ({', '.join(found_brands)})",
+                )
+
         if self.apostrophe_re.search(cleaned_str):
-            if not self.exclude_message("TE01", node.id.name):
+            if not self.exclude_message("TE01", message_id):
                 self.add_error(
                     node,
-                    node.id.name,
+                    message_id,
                     "TE01",
                     "Strings with apostrophes should use foo\u2019s instead of foo's.",
                 )
         if self.incorrect_apostrophe_re.search(cleaned_str):
-            if not self.exclude_message("TE02", node.id.name):
+            if not self.exclude_message("TE02", message_id):
                 self.add_error(
                     node,
-                    node.id.name,
+                    message_id,
                     "TE02",
                     "Strings with apostrophes should use foo\u2019s instead of foo\u2018s.",
                 )
         if self.single_quote_re.search(cleaned_str):
-            if not self.exclude_message("TE03", node.id.name):
+            if not self.exclude_message("TE03", message_id):
                 self.add_error(
                     node,
-                    node.id.name,
+                    message_id,
                     "TE03",
                     "Single-quoted strings should use Unicode \u2018foo\u2019 instead of 'foo'.",
                 )
@@ -166,19 +190,19 @@ class Linter(visitor.Visitor):
                 cleaned_str = regex.sub("", cleaned_str)
 
             if self.double_quote_re.search(cleaned_str) and not self.exclude_message(
-                "TE04", node.id.name
+                "TE04", message_id
             ):
                 self.add_error(
                     node,
-                    node.id.name,
+                    message_id,
                     "TE04",
                     'Double-quoted strings should use Unicode \u201cfoo\u201d instead of "foo".',
                 )
         if self.ellipsis_re.search(cleaned_str):
-            if not self.exclude_message("TE05", node.id.name):
+            if not self.exclude_message("TE05", message_id):
                 self.add_error(
                     node,
-                    node.id.name,
+                    message_id,
                     "TE05",
                     "Strings with an ellipsis should use the Unicode \u2026 character"
                     " instead of three periods",
@@ -298,25 +322,8 @@ class Linter(visitor.Visitor):
         html_stripper.feed(node.value)
         cleaned_str = html_stripper.get_data()
 
-        # If part of a message, check for brand and banned words
+        # If part of a message, check for banned words
         message_id = self.last_message_id
-        if message_id is not None and not self.exclude_message(
-            "CO01", message_id, self.path
-        ):
-            found_brands = []
-            for brand in self.brand_names:
-                brand_re = re.compile(r"\b" + brand + r"\b")
-                if brand_re.search(cleaned_str):
-                    found_brands.append(brand)
-            if found_brands:
-                self.add_error(
-                    node,
-                    message_id,
-                    "CO01",
-                    "Strings should use the corresponding terms instead of"
-                    f" hard-coded brand names ({', '.join(found_brands)})",
-                )
-
         if message_id is not None and not self.exclude_message(
             "CO02", message_id, self.path
         ):
@@ -534,7 +541,7 @@ class Linter(visitor.Visitor):
     def add_error(self, node, message_id, rule, msg):
         (col, line) = self.span_to_line_and_col(node.span)
 
-        file_path = os.path.relpath(self.path, self.root_folder)
+        file_path = os.path.relpath(self.path)
         message_id = message_id if message_id is not None else "-"
         error_msg = f"""
             File path: {file_path}

{moz-fluent-linter-0.4.4 → moz_fluent_linter-0.4.6/src/moz_fluent_linter.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: moz-fluent-linter
-Version: 0.4.4
+Version: 0.4.6
 Summary: Linter package used to check Fluent files
 Home-page: https://github.com/mozilla-l10n/moz-fluent-linter
 Author: Francesco Lodolo
@@ -14,7 +14,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: Localization
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
-License-File: LICENSE.md
+License-File: LICENSE
 Requires-Dist: fluent.syntax<0.19,>=0.18.0
 Requires-Dist: pyyaml
 Requires-Dist: six
@@ -41,7 +41,7 @@ Using [pre-commit](https://pre-commit.com/), add this to the `.pre-commit-config
 ```yaml
 repos:
   - repo: https://github.com/mozilla-l10n/moz-fluent-linter
-    rev: v0.4.4
+    rev: v0.4.6
     hooks:
       - id: fluent_linter
         files: \.ftl$

{moz-fluent-linter-0.4.4 → moz_fluent_linter-0.4.6}/src/moz_fluent_linter.egg-info/SOURCES.txt

@@ -1,4 +1,4 @@
-LICENSE.md
+LICENSE
 README.md
 pyproject.toml
 setup.cfg

{moz-fluent-linter-0.4.4 → moz_fluent_linter-0.4.6}/tests/test_brands.py

@@ -36,6 +36,10 @@ good-mozilla2 = Welcome to { mozilla-message }
 bad-monitor = Monitor your email
 good-monitor = Monitored emails
 good-monitor2 = Set up your monitor.
+
+bad-account = Set up your { -brand-short-name } account
+good-account = Set up your { -brand-short-name }. Account.
+good-account2 = Set up your { -brand-short-name } Account.
 """
 
         config = {
@@ -49,19 +53,20 @@ good-monitor2 = Set up your monitor.
         config = {
             "CO01": {
                 "enabled": True,
-                "brands": ["Firefox", "Mozilla"],
+                "brands": ["Firefox", "Mozilla", "{ -brand-short-name } account"],
                 "exclusions": {
                     "messages": ["bad-firefox-excluded"],
                 },
             }
         }
         results = self.checkContent(config, content)
-        self.assertEqual(len(results), 8)
+        self.assertEqual(len(results), 9)
         self.assertTrue("CO01" in results[0])
         self.assertTrue("Firefox" in results[0])
-        self.assertTrue("line 5" in results[1])
+        self.assertTrue("line 4" in results[1])
         self.assertTrue("bad-firefox2" in results[1])
         self.assertTrue("Mozilla" in results[5])
+        self.assertTrue("{ -brand-short-name } account" in results[8])
 
         config = {
             "CO01": {

moz-fluent-linter-0.4.4/src/fluent_linter/__init__.py

@@ -1 +0,0 @@
-version = "0.4.4"