js-dev-tool 1.1.2 → 1.1.3

package/literate-regex/README.md

@@ -1,14 +1,41 @@
 
 # literate-regex
 
-Write readable (literate) regex sources with `#` comments, and normalize them into a compact JavaScript `RegExp.source` **at the type level**.
+## ✨ Motivation
 
-This package is built for the real world where regexes are often:
-- long,
-- unreadable,
-- and fragile.
+Regular expressions are absurdly powerful — a tiny automaton you can carry in your pocket.  
+But once a regex grows beyond “a few tokens and a prayer”, it becomes:
 
-With `literate-regex`, you can keep them readable (multi-line + comments) while still getting a normalized, single-line `RegExp.source` type that stays stable.
+- hard to read
+- easy to break
+- painful to maintain
+
+This library exists to keep regexes **literate**.
+
+Write a multi-line, commented, PCRE-style regex source (with `#` notes), then normalize it into a compact JavaScript `RegExp.source` **while preserving the normalized source as a TypeScript string literal type**.
+
+That gives you two superpowers:
+
+1. **Human-friendly editing** (readable formatting + comments)
+2. **Machine-friendly safety** (typed, normalized sources that flow through your codebase)
+
+In short: fewer regex jump-scares, more confidence.
+
+### Before
+```ts
+const re = /^(?:\s*\/\*\*\s+|\s+\*?\s+)(?:(?=@(...))|...)/gm;
+```
+
+### After
+```ts
+const RE_SOURCE = `
+/^         # start
+(?: ... )  # jsdoc start
+...        # more notes
+/gm` as const;
+
+const re = compilePCREStyleRegExpLiteral(RE_SOURCE);
+```
 
 ---
 
@@ -96,15 +123,13 @@ const src = `
 const normalized = normalizePCREStyleSource(src);
 ```
 
