enchancement(scripts) Improve sorting of update-dictionary (gatsbyjs#25663)

* Make update-dictionary better

* better word compare

Author: tesseralis

scripts/update-dictionary.js

@@ -5,6 +5,21 @@
 const { execSync } = require(`child_process`)
 const fs = require(`fs`)
 
+// Strip the string
+function trim(str) {
+  // `*` is used to negate words, so negated words should be put with the original word
+  // e.g. npm, *NPM
+  return str.replace(/^\*/, ``)
+}
+
+function compareWords(a, b) {
+  // The empty string should go at the end
+  if (a === ``) return 1
+  if (b === ``) return -1
+  // Compare the two words
+  return trim(a).localeCompare(trim(b))
+}
+
 // Get our current list of words
 const words = new Set(fs.readFileSync(`./dictionary.txt`, `utf-8`).split(`\n`))
 
@@ -34,7 +49,7 @@ for (const match of matches) {
 
 const wordList = [...words]
 // Sort in alphabetical order for convenience
-wordList.sort((a, b) => a.localeCompare(b))
+wordList.sort(compareWords)
 
 // Write back to the dictionary file
 fs.writeFileSync(`./dictionary.txt`, wordList.join(`\n`))