Merge pull request #17 from ddbeck/make-descriptions-requirable

Make it possible to require short-descriptions

index.js

@@ -0,0 +1,37 @@
+const extend = require('extend');
+const fs = require('fs');
+const path = require('path');
+
+function walk(directory, callback) {
+  fs.readdirSync(directory).forEach((filename) => {
+    const filepath = path.join(directory, filename);
+
+    if (fs.statSync(filepath).isDirectory()) {
+      walk(filepath, callback);
+    }
+    callback(filepath);
+  });
+}
+
+function collectJSON(directory) {
+  const filepaths = [];
+  walk(directory, (fp) => {
+    if (path.extname(fp) === '.json') {
+      filepaths.push(fp);
+    }
+  });
+  return filepaths;
+}
+
+function loadJSON() {
+  const jsons = collectJSON(path.resolve(__dirname, './descriptions'));
+  const finalObj = {};
+
+  jsons.forEach((json) => {
+    const nextObj = JSON.parse(fs.readFileSync(json, 'utf8'));
+    extend(true, finalObj, nextObj);
+  });
+  return finalObj;
+}
+
+module.exports = loadJSON();

package.json

@@ -6,7 +6,9 @@
   "directories": {
     "test": "test"
   },
-  "dependencies": {},
+  "dependencies": {
+    "extend": "^3.0.2"
+  },
   "devDependencies": {
     "eslint": "^5.9.0",
     "eslint-config-airbnb-base": "^13.1.0",
@@ -16,7 +18,7 @@
     "request": "^2.88.0"
   },
   "scripts": {
-    "test": "npm run lint-js && node test/json-format-rules.js && node test/content-rules.js && npm run lint-json",
+    "test": "node test/test.js && npm run lint-js && node test/json-format-rules.js && node test/content-rules.js && npm run lint-json",
     "lint-js": "eslint test/*.js scripts/*.js",
     "lint-json": "node test/lint-json.js",
     "lint-wiki": "node test/lint-wiki.js",

test/test.js

@@ -0,0 +1,8 @@
+/* eslint-disable no-underscore-dangle */
+const assert = require('assert');
+
+const descriptions = require('..');
+
+// Make sure the data is importable and does something vaguely useful
+assert(typeof descriptions.css.properties.opacity.__short_description === 'string');
+assert(descriptions.css.properties.opacity.__short_description.length > 0);