Automate the title creation in new roadmap content

bin/roadmap-content.cjs

@@ -0,0 +1,81 @@
+const fs = require('fs');
+const path = require('path');
+
+const OPEN_AI_API_KEY = process.env.OPEN_AI_API_KEY;
+const ALL_ROADMAPS_DIR = path.join(__dirname, '../src/data/roadmaps');
+const ROADMAP_JSON_DIR = path.join(__dirname, '../public/jsons/roadmaps');
+
+const roadmapId = process.argv[2];
+
+const allowedRoadmapIds = fs.readdirSync(ALL_ROADMAPS_DIR);
+if (!roadmapId) {
+  console.error('roadmapId is required');
+  process.exit(1);
+}
+
+if (!allowedRoadmapIds.includes(roadmapId)) {
+  console.error(`Invalid roadmap key ${roadmapId}`);
+  console.error(`Allowed keys are ${allowedRoadmapIds.join(', ')}`);
+  process.exit(1);
+}
+
+const ROADMAP_CONTENT_DIR = path.join(ALL_ROADMAPS_DIR, roadmapId, 'content');
+
+function getFilesInFolder(folderPath, fileList = {}) {
+  const files = fs.readdirSync(folderPath);
+
+  files.forEach((file) => {
+    const filePath = path.join(folderPath, file);
+    const stats = fs.statSync(filePath);
+
+    if (stats.isDirectory()) {
+      getFilesInFolder(filePath, fileList);
+    } else if (stats.isFile()) {
+      const fileUrl = filePath
+        .replace(ROADMAP_CONTENT_DIR, '') // Remove the content folder
+        .replace(/\/\d+-/g, '/') // Remove ordering info `/101-ecosystem`
+        .replace(/\/index\.md$/, '') // Make the `/index.md` to become the parent folder only
+        .replace(/\.md$/, ''); // Remove `.md` from the end of file
+
+      fileList[fileUrl] = filePath;
+    }
+  });
+
+  return fileList;
+}
+
+const topicUrlToPathMapping = getFilesInFolder(ROADMAP_CONTENT_DIR);
+
+const roadmapJson = require(path.join(ROADMAP_JSON_DIR, `${roadmapId}.json`));
+const groups = roadmapJson?.mockup?.controls?.control?.filter(
+  (control) => control.typeID === '__group__' && !control.properties?.controlName?.startsWith('ext_link')
+);
+
+groups.forEach((group) => {
+  const topicId = group?.properties?.controlName;
+  const topicTitle = group?.children?.controls?.control?.find((control) => control?.typeID === 'Label')?.properties
+    ?.text;
+  const currTopicUrl = topicId.replace(/^\d+-/g, '/').replace(/:/g, '/');
+  const contentFilePath = topicUrlToPathMapping[currTopicUrl];
+
+  const currentFileContent = fs.readFileSync(contentFilePath, 'utf8');
+  const isFileEmpty = currentFileContent.replace(/^#.+/, ``).trim() == '';
+
+  if (!isFileEmpty) {
+    console.log(`${topicId} not empty. Ignoring...`);
+    return;
+  }
+
+  let newFileContent = `# ${topicTitle}`;
+
+  if (!OPEN_AI_API_KEY) {
+    console.log(`OPEN_AI_API_KEY not set. Only adding title to ${topicId}..`);
+    fs.writeFileSync(contentFilePath, newFileContent, 'utf8');
+    return;
+  }
+
+  // console.log(currentFileContent);
+  // console.log(currTopicUrl);
+  // console.log(topicTitle);
+  // console.log(topicUrlToPathMapping[currTopicUrl]);
+});

package.json

@@ -14,6 +14,7 @@
     "upgrade": "ncu -u",
     "roadmap-links": "node bin/roadmap-links.cjs",
     "roadmap-dirs": "node bin/roadmap-dirs.cjs",
+    "roadmap-content": "node bin/roadmap-content.cjs",
     "best-practice-dirs": "node bin/best-practice-dirs.cjs",
     "test:e2e": "playwright test"
   },

