Ensure that icons data object fields are sorted (#12243)

_data/simple-icons.json

@@ -370,13 +370,13 @@
         },
         {
             "title": "AEW",
+            "hex": "000000",
+            "source": "https://commons.wikimedia.org/wiki/File:AEW_Logo_(simplified).svg",
             "aliases": {
                 "aka": [
                     "All Elite Wrestling"
                 ]
-            },
+            }
-            "hex": "000000",
-            "source": "https://commons.wikimedia.org/wiki/File:AEW_Logo_(simplified).svg"
         },
         {
             "title": "AFFiNE",
@@ -1040,10 +1040,10 @@
             "title": "Anki",
             "hex": "80C2EE",
             "source": "https://commons.wikimedia.org/wiki/File:Anki-icon.svg",
+            "guidelines": "https://github.com/ankitects/anki/blob/4ab0db3127af8508317f84174aff9d20faedc41a/LICENSE",
             "license": {
                 "type": "AGPL-3.0-only"
-            },
+            }
-            "guidelines": "https://github.com/ankitects/anki/blob/4ab0db3127af8508317f84174aff9d20faedc41a/LICENSE"
         },
         {
             "title": "Ansible",
@@ -4652,14 +4652,14 @@
         },
         {
             "title": "DVC",
+            "hex": "13ADC7",
+            "source": "https://iterative.ai/brand/",
+            "guidelines": "https://iterative.ai/brand/",
             "aliases": {
                 "aka": [
                     "Data Version Control"
                 ]
-            },
+            }
-            "hex": "13ADC7",
-            "source": "https://iterative.ai/brand/",
-            "guidelines": "https://iterative.ai/brand/"
         },
         {
             "title": "dwm",
@@ -5190,8 +5190,8 @@
         },
         {
             "title": "F#",
-            "hex": "378BBA",
             "slug": "fsharp",
+            "hex": "378BBA",
             "source": "https://foundation.fsharp.org/logo",
             "guidelines": "https://foundation.fsharp.org/logo",
             "aliases": {
@@ -6372,14 +6372,14 @@
         },
         {
             "title": "Google",
+            "hex": "4285F4",
+            "source": "https://partnermarketinghub.withgoogle.com",
+            "guidelines": "https://about.google/brand-resource-center/brand-elements/",
             "aliases": {
                 "loc": {
                     "ko-KR": "구글"
                 }
-            },
+            }
-            "hex": "4285F4",
-            "source": "https://partnermarketinghub.withgoogle.com",
-            "guidelines": "https://about.google/brand-resource-center/brand-elements/"
         },
         {
             "title": "Google AdMob",
@@ -8286,23 +8286,23 @@
         },
         {
             "title": "Kakao",
+            "hex": "FFCD00",
+            "source": "https://www.kakaocorp.com/kakao/introduce/ci",
             "aliases": {
                 "loc": {
                     "ko-KR": "카카오"
                 }
-            },
+            }
-            "hex": "FFCD00",
-            "source": "https://www.kakaocorp.com/kakao/introduce/ci"
         },
         {
             "title": "KakaoTalk",
+            "hex": "FFCD00",
+            "source": "https://commons.wikimedia.org/wiki/File:KakaoTalk_logo.svg",
             "aliases": {
                 "loc": {
                     "ko-KR": "카카오톡"
                 }
-            },
+            }
-            "hex": "FFCD00",
-            "source": "https://commons.wikimedia.org/wiki/File:KakaoTalk_logo.svg"
         },
         {
             "title": "Kali Linux",
@@ -8494,13 +8494,13 @@
         },
         {
             "title": "Kingston Technology",
+            "hex": "000000",
+            "source": "https://www.kingston.com",
             "aliases": {
                 "aka": [
                     "Kingston"
                 ]
-            },
+            }
-            "hex": "000000",
-            "source": "https://www.kingston.com"
         },
         {
             "title": "Kinopoisk",
@@ -8646,14 +8646,14 @@
         },
         {
             "title": "Kotlin",
+            "hex": "7F52FF",
+            "source": "https://www.jetbrains.com/company/brand/logos/",
+            "guidelines": "https://www.jetbrains.com/company/brand/",
             "aliases": {
                 "loc": {
                     "ko-KR": "코틀린"
                 }
-            },
+            }
-            "hex": "7F52FF",
-            "source": "https://www.jetbrains.com/company/brand/logos/",
-            "guidelines": "https://www.jetbrains.com/company/brand/"
         },
         {
             "title": "Koyeb",
@@ -9094,15 +9094,15 @@
         },
         {
             "title": "LINE",
+            "hex": "00C300",
+            "source": "https://line.me/en/logo",
+            "guidelines": "https://line.me/en/logo",
             "aliases": {
                 "loc": {
                     "ko-KR": "라인",
                     "ja-JP": "ライン"
                 }
-            },
+            }
-            "hex": "00C300",
-            "source": "https://line.me/en/logo",
-            "guidelines": "https://line.me/en/logo"
         },
         {
             "title": "LineageOS",
@@ -9915,14 +9915,14 @@
         },
         {
             "title": "MG",
+            "hex": "FF0000",
+            "source": "https://www.mg.co.uk/themes/custom/mg/assets/images/svg/mg-logo-desktop.svg",
+            "guidelines": "https://www.mg.co.uk/terms-and-conditions",
             "aliases": {
                 "aka": [
                     "Morris Garages"
                 ]
-            },
+            }
-            "hex": "FF0000",
-            "source": "https://www.mg.co.uk/themes/custom/mg/assets/images/svg/mg-logo-desktop.svg",
-            "guidelines": "https://www.mg.co.uk/terms-and-conditions"
         },
         {
             "title": "Micro Editor",
@@ -10159,8 +10159,8 @@
         },
         {
             "title": "Mongoose",
-            "hex": "F04D35",
             "slug": "mongoosedotws",
+            "hex": "F04D35",
             "source": "https://mongoose.ws"
         },
         {
@@ -10260,13 +10260,13 @@
         },
         {
             "title": "MSI",
+            "hex": "FF0000",
+            "source": "https://www.msi.com/page/brochure",
             "aliases": {
                 "aka": [
                     "Micro-Star International"
                 ]
-            },
+            }
-            "hex": "FF0000",
-            "source": "https://www.msi.com/page/brochure"
         },
         {
             "title": "MSI Business",
@@ -10290,13 +10290,13 @@
         },
         {
             "title": "MUI",
+            "hex": "007FFF",
+            "source": "https://github.com/mui-org/material-ui/blob/353cecb5391571163eb6bd8cbf36d2dd299aaf56/docs/src/icons/SvgMuiLogo.tsx",
             "aliases": {
                 "aka": [
                     "Material-UI"
                 ]
-            },
+            }
-            "hex": "007FFF",
-            "source": "https://github.com/mui-org/material-ui/blob/353cecb5391571163eb6bd8cbf36d2dd299aaf56/docs/src/icons/SvgMuiLogo.tsx"
         },
         {
             "title": "Mulesoft",
@@ -12155,13 +12155,13 @@
         },
         {
             "title": "PlayStation Portable",
+            "hex": "003791",
+            "source": "https://commons.wikimedia.org/wiki/File:PSP_Logo.svg",
             "aliases": {
                 "aka": [
                     "PSP"
                 ]
-            },
+            }
-            "hex": "003791",
-            "source": "https://commons.wikimedia.org/wiki/File:PSP_Logo.svg"
         },
         {
             "title": "PlayStation Vita",
@@ -13388,14 +13388,14 @@
         },
         {
             "title": "Republic of Gamers",
+            "hex": "FF0029",
+            "source": "https://rog.asus.com",
             "aliases": {
                 "aka": [
                     "ASUS ROG",
                     "ROG"
                 ]
-            },
+            }
-            "hex": "FF0029",
-            "source": "https://rog.asus.com"
         },
         {
             "title": "ReScript",
@@ -14873,13 +14873,13 @@
         {
             "title": "Sphere Online Judge",
             "slug": "spoj",
+            "hex": "337AB7",
+            "source": "https://www.spoj.com",
             "aliases": {
                 "aka": [
                     "SPOJ"
                 ]
-            },
+            }
-            "hex": "337AB7",
-            "source": "https://www.spoj.com"
         },
         {
             "title": "Sphinx",
@@ -15849,13 +15849,13 @@
         {
             "title": "Tether",
             "hex": "50AF95",
+            "source": "https://tether.to/branding/",
+            "guidelines": "https://tether.to/branding/",
             "aliases": {
                 "aka": [
                     "USDt"
                 ]
-            },
+            }
-            "source": "https://tether.to/branding/",
-            "guidelines": "https://tether.to/branding/"
         },
         {
             "title": "Textpattern",
@@ -15924,13 +15924,13 @@
         },
         {
             "title": "The Movie Database",
+            "hex": "01B4E4",
+            "source": "https://www.themoviedb.org/about/logos-attribution",
             "aliases": {
                 "aka": [
                     "TMDB"
                 ]
-            },
+            }
-            "hex": "01B4E4",
-            "source": "https://www.themoviedb.org/about/logos-attribution"
         },
         {
             "title": "The North Face",
@@ -17022,6 +17022,9 @@
         },
         {
             "title": "VictoriaMetrics",
+            "hex": "621773",
+            "source": "https://github.com/VictoriaMetrics/VictoriaMetrics/blob/24d61bf19374b42ef9839c13c7d35ce8888170e0/docs/assets/images/vm_logo.svg",
+            "guidelines": "https://docs.victoriametrics.com/#victoriametrics-logo",
             "aliases": {
                 "aka": [
                     "VM"
@@ -17029,10 +17032,7 @@
                 "loc": {
                     "ko-KR": "빅토리아메트릭스"
                 }
-            },
+            }
-            "hex": "621773",
-            "source": "https://github.com/VictoriaMetrics/VictoriaMetrics/blob/24d61bf19374b42ef9839c13c7d35ce8888170e0/docs/assets/images/vm_logo.svg",
-            "guidelines": "https://docs.victoriametrics.com/#victoriametrics-logo"
         },
         {
             "title": "Victron Energy",
@@ -17058,13 +17058,13 @@
         },
         {
             "title": "Virgin",
+            "hex": "E10A0A",
+            "source": "https://www.virgin.com/img/virgin-logo-square.svg",
             "aliases": {
                 "aka": [
                     "Virgin Group"
                 ]
-            },
+            }
-            "hex": "E10A0A",
-            "source": "https://www.virgin.com/img/virgin-logo-square.svg"
         },
         {
             "title": "Virgin Atlantic",
@@ -17529,13 +17529,13 @@
         },
         {
             "title": "Welcome to the Jungle",
+            "hex": "FFCD00",
+            "source": "https://www.welcometothejungle.com",
             "aliases": {
                 "aka": [
                     "WTTJ"
                 ]
-            },
+            }
-            "hex": "FFCD00",
-            "source": "https://www.welcometothejungle.com"
         },
         {
             "title": "Wellfound",
@@ -17554,13 +17554,13 @@
         },
         {
             "title": "Western Digital",
+            "hex": "995DFF",
+            "source": "https://www.westerndigital.com",
             "aliases": {
                 "aka": [
                     "WD"
                 ]
-            },
+            }
-            "hex": "995DFF",
-            "source": "https://www.westerndigital.com"
         },
         {
             "title": "Western Union",
@@ -18074,14 +18074,14 @@
         },
         {
             "title": "Zcash",
+            "hex": "F3B724",
+            "source": "https://z.cash",
+            "guidelines": "https://zfnd.org/trademark-policy",
             "aliases": {
                 "aka": [
                     "ZEC"
                 ]
-            },
+            }
-            "hex": "F3B724",
-            "source": "https://z.cash",
-            "guidelines": "https://zfnd.org/trademark-policy"
         },
         {
             "title": "ZCOOL",

scripts/lint/ourlint.js

@@ -23,7 +23,7 @@ import {getSpdxLicenseIds} from '../utils.js';
 
 /**
  * Contains our tests so they can be isolated from each other.
- * @type {{[k: string]: (arg0: {icons: IconsData}, arg1: string) => Promise<string | undefined> | string | undefined}}
+ * @type {{[k: string]: (data: {icons: IconsData}, dataString: string) => Promise<string | undefined> | string | undefined}}
  */
 const TESTS = {
   /**
@@ -31,7 +31,7 @@ const TESTS = {
    * @param {{icons: IconsData}} data Icons data.
    * @returns {string|undefined} Error message or undefined.
    */
-  alphabetical(data) {
+  alphabetical({icons}) {
     /**
      * Collects invalid alphabet ordered icons.
      * @param {IconData[]} invalidEntries Invalid icons reference.
@@ -72,7 +72,7 @@ const TESTS = {
     };
 
     // eslint-disable-next-line unicorn/no-array-reduce, unicorn/no-array-callback-reference
-    const invalids = data.icons.reduce(collector, []);
+    const invalids = icons.reduce(collector, []);
     if (invalids.length > 0) {
       return `Some icons aren't in alphabetical order:
         ${invalids.map((icon) => format(icon)).join(', ')}`;
@@ -91,7 +91,7 @@ const TESTS = {
   },
 
   /* Check redundant trailing slash in URL */
-  checkUrl(data) {
+  checkUrl({icons}) {
     /**
      * Check if an URL has a redundant trailing slash.
      * @param {URL} $url URL instance.
@@ -150,7 +150,7 @@ const TESTS = {
      * @type {[boolean, string][]}
      */
     const allUrlFields = [];
-    for (const icon of data.icons) {
+    for (const icon of icons) {
       allUrlFields.push([true, icon.source]);
       if (icon.guidelines) {
         allUrlFields.push([false, icon.guidelines]);
@@ -206,10 +206,10 @@ const TESTS = {
   },
 
   /* Check if all licenses are valid SPDX identifiers */
-  async checkLicense(data) {
+  async checkLicense({icons}) {
     const spdxLicenseIds = new Set(await getSpdxLicenseIds());
     const badLicenses = [];
-    for (const {title, slug, license} of data.icons) {
+    for (const {title, slug, license} of icons) {
       if (
         license &&
         license.type !== 'custom' &&
@@ -225,6 +225,45 @@ const TESTS = {
       return `Bad licenses:\n\n${badLicenses.join('\n')}\n\nSee the valid license indentifiers at https://spdx.org/licenses`;
     }
   },
+
+  /* Ensure that fields are sorted in the same way for all icons */
+  fieldsSorted({icons}) {
+    const expectedOrder = [
+      'title',
+      'slug',
+      'hex',
+      'source',
+      'guidelines',
+      'license',
+      'aliases',
+    ];
+
+    const errors = [];
+    for (const icon of icons) {
+      const fields = Object.keys(icon);
+      const previousFields = [...fields];
+      fields.sort(
+        (a, b) => expectedOrder.indexOf(a) - expectedOrder.indexOf(b),
+      );
+      const previousFieldsString = JSON.stringify(previousFields);
+      const fieldsString = JSON.stringify(fields);
+      if (previousFieldsString !== fieldsString) {
+        const subject = icon.slug ? `${icon.title} (${icon.slug})` : icon.title;
+        errors.push(
+          `${subject} fields are not sorted.` +
+            ` Found ${previousFieldsString.replaceAll(',', ', ')},` +
+            ` but expected ${fieldsString.replaceAll(',', ', ')}`,
+        );
+      }
+    }
+
+    if (errors.length > 0) {
+      return (
+        'Wrong order of fields in _data/simple-icons.json icons:\n' +
+        `- ${errors.join('\n- ')}`
+      );
+    }
+  },
 };
 
 const iconsDataString = await getIconsDataString();