Rework #1

.github/workflows/check_lib.yaml

@@ -0,0 +1,38 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Fart Lib Check
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  website_check:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        deno_version: [canary]
+        # See supported Deno releases at:
+        #   https://github.com/denoland/deno/releases
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set up Deno ${{ matrix.deno_version }}
+        uses: denoland/setup-deno@v1
+        with:
+          node-version: ${{ matrix.deno_version }}
+
+      - name: Lint
+        run: deno lint
+
+      - name: Test and Check Coverage
+        run: |
+          deno test lib --coverage=cov_profile
+          deno coverage cov_profile --lcov > cov_profile.lcov
+          deno run --allow-read --unstable devops/check_cov.ts

.gitignore

@@ -1,2 +1,5 @@
 # Mac for Deno
-Users
+Users
+
+# Secrets
+.env

.vscode/settings.json

@@ -13,5 +13,5 @@
     "https://cdn.skypack.dev": false,
     "https://fart.tools": false
   },
-  "cSpell.words": ["typemap", "typemaps"]
+  "cSpell.words": ["transpiles", "typedefs", "typemap", "typemaps"]
 }

deps/std/flags.ts

@@ -1 +1 @@
-export { parse } from "https://deno.land/std@0.110.0/flags/mod.ts";
+export { parse } from "https://deno.land/std@0.119.0/flags/mod.ts";

deps/std/fs.ts

@@ -1 +1 @@
-export { exists, expandGlob } from "https://deno.land/std@0.110.0/fs/mod.ts";
+export { exists, expandGlob } from "https://deno.land/std@0.119.0/fs/mod.ts";

deps/std/path.ts

@@ -5,4 +5,4 @@ export {
   join,
   normalize,
   parse,
-} from "https://deno.land/std@0.110.0/path/mod.ts";
+} from "https://deno.land/std@0.119.0/path/mod.ts";

deps/std/testing.ts

@@ -2,4 +2,13 @@ export {
   assert,
   assertEquals,
   assertThrows,
-} from "https://deno.land/[email protected]/testing/asserts.ts";
+} from "https://deno.land/[email protected]/testing/asserts.ts";
+export {
+  bench,
+  runBenchmarks,
+} from "https://deno.land/[email protected]/testing/bench.ts";
+export type {
+  BenchmarkResult,
+  BenchmarkRunProgress,
+  BenchmarkTimer,
+} from "https://deno.land/[email protected]/testing/bench.ts";

deps/third_party/octokit/rest.ts

@@ -1,4 +1,2 @@
+// More info: https://cdn.skypack.dev/@octokit/rest/rest.js
 export { Octokit } from "https://cdn.skypack.dev/@octokit/[email protected]";
-
-// More info:
-// https://cdn.skypack.dev/@octokit/rest/rest.js

devops/check_cov.ts

@@ -0,0 +1,59 @@
+/**
+ * Name: check_cov.ts
+ * Author: EthanThatOneKid
+ * Description: This script checks the coverage of the codebase.
+ *
+ * Handy Commands:
+ * - Generate cov: deno test lib --coverage=cov_profile & deno coverage cov_profile --lcov > cov_profile.lcov
+ * - Check cov: deno run --allow-read --unstable devops/check_cov.ts
+ * - Visualize cov: deno coverage cov_profile
+ */
+
+import { source as parseFile } from "https://cdn.skypack.dev/lcov-parse";
+
+interface LineDetail {
+  line: number;
+  hit: number;
+}
+
+interface FunctionDetail {
+  name: string;
+  line: number;
+  hit: number;
+}
+
+interface BranchDetail {
+  line: number;
+  block: number;
+  branch: number;
+  taken: number;
+}
+
+interface LcovResult {
+  file: string;
+  lines: { found: number; hit: number; details: LineDetail[] };
+  functions: { found: number; hit: number; details: FunctionDetail[] };
+  branches: { found: number; hit: number; details: BranchDetail[] };
+}
+
+const lcov = await Deno.readTextFile("./cov_profile.lcov");
+
+// TODO: Compute which files have uncovered code and its percentage.
+// TODO: Compute overall coverage percentage.
+parseFile(lcov, (errorMessage: string | null, results: LcovResult[]) => {
+  if (errorMessage !== null) {
+    return console.error(errorMessage);
+  }
+  for (const report of results) {
+    const uncoveredFns = report.functions.details.filter((fn) => fn.hit === 0);
+    if (uncoveredFns.length > 0) {
+      console.log("\nFile:", report.file);
+      for (const fn of uncoveredFns) {
+        console.log(
+          "Uncovered function!",
+          `${fn.name} (${report.file}:${fn.line})`,
+        );
+      }
+    }
+  }
+});

