@gtkx/utils 1.0.0-rc.2 → 1.0.0-rc.4

package/src/source/source-string-literal.ts

@@ -10,16 +10,6 @@ const SOURCE_ESCAPES: Record<string, string> = {
 
 const UNSAFE_SOURCE_CHARS = new RegExp(`[${Object.keys(SOURCE_ESCAPES).join("")}]`, "g");
 
-/**
- * Encodes a string as a JavaScript string literal, additionally escaping characters that are unsafe
- * to embed in generated source (angle brackets and the line and paragraph separators).
- *
- * @param value - The string to encode.
- * @returns The quoted, source-safe string literal.
- *
- * @example
- * sourceStringLiteral("hello"); // '"hello"'
- */
 function sourceStringLiteral(value: string): string {
     return JSON.stringify(value).replaceAll(UNSAFE_SOURCE_CHARS, (char) => SOURCE_ESCAPES[char] ?? char);
 }

package/src/source/to-camel-identifier.ts

@@ -1,16 +1,6 @@
-import { camelCase } from "../string/camel-case.js";
-import { sanitizeIdentifier } from "./sanitize-identifier.js";
+import { camelCase } from "../string/camel-case.ts";
+import { sanitizeIdentifier } from "./sanitize-identifier.ts";
 
-/**
- * Converts a name to camel case and sanitizes it into a valid JavaScript identifier.
- *
- * @param name - The name to convert.
- * @returns The camel-cased, reserved-word-safe identifier.
- *
- * @example
- * toCamelIdentifier("icon_name"); // "iconName"
- * toCamelIdentifier("class"); // "class_"
- */
 function toCamelIdentifier(name: string): string {
     return sanitizeIdentifier(camelCase(name));
 }

package/src/string/camel-case.ts

@@ -1,20 +1,6 @@
-import { upperFirst } from "./upper-first.js";
-import { mapWordSegments } from "./word-segments.js";
+import { upperFirst } from "./upper-first.ts";
+import { mapWordSegments } from "./word-segments.ts";
 
-/**
- * Converts an underscore- or hyphen-delimited string to camel case.
- *
- * Unlike a general-purpose converter, this splits only on `_` and `-` and keeps the first segment
- * verbatim, so GObject acronyms are preserved (`camelCase("GLArea")` stays `"GLArea"`).
- *
- * @param str - The string to convert.
- * @returns The camel-cased string.
- *
- * @example
- * camelCase("icon_name"); // "iconName"
- * camelCase("start-widget"); // "startWidget"
- * camelCase("Box"); // "Box"
- */
 function camelCase(str: string): string {
     return mapWordSegments(str, (part, index) => (index === 0 ? part : upperFirst(part)));
 }

package/src/string/index.ts

@@ -1,5 +1,5 @@
-export { camelCase } from "./camel-case.js";
-export { kebabCase } from "./kebab-case.js";
-export { lowerFirst } from "./lower-first.js";
-export { pascalCase } from "./pascal-case.js";
-export { upperFirst } from "./upper-first.js";
+export { camelCase } from "./camel-case.ts";
+export { kebabCase } from "./kebab-case.ts";
+export { lowerFirst } from "./lower-first.ts";
+export { pascalCase } from "./pascal-case.ts";
+export { upperFirst } from "./upper-first.ts";

package/src/string/kebab-case.ts

@@ -1,14 +1,3 @@
-/**
- * Converts a camelCase or PascalCase string to kebab case by lower-casing uppercase letters and
- * inserting hyphens before interior ones.
- *
- * @param str - The string to convert.
- * @returns The kebab-cased string.
- *
- * @example
- * kebabCase("iconName"); // "icon-name"
- * kebabCase("Title"); // "title"
- */
 function kebabCase(str: string): string {
     return str.replaceAll(/[A-Z]/g, (char, index: number) =>
         index === 0 ? char.toLowerCase() : `-${char.toLowerCase()}`,

package/src/string/lower-first.ts

@@ -1,13 +1,3 @@
-/**
- * Converts the first character of a string to lower case.
- *
- * @param str - The string to transform.
- * @returns The string with its first character lower-cased.
- *
- * @example
- * lowerFirst("Fred"); // "fred"
- * lowerFirst("FRED"); // "fRED"
- */
 function lowerFirst(str: string): string {
     return str.charAt(0).toLowerCase() + str.slice(1);
 }

package/src/string/pascal-case.ts

@@ -1,19 +1,6 @@
-import { upperFirst } from "./upper-first.js";
-import { mapWordSegments } from "./word-segments.js";
+import { upperFirst } from "./upper-first.ts";
+import { mapWordSegments } from "./word-segments.ts";
 
-/**
- * Converts an underscore- or hyphen-delimited string to Pascal case.
- *
- * Splits only on `_` and `-` and capitalizes each segment's first character, so GObject acronyms
- * are preserved (`pascalCase("GLArea")` stays `"GLArea"`).
- *
- * @param str - The string to convert.
- * @returns The Pascal-cased string.
- *
- * @example
- * pascalCase("icon_name"); // "IconName"
- * pascalCase("scrolled-window"); // "ScrolledWindow"
- */
 function pascalCase(str: string): string {
     return mapWordSegments(str, upperFirst);
 }

package/src/string/upper-first.ts

@@ -1,13 +1,3 @@
-/**
- * Converts the first character of a string to upper case.
- *
- * @param str - The string to transform.
- * @returns The string with its first character upper-cased.
- *
- * @example
- * upperFirst("fred"); // "Fred"
- * upperFirst("Fred"); // "Fred"
- */
 function upperFirst(str: string): string {
     return str.charAt(0).toUpperCase() + str.slice(1);
 }

package/src/util/index.ts

@@ -1 +1 @@
-export { packageVersion } from "./package-version.js";
+export { packageVersion } from "./package-version.ts";

package/src/util/package-version.ts

@@ -1,14 +1,5 @@
 import { createRequire } from "node:module";
 
-/**
- * Reads the `version` field from the `package.json` next to the calling module.
- *
- * @param importMetaUrl - The caller's `import.meta.url`, used to resolve the sibling `package.json`.
- * @returns The package's version string.
- *
- * @example
- * packageVersion(import.meta.url); // "1.2.3"
- */
 function packageVersion(importMetaUrl: string): string {
     return (createRequire(importMetaUrl)("../package.json") as { version: string }).version;
 }

package/dist/function/call-method.d.ts

@@ -1,3 +0,0 @@
-declare function callMethod(target: object, method: string, args: unknown[]): unknown;
-export { callMethod };
-//# sourceMappingURL=call-method.d.ts.map

package/dist/function/call-method.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"call-method.d.ts","sourceRoot":"","sources":["../../src/function/call-method.ts"],"names":[],"mappings":"AAeA,iBAAS,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAI5E;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/function/call-method.js

@@ -1,19 +0,0 @@
-/**
- * Calls the named method on `target` with the given arguments, returning `undefined` when the
- * property is missing or not callable.
- *
- * @param target - The object to read the method from and bind as `this`.
- * @param method - The name of the method to look up.
- * @param args - The arguments passed to the method.
- * @returns The method's return value, or `undefined` when it is not a function.
- *
- * @example
- * callMethod(console, "log", ["hi"]); // logs "hi"; returns undefined
- */
-const isCallable = (value) => typeof value === "function";
-function callMethod(target, method, args) {
-    const fn = Reflect.get(target, method);
-    return isCallable(fn) ? Reflect.apply(fn, target, args) : undefined;
-}
-export { callMethod };
-//# sourceMappingURL=call-method.js.map

package/dist/function/call-method.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"call-method.js","sourceRoot":"","sources":["../../src/function/call-method.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,GAAG,CAAC,KAAc,EAA0D,EAAE,CAC1F,OAAO,KAAK,KAAK,UAAU,CAAC;AAEhC,SAAS,UAAU,CAAC,MAAc,EAAE,MAAc,EAAE,IAAe;IAC/D,MAAM,EAAE,GAAY,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhD,OAAO,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACxE,CAAC;AAED,OAAO,EAAE,UAAU,EAAE,CAAC","sourcesContent":["/**\n * Calls the named method on `target` with the given arguments, returning `undefined` when the\n * property is missing or not callable.\n *\n * @param target - The object to read the method from and bind as `this`.\n * @param method - The name of the method to look up.\n * @param args - The arguments passed to the method.\n * @returns The method's return value, or `undefined` when it is not a function.\n *\n * @example\n * callMethod(console, \"log\", [\"hi\"]); // logs \"hi\"; returns undefined\n */\nconst isCallable = (value: unknown): value is (this: object, ...args: unknown[]) => unknown =>\n    typeof value === \"function\";\n\nfunction callMethod(target: object, method: string, args: unknown[]): unknown {\n    const fn: unknown = Reflect.get(target, method);\n\n    return isCallable(fn) ? Reflect.apply(fn, target, args) : undefined;\n}\n\nexport { callMethod };\n"]}

package/dist/function/index.d.ts

@@ -1,2 +0,0 @@
-export { callMethod } from "./call-method.js";
-//# sourceMappingURL=index.d.ts.map

package/dist/function/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/function/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/function/index.js

@@ -1,2 +0,0 @@
-export { callMethod } from "./call-method.js";
-//# sourceMappingURL=index.js.map

package/dist/function/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/function/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC","sourcesContent":["export { callMethod } from \"./call-method.js\";\n"]}

package/src/function/call-method.ts

@@ -1,22 +0,0 @@
-/**
- * Calls the named method on `target` with the given arguments, returning `undefined` when the
- * property is missing or not callable.
- *
- * @param target - The object to read the method from and bind as `this`.
- * @param method - The name of the method to look up.
- * @param args - The arguments passed to the method.
- * @returns The method's return value, or `undefined` when it is not a function.
- *
- * @example
- * callMethod(console, "log", ["hi"]); // logs "hi"; returns undefined
- */
-const isCallable = (value: unknown): value is (this: object, ...args: unknown[]) => unknown =>
-    typeof value === "function";
-
-function callMethod(target: object, method: string, args: unknown[]): unknown {
-    const fn: unknown = Reflect.get(target, method);
-
-    return isCallable(fn) ? Reflect.apply(fn, target, args) : undefined;
-}
-
-export { callMethod };

package/src/function/index.ts

@@ -1 +0,0 @@
-export { callMethod } from "./call-method.js";