Chore: Rework codebase, prepare for next release (#10)

* refactor: change how table is assembled

* feature: Add lineWidth option, add docs for options

* chore: refactor docs snapper

* fix: readd try-catch in thematicBreak

* fmt

* refactor for better fmt

* chore: update Readme, add NodePosition type

* feat: add start of proper node types

* feat: Add node types

* refactor: typeings

* chore Update CI deno version

Author: littletof

.github/workflows/ci.yml

@@ -28,7 +28,7 @@ jobs:
       - name: Install deno
         uses: denolib/setup-deno@master
         with:
-          deno-version: 1.24.0
+          deno-version: 1.42.4
 
       - name: Running tests
         if: matrix.config.kind == 'test'

.gitignore

@@ -1,2 +1,6 @@
 .vscode
-eggs-debug.log
+cov
+
+TODO.md
+test/tableTest.md
+test/listest.md

README.md

@@ -123,9 +123,9 @@ Feedback and contributions are always welcome. Open an issue or a PR, or contact
 - [x] fix lists
 - [x] remove dots from codeblock backgrounds
 - [x] links with images
-- [x] ```# Header with *italic*```
+- [x] `# Header with *italic*`
 - [x] strikethrough, ~~underline~~
 - [x] basic tests
 - [x] lint
-- [ ] fmt
+- [x] fmt
 - [ ] Look into alternatives for the AST generation.

cli.ts

@@ -1,28 +1,28 @@
-import {renderMarkdown} from './mod.ts';
+import { renderMarkdown } from "./mod.ts";
 
-if(!Deno.args) {
-    throw Error('Please provide a path or url to a file or a markdown string');
+if (!Deno.args) {
+  throw Error("Please provide a path or url to a file or a markdown string");
 } else {
-    if(!Deno.args[0] || !Deno.args[1]) {
-        throw Error("Please provide -l, -r and a path, or -s and a markdown string as arguments");
-    }
+  if (!Deno.args[0] || !Deno.args[1]) {
+    throw Error("Please provide -l, -r and a path, or -s and a markdown string as arguments");
+  }
 
-    let text;
-    switch(Deno.args[0]) {
-        case '-l':
-            text = Deno.readTextFileSync(Deno.args[1]);
-            break;
-        case '-r': {
-            const resp = await fetch(Deno.args[1]);
-            text = await resp.text();
-            break;
-        }
-        case '-s':
-            text = Deno.args[1];
-            break;
-        default:
-            throw Error('Only -l, -r and -s is allowed');
+  let text;
+  switch (Deno.args[0]) {
+    case "-l":
+      text = Deno.readTextFileSync(Deno.args[1]);
+      break;
+    case "-r": {
+      const resp = await fetch(Deno.args[1]);
+      text = await resp.text();
+      break;
     }
+    case "-s":
+      text = Deno.args[1];
+      break;
+    default:
+      throw Error("Only -l, -r and -s is allowed");
+  }
 
-    console.log(renderMarkdown(text));
-}
+  console.log(renderMarkdown(text));
+}

deno.json

@@ -1,17 +1,19 @@
 {
-    "tasks": {
-        "example": "deno run --unstable example.ts",
-        "bundle:mdast": "deno bundle --no-check ./mdast_shimmed_dep.ts mdast-util-from-markdown@1_2_0-shimmed.js",
-        "docs:gen": "deno run -A --unstable ./docs/snapper.ts",
-        "test": "deno test --allow-read=./test"
-    },
-    "fmt": {
-        "files": {
-            "exclude": [
-                "./mdast-util-from-markdown@1_2_0-shimmed.js",
-                "./test/testCases",
-                "./test/exampleOutput.out"
-            ]
-        }
-    }
-}
+  "tasks": {
+    "example": "deno run example.ts",
+    "bundle:mdast": "deno bundle --no-check ./mdast_shimmed_dep.ts mdast-util-from-markdown@1_2_0-shimmed.js",
+    "docs:gen": "deno run -A ./docs/snapper.ts",
+    "test": "deno test --allow-read=./test"
+  },
+  "fmt": {
+    "lineWidth": 120,
+    "exclude": [
+      "./README.md",
+      "./docs/docs.md",
+      "./mdast-util-from-markdown@1_2_0-shimmed.js",
+      "./test/testCases",
+      "./test/exampleOutput.out"
+    ]
+  },
+  "lock": false
+}

deps.ts

@@ -1,8 +1,13 @@
-export  * as colors from 'https://deno.land/std@0.105.0/fmt/colors.ts';
+export * as colors from "https://deno.land/std@0.105.0/fmt/colors.ts";
 
-import { mdast, gfmStrikethroughFromMarkdown, gfmStrikethrough } from './mdast-util-from-markdown@1_2_0-shimmed.js';
+import { gfmStrikethrough, gfmStrikethroughFromMarkdown, mdast } from "./mdast-util-from-markdown@1_2_0-shimmed.js";
 export const strikethroughExt = gfmStrikethroughFromMarkdown;
 export const strike = gfmStrikethrough;
-// deno-lint-ignore no-explicit-any
-export type mdastFromMarkdownFn = (markdown: string, encodig?: string, options?: {extensions?: any[], mdastExtensions?: any[]}) => any;
+export type mdastFromMarkdownFn = (
+  markdown: string,
+  encodig?: string,
+  // deno-lint-ignore no-explicit-any
+  options?: { extensions?: any[]; mdastExtensions?: any[] },
+  // deno-lint-ignore no-explicit-any
+) => any;
 export const fromMarkdown: mdastFromMarkdownFn = mdast;

docs/docs.ts

@@ -1,7 +1,9 @@
-import {renderMarkdown} from '../mod.ts';
+import { renderMarkdown } from "../mod.ts";
 
-let md = Deno.readTextFileSync('docs/docs.md');
+const md = Deno.readTextFileSync("docs/docs.md");
 let r = renderMarkdown(md);
-// remove empty lines after header, to save space on image
-r = r.replace(/\n\n/, "\n").replace(/\n\n/, "\n").replace(/\n\n/, "\n").replace(/\n\n/, "\n").replace(/\n\n/, "\n").replace(/\n\n/, "\n");
-console.log(r);
+// remove empty lines after headers to save space on image
+for (let i = 0; i < 6; i++) {
+  r = r.replace(/\n\n/, "\n");
+}
+console.log(r);

docs/snapper.ts

@@ -1,16 +1,19 @@
-import {snap} from 'https://deno.land/x/snapper@v0.0.6/mod.ts';
+import { snap } from "https://deno.land/x/snapper@v0.0.6/mod.ts";
 import { renderMarkdown } from "../mod.ts";
 
 // Usage:
 // 1. have deno Puppeteer installed
 // 2. deno run -A --unstable .\docs\snapper.ts
+// https://www.diffchecker.com/image-compare/
 
-const md = Deno.readTextFileSync('docs/docs.md');
-let r = renderMarkdown(md);
-// remove empty lines after header, to save space on image
-r = r.replace(/\n\n/, "\n").replace(/\n\n/, "\n").replace(/\n\n/, "\n").replace(/\n\n/, "\n").replace(/\n\n/, "\n").replace(/\n\n/, "\n").replace(/_{25}/, '');
+const md = Deno.readTextFileSync("docs/docs.md");
+let r = renderMarkdown(md, { lineWidth: 69 });
 
+// remove empty lines after headers to save space on image
+for (let i = 0; i < 6; i++) {
+  r = r.replace(/\n\n/, "\n");
+}
 
 await snap([
-    {content: r, imageSavePath: 'docs/showcase.png', viewport: {width: 675}}
-]);
+  { content: r, imageSavePath: "docs/showcase.png", viewport: { width: 675 } },
+]);

example.ts

@@ -1,6 +1,6 @@
-import {renderMarkdown} from './mod.ts';
+import { renderMarkdown } from "./mod.ts";
 
-export const demoText = `
+export const demoText: string = `
 # deno charmd
 
 This is an example, to showcase https://github.com/littletof/charmd
@@ -179,14 +179,14 @@ Autoconverted link https://deno.land
 
 `;
 
-if(import.meta.main) {
+if (import.meta.main) {
   let md;
-  if(Deno.args[0]) {
-      md = Deno.readTextFileSync(Deno.args[0]);
+  if (Deno.args[0]) {
+    md = Deno.readTextFileSync(Deno.args[0]);
   } else {
-      md = demoText;
+    md = demoText;
   }
 
   // renderMarkdown(md)
   console.log(renderMarkdown(md));
-}
+}