Merge pull request #1246 from fturmel/PR/improve-content-tests

Improved content tests

Author: shiffman

content-testing/content-structure.js

@@ -1,19 +1,3 @@
-const {
-  video: videoFormat,
-  track: trackFormat,
-  trackOrder: trackOrderFormat,
-  contribution: contributionFormat,
-  faqPage: faqPageFormat,
-  faq: faqFormat
-} = require('./file-formats.js');
-
-const {
-  video: videoSlugReferences,
-  track: trackSlugReference,
-  trackOrder: trackOrderSlugReference,
-  faqsOrder: faqsOrderSlugReference
-} = require('./slug-references.js');
-
 const contentStructure = {
   folders: {
     videos: {
@@ -24,7 +8,7 @@ const contentStructure = {
               folders: {
                 showcase: {
                   files: {
-                    '': { isRequired: false, jsonFormat: contributionFormat }
+                    '': { isRequired: false }
                   },
                   folder: {},
                   isRequired: false,
@@ -41,9 +25,7 @@ const contentStructure = {
               },
               files: {
                 'index.json': {
-                  isRequired: true,
-                  jsonFormat: videoFormat,
-                  slugReferences: videoSlugReferences
+                  isRequired: true
                 },
                 'index.jpg': { isRequired: false },
                 'index.png': { isRequired: false }
@@ -72,7 +54,7 @@ const contentStructure = {
           folders: {
             showcase: {
               files: {
-                '': { isRequired: false, jsonFormat: contributionFormat }
+                '': { isRequired: false }
               },
               folder: {},
               isRequired: false,
@@ -89,9 +71,7 @@ const contentStructure = {
           },
           files: {
             'index.json': {
-              isRequired: true,
-              jsonFormat: videoFormat,
-              slugReferences: videoSlugReferences
+              isRequired: true
             },
             'index.jpg': { isRequired: false },
             'index.png': { isRequired: false }
@@ -124,9 +104,7 @@ const contentStructure = {
               folders: {},
               files: {
                 'index.json': {
-                  isRequired: true,
-                  jsonFormat: trackFormat,
-                  slugReferences: trackSlugReference
+                  isRequired: true
                 },
                 'index.jpg': { isRequired: false },
                 'index.png': { isRequired: false }
@@ -156,9 +134,7 @@ const contentStructure = {
               folders: {},
               files: {
                 'index.json': {
-                  isRequired: true,
-                  jsonFormat: trackFormat,
-                  slugReferences: trackSlugReference
+                  isRequired: true
                 },
                 'index.jpg': { isRequired: false },
                 'index.png': { isRequired: false }
@@ -185,9 +161,7 @@ const contentStructure = {
       },
       files: {
         'index.json': {
-          isRequired: false,
-          jsonFormat: trackOrderFormat,
-          slugReferences: trackOrderSlugReference
+          isRequired: false
         }
       },
       isFileSensitive: true,
@@ -199,13 +173,10 @@ const contentStructure = {
         faqs: {
           files: {
             'index.json': {
-              isRequired: true,
-              jsonFormat: faqPageFormat,
-              slugReferences: faqsOrderSlugReference
+              isRequired: true
             },
             '': {
-              isRequired: false,
-              jsonFormat: { ...faqFormat, exceptions: 'index.json' }
+              isRequired: false
             }
           },
           folder: {},

content-testing/content.js

@@ -0,0 +1,80 @@
+const { globSync } = require('glob');
+const { readFileSync } = require('node:fs');
+const path = require('node:path');
+
+/**
+ * Paths to content files
+ * @type {Object.<string, string[]>}
+ */
+const paths = {
+  // collections
+  guides: globSync('content/pages/guides/*.md'),
+  tracks: globSync('content/tracks/*/*/index.json'),
+  showcases: globSync('content/videos/**/showcase/*.json'),
+  faqs: globSync('content/pages/faqs/*.json', {
+    ignore: '**/index.json'
+  }),
+  videosAndChallenges: globSync('content/videos/**/index.json'),
+  videos: globSync('content/videos/**/index.json', {
+    ignore: 'content/videos/challenges/**'
+  }),
+  challenges: globSync('content/videos/challenges/*/index.json'),
+
+  // single pages
+  pageGuides: ['content/pages/guides/index.json'],
+  pageHome: ['content/pages/homepage/index.json'],
+  pageFaqs: ['content/pages/faqs/index.json'],
+  pageAbout: ['content/pages/about/index.json'],
+  tracksIndex: ['content/tracks/index.json']
+};
+
+/**
+ * Path to slug conversion functions
+ * @type {Object.<string, function(string): string>}
+ */
+const toSlug = {
+  guides: (p) => path.parse(p).name,
+  tracks: (p) => p.split('/').at(-2),
+  showcases: (p) => p.split('/').slice(2).join('/'),
+  faqs: (p) => path.parse(p).name,
+  videosAndChallenges: (p) => p.split('/').slice(2, -1).join('/'),
+  challenges: (p) => p.split('/').at(-2)
+};
+
+/**
+ * Slug sets
+ * @type {Object.<string, Set<string>>}
+ */
+const slugs = {
+  guides: new Set(
+    paths.guides
+      // only keep markdown files with frontmatter, the other ones are internal documentation
+      .filter((p) => readFileSync(p).toString('utf-8').startsWith('---\n'))
+      .map(toSlug.guides)
+  ),
+  tracks: (() => {
+    const slugs = new Set();
+    for (const p of paths.tracks) {
+      const slug = toSlug.tracks(p);
+      if (slugs.has(slug)) {
+        throw new Error(
+          `A main and side track share the slug "${slug}". Rename one of their content directories to resolve the conflict.`
+        );
+      }
+      slugs.add(slug);
+    }
+    return slugs;
+  })(),
+  showcases: new Set(paths.showcases.map(toSlug.showcases)),
+  faqs: new Set(paths.faqs.map(toSlug.faqs)),
+  challenges: new Set(paths.challenges.map(toSlug.challenges)),
+  videosAndChallenges: new Set(
+    paths.videosAndChallenges.map(toSlug.videosAndChallenges)
+  )
+};
+
+module.exports = {
+  paths,
+  toSlug,
+  slugs
+};