Generate snippets from custom format on

demand, add docs

Author: matijaoe

README.md

@@ -1,7 +1,7 @@
 {
   "name": "modern-js-snippets",
   "displayName": "Modern JavaScript Snippets ⚡",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "MIT",
   "description": "Code snippets for modern JavaScript & TypeScript",
   "icon": "assets/icon.png",
@@ -39,33 +39,34 @@
   "scripts": {
     "publish": "vsce package && vsce publish",
     "generate": "deno run --allow-write --allow-read src/app.ts",
-    "docs": "deno run --allow-write --allow-read src/docs-gen.ts"
+    "generate:table": "deno run --allow-write --allow-read src/app.ts --table --snippets=false",
+    "generate:all": "deno run --allow-write --allow-read src/app.ts --table --snippets"
   },
   "contributes": {
     "snippets": [
       {
         "language": "javascript",
-        "path": "./snippets/js.code-snippets"
+        "path": "./dist/js.code-snippets"
       },
       {
         "language": "typescript",
-        "path": "./snippets/js.code-snippets"
+        "path": "./dist/js.code-snippets"
       },
       {
         "language": "typescriptreact",
-        "path": "./snippets/js.code-snippets"
+        "path": "./dist/js.code-snippets"
       },
       {
         "language": "typescriptreact",
-        "path": "./snippets/js.code-snippets"
+        "path": "./dist/js.code-snippets"
       },
       {
         "language": "typescript",
-        "path": "./snippets/ts.code-snippets"
+        "path": "./dist/ts.code-snippets"
       },
       {
         "language": "typescriptreact",
-        "path": "./snippets/ts.code-snippets"
+        "path": "./dist/ts.code-snippets"
       }
     ]
   }

package.json

@@ -1,12 +1,28 @@
+import { parse } from "https://deno.land/std@0.168.0/flags/mod.ts";
 import { variants } from "./snippets/app.ts";
 import {
   convertToVscSnippet,
+  generateSnippetsFile,
   groupSnippets,
-  writeSnippetFile,
+  logTables,
 } from "./utils/app.ts";
 
-variants.forEach((variant) => {
-  const snippetSections = variant.snippets.map(convertToVscSnippet);
-  const snippetSingle = groupSnippets(snippetSections);
-  writeSnippetFile(variant.language.toLowerCase(), snippetSingle);
+const flags = parse(Deno.args, {
+  boolean: ["table", "snippets"],
+  default: { snippets: true },
 });
+
+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);
+    if (flags.table) {
+      logTables(variant.label, categorizedVscSnippets);
+    }
+    if (flags.snippets) {
+      const variantVscSnippet = groupSnippets(categorizedVscSnippets);
+      generateSnippetsFile(variant.extension, variantVscSnippet);
+    }
+  });
+}

src/app.ts

@@ -3,10 +3,9 @@ export type VscSnippet = {
   body: string | string[];
   description?: string;
 };
-// name: { prefix: string | [], body: string | string[], description?: string }
+
 export type VscSnippetDict = Record<string, VscSnippet>;
 
 export type XSnippet = Omit<VscSnippet, "prefix"> & { name: string };
 
-// prefix: { name: string, body: string | string[], description?: string }
 export type XSnippetDict = Record<string, XSnippet>;

src/docs-gen.ts

@@ -3,11 +3,15 @@ import { typescript } from "./ts/app.ts";
 
 export const variants = [
   {
-    language: "JavaScript",
+    label: "JavaScript",
+    language: "javascript",
+    extension: "js",
     snippets: javascript,
   },
   {
-    language: "TypeScript",
+    label: "TypeScript",
+    language: "typescript",
+    extension: "ts",
     snippets: typescript,
   },
 ];