src/data/roadmaps/ux-design/content/101-behavior-change-strategies/100-changing-user-behavior/100-help-user-think-about-their-action.md

@@ -1 +1 @@
-# Help user think about their action
+# Help User think about Their Action

src/data/roadmaps/ux-design/content/101-behavior-change-strategies/100-changing-user-behavior/101-educate-and-encourage-user.md

@@ -1 +1 @@
-# Educate and encourage user
+# Educate and Encourage User

src/data/roadmaps/ux-design/content/101-behavior-change-strategies/100-changing-user-behavior/index.md

@@ -1 +1 @@
-# Changing user behavior
+# Support Conscious Action

src/data/roadmaps/ux-design/content/101-behavior-change-strategies/101-cheating/101-make-it-incidental.md

@@ -1 +1 @@
-# Make it incidental
+# Make it Incidental

src/data/roadmaps/ux-design/content/101-behavior-change-strategies/101-cheating/102-automate-act-of-repition.md

@@ -1 +1 @@
-# Automate act of repition
+# Automate the Act of Repetition

src/data/roadmaps/ux-design/content/101-behavior-change-strategies/102-make-or-change-habbits/existing-behavior/100-help-user-avoiding-the-cue.md

@@ -1 +1 @@
-# Help user avoiding the cue
+# Help User Avoiding the Cue

src/data/roadmaps/ux-design/content/101-behavior-change-strategies/102-make-or-change-habbits/existing-behavior/101-replace-the-routine.md

@@ -1 +1 @@
-# Replace the routine
+# Replace the Routine

src/data/roadmaps/ux-design/content/101-behavior-change-strategies/102-make-or-change-habbits/existing-behavior/102-use-consciousness-to-interfere.md

@@ -1 +1 @@
-# Use consciousness to interfere
+# Use Consciousness to Interfere

src/data/roadmaps/ux-design/content/101-behavior-change-strategies/102-make-or-change-habbits/existing-behavior/103-mindfulness-to-avoid-acting-on-the-cue.md

@@ -1 +1 @@
-# Mindfulness to avoid acting on the cue
+# Mindfulness to Avoid Acting on the Cue

src/data/roadmaps/ux-design/content/101-behavior-change-strategies/102-make-or-change-habbits/existing-behavior/104-crowd-out-old-habit-with-new-behavior.md

@@ -1 +1 @@
-# Crowd out old habit with new behavior
+# Crowd Out Old Habit with New Behavior

src/data/roadmaps/ux-design/content/101-behavior-change-strategies/102-make-or-change-habbits/index.md

@@ -1 +1 @@
-# Make or change habbits
+# Make or Change Habbits

src/data/roadmaps/ux-design/content/101-behavior-change-strategies/classifying-behavior/100-bj-frogg-behavior-grid.md

@@ -1 +1 @@
-# BJ Fogg's Behavior Model
+# BJ Fogg’s Behavior Grid

src/data/roadmaps/ux-design/content/101-behavior-change-strategies/making-users-addicted/100-nir-eyal-hook-model.md

@@ -1 +1 @@
-# Nir eyal hook model
+# Nir Eyal’s Hook Model

src/data/roadmaps/ux-design/content/101-behavior-change-strategies/making-users-addicted/101-cue-routine-reward-model.md

@@ -1 +1 @@
-# Cue routine reward model
+# Cue Routine Reward Model

src/data/roadmaps/ux-design/content/102-understand-the-product/clarify-product/100-target-outcome.md

@@ -1 +1 @@
-# Target outcome
+# Target Outcome

src/data/roadmaps/ux-design/content/102-understand-the-product/clarify-product/101-target-actor.md

@@ -1 +1 @@
-# Target actor
+# Target Actor

src/data/roadmaps/ux-design/content/102-understand-the-product/clarify-product/102-target-action.md

