Adding scripts to migrate, check and consolidate snippets.

Author: Mathys-Gasnier

public/icons/html5.svg renamed to public/icons/html.svg

@@ -0,0 +1,6 @@
+import { exit } from 'process';
+import { parseAllSnippets } from './snippetParser.js';
+
+const [ errored ] = parseAllSnippets();
+
+if(errored) exit(1);

public/icons/sass.svg renamed to public/icons/scss.svg

@@ -0,0 +1,28 @@
+import { exit } from 'process';
+import { parseAllSnippets, reverseSlugify } from './snippetParser.js';
+import { join } from 'path';
+import { copyFileSync, writeFileSync } from 'fs';
+
+const dataPath = 'public/data/';
+const indexPath = join(dataPath, '_index.json');
+const iconPath = 'public/icons/';
+const snippetsPath = 'snippets/';
+
+const [ errored, snippets ] = parseAllSnippets();
+
+if(errored) exit(1);
+
+const index = [];
+for(const [language, categories] of Object.entries(snippets)) {
+    const languageIconPath = join(snippetsPath, language, 'icon.svg');
+
+    copyFileSync(languageIconPath, join(iconPath, `${language}.svg`));
+
+    index.push({ lang: reverseSlugify(language), icon: `/icons/${language}.svg` });
+    
+    const languageFilePath = join(dataPath, `${language}.json`);
+    
+    writeFileSync(languageFilePath, JSON.stringify(categories, null, 4));
+}
+
+writeFileSync(indexPath, JSON.stringify(index, null, 4));

utils/checkSnippetFormatting.js

@@ -0,0 +1,57 @@
+import { copyFileSync, mkdirSync, readdirSync, readFileSync, writeFileSync } from 'fs';
+import { join } from 'path';
+
+function slugify(string, separator = "-") {
+    return string
+        .toString() // Cast to string (optional)
+        .toLowerCase() // Convert the string to lowercase letters
+        .trim() // Remove whitespace from both sides of a string (optional)
+        .replace(/\s+/g, separator) // Replace spaces with {separator}
+        .replace(/[^\w\-]+/g, "") // Remove all non-word chars
+        .replace(/\_/g, separator) // Replace _ with {separator}
+        .replace(/\-\-+/g, separator) // Replace multiple - with single {separator}
+        .replace(/\-$/g, ""); // Remove trailing -
+}
+
+function formatSnippet(snippet) {
+    return `---
+Title: ${snippet.title}
+Description: ${snippet.description}
+Author: ${snippet.author}
+Tags: ${snippet.tags}
+---
+
+\`\`\`
+${snippet.code.join('\n')}
+\`\`\`
+`;
+}
+
+const dataDir = "public/data";
+const iconsDir = "public/icons";
+const snippetDir = "snippets";
+
+for (const file of readdirSync(dataDir)) {
+    if(!file.endsWith('.json') || file === '_index.json') continue;
+    
+    const languageName = file.slice(0, -5);
+    const content = JSON.parse(readFileSync(join(dataDir, file)));
+    const languagePath = join(snippetDir, languageName);
+    const iconPath = join(iconsDir, `${languageName}.svg`);
+
+    mkdirSync(languagePath, { recursive: true });
+    copyFileSync(iconPath, join(languagePath, 'icon.svg'));
+
+    for (const category of content) {
+        if(category === 'icon.svg') continue;
+        const categoryPath = join(languagePath, slugify(category.categoryName));
+
+        mkdirSync(categoryPath, { recursive: true });
+
+        for(const snippet of category.snippets) {
+            const snippetPath = join(categoryPath, `${slugify(snippet.title)}.md`);
+
+            writeFileSync(snippetPath, formatSnippet(snippet));
+        }
+    }
+}

utils/consolidateSnippets.js

@@ -0,0 +1,97 @@
+import { existsSync, readdirSync, readFileSync } from 'fs';
+import { join } from 'path';
+
+export function reverseSlugify(string, separator = "-") {
+    return string
+        .split(separator)
+        .map((segment) => segment.charAt(0).toUpperCase() + segment.slice(1))
+        .join(' ')
+        .trim();
+}
+
+let errored = false;
+function raise(issue, snippet = '') {
+    console.error(`${issue}${snippet ? ` in '${snippet}'` : ''}`);
+    errored = true;
+    return null;
+}
+
+const propertyRegex = /^\s+([a-zA-Z]+): (.+)/;
+const headerEndCodeStartRegex = /^\s+---\s+```.*\n/;
+const codeRegex = /^(.+)```/s
+function parseSnippet(snippetPath, text) {
+    let cursor = 0;
+
+    const fromCursor = () => text.substring(cursor);
+
+    if(!fromCursor().trim().startsWith('---')) return raise('Missing header start delimiter \'---\'', snippetPath);
+    cursor += 3;
+
+    const properties = {};
+    let match;
+    while((match = propertyRegex.exec(fromCursor())) !== null) {
+        cursor += match[0].length;
+        properties[match[1].toLowerCase()] = match[2];
+    }
+
+    if(!('title' in properties)) return raise(`Missing 'title' property`, snippetPath);
+    if(!('description' in properties)) return raise(`Missing 'description' property`, snippetPath);
+    if(!('author' in properties)) return raise(`Missing 'author' property`, snippetPath);
+    if(!('tags' in properties)) return raise(`Missing 'tags' property`, snippetPath);
+
+    match = headerEndCodeStartRegex.exec(fromCursor());
+    if(match === null) return raise('Missing header end \'---\' or code start \'```\'', snippetPath);
+    cursor += match[0].length;
+
+    match = codeRegex.exec(fromCursor());
+    if(match === null) return raise('Missing code block end \'```\'', snippetPath);
+    const code = match[1];
+
+    return {
+        title: properties.title,
+        description: properties.description,
+        author: properties.author,
+        tags: properties.tags.split(',').map((tag) => tag.trim()).filter((tag) => tag),
+        code: code,
+    }
+}
+
+const snippetPath = "snippets/";
+export function parseAllSnippets() {
+    const snippets = {};
+
+    for(const language of readdirSync(snippetPath)) {
+        const languagePath = join(snippetPath, language);
+    
+        const languageIconPath = join(languagePath, 'icon.svg');
+    
+        if(!existsSync(languageIconPath)) {
+            raise(`icon for '${language}' is missing`);
+            continue;
+        }
+        
+        const categories = [];
+        for(const category of readdirSync(languagePath)) {
+            if(category === 'icon.svg') continue;
+            const categoryPath = join(languagePath, category);
+    
+            const categorySnippets = [];
+            for(const snippet of readdirSync(categoryPath)) {
+                const snippetPath = join(categoryPath, snippet);
+                const snippetContent = readFileSync(snippetPath).toString();
+    
+                const snippetData = parseSnippet(snippetPath, snippetContent);
+                if(!snippetData) continue;
+                categorySnippets.push(snippetData);
+            }
+            categories.push({
+                categoryName: reverseSlugify(category),
+                snippets: categorySnippets,
+            });
+        }
+
+        snippets[language] = categories;
+    }
+
+    return [ errored, snippets ];
+}