Create camara-language-avoid-telco.js

lint_function/camara-language-avoid-telco.js

@@ -0,0 +1,40 @@
+// CAMARA Project - support function for Spectral linter
+// 31.01.2024 - initial version
+
+const replacements = [
+  { original: 'UE', recommended: 'device' },
+  { original: 'MSISDN', recommended: 'phone number' },
+  { original: 'mobile network', recommended: 'network' }
+];
+
+export default async function (input) {
+  const errors = [];
+  const suggestions = [];
+
+  // Iterate over properties of the input object
+  for (const path in input) {
+    const value = input[path];
+
+    // Check if the value is a string
+    if (typeof value === 'string') {
+      for (const replacement of replacements) {
+        const original = replacement.original;
+        const recommended = replacement.recommended;
+
+        // Use a regular expression to match 'original' as a standalone word
+        const regex = new RegExp(`\\b${original}\\b`, 'g');
+
+        // Check if 'original' exists in the value
+        if (regex.test(value)) {
+          errors.push(replacement);
+          suggestions.push(` Telco-specific terminology found in input: Consider replacing '${original}' with '${recommended}'.`);
+        }
+      }
+    }
+  }
+
+ // Check if any word from 'replacements' is in the suggestions
+  if (errors.length > 0) {
+    console.log(`Hint     camara-language-avoid-telco ` + suggestions.join(', '));
+  }
+};