@@ -1 +1 @@
-# Target action
+# Target Action

src/data/roadmaps/ux-design/content/102-understand-the-product/define-target-users/100-create-user-personas.md

@@ -1 +1 @@
-# Create user personas
+# Create User Personas

src/data/roadmaps/ux-design/content/102-understand-the-product/existing-business-model/100-business-model-canvas.md

@@ -1 +1 @@
-# Business model canvas
+# Business Model Canvas

src/data/roadmaps/ux-design/content/102-understand-the-product/existing-business-model/101-lean-canvas.md

@@ -1 +1 @@
-# Lean canvas
+# Lean Canvas

src/data/roadmaps/ux-design/content/102-understand-the-product/index.md

@@ -1 +1 @@
-# Understand the product
+# Understanding the Product

src/data/roadmaps/ux-design/content/102-understand-the-product/new-business-model/100-business-model-inspirator.md

@@ -1 +1 @@
-# Business model inspirator
+# Business Model Inspirator

src/data/roadmaps/ux-design/content/102-understand-the-product/new-business-model/101-competitor-analysis.md

@@ -1 +1 @@
-# Competitor analysis
+# Competitor Analysis

src/data/roadmaps/ux-design/content/102-understand-the-product/new-business-model/102-five-forces-model.md

@@ -1 +1 @@
-# Five forces model
+# Five Forces Model

src/data/roadmaps/ux-design/content/102-understand-the-product/new-business-model/103-swot-analysis.md

@@ -1 +1 @@
-# Swot analysis
+# SWOT Analysis

src/data/roadmaps/ux-design/content/103-conceptual-design/create-product-backlog/100-user-stories.md

@@ -1 +1 @@
-# User stories
+# User Stories

src/data/roadmaps/ux-design/content/103-conceptual-design/deliverables/100-custom-experience-map.md

@@ -1 +1 @@
-# Custom experience map
+# Customer Experience Map by Mel Edwards

src/data/roadmaps/ux-design/content/103-conceptual-design/deliverables/101-simple-flowchart.md

@@ -1 +1 @@
-# Simple flowchart
+# Simple Flowchart

src/data/roadmaps/ux-design/content/103-conceptual-design/deliverables/102-event-driven-process-chain-model.md

@@ -1 +1 @@
-# Event driven process chain model
+# Event-Driven Process Chain Model (EPC)

src/data/roadmaps/ux-design/content/103-conceptual-design/deliverables/103-business-process-model-and-notation.md

@@ -1 +1 @@
-# Business process model and notation
+# Business Process Model and Notation (BPMN)

src/data/roadmaps/ux-design/content/103-conceptual-design/index.md

@@ -1 +1 @@
-# Conceptual design
+# Conceptual Design

src/data/roadmaps/ux-design/content/103-conceptual-design/things-to-lookout-for/100-keep-it-short-simple.md

@@ -1 +1 @@
-# Keep it short simple
+# In general, Keep it Short and Simple

src/data/roadmaps/ux-design/content/103-conceptual-design/things-to-lookout-for/101-make-it-easy.md

@@ -1 +1 @@
-# Make it easy
+# Make it Easy to Understand, Easy to Complete

src/data/roadmaps/ux-design/content/103-conceptual-design/things-to-lookout-for/102-make-progress-visible.md

@@ -1 +1 @@
-# Make progress visible
+# Make Progress Visible to User

src/data/roadmaps/ux-design/content/103-conceptual-design/things-to-lookout-for/103-make-progress-meaningful-reward-user.md

@@ -1 +1 @@
-# Make progress meaningful reward user
+# Make Progress Meaningful in order to Reward User

src/data/roadmaps/ux-design/content/103-conceptual-design/things-to-lookout-for/104-make-successful-completion-clearly-visible.md

@@ -1 +1 @@
-# Make successful completion clearly visible
+# Make Successful Completion Clearly Visible

src/data/roadmaps/ux-design/content/104-prototyping/100-good-layout-rules.md

