feat(resources): Add custom resources directory which is git ignored (#27)

Author: Joxit

.gitignore

@@ -16,5 +16,8 @@ resources/whosonfirst/dictionaries/*/*.txt
 !resources/whosonfirst/dictionaries/locality/name:eng_x_preferred.txt
 !resources/whosonfirst/dictionaries/locality/name:fra_x_preferred.txt
 
+# ignore all custom dictionaries
+resources/custom/dictionaries
+
 # ignore any openaddresses test cases
 test/oa

resources/custom/custom.js

@@ -0,0 +1,20 @@
+const fs = require('fs')
+const path = require('path')
+const dictPath = path.join(__dirname, `./dictionaries`)
+
+function load (filename, add, remove) {
+  let filepath = path.join(dictPath, filename)
+  if (!fs.existsSync(filepath)) { return }
+  let dict = fs.readFileSync(filepath, 'utf8')
+  dict.split('\n').forEach(row => {
+    if (row.trim().startsWith('#')) {
+      // Do nothing, this is a comment
+    } else if (row.startsWith('!')) {
+      row.substring(1).split('|').forEach(remove)
+    } else {
+      row.split('|').forEach(add)
+    }
+  })
+}
+
+module.exports.load = load

resources/libpostal/libpostal.js

@@ -1,6 +1,7 @@
 const fs = require('fs')
 const path = require('path')
 const pelias = require('../pelias/pelias')
+const custom = require('../custom/custom')
 const dictPath = path.join(__dirname, `./dictionaries`)
 const allLanguages = fs.readdirSync(dictPath).filter(p => !p.includes('.'))
 
@@ -20,6 +21,10 @@ function load (index, langs, filename, options) {
   langs.forEach(lang => {
     pelias.load(path.join('libpostal', lang, filename), add, remove)
   })
+
+  langs.forEach(lang => {
+    custom.load(path.join('libpostal', lang, filename), add, remove)
+  })
 }
 
 function _normalize (cell, options) {

resources/whosonfirst/whosonfirst.js

@@ -1,6 +1,7 @@
 const fs = require('fs')
 const path = require('path')
 const pelias = require('../pelias/pelias')
+const custom = require('../custom/custom')
 const dictPath = path.join(__dirname, `./dictionaries`)
 const allPlacetypes = fs.readdirSync(dictPath).filter(p => !p.includes('.'))
 
@@ -24,6 +25,12 @@ function load (set, placetypes, filenames, options) {
       pelias.load(path.join('whosonfirst', placetype, filename), add, remove)
     })
   })
+
+  placetypes.forEach(placetype => {
+    filenames.forEach(filename => {
+      custom.load(path.join('whosonfirst', placetype, filename), add, remove)
+    })
+  })
 }
 
 function _normalize (cell, options) {