docs/getting-started.md

@@ -8,3 +8,10 @@ self_link: https://fart.tools/getting-started
 > Fart deserves better!
 
 > Curious reader, visit <https://fart.tools/getting-started/>.
+
+## Project Scripts
+
+- **Upgrade a Dependency**: `deno run --unstable --allow-read --allow-write devops/upgrade_dep.ts -y --verbose --dep=std --v=0.116.0`
+- **Run the CLI**: `deno run --allow-read --allow-write fart_cli/run.ts ./ex/pokemon/mod.fart --reg=ts --output=./ex/pokemon/mod.out.ts`
+- **Spin up Server**: `deno run --allow-net --allow-read --allow-env --unstable fart_server/serve_http.ts`
+- **Develop the Server**: `deployctl run --watch fart_server/worker.ts`

fart_server/README.md

@@ -0,0 +1,9 @@
+# Fart Server
+
+## Usage
+
+### Spin up local Fart server
+
+```bash
+deno run --allow-env --allow-net fart_server/serve.ts
+```

fart_server/bonus_features/doc_generator/deno_doc.ts

@@ -0,0 +1,12 @@
+// deno-lint-ignore-file
+
+/**
+ * @param url ex: <https://deno.land/x/[email protected]/lib/fart.ts>
+ * @returns raw HTML generated from [`deno doc`](https://deno.land/[email protected]/tools/documentation_generator)
+ * @todo @ethanthatonekid mirror https://doc.deno.land/https/deno.land%2Fx%2Ffart%40v0.1%2Flib%2Ffart.ts
+ * @todo @ethanthatonekid serve any static files
+ * @todo @ethanthatonekid remove deno-lint-ignore-file
+ */
+export const fetchDenoDoc = async (url: string): Promise<string> => {
+  return "";
+};

fart_server/bonus_features/doc_generator/gh_doc.ts

@@ -0,0 +1,10 @@
+// deno-lint-ignore-file
+
+/**
+ * @param url ex: <https://etok.codes/fart/blob/main/docs/pokemon-example.md>
+ * @returns raw HTML of parsed documentation found on <https://etok.codes/fart/>
+ * @todo @ethanthatonekid refactor https://github.com/EthanThatOneKid/fart/blob/c43f2333458b2cbc40d167610d87e2a2e3f89885/std/server/middleware/gh_docs.ts
+ */
+export const fetchGitHubDoc = async (url: string): Promise<string> => {
+  return "";
+};

fart_server/bonus_features/doc_generator/mod.ts

@@ -0,0 +1,2 @@
+export { fetchGitHubDoc } from "./gh_doc.ts";
+export { fetchDenoDoc } from "./deno_doc.ts";

fart_server/bonus_features/shortlinks/mod.ts

@@ -0,0 +1 @@
+export { redirectIfShortlink } from "./shortlinks.ts";

fart_server/bonus_features/shortlinks/shortlinks.json

@@ -0,0 +1,5 @@
+{
+  "/design": "https://docs.google.com/document/d/1pGNLsDr-WysIIqB4nc1pTCL8FMmPxkJMNoGsRMkA0TY/edit",
+  "/github": "https://github.com/EthanThatOneKid/fart",
+  "/author": "https://etok.codes"
+}