Merge pull request #842 from cmu-delphi/release-v2.0.0

Release v2.0.0

Author: sgratzl

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

.prettierignore

@@ -4,7 +4,7 @@
 .browserslistrc
 .gitattributes
 .prettierignore
-/old_maps
+/.husky
 *.ico
 *.png
 *.svg

package-lock.json

@@ -23,13 +23,13 @@
     "clean": "rimraf \"*.zip\" \"*.tgz\" public",
     "gen": "node ./scripts/generateDescriptions.js",
     "gen:check": "npm run gen -- --check",
+    "gen:local": "npm run gen -- --localOnly",
     "gen:fallback": "npm run gen -- --fallback",
     "process-geo": "node ./src/maps/process.js",
-    "start": "npm run gen:fallback && cross-env NODE_ENV=development webpack-dev-server -d --open",
+    "start": "npm run gen:fallback && cross-env NODE_ENV=development webpack serve --mode development --hot --devtool eval-cheap-module-source-map",
     "prebuild": "npm run clean",
-    "build": "npm run gen:fallback && cross-env NODE_ENV=production webpack -p",
+    "build": "npm run gen:fallback && cross-env NODE_ENV=production webpack --mode production",
     "watch": "cross-env NODE_ENV=development webpack --mode development -w",
-    "deploy": "npm run build; gh-pages -d public",
     "zip": "cd public && bestzip ../release.zip *",
     "prettier": "prettier --write \"**/*\"",
     "lint": "npm run gen:check && eslint src --ext .js,.svelte && prettier --check \"**/*\"",
