@thi.ng/tangle 0.2.15 → 0.2.17

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-04-23T07:02:18Z
+- **Last updated**: 2024-06-21T19:34:38Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+### [0.2.17](https://github.com/thi-ng/umbrella/tree/@thi.ng/tangle@0.2.17) (2024-06-21)
+
+#### ♻️ Refactoring
+
+- enforce uniform naming convention of internal functions ([56992b2](https://github.com/thi-ng/umbrella/commit/56992b2))
+
 ## [0.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/tangle@0.2.0) (2024-03-07)
 
 #### 🚀 Features

package/README.md

@@ -7,7 +7,7 @@
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 > [!NOTE]
-> This is one of 192 standalone projects, maintained as part
+> This is one of 193 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >
@@ -338,7 +338,7 @@ For Node.js REPL:
 const tan = await import("@thi.ng/tangle");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 1.99 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 2.00 KB
 
 ## Dependencies
 

package/cli.js

@@ -43,11 +43,9 @@ const showUsage = () => {
 };
 try {
   const result = parse(argOpts, process.argv, { start: 3, usageOpts });
-  if (!result)
-    process.exit(1);
+  if (!result) process.exit(1);
   const { result: opts, rest } = result;
-  if (!rest.length)
-    showUsage();
+  if (!rest.length) showUsage();
   let ctx = {
     logger: new ConsoleLogger("tangle", opts.debug ? "DEBUG" : "INFO"),
     opts: {
@@ -61,8 +59,7 @@ try {
     writeText(out, ctx.outputs[out], ctx.logger, opts.dryRun);
   }
 } catch (e) {
-  if (!(e instanceof ParseError))
-    process.stderr.write(e.message);
+  if (!(e instanceof ParseError)) process.stderr.write(e.message);
   process.exit(1);
 }
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/tangle",
-  "version": "0.2.15",
+  "version": "0.2.17",
   "description": "Literate programming code block tangling / codegen utility, inspired by org-mode & noweb",
   "type": "module",
   "module": "./index.js",
@@ -11,7 +11,7 @@
     "type": "git",
     "url": "https://github.com/thi-ng/umbrella.git"
   },
-  "homepage": "https://github.com/thi-ng/umbrella/tree/develop/packages/tangle#readme",
+  "homepage": "https://thi.ng/tangle",
   "funding": [
     {
       "type": "github",
@@ -37,23 +37,23 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.1",
-    "@thi.ng/args": "^2.3.32",
-    "@thi.ng/checks": "^3.6.3",
-    "@thi.ng/compare": "^2.3.4",
-    "@thi.ng/date": "^2.7.17",
-    "@thi.ng/errors": "^2.5.6",
-    "@thi.ng/file-io": "^2.1.1",
-    "@thi.ng/logger": "^3.0.11",
-    "@thi.ng/strings": "^3.7.32",
-    "@thi.ng/transducers": "^9.0.4"
+    "@thi.ng/api": "^8.11.3",
+    "@thi.ng/args": "^2.3.34",
+    "@thi.ng/checks": "^3.6.5",
+    "@thi.ng/compare": "^2.3.6",
+    "@thi.ng/date": "^2.7.19",
+    "@thi.ng/errors": "^2.5.8",
+    "@thi.ng/file-io": "^2.1.3",
+    "@thi.ng/logger": "^3.0.13",
+    "@thi.ng/strings": "^3.7.34",
+    "@thi.ng/transducers": "^9.0.6"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.43.0",
-    "@thi.ng/testament": "^0.4.28",
-    "esbuild": "^0.20.2",
-    "typedoc": "^0.25.12",
-    "typescript": "^5.4.3"
+    "@microsoft/api-extractor": "^7.47.0",
+    "@thi.ng/testament": "^0.4.30",
+    "esbuild": "^0.21.5",
+    "typedoc": "^0.25.13",
+    "typescript": "^5.5.2"
   },
   "keywords": [
     "codegen",
@@ -93,5 +93,5 @@
     "status": "alpha",
     "year": 2022
   },
-  "gitHead": "0bec55821066c18eb977a7eabd42c0bb2b096d98\n"
+  "gitHead": "154c95cf9d6bab32174498ec3b5b5d87e42be7f9\n"
 }

package/tangle.js

@@ -15,7 +15,7 @@ const UnknownBlockError = defError(
   (err) => `can't include unknown block ID: ${err[0]} (via ${err[1]})`,
   () => ""
 );
-const extractBlocks = (src, { format, logger }) => {
+const __extractBlocks = (src, { format, logger }) => {
   let nextID = 0;
   const blocks = {};
   const prefix = new RegExp(
@@ -25,7 +25,7 @@ const extractBlocks = (src, { format, logger }) => {
   const suffix = isString(format.suffix) ? new RegExp(`${format.suffix.replace("+", "\\+")}`) : format.suffix;
   let matchPrefix;
   while (matchPrefix = prefix.exec(src)) {
-    let { id, tangle, noweb, publish } = parseBlockHeader(matchPrefix[2]);
+    let { id, tangle, noweb, publish } = __parseBlockHeader(matchPrefix[2]);
     !id && (id = `__block-${nextID++}`);
     const matchStart = matchPrefix.index;
     const start = src.indexOf("\n", matchStart + 1) + 1;
@@ -38,8 +38,7 @@ const extractBlocks = (src, { format, logger }) => {
       start
     );
     const matchSuffix = suffix.exec(src.substring(start));
-    if (!matchSuffix)
-      illegalState("no codeblock end found");
+    if (!matchSuffix) illegalState("no codeblock end found");
     const end = start + matchSuffix.index;
     const matchEnd = end + matchSuffix[0].length + 1;
     logger.debug(
@@ -67,9 +66,8 @@ const extractBlocks = (src, { format, logger }) => {
   }
   return blocks;
 };
-const resolveBlock = (block, ref, ctx) => {
-  if (block.resolved)
-    return;
+const __resolveBlock = (block, ref, ctx) => {
+  if (block.resolved) return;
   if (block.noweb === "no") {
     block.resolved = true;
     return;
@@ -87,7 +85,7 @@ const resolveBlock = (block, ref, ctx) => {
     let childBlock;
     if (childID.indexOf("#") > 0) {
       const [file, blockID] = childID.split("#");
-      childBlock = loadAndResolveBlocks(
+      childBlock = __loadAndResolveBlocks(
         ctx.fs.resolve(ctx.fs.resolve(ref.path, ".."), file),
         ctx
       ).blocks[blockID];
@@ -96,54 +94,51 @@ const resolveBlock = (block, ref, ctx) => {
       childID = childID.replace("#", "");
       childBlock = ref.blocks[childID];
     }
-    if (!childBlock)
-      throw new UnknownBlockError([childID, block.id]);
-    resolveBlock(childBlock, ref, ctx);
-    const newBody = isPlainObject(params) ? parametricBody(childBlock.body, params) : childBlock.body;
+    if (!childBlock) throw new UnknownBlockError([childID, block.id]);
+    __resolveBlock(childBlock, ref, ctx);
+    const newBody = isPlainObject(params) ? __parametricBody(childBlock.body, params) : childBlock.body;
     block.body = block.body.replace(`<<${match[1]}>>`, newBody);
     block.edited = true;
   }
   block.resolved = true;
   block.body = block.body.replace(/\\</g, "<");
 };
-const resolveBlocks = (ref, ctx) => {
+const __resolveBlocks = (ref, ctx) => {
   for (let id in ref.blocks) {
-    resolveBlock(ref.blocks[id], ref, ctx);
+    __resolveBlock(ref.blocks[id], ref, ctx);
   }
   return ref;
 };
-const parseFileMeta = (src) => {
-  if (!src.startsWith("---\n"))
-    return {};
+const __parseFileMeta = (src) => {
+  if (!src.startsWith("---\n")) return {};
   const res = {};
   for (let line of split(src.substring(4))) {
-    if (line === "---")
-      break;
+    if (line === "---") break;
     const [key, val] = line.split(/:\s+/g);
     res[key.trim()] = val.trim();
   }
   return res;
 };
-const parseBlockHeader = (header) => transduce(
+const __parseBlockHeader = (header) => transduce(
   map((x) => x.split(":")),
   assocObj(),
   header.split(/\s+/)
 );
-const parametricBody = (body, params) => body.replace(
+const __parametricBody = (body, params) => body.replace(
   /\{\{(\w+)\}\}/g,
   (_, id) => params[id] != null ? params[id] : id
 );
-const commentForLang = (lang, body) => {
+const __commentForLang = (lang, body) => {
   const syntax = COMMENT_FORMATS[lang];
   return isString(syntax) ? `${syntax} ${body}` : `${syntax[0]} ${body} ${syntax[1]}`;
 };
-const loadAndResolveBlocks = (path, ctx) => {
+const __loadAndResolveBlocks = (path, ctx) => {
   path = ctx.fs.resolve(path);
   if (!ctx.files[path]) {
     const src = ctx.fs.read(path, ctx.logger);
-    const blocks = extractBlocks(src, ctx);
+    const blocks = __extractBlocks(src, ctx);
     const ref = ctx.files[path] = { path, src, blocks };
-    resolveBlocks(ref, ctx);
+    __resolveBlocks(ref, ctx);
   }
   return ctx.files[path];
 };
@@ -166,9 +161,9 @@ const tangleFile = (path, ctx = {}) => {
       ...ctx.opts
     }
   };
-  const { path: $path, src, blocks } = loadAndResolveBlocks(path, $ctx);
+  const { path: $path, src, blocks } = __loadAndResolveBlocks(path, $ctx);
   const parentDir = $ctx.fs.resolve($path, "..");
-  const meta = parseFileMeta(src);
+  const meta = __parseFileMeta(src);
   const sorted = Object.values(blocks).sort(compareByKey("start"));
   let prev = 0;
   let res = [];
@@ -193,11 +188,11 @@ ${fmt.suffix}
       if (!$ctx.outputs[dest]) {
         if ($ctx.opts.comments && COMMENT_FORMATS[block.lang]) {
           body = [
-            commentForLang(
+            __commentForLang(
               block.lang,
               `Tangled @ ${FMT_ISO_SHORT()} - DO NOT EDIT!`
             ),
-            commentForLang(block.lang, `Source: ${$path}`),
+            __commentForLang(block.lang, `Source: ${$path}`),
             "",
             body
           ].join("\n");