-## helper function compilePCREStyleRegExpLiteral
-
+## 🔧 Runtime creation Compile PCRE Style RegExpLiteral
 
 ```ts
 import {
   TypedRegExp,
-  normalizePCREStyleSource,
+  // normalizePCREStyleSource,
   compilePCREStyleRegExpLiteral,
-  extractJsRegexPartsFromPCREStyleRegExpLiteral
 } from "literate-regex";
 import type {
   RegExpLiteralParts,

package/literate-regex/dist/cjs/index.d.ts

@@ -13,4 +13,10 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 */
-export * from "./util";
+import type { TypedRegExp, PCREStyleRegExpFlags, PCREStyleRegExpParts, PCREStyleRegExpPattern, PCREStyleToJsRegExpSource } from "../";
+export declare const normalizePCREStyleSource: <const S extends string>(src: S) => PCREStyleToJsRegExpSource<S>;
+export declare const extractJsRegexPartsFromPCREStyleRegExpLiteral: <const S extends string, const TRegexParts extends PCREStyleRegExpParts<S>>(src: S) => {
+    pattern: TRegexParts["pattern"];
+    flags: TRegexParts["flags"];
+};
+export declare const compilePCREStyleRegExpLiteral: <const S extends string>(src: S) => TypedRegExp<PCREStyleRegExpPattern<S>, PCREStyleRegExpFlags<S>>;

package/literate-regex/dist/cjs/index.js

@@ -14,19 +14,32 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./util"), exports);
+exports.compilePCREStyleRegExpLiteral =
+  exports.extractJsRegexPartsFromPCREStyleRegExpLiteral =
+  exports.normalizePCREStyleSource =
+    void 0;
+const NORMALIZE_PCRE_STYLE_REGEX = /(?<!\\)\#\s*.*$|\s+/gm;
+const normalizePCREStyleSource = (src) => {
+  return src.replace(NORMALIZE_PCRE_STYLE_REGEX, "").replace(/\\#/g, "#");
+};
+exports.normalizePCREStyleSource = normalizePCREStyleSource;
+const extractJsRegexPartsFromPCREStyleRegExpLiteral = (src) => {
+  const normalized = (0, exports.normalizePCREStyleSource)(src);
+  if (normalized[0] !== "/")
+    throw new Error("Expected regex literal to start with '/'");
+  const lastSlash = normalized.lastIndexOf("/");
+  if (lastSlash <= 0)
+    throw new Error("Invalid regex literal: missing trailing '/'");
+  const pattern = normalized.slice(1, lastSlash);
+  const flags = normalized.slice(lastSlash + 1);
+  return { pattern, flags };
+};
+exports.extractJsRegexPartsFromPCREStyleRegExpLiteral =
+  extractJsRegexPartsFromPCREStyleRegExpLiteral;
+const compilePCREStyleRegExpLiteral = (src) => {
+  const { pattern, flags } = (0,
+  exports.extractJsRegexPartsFromPCREStyleRegExpLiteral)(src);
+  return new RegExp(pattern, flags);
+};
+exports.compilePCREStyleRegExpLiteral = compilePCREStyleRegExpLiteral;

package/literate-regex/dist/esm/index.mjs

@@ -13,4 +13,22 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 */
-export * from "./util.mjs";
+const NORMALIZE_PCRE_STYLE_REGEX = /(?<!\\)\#\s*.*$|\s+/gm;
+export const normalizePCREStyleSource = (src) => {
+  return src.replace(NORMALIZE_PCRE_STYLE_REGEX, "").replace(/\\#/g, "#");
+};
+export const extractJsRegexPartsFromPCREStyleRegExpLiteral = (src) => {
+  const normalized = normalizePCREStyleSource(src);
+  if (normalized[0] !== "/")
+    throw new Error("Expected regex literal to start with '/'");
+  const lastSlash = normalized.lastIndexOf("/");
+  if (lastSlash <= 0)
+    throw new Error("Invalid regex literal: missing trailing '/'");
+  const pattern = normalized.slice(1, lastSlash);
+  const flags = normalized.slice(lastSlash + 1);
+  return { pattern, flags };
+};
+export const compilePCREStyleRegExpLiteral = (src) => {
+  const { pattern, flags } = extractJsRegexPartsFromPCREStyleRegExpLiteral(src);
+  return new RegExp(pattern, flags);
+};

package/literate-regex/package.json

@@ -17,12 +17,6 @@
       "types": "./dist/global.d.ts"
     }
   },
-  "scripts": {
-    "clean": "rimraf -g ./dist/*",
-    "build": "tsc & tsc -p ./tsconfig-esm.json",
-    "postbuild": "cpx ./*.d.ts dist -v & yarn run:extras && jstool -cmd rmc -rmc4ts -basePath ./dist -test \"/\\.(m?js|d\\.m?ts)$/\"",
-    "run:extras": "jstool -cmd cjbm -root ./dist/esm -ext mjs && mv ./dist/esm/util.d.ts ./dist/esm/util.d.mts"
-  },
   "files": [
     "README.md",
     "LICENSE",
@@ -37,4 +31,4 @@
     "pcre",
     "jsdoc"
   ]
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-dev-tool",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "bin": {
     "jstool": "tools.js"
   },

package/literate-regex/dist/cjs/util.d.ts

@@ -1,22 +0,0 @@
-/*!
-// Copyright jeffy-g 2025
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-*/
-import type { TypedRegExp, PCREStyleRegExpFlags, PCREStyleRegExpParts, PCREStyleRegExpPattern, PCREStyleToJsRegExpSource } from "../";
-export declare const normalizePCREStyleSource: <const S extends string>(src: S) => PCREStyleToJsRegExpSource<S>;
-export declare const extractJsRegexPartsFromPCREStyleRegExpLiteral: <const S extends string, const TRegexParts extends PCREStyleRegExpParts<S>>(src: S) => {
-    pattern: TRegexParts["pattern"];
-    flags: TRegexParts["flags"];
-};
-export declare const compilePCREStyleRegExpLiteral: <const S extends string>(src: S) => TypedRegExp<PCREStyleRegExpPattern<S>, PCREStyleRegExpFlags<S>>;

package/literate-regex/dist/cjs/util.js

@@ -1,50 +0,0 @@
-"use strict";
-/*!
-// Copyright jeffy-g 2025
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-*/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compilePCREStyleRegExpLiteral = exports.extractJsRegexPartsFromPCREStyleRegExpLiteral = exports.normalizePCREStyleSource = void 0;
-const NORMALIZE_PCRE_STYLE_REGEX = /(?<!\\)\#\s*.*$|\s+/gm;
-const normalizePCREStyleSource = (src) => {
-    return src
-        .replace(/\\#/g, "\x00#")
-        .replace(NORMALIZE_PCRE_STYLE_REGEX, "")
-        .replace(/\x00#/g, "#");
-};
-exports.normalizePCREStyleSource = normalizePCREStyleSource;
-const extractJsRegexPartsFromPCREStyleRegExpLiteral = (src) => {
-    const normalized = (0, exports.normalizePCREStyleSource)(src);
-    if (normalized[0] !== "/")
-        throw new Error("Expected regex literal to start with '/'");
-    const lastSlash = normalized.lastIndexOf("/");
-    if (lastSlash <= 0)
-        throw new Error("Invalid regex literal: missing trailing '/'");
-    const pattern = normalized.slice(1, lastSlash);
-    const flags = normalized.slice(lastSlash + 1);
-    return { pattern, flags };
-};
-exports.extractJsRegexPartsFromPCREStyleRegExpLiteral = extractJsRegexPartsFromPCREStyleRegExpLiteral;
-const compilePCREStyleRegExpLiteral = (src) => {
-    const normalized = (0, exports.normalizePCREStyleSource)(src);
-    if (normalized[0] !== "/")
-        throw new Error("Expected regex literal to start with '/'");
-    const lastSlash = normalized.lastIndexOf("/");
-    if (lastSlash <= 0)
-        throw new Error("Invalid regex literal: missing trailing '/'");
-    const pattern = normalized.slice(1, lastSlash);
-    const flags = normalized.slice(lastSlash + 1);
-    return new RegExp(pattern, flags);
-};
-exports.compilePCREStyleRegExpLiteral = compilePCREStyleRegExpLiteral;

package/literate-regex/dist/esm/index.d.ts

@@ -1,16 +0,0 @@
-/*!
-// Copyright jeffy-g 2025
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-*/
-export * from "./util";

package/literate-regex/dist/esm/util.mjs

@@ -1,44 +0,0 @@
-/*!
-// Copyright jeffy-g 2025
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-*/
-const NORMALIZE_PCRE_STYLE_REGEX = /(?<!\\)\#\s*.*$|\s+/gm;
-export const normalizePCREStyleSource = (src) => {
-    return src
-        .replace(/\\#/g, "\x00#")
-        .replace(NORMALIZE_PCRE_STYLE_REGEX, "")
-        .replace(/\x00#/g, "#");
-};
-export const extractJsRegexPartsFromPCREStyleRegExpLiteral = (src) => {
-    const normalized = normalizePCREStyleSource(src);
-    if (normalized[0] !== "/")
-        throw new Error("Expected regex literal to start with '/'");
-    const lastSlash = normalized.lastIndexOf("/");
-    if (lastSlash <= 0)
-        throw new Error("Invalid regex literal: missing trailing '/'");
-    const pattern = normalized.slice(1, lastSlash);
-    const flags = normalized.slice(lastSlash + 1);
-    return { pattern, flags };
-};
-export const compilePCREStyleRegExpLiteral = (src) => {
-    const normalized = normalizePCREStyleSource(src);
-    if (normalized[0] !== "/")
-        throw new Error("Expected regex literal to start with '/'");
-    const lastSlash = normalized.lastIndexOf("/");
-    if (lastSlash <= 0)
-        throw new Error("Invalid regex literal: missing trailing '/'");
-    const pattern = normalized.slice(1, lastSlash);
-    const flags = normalized.slice(lastSlash + 1);
-    return new RegExp(pattern, flags);
-};