@@ -44,34 +44,35 @@
     "prepack": "npm run build"
   },
   "devDependencies": {
-    "@babel/core": "^7.12.10",
-    "@babel/preset-env": "^7.12.11",
-    "@fortawesome/fontawesome-free": "^5.15.1",
-    "@octokit/request": "^5.4.12",
-    "@popperjs/core": "^2.6.0",
-    "@testing-library/cypress": "^7.0.3",
-    "@testing-library/jest-dom": "^5.11.8",
+    "@babel/core": "^7.13.10",
+    "@babel/preset-env": "^7.13.10",
+    "@fortawesome/fontawesome-free": "^5.15.3",
+    "@octokit/request": "^5.4.14",
+    "@popperjs/core": "^2.9.1",
+    "@testing-library/cypress": "^7.0.4",
+    "@testing-library/jest-dom": "^5.11.9",
     "@testing-library/svelte": "^3.0.3",
-    "@turf/bbox": "^6.0.1",
-    "@turf/boolean-disjoint": "^6.0.2",
-    "@turf/center-of-mass": "^6.0.1",
+    "@turf/bbox": "^6.3.0",
+    "@turf/boolean-disjoint": "^6.3.0",
+    "@turf/center-of-mass": "^6.3.0",
     "@turf/combine": "^6.3.0",
     "@turf/dissolve": "^6.3.0",
-    "@turf/intersect": "^6.1.3",
-    "@turf/meta": "^6.0.2",
+    "@turf/intersect": "^6.3.0",
+    "@turf/meta": "^6.3.0",
     "@types/lodash-es": "^4.17.4",
     "babel-jest": "^26.6.3",
     "babel-loader": "^8.2.2",
     "bestzip": "^2.1.7",
     "clean-webpack-plugin": "^3.0.0",
     "compute-logspace": "^1.0.0",
-    "concurrently": "^5.3.0",
-    "copy-webpack-plugin": "^7.0.0",
-    "core-js": "^3.8.1",
+    "concurrently": "^6.0.0",
+    "copy-webpack-plugin": "^8.0.0",
+    "core-js": "^3.9.1",
     "cross-env": "^7.0.3",
-    "css-loader": "^5.0.1",
-    "cypress": "^6.2.0",
-    "cypress-image-snapshot": "^4.0.0",
+    "css-loader": "^5.1.3",
+    "css-minimizer-webpack-plugin": "^1.3.0",
+    "cypress": "^6.6.0",
+    "cypress-image-snapshot": "^4.0.1",
     "d3-color": "^2.0.0",
     "d3-dsv": "^2.0.0",
     "d3-format": "^2.0.0",
@@ -81,61 +82,52 @@
     "d3-time": "^2.0.0",
     "d3-time-format": "^3.0.0",
     "dirty-reprojectors": "0.0.2",
-    "eslint": "^7.16.0",
+    "eslint": "^7.22.0",
     "eslint-plugin-cypress": "^2.11.2",
-    "eslint-plugin-svelte3": "^3.0.0",
+    "eslint-plugin-svelte3": "^3.1.2",
     "file-loader": "^6.2.0",
     "geo-albers-usa-territories": "^0.1.0",
-    "gh-pages": "^3.1.0",
-    "html-webpack-harddisk-plugin": "^1.0.2",
-    "html-webpack-plugin": "^4.5.0",
+    "html-webpack-harddisk-plugin": "^2.0.0",
+    "html-webpack-plugin": "^5.3.1",
     "http-server": "^0.12.3",
-    "husky": "^4.3.6",
+    "husky": "^5.1.3",
     "identity-obj-proxy": "^3.0.0",
     "jest": "^26.6.3",
     "js-cookie": "^2.2.1",
-    "js-yaml": "^3.14.1",
-    "lint-staged": "^10.5.3",
-    "lodash-es": "^4.17.20",
+    "js-yaml": "^4.0.0",
+    "lint-staged": "^10.5.4",
+    "lodash-es": "^4.17.21",
     "mapbox-gl": "^1.13.0",
-    "marked": "^2.0.0",
-    "mini-css-extract-plugin": "^1.3.3",
+    "marked": "^2.0.1",
+    "mini-css-extract-plugin": "^1.3.9",
     "node-fetch": "^2.6.1",
-    "nouislider": "^14.6.3",
-    "optimize-css-assets-webpack-plugin": "^5.0.4",
+    "nouislider": "^14.6.4",
     "prettier": "^2.2.1",
-    "prettier-plugin-svelte": "^1.4.2",
+    "prettier-plugin-svelte": "^2.2.0",
     "raw-loader": "^4.0.2",
     "regenerator-runtime": "^0.13.7",
-    "release-it": "^14.2.2",
+    "release-it": "^14.4.1",
     "resize-observer-polyfill": "^1.5.1",
-    "sass": "^1.32.0",
-    "sass-loader": "^10.1.0",
+    "sass": "^1.32.8",
+    "sass-loader": "^11.0.1",
     "seedrandom": "^3.0.5",
     "style-loader": "^2.0.0",
-    "svelte": "^3.31.0",
+    "svelte": "^3.35.0",
     "svelte-icons": "^2.1.0",
     "svelte-jester": "^1.3.0",
-    "svelte-loader": "^2.13.6",
-    "svelte-loader-hot": "^0.3.1",
-    "terser-webpack-plugin": "^4.2.3",
+    "svelte-loader": "^3.0.0",
     "topojson-client": "^3.1.0",
     "topojson-server": "^3.0.1",
     "url-loader": "^4.1.1",
-    "vega": "^5.19.1",
-    "vega-embed": "^6.15.1",
-    "vega-lite": "^4.17.0",
-    "webpack": "^4.44.2",
-    "webpack-cli": "^3.3.12",
-    "webpack-dev-server": "^3.11.1"
+    "vega": "^5.20.0",
+    "vega-embed": "^6.16.0",
+    "vega-lite": "^5.0.0",
+    "webpack": "^5.26.3",
+    "webpack-cli": "^4.5.0",
+    "webpack-dev-server": "^3.11.2"
   },
   "dependencies": {
-    "uikit": "^3.6.5"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "npx lint-staged"
-    }
+    "uikit": "^3.6.18"
   },
   "lint-staged": {
     "*.{js,svelte}": "eslint --cache --fix",

package.json

@@ -9,6 +9,7 @@ const marked = require('marked');
 
 const isCheckMode = process.argv.includes('--check');
 const isFallBackMode = process.argv.includes('--fallback');
+const isLocalOnlyMode = process.argv.includes('--localOnly');
 
 // has to be publicly viewable
 const DOC_URL =
@@ -32,7 +33,7 @@ async function loadDoc(url) {
   const start = text.indexOf('---');
   let code = text.slice(start).trim();
   // replace * in links
-  code = code.replace(/^[*] (.*)$/gm, ' - link: "$1"');
+  code = code.replace(/^[*] (.*)$/gm, ' - "$1"');
   // console.log(code);
   // unify line endings
   return code.replace(/\r?\n/g, '\n');
@@ -59,11 +60,11 @@ function compare(current, fileName) {
 }
 
 async function handleFile(docUrl, fileName, converter) {
-  const code = (await Promise.all(docUrl.split(',').map(loadDoc))).join('\n\n');
+  const code = isLocalOnlyMode ? null : (await Promise.all(docUrl.split(',').map(loadDoc))).join('\n\n');
   if (isCheckMode) {
     return compare(code, fileName);
   }
-  if (!code && isFallBackMode && fs.existsSync(fileName)) {
+  if (!code && (isFallBackMode || isLocalOnlyMode) && fs.existsSync(fileName)) {
     converter(fs.readFileSync(fileName).toString());
     return;
   }
@@ -75,32 +76,44 @@ async function handleFile(docUrl, fileName, converter) {
   converter(code);
 }
 
+function parseObject(obj, processors = {}) {
+  const r = {};
+  Object.entries(obj).map(([key, value]) => {
+    const formattedKey = key[0].toLowerCase() + key.slice(1);
+    if (typeof processors[formattedKey] === 'function') {
+      value = processors[formattedKey](value, formattedKey, processors);
+    }
+    r[formattedKey] = value;
+  });
+  return r;
+}
+
+function parseMarkdown(value) {
+  return marked.parse(value.trim());
+}
+function parseMarkdownInline(value) {
+  return marked.parseInline(value.trim());
+}
+function parseNestedOrString(value, _key, processors) {
+  if (typeof value === 'string') {
+    return value;
+  }
+  return parseObject(value, processors);
+}
+function parseArray(value, _key, processors) {
+  return value.map((v) => parseObject(v, processors));
+}
+
 function convertDescriptions(code) {
-  const entries = [];
-  yaml.safeLoadAll(code, (doc) => {
-    const r = {};
-    Object.entries(doc).map(([key, value]) => {
-      const formattedKey = key[0].toLowerCase() + key.slice(1);
-      if (formattedKey === 'description' || formattedKey === 'credits') {
-        value = marked.parseInline(value.trim());
-      } else if (formattedKey === 'links') {
-        // expect an array with an link property
-        value = value.map((value) => marked.parseInline(value.link.trim()));
-      } else if (
-        formattedKey === 'casesOrDeathSignals' ||
-        (formattedKey === 'mapTitleText' && typeof value !== 'string') ||
-        (formattedKey === 'yAxis' && typeof value !== 'string')
-      ) {
-        // also format nested object
-        const sub = {};
-        Object.entries(value).forEach(([k, v]) => {
-          sub[k[0].toLowerCase() + k.slice(1)] = v;
-        });
-        value = sub;
-      }
-      r[formattedKey] = value;
+  const entries = yaml.loadAll(code).map((doc) => {
+    return parseObject(doc, {
+      description: parseMarkdownInline,
+      credits: parseMarkdownInline,
+      links: (v) => v.map((d) => parseMarkdownInline(d)),
+      yAxis: parseNestedOrString,
+      casesOrDeathSignals: parseNestedOrString,
+      mapTitleText: parseNestedOrString,
     });
-    entries.push(r);
   });
   fs.writeFileSync('./src/stores/descriptions.generated.json', JSON.stringify(entries, null, 2));
 }
@@ -115,31 +128,27 @@ function convertSurveyDescriptions(code) {
     questions: [],
   };
 
-  let first = true;
-
-  yaml.safeLoadAll(code, (doc) => {
-    const r = {};
-    Object.entries(doc).map(([key, value]) => {
-      const formattedKey = key[0].toLowerCase() + key.slice(1);
-      if (formattedKey === 'overview') {
-        value = marked.parse(value.trim());
-      } else if (formattedKey === 'description' || formattedKey === 'question') {
-        value = marked.parseInline(value.trim());
-      }
-      r[formattedKey] = value;
+  const [overview, ...rest] = yaml.loadAll(code);
+
+  function parseDoc(doc) {
+    return parseObject(doc, {
+      overview: parseMarkdown,
+      description: parseMarkdownInline,
+      question: parseMarkdownInline,
+      oldRevisions: parseArray,
+      change: parseMarkdownInline,
+      links: (v) => v.map((d) => parseMarkdownInline(d)),
     });
-    if (first) {
-      Object.assign(parsed, r);
-      first = false;
-    } else {
-      parsed.questions.push(r);
-    }
-  });
-  fs.writeFileSync('./src/modes/survey/descriptions.generated.json', JSON.stringify(parsed, null, 2));
+  }
+  Object.assign(parsed, parseDoc(overview));
+  for (const doc of rest) {
+    parsed.questions.push(parseDoc(doc));
+  }
+  fs.writeFileSync('./src/stores/questions.generated.json', JSON.stringify(parsed, null, 2));
 }
 
 function generateSurveyDescriptions() {
-  return handleFile(SURVEY_DOC_URL, './src/modes/survey/descriptions.raw.txt', convertSurveyDescriptions);
+  return handleFile(SURVEY_DOC_URL, './src/stores/questions.raw.txt', convertSurveyDescriptions);
 }
 
 if (require.main === module) {

scripts/generateDescriptions.js

@@ -18,12 +18,6 @@
   $: currentComponent = $currentMode.component();
 </script>
 
-<style>
-  .loader {
-    flex-grow: 1;
-  }
-</style>
-
 {#await currentComponent}
   <div class="loader loading" />
 {:then value}
@@ -36,3 +30,9 @@
 {/await}
 <Disclaimer />
 <InfoDialog />
+
+<style>
+  .loader {
+    flex-grow: 1;
+  }
+</style>