Work on auto generating markdown tables, and custom snippet format

matijaoe · matijaoe · commit aaab2e7f492e · 2022-12-26T22:33:47.000+01:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,4 @@
+{
+  "deno.enable": true,
+  "deno.unstable": true
+}
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ Supported file extensions:
 ## Setup
 The following is not mandatory, but provides a nicer experience.
 
-Search for `editor.snippetSuggestions` and `editor.snippetSuggestions` in user settings, or edit the settings.json directly:
+Search for `editor.tabCompletion` in user settings, or edit the settings.json directly:
 ```jsonc
 // Tab complete will insert the best matching suggestion when pressing tab.
 "editor.tabCompletion": "on"
@@ -54,6 +54,17 @@ You can use these snippets along with Prettier/ESLint to have your code automati
 
 ## Snippets
 
+### Declarations
+| Prefix     | Description           | Body                           |
+| ---------- | --------------------- | ------------------------------ |
+| `c`        | const                 | `const $0`                     |
+| `l`        | let                   | `let $0`                       |
+| `ca`       | const assignment      | `const $1 = $0`                |
+| `la`       | let assignment        | `let $1 = $0`                  |
+| `cas`      | const string          | `const $1 = '$0'`              |
+| `car`      | const array           | `const $1 = [$0]`              |
+| `cao`      | const object          | `const $1 = { $0 }`            |
+
 ### Declarations
 
 #### `c` &nbsp; - &nbsp; const statement
diff --git a/javascript.code-snippets b/javascript.code-snippets
@@ -0,0 +1,66 @@
+{
+  "const ⚡": {
+    "prefix": "c",
+    "body": "const $0"
+  },
+  "let ⚡": {
+    "prefix": "l",
+    "body": "let $0"
+  },
+  "const assignment ⚡ ⚡": {
+    "prefix": "ca",
+    "body": "const $1 = $0"
+  },
+  "let assignment ⚡ ⚡": {
+    "prefix": "la",
+    "body": "let $1 = $0"
+  },
+  "const string ⚡ ⚡": {
+    "prefix": "cas",
+    "body": "const $1 = '$0'"
+  },
+  "const array ⚡ ⚡": {
+    "prefix": "car",
+    "body": "const $1 = [$0]"
+  },
+  "const object ⚡ ⚡": {
+    "prefix": "cao",
+    "body": "const $1 = { $0 }"
+  },
+  "promise ⚡": {
+    "prefix": "pr",
+    "body": "new Promise((resolve, reject) => {\n\t$0\n})"
+  },
+  "promise resolve ⚡": {
+    "prefix": "prs",
+    "body": "Promise.resolve($1)$0"
+  },
+  "promise reject ⚡": {
+    "prefix": "prj",
+    "body": "Promise.reject($1)$0"
+  },
+  "promise.then ⚡": {
+    "prefix": "then",
+    "body": "$1.then((${2:value}) => $0"
+  },
+  "promise.catch ⚡": {
+    "prefix": "catch",
+    "body": "$1.catch((${2:err}) => $0"
+  },
+  "promise.then.catch ⚡": {
+    "prefix": "thenc",
+    "body": "$1.then((${2:value}) => $3.catch((${4:err}) => $5"
+  },
+  "promise.all ⚡": {
+    "prefix": "pra",
+    "body": "Promise.all($1)$0"
+  },
+  "promise.allSettled ⚡": {
+    "prefix": "prsa",
+    "body": "Promise.allSettled($1)$0"
+  },
+  "promise.any ⚡": {
+    "prefix": "pran",
+    "body": "Promise.any($1)$0"
+  }
+}
diff --git a/package.json b/package.json
@@ -37,7 +37,8 @@
     "vscode": "^1.x.x"
   },
   "scripts": {
-    "publish": "vsce package && vsce publish"
+    "publish": "vsce package && vsce publish",
+    "generate": "deno run --allow-write src/app.ts"
   },
   "contributes": {
     "snippets": [
diff --git a/src/app.ts b/src/app.ts
@@ -0,0 +1,22 @@
+import { javascript, typescript } from "./snippets/app.ts";
+import {
+  convertToVscSnippet,
+  groupSnippets,
+  logTables,
+  writeSnippetFile,
+} from "./utils/app.ts";
+
+const javascriptVscArray = javascript.map(convertToVscSnippet);
+const typescriptVscArray = typescript.map(convertToVscSnippet);
+
+// Log tables for every section of every language
+logTables("JavaScript", javascriptVscArray);
+logTables("TypeScript", typescriptVscArray);
+
+// Create single snippet object
+const snippetJavascript = groupSnippets(javascriptVscArray);
+const snippetTypescript = groupSnippets(typescriptVscArray);
+
+// Single snippet files
+writeSnippetFile("javascript", snippetJavascript);
+writeSnippetFile("typescript", snippetTypescript);
diff --git a/src/models/app.ts b/src/models/app.ts
@@ -0,0 +1,12 @@
+export type VscSnippet = {
+  prefix: string | string[];
+  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>;
diff --git a/src/snippets/app.ts b/src/snippets/app.ts
@@ -0,0 +1,2 @@
+export * from "./js/app.ts";
+export * from "./ts/app.ts";
diff --git a/src/snippets/js.code-snippets b/src/snippets/js.code-snippets
@@ -10,7 +10,7 @@
   },
   "const assignment ⚡": {
     "prefix": "ca",
-    "body": "const $1 = $0;"
+    "body": "const $1 = $0"
   },
   "let assignment ⚡": {
     "prefix": "la",
diff --git a/src/snippets/js/app.ts b/src/snippets/js/app.ts
@@ -0,0 +1,7 @@
+import { promises } from "./promises.ts";
+import { declarations } from "./declarations.ts";
+
+export const javascript = [
+  declarations,
+  promises,
+];
diff --git a/src/snippets/js/declarations.ts b/src/snippets/js/declarations.ts
@@ -0,0 +1,30 @@
+export const declarations = {
+  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 ⚡",
+    body: "const $1 = '$0'",
+  },
+  car: {
+    name: "const array ⚡",
+    body: "const $1 = [$0]",
+  },
+  cao: {
+    name: "const object ⚡",
+    body: "const $1 = { $0 }",
+  },
+};
diff --git a/src/snippets/js/promises.ts b/src/snippets/js/promises.ts
@@ -0,0 +1,38 @@
+export const promises = {
+  pr: {
+    name: "promise",
+    body: "new Promise((resolve, reject) => {\n\t$0\n})",
+  },
+  prs: {
+    name: "promise resolve",
+    body: "Promise.resolve($1)$0",
+  },
+  prj: {
+    name: "promise reject",
+    body: "Promise.reject($1)$0",
+  },
+  then: {
+    name: "promise.then",
+    body: "$1.then((${2:value}) => $0",
+  },
+  catch: {
+    name: "promise.catch",
+    body: "$1.catch((${2:err}) => $0",
+  },
+  thenc: {
+    name: "promise.then.catch",
+    body: "$1.then((${2:value}) => $3.catch((${4:err}) => $5",
+  },
+  pra: {
+    name: "promise.all",
+    body: "Promise.all($1)$0",
+  },
+  prsa: {
+    name: "promise.allSettled",
+    body: "Promise.allSettled($1)$0",
+  },
+  pran: {
+    name: "promise.any",
+    body: "Promise.any($1)$0",
+  },
+};
diff --git a/src/snippets/ts.code-snippets b/src/snippets/ts.code-snippets
diff --git a/src/snippets/ts/app.ts b/src/snippets/ts/app.ts
@@ -0,0 +1,7 @@
+import { declarations } from "./declarations.ts";
+import { types } from "./types.ts";
+
+export const typescript = [
+  declarations,
+  types,
+];
diff --git a/src/snippets/ts/declarations.ts b/src/snippets/ts/declarations.ts
@@ -0,0 +1,18 @@
+export const declarations = {
+  cat: {
+    name: "const assignment (typed)",
+    body: "const ${1:name}: ${2:string} = ${3:value}",
+  },
+  lat: {
+    name: "let assignment (typed)",
+    body: "let ${1:name}: ${2:string} = ${3:value}",
+  },
+  caat: {
+    name: "const array (typed)",
+    body: "const ${1:items}: ${2:string}[] = [$0]",
+  },
+  caot: {
+    name: "const object (typed)",
+    body: "const ${1:name}: ${2:object} = { $0 }",
+  },
+};
diff --git a/src/snippets/ts/types.ts b/src/snippets/ts/types.ts
@@ -0,0 +1,22 @@
+export const types = {
+  int: {
+    name: "interface",
+    body: "interface ${1:Model} {\n\t$0\n}",
+  },
+  inte: {
+    name: "interface extends",
+    body: "interface ${1:Model} extends ${2:Base} {\n\t$0\n}",
+  },
+  tp: {
+    name: "type",
+    body: "type ${1:Model} = $0",
+  },
+  tpu: {
+    name: "type union",
+    body: "type ${1:Model} = ${2:first} | ${3:second}",
+  },
+  tpi: {
+    name: "type intersection",
+    body: "type ${1:Model} = ${2:first} & ${3:second}",
+  },
+};
diff --git a/src/utils/app.ts b/src/utils/app.ts
@@ -0,0 +1,58 @@
+import { markdownTable } from "https://esm.sh/markdown-table@3";
+import { VscSnippet, VscSnippetDict, XSnippetDict } from "../models/app.ts";
+
+// only to move current code-snippets to my format
+export const vscToCustom = (snippets: VscSnippetDict): XSnippetDict => {
+  return Object.entries(snippets).reduce((acc, [name, { prefix, body }]) => {
+    acc[prefix as string] = { name: name.replace(` ⚡`, ""), body };
+    return acc;
+  }, {} as XSnippetDict);
+};
+
+export const convertToVscSnippet = (snippets: XSnippetDict): VscSnippetDict => {
+  return Object.entries(snippets)
+    .reduce((acc, [prefix, { name, body }]) => {
+      const styledName = `${name} ⚡`;
+      acc[styledName] = { prefix, body } as VscSnippet;
+      return acc;
+    }, {} as VscSnippetDict);
+};
+
+export const groupSnippets = (dicts: VscSnippetDict[]) => {
+  return dicts.reduce((acc, curr) => ({
+    ...acc,
+    ...curr,
+  }));
+};
+
+export const writeSnippetFile = (name: string, data: VscSnippetDict) => {
+  Deno.writeTextFileSync(
+    `./${name}.code-snippets`,
+    JSON.stringify(data, null, 2),
+  );
+};
+
+export const generateMarkdownTable = (input: VscSnippetDict) => {
+  const header = ["Prefix", "Description", "Body"];
+
+  const symbol = "⚡";
+  const replaceSymbol = (str: string) => str.replace(` ${symbol}`, "");
+  const code = (str: string) => `\`${str}\``;
+
+  const rows = Object.entries(input)
+    .map(([name, { prefix, body }]) => [
+      code(prefix as string),
+      replaceSymbol(name),
+      code(body as string),
+    ]);
+
+  return markdownTable([header, ...rows]);
+};
+
+export const logTables = (language: string, snippets: VscSnippetDict[]) => {
+  console.log(`## ${language}`);
+  snippets.forEach((s) => {
+    console.log(generateMarkdownTable(s));
+    console.log("\n");
+  });
+};
diff --git a/test.ts b/test.ts
diff --git a/typescript.code-snippets b/typescript.code-snippets
@@ -0,0 +1,38 @@
+{
+  "const assignment (typed) ⚡": {
+    "prefix": "cat",
+    "body": "const ${1:name}: ${2:string} = ${3:value}"
+  },
+  "let assignment (typed) ⚡": {
+    "prefix": "lat",
+    "body": "let ${1:name}: ${2:string} = ${3:value}"
+  },
+  "const array (typed) ⚡": {
+    "prefix": "caat",
+    "body": "const ${1:items}: ${2:string}[] = [$0]"
+  },
+  "const object (typed) ⚡": {
+    "prefix": "caot",
+    "body": "const ${1:name}: ${2:object} = { $0 }"
+  },
+  "interface ⚡": {
+    "prefix": "int",
+    "body": "interface ${1:Model} {\n\t$0\n}"
+  },
+  "interface extends ⚡": {
+    "prefix": "inte",
+    "body": "interface ${1:Model} extends ${2:Base} {\n\t$0\n}"
+  },
+  "type ⚡": {
+    "prefix": "tp",
+    "body": "type ${1:Model} = $0"
+  },
+  "type union ⚡": {
+    "prefix": "tpu",
+    "body": "type ${1:Model} = ${2:first} | ${3:second}"
+  },
+  "type intersection ⚡": {
+    "prefix": "tpi",
+    "body": "type ${1:Model} = ${2:first} & ${3:second}"
+  }
+}

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "deno.enable": true,
 +  "deno.unstable": true
 +}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export * from "./js/app.ts";`
	`2`	`+export * from "./ts/app.ts";`