Automate markdown table generation, define snippet definition with meta

Author: matijaoe

README.md

@@ -1,11 +1,12 @@
-import { parse } from "https://deno.land/std@0.168.0/flags/mod.ts";
+import { parse } from "./deps.ts";
+import { VscSnippetDefinition } from "./models/app.ts";
 import { variants } from "./snippets/app.ts";
+import { logTables } from "./utils/markdown.ts";
 import {
   convertToVscSnippet,
   generateSnippetsFile,
   groupSnippets,
-  logTables,
-} from "./utils/app.ts";
+} from "./utils/snippets.ts";
 
 const flags = parse(Deno.args, {
   boolean: ["table", "snippets"],
@@ -16,12 +17,21 @@ if (!flags.table && !flags.snippets) {
   console.log("Please specify at least one flag: --table or --snippets");
 } else {
   variants.forEach((variant) => {
-    const categorizedVscSnippets = variant.snippets.map(convertToVscSnippet);
+    const categorizedVscSnippets: VscSnippetDefinition[] = variant
+      .snippetsWithMeta.map(
+        (item) => ({
+          ...item,
+          snippets: convertToVscSnippet(item.snippets),
+        }),
+      );
+
     if (flags.table) {
       logTables(variant.label, categorizedVscSnippets);
     }
     if (flags.snippets) {
-      const variantVscSnippet = groupSnippets(categorizedVscSnippets);
+      const variantVscSnippet = groupSnippets(
+        categorizedVscSnippets.map((item) => item.snippets),
+      );
       generateSnippetsFile(variant.extension, variantVscSnippet);
     }
   });

src/app.ts

@@ -0,0 +1,3 @@
+export { parse } from "https://deno.land/std@0.168.0/flags/mod.ts";
+export { ensureDirSync } from "https://deno.land/std@0.141.0/fs/ensure_dir.ts";
+export { markdownTable } from "https://esm.sh/markdown-table@3";

src/deps.ts

@@ -3,9 +3,19 @@ export type VscSnippet = {
   body: string | string[];
   description?: string;
 };
-
 export type VscSnippetDict = Record<string, VscSnippet>;
 
 export type XSnippet = Omit<VscSnippet, "prefix"> & { name: string };
-
 export type XSnippetDict = Record<string, XSnippet>;
+
+export type XSnippetMeta = {
+  title: string;
+  description?: string;
+};
+
+export type GenericSnippetDictWithMeta<T> = {
+  meta: XSnippetMeta;
+  snippets: T;
+};
+export type XSnippetDefinition = GenericSnippetDictWithMeta<XSnippetDict>;
+export type VscSnippetDefinition = GenericSnippetDictWithMeta<VscSnippetDict>;

src/models/app.ts

@@ -1,17 +1,24 @@
+import { XSnippetDefinition } from "../models/app.ts";
 import { javascript } from "./js/app.ts";
 import { typescript } from "./ts/app.ts";
 
-export const variants = [
+type SnippetVariant = {
+  label: string;
+  language: string;
+  extension: string;
+  snippetsWithMeta: XSnippetDefinition[];
+};
+export const variants: SnippetVariant[] = [
   {
-    label: "JavaScript",
+    label: "Snippets",
     language: "javascript",
     extension: "js",
-    snippets: javascript,
+    snippetsWithMeta: javascript,
   },
   {
-    label: "TypeScript",
+    label: "TypeScript specific",
     language: "typescript",
     extension: "ts",
-    snippets: typescript,
+    snippetsWithMeta: typescript,
   },
 ];

src/snippets/app.ts

@@ -2,7 +2,7 @@ import { arrayMethods } from "./array-methods.ts";
 import { classes } from "./classes.ts";
 import { console } from "./console.ts";
 import { dates } from "./dates.ts";
-import { declarations } from "./declarations.ts";
+import { assignments } from "./assignments.ts";
 import { dom } from "./dom.ts";
 import { flowControl } from "./flow-control.ts";
 import { functions } from "./functions.ts";
@@ -20,7 +20,7 @@ import { types } from "./types.ts";
 import { uncategorized } from "./uncategorized.ts";
 
 export const javascript = [
-  declarations,
+  assignments,
   flowControl,
   functions,
   loops,

src/snippets/js/app.ts

@@ -1,50 +1,57 @@
-export const arrayMethods = {
-  fe: {
-    name: "Array.forEach()",
-    body: "$1.forEach((${2:item}) => {\n\t$0\n})",
-  },
-  map: {
-    name: "Array.map()",
-    body: "$1.map((${2:item}) => ${3})$0",
-  },
-  reduce: {
-    name: "Array.reduce()",
-    body: "$1.reduce((${2:acc}, ${3:curr}) => {\n\t$0\n}, ${4:initial})",
-  },
-  "reduce-right": {
-    name: "Array.reduceRight()",
-    body: "$1.reduceRight((${2:acc}, ${3:curr}) => {\n\t$0\n}, ${4:initial})",
-  },
-  filter: {
-    name: "Array.filter()",
-    body: "$1.filter((${2:item}) => ${3})$0",
-  },
-  find: {
-    name: "Array.find()",
-    body: "$1.find((${2:item}) => ${3})$0",
-  },
-  every: {
-    name: "Array.every()",
-    body: "$1.every((${2:item}) => ${3})$0",
-  },
-  some: {
-    name: "Array.some()",
-    body: "$1.some((${2:item}) => ${3})$0",
-  },
-  reverse: {
-    name: "Array.reverse()",
-    body: "$1.reverse()$0",
-  },
-  "map-string": {
-    name: "Array.map() as string",
-    body: "$1.map(String)$0",
-  },
-  "map-number": {
-    name: "Array.map() as number",
-    body: "$1.map(Number)$0",
-  },
-  "filter-true": {
-    name: "Array.filter() truthy",
-    body: "$1.filter(Boolean)$0",
+import { XSnippetDefinition } from "../../models/app.ts";
+
+export const arrayMethods: XSnippetDefinition = {
+  meta: {
+    title: "Array methods",
+  },
+  snippets: {
+    fe: {
+      name: "Array.forEach()",
+      body: "$1.forEach((${2:item}) => {\n\t$0\n})",
+    },
+    map: {
+      name: "Array.map()",
+      body: "$1.map((${2:item}) => ${3})",
+    },
+    reduce: {
+      name: "Array.reduce()",
+      body: "$1.reduce((${2:acc}, ${3:curr}) => {\n\t$0\n}, ${4:initial})",
+    },
+    "reduce-right": {
+      name: "Array.reduceRight()",
+      body: "$1.reduceRight((${2:acc}, ${3:curr}) => {\n\t$0\n}, ${4:initial})",
+    },
+    filter: {
+      name: "Array.filter()",
+      body: "$1.filter((${2:item}) => ${3})",
+    },
+    find: {
+      name: "Array.find()",
+      body: "$1.find((${2:item}) => ${3})",
+    },
+    every: {
+      name: "Array.every()",
+      body: "$1.every((${2:item}) => ${3})",
+    },
+    some: {
+      name: "Array.some()",
+      body: "$1.some((${2:item}) => ${3})",
+    },
+    reverse: {
+      name: "Array.reverse()",
+      body: "$1.reverse()",
+    },
+    "map-string": {
+      name: "Array.map() as string",
+      body: "$1.map(String)",
+    },
+    "map-number": {
+      name: "Array.map() as number",
+      body: "$1.map(Number)",
+    },
+    "filter-true": {
+      name: "Array.filter() truthy",
+      body: "$1.filter(Boolean)",
+    },
   },
 };

src/snippets/js/array-methods.ts

@@ -0,0 +1,45 @@
+import { XSnippetDefinition } from "../../models/app.ts";
+
+export const assignments: XSnippetDefinition = {
+  meta: {
+    title: "Assignments",
+  },
+  snippets: {
+    c: {
+      name: "const",
+      body: "const $0",
+    },
+    l: {
+      name: "let",
+      body: "let $0",
+    },
+    ca: {
+      name: "const assignment",
+      body: "const $1 = $0",
+    },
+    la: {
+      name: "let assignment",
+      body: "let $1 = $0",
+    },
+    cas: {
+      name: "const string assignment",
+      body: "const $1 = '$0'",
+    },
+    car: {
+      name: "const array assignment",
+      body: "const $1 = [$0]",
+    },
+    cao: {
+      name: "const object assignment",
+      body: "const $1 = { $0 }",
+    },
+    dob: {
+      name: "object destructuring",
+      body: "const { $0 } = ${1:object}",
+    },
+    dar: {
+      name: "array destructuring",
+      body: "const [$0] = ${1:array}",
+    },
+  },
+};

src/snippets/js/assignments.ts

@@ -1,55 +1,62 @@
-export const classes = {
-  cs: {
-    name: "class",
-    body: "class $1 {\n\t$0\n}",
-  },
-  cse: {
-    name: "class extends",
-    body: "class $1 extends ${2:Base} {\n\t$0\n}",
-  },
-  csc: {
-    name: "class with constructor",
-    body: [
-      "class $1 {",
-      "\tconstructor($2) {",
-      "\t\t$0",
-      "\t}",
-      "}",
-    ],
-  },
-  csec: {
-    name: "class extends with constructor",
-    body: [
-      "class $1 extends ${2:Base} {",
-      "\tconstructor($3) {",
-      "\t\t$0",
-      "\t}",
-      "}",
-    ],
-  },
-  ctor: {
-    name: "class constructor",
-    body: "constructor($1) {$0}",
-  },
-  get: {
-    name: "getter",
-    body: "get ${1:property}() {\n\t$0\n}",
-  },
-  set: {
-    name: "setter",
-    body: "set ${1:property}(${2:value}) {\n\t$0\n}",
-  },
-  gs: {
-    name: "getter and setter",
-    body:
-      "get ${1:property}() {\n\t$0\n}\nset ${1:property}(${2:value}) {\n\t\n}",
-  },
-  met: {
-    name: "method",
-    body: "${1:name}($2) {\n\t$0\n}",
-  },
+import { XSnippetDefinition } from "../../models/app.ts";
+
+export const classes: XSnippetDefinition = {
   meta: {
-    name: "async method",
-    body: "async ${1:name}($2) {\n\t$0\n}",
+    title: "Classes",
+  },
+  snippets: {
+    cs: {
+      name: "class",
+      body: "class $1 {\n\t$0\n}",
+    },
+    cse: {
+      name: "class extends",
+      body: "class $1 extends ${2:Base} {\n\t$0\n}",
+    },
+    csc: {
+      name: "class with constructor",
+      body: [
+        "class $1 {",
+        "\tconstructor($2) {",
+        "\t\t$0",
+        "\t}",
+        "}",
+      ],
+    },
+    csec: {
+      name: "class extends with constructor",
+      body: [
+        "class $1 extends ${2:Base} {",
+        "\tconstructor($3) {",
+        "\t\t$0",
+        "\t}",
+        "}",
+      ],
+    },
+    ctor: {
+      name: "class constructor",
+      body: "constructor($1) {$0}",
+    },
+    get: {
+      name: "getter",
+      body: "get ${1:property}() {\n\t$0\n}",
+    },
+    set: {
+      name: "setter",
+      body: "set ${1:property}(${2:value}) {\n\t$0\n}",
+    },
+    gs: {
+      name: "getter and setter",
+      body:
+        "get ${1:property}() {\n\t$0\n}\nset ${1:property}(${2:value}) {\n\t\n}",
+    },
+    met: {
+      name: "method",
+      body: "${1:name}($2) {\n\t$0\n}",
+    },
+    meta: {
+      name: "async method",
+      body: "async ${1:name}($2) {\n\t$0\n}",
+    },
   },
 };