@ts-for-gir/lib/src/utils/girs.ts

Typescript .d.ts generator from GIR for gjs

import type { GirInfoAttrs } from "@gi.ts/parser";
import type { TsDoc } from "../types/index.ts";

/**
 * Split a package name into namespace and version
 */
export const splitModuleName = (packageName: string): { packageName: string; namespace: string; version: string } => {
	// Workaround for Vte-4-2.91
	if (packageName.startsWith("Vte-4")) {
		return {
			packageName,
			namespace: "Vte",
			version: packageName.replace("Vte-", ""),
		};
	}
	if (!packageName.includes("-")) {
		return {
			packageName,
			namespace: packageName,
			version: "",
		};
	}
	// There are modules that use multiple hyphens like 'GUPnP-DLNA-1.0'
	const splits = packageName.split("-");
	const version = splits.splice(-1, 1)[0];
	const namespace = splits.join("");

	return {
		packageName,
		namespace,
		version,
	};
};

/** Remove namespace prefix */
export const removeNamespace = (type: string, namespace: string) => {
	if (type.startsWith(`${namespace}.`)) {
		type = type.substring(namespace.length + 1);
	}
	return type;
};

/** Remove class module name prefix */
export const removeClassModule = removeNamespace;

/**
 * Add namespace prefix
 */
export const addNamespace = (type: string, namespace: string) => {
	if (!type.startsWith(`${namespace}.`)) {
		type = `${namespace}.${type}`;
	}
	return type;
};

/**
 * Check if a line is a comment line
 * @param line The line to check
 * @returns Whether the line is a comment line or not
 */
export const isCommentLine = (line: string) => {
	const lineTrim = line.trim();
	return lineTrim.startsWith("//") || (lineTrim.startsWith("/*") && lineTrim.endsWith("*/"));
};

/**
 * Convert a GirBoolean to a boolean
 * @param boolStr The GirBoolean string
 * @param defaultVal The default value
 * @returns The boolean value
 */
export const girBool = (boolStr: string | undefined, defaultVal = false): boolean => {
	if (boolStr) {
		if (parseInt(boolStr, 10) === 0) return false;
		return true;
	}
	return defaultVal;
};

export const printGirDocComment = (tsDoc: TsDoc, config: { noComments: boolean }) => {
	const desc: string[] = [];
	if (config.noComments) {
		return desc.join("\n");
	}

	const text = tsDoc.text;

	if (text) {
		if (text) {
			const lines = text.split("\n");
			if (lines.length) {
				for (const line of lines) {
					desc.push(`${line}`);
				}
			}
		}

		for (const tag of tsDoc.tags) {
			if (tag.paramName) {
				desc.push(`@${tag.tagName} ${tag.paramName} ${tag.text}`);
			} else {
				desc.push(`@${tag.tagName} ${tag.text}`);
			}
		}
	}
	return desc.join("\n");
};

export const isIntrospectable = (e: { $?: GirInfoAttrs }) => !e?.$?.introspectable || e.$.introspectable === "1";
export const isDeprecated = (e: { $: GirInfoAttrs }) => e?.$ && e.$.deprecated === "1";
export const deprecatedVersion = (e: { $: GirInfoAttrs }) => e?.$?.["deprecated-version"];
export const introducedVersion = (e: { $: GirInfoAttrs }) => e?.$?.version;