chore: add upgrade step while processing resume

Author: SethFalco

index.js

@@ -75,6 +75,112 @@ Handlebars.registerHelper('link', (body) => {
   return `<a href="${body}">${host}</a>`;
 });
 
+/**
+ * Many users still have JSON Resumes written against old versions of the
+ * schema. We detect this and upgrade them to the latest version behind the
+ * scenes.
+ *
+ * Writes to the object directly.
+ *
+ * @param {any} resume
+ * @returns {boolean}
+ *   If the JSON Resume was modified, so it was using outdated property names.
+ *
+ * @see https://github.com/jsonresume/resume-schema/releases/tag/v0.0.17
+ * @see https://github.com/jsonresume/resume-schema/releases/tag/v0.0.12
+ */
+function upgradeOutdatedResume(resume) {
+  let upgraded = false;
+
+  if (resume.bio && !resume.basics) {
+    resume.basics = resume.bio;
+    upgraded = true;
+  }
+
+  if ((resume.basics?.firstName || resume.basics?.lastName) && !resume.basics.name) {
+    const names = [];
+
+    if (resume.basics.firstName) {
+      names.push(resume.basics.firstName);
+    }
+
+    if (resume.basics.lastName) {
+      names.push(resume.basics.lastName);
+    }
+
+    resume.basics.name = names.join(' ');
+    upgraded = true;
+  }
+
+  if (resume.basics?.picture && !resume.basics.image) {
+    resume.basics.image = resume.basics.picture;
+    upgraded = true;
+  }
+
+  if (resume.basics?.website && !resume.basics.url) {
+    resume.basics.url = resume.basics.website;
+    upgraded = true;
+  }
+
+  if (resume.basics?.state && !resume.basics?.region) {
+    resume.basics.region = resume.basics.state;
+    upgraded = true;
+  }
+
+  if (Array.isArray(resume.work)) {
+    for (const work of resume.work) {
+      if (work?.company && !work.name) {
+        work.name = work.company;
+        upgraded = true;
+      }
+
+      if (work?.website && !work.url) {
+        work.url = work.website;
+        upgraded = true;
+      }
+    }
+  }
+
+  if (Array.isArray(resume.volunteer)) {
+    for (const volunteer of resume.volunteer) {
+      if (volunteer?.website && !volunteer.url) {
+        volunteer.url = volunteer.website;
+        upgraded = true;
+      }
+    }
+  }
+
+  if (Array.isArray(resume.publications)) {
+    for (const publication of resume.publications) {
+      if (publication?.website && !publication.url) {
+        publication.url = publication.website;
+        upgraded = true;
+      }
+    }
+  }
+
+  if (resume.hobbies && !resume.interests) {
+    resume.interests = resume.hobbies;
+    upgraded = true;
+  }
+
+  if (Array.isArray(resume.languages)) {
+    for (const language of resume.languages) {
+      if (language?.name && !language.language) {
+        language.language = language.name;
+        upgraded = true;
+      }
+
+      if (language?.level && !language.fluency) {
+        language.fluency = language.level;
+        upgraded = true;
+      }
+    }
+  }
+
+  return upgraded;
+}
+
 /**
  * @param {any} resume
  * @returns {Promise<string>}
@@ -85,9 +191,12 @@ export async function render(resume) {
     fs.readFile(import.meta.dirname + '/resume.handlebars', 'utf-8'),
   ]);
 
-  const { profiles } = resume.basics;
+  if (upgradeOutdatedResume(resume)) {
+    console.warn('⚠️  Resume is written against an outdated version of the JSON Resume schema.\n⚠️  This will still work, but you should consider updating your resume.\n⚠️  See: https://jsonresume.org/schema');
+  }
 
-  if (Array.isArray(profiles)) {
+  if (Array.isArray(resume.basics?.profiles)) {
+    const { profiles } = resume.basics;
     const xTwitter = profiles.find((profile) => {
       const name = profile.network.toLowerCase();
       return name === 'x' || name === 'twitter';

resume.handlebars

@@ -65,11 +65,6 @@
 
             {{{link url}}}
           </div>
-          {{else if website}}
-          <div class="website">
-            <strong>Website</strong>
-            <a href="{{website}}">{{website}}</a>
-          </div>
           {{/if}}
           {{#if email}}
           <div class="email">
@@ -129,10 +124,6 @@
         <h3 class="work_name">
           {{name}}
         </h3>
-        {{else if company}}
-        <h3 class="work_name">
-          {{company}}
-        </h3>
         {{/if}}
 
         <div class="split">
@@ -152,10 +143,6 @@
           <div class="work_website">
             {{{link url}}}
           </div>
-          {{else if website}}
-          <div class="work_website">
-            <a href="{{website}}">{{website}}</a>
-          </div>
           {{/if}}
         </div>
 
@@ -209,10 +196,6 @@
           <div class="work_website">
             {{{link url}}}
           </div>
-          {{else if website}}
-          <div class="work_website">
-            <a href="{{website}}">{{website}}</a>
-          </div>
           {{/if}}
         </div>
 

test/fixture.resume.json

@@ -27,7 +27,7 @@
   },
   "work": [
     {
-      "name": "JSON Resume",
+      "company": "JSON Resume",
       "location": "Remote",
       "position": "Open Sourcerer 🧙‍♂️",
       "url": "https://jsonresume.org",

tsconfig.json

@@ -10,7 +10,8 @@
     "checkJs": true,
     "strict": true,
     "resolveJsonModule": true,
-    "skipLibCheck": true
+    "skipLibCheck": true,
+    "noImplicitAny": false
   },
   "exclude": [
     ".yarn/",