@@ -1 +1 @@
-# Good layout rules
+# Good Layout Rules

src/data/roadmaps/ux-design/content/104-prototyping/index.md

@@ -1 +1 @@
-# Prototyping
+# ProtoTyping

src/data/roadmaps/ux-design/content/104-prototyping/ux-patterns/100-call-to-action.md

@@ -1 +1 @@
-# Call to action
+# Call to Action

src/data/roadmaps/ux-design/content/104-prototyping/ux-patterns/101-status-reports.md

@@ -1 +1 @@
-# Status reports
+# Status Reports

src/data/roadmaps/ux-design/content/104-prototyping/ux-patterns/102-how-to-tips.md

@@ -1 +1 @@
-# How to tips
+# How-to-Tips

src/data/roadmaps/ux-design/content/104-prototyping/ux-patterns/103-reminders-planning-prompts.md

@@ -1 +1 @@
-# Reminders planning prompts
+# Simple Reminders and Planning Prompts

src/data/roadmaps/ux-design/content/104-prototyping/ux-patterns/104-decision-making-support.md

@@ -1 +1 @@
-# Decision making support
+# Decision-Making Support

src/data/roadmaps/ux-design/content/104-prototyping/ux-patterns/105-behavior-change-games.md

@@ -1 +1 @@
-# Behavior change games
+# Behavior Change Games

src/data/roadmaps/ux-design/content/104-prototyping/ux-patterns/109-social-sharing.md

@@ -1 +1 @@
-# Social sharing
+# Social Sharing

src/data/roadmaps/ux-design/content/104-prototyping/ux-patterns/110-goal-trackers.md

@@ -1 +1 @@
-# Goal trackers
+# Goal Trackers

src/data/roadmaps/ux-design/content/104-prototyping/wireframing/101-adobe-xd.md

@@ -1 +1 @@
-# Adobe xd
+# Adobe XD

src/data/roadmaps/ux-design/content/105-ux-best-practices/create-urgency/100-avoid-temporal-myopia.md

@@ -1 +1 @@
-# Avoid temporal myopia
+# Frame Text to Avoid Temporal Myopia

src/data/roadmaps/ux-design/content/105-ux-best-practices/create-urgency/101-remind-of-prior-commitment-to-act.md

@@ -1 +1 @@
-# Remind of prior commitment to act
+# Remind of Prior Commitment to Act

src/data/roadmaps/ux-design/content/105-ux-best-practices/create-urgency/102-make-commitment-to-friends.md

@@ -1 +1 @@
-# Make commitment to friends
+# Make Commitment to Friends

src/data/roadmaps/ux-design/content/105-ux-best-practices/create-urgency/103-make-reward-scarce.md

@@ -1 +1 @@
-# Make reward scarce
+# Make Reward Scarce

src/data/roadmaps/ux-design/content/105-ux-best-practices/getting-attention/100-tell-user-and-ask.md

@@ -1 +1 @@
-# Tell user and ask
+# Tell User What the Action is and Ask for it

src/data/roadmaps/ux-design/content/105-ux-best-practices/getting-attention/101-make-it-clear-where-to-act.md

@@ -1 +1 @@
-# Make it clear where to act
+# Make it Clear, Where to Act

src/data/roadmaps/ux-design/content/105-ux-best-practices/getting-attention/102-clear-the-page-of-distractions.md

@@ -1 +1 @@
-# Clear the page of distractions
+# Clear the Page of Distractions

src/data/roadmaps/ux-design/content/105-ux-best-practices/getting-favorable-conscious-evaluation/100-prime-user-relevant-associations.md

@@ -1 +1 @@
-# Prime user relevant associations
+# Prime User-Relevant Associations

src/data/roadmaps/ux-design/content/105-ux-best-practices/getting-favorable-conscious-evaluation/101-leverage-loss-aversion.md

@@ -1 +1 @@
-# Leverage loss aversion
+# Leverage Loss Aversion

src/data/roadmaps/ux-design/content/105-ux-best-practices/getting-favorable-conscious-evaluation/102-use-peer-comparisons.md

@@ -1 +1 @@
-# Use peer comparisons
+# Use Peer Comparisons

src/data/roadmaps/ux-design/content/105-ux-best-practices/getting-favorable-conscious-evaluation/103-use-competition.md

@@ -1 +1 @@
-# Use competition
+# Use Competition

src/data/roadmaps/ux-design/content/105-ux-best-practices/getting-favorable-conscious-evaluation/104-avoid-cognitive-overhead.md

@@ -1 +1 @@
-# Avoid cognitive overhead
+# Avoid Cognitive Overhead

src/data/roadmaps/ux-design/content/105-ux-best-practices/getting-favorable-conscious-evaluation/105-avoid-choice-overload.md

@@ -1 +1 @@
-# Avoid choice overload
+# Avoid Choice Overload

src/data/roadmaps/ux-design/content/105-ux-best-practices/getting-favorable-conscious-evaluation/106-avoid-direct-payments.md

@@ -1 +1 @@
-# Avoid direct payments
+# Avoid Direct Payments

src/data/roadmaps/ux-design/content/105-ux-best-practices/index.md

@@ -1 +1 @@
-# Ux best practices
+# UX Best Practices

src/data/roadmaps/ux-design/content/105-ux-best-practices/make-it-easy-for-users/100-elicit-implementation-intentions.md

@@ -1 +1 @@
-# Elicit implementation intentions
+# Elicit Implementation Intentions

src/data/roadmaps/ux-design/content/105-ux-best-practices/make-it-easy-for-users/101-default-everything.md

@@ -1 +1 @@
-# Default everything
+# Default Everything

src/data/roadmaps/ux-design/content/105-ux-best-practices/make-it-easy-for-users/102-lessen-the-burden-of-action-info.md

@@ -1 +1 @@
-# Lessen the burden of action info
+# Lessen the Burden of Action/Info.

src/data/roadmaps/ux-design/content/105-ux-best-practices/make-it-easy-for-users/103-deploy-peer-comparisons.md

@@ -1 +1 @@
-# Deploy peer comparisons
+# Deploy Peer Comparisons

src/data/roadmaps/ux-design/content/105-ux-best-practices/positive-intuitive-reaction/100-make-ui-professional-and-beautiful.md

@@ -1 +1 @@
-# Make ui professional and beautiful
+# Make UI Professional and Beautiful

src/data/roadmaps/ux-design/content/105-ux-best-practices/positive-intuitive-reaction/101-deploy-social-proof.md

@@ -1 +1 @@
-# Deploy social proof
+# Deploy Social Proof

src/data/roadmaps/ux-design/content/105-ux-best-practices/positive-intuitive-reaction/102-deploy-strong-subject-authority.md

@@ -1 +1 @@
-# Deploy strong subject authority
+# Deploy Strong Authority on Subject

src/data/roadmaps/ux-design/content/105-ux-best-practices/positive-intuitive-reaction/103-be-authentic-and-personal.md

@@ -1 +1 @@
-# Be authentic and personal
+# Be Authentic and Personal

src/data/roadmaps/ux-design/content/106-measuring-the-impact/100-gather-lessons-prioritize-integrate.md

@@ -1 +1 @@
-# Gather lessons prioritize integrate
+# Gather Lessons Learned,

src/data/roadmaps/ux-design/content/106-measuring-the-impact/index.md

@@ -1 +1 @@
-# Measuring the impact
+# Measuring the Impact

src/data/roadmaps/ux-design/content/106-measuring-the-impact/testing/100-incremental-ab-testing.md

@@ -1 +1 @@
-# Incremental ab testing
+# Incremental A/B Testing

src/data/roadmaps/ux-design/content/106-measuring-the-impact/testing/101-multivariate-testing.md

@@ -1 +1 @@
-# Multivariate testing
+# Multivariate Testing