@ts-for-gir/lib 4.0.0-beta.22 → 4.0.0-beta.24

package/lib/utils.d.ts

@@ -1,267 +0,0 @@
-import lodash from 'lodash';
-import { FileInfo } from './types/index.js';
-import { inspect } from 'util';
-export { inspect };
-export declare const __filename: string;
-export declare const __dirname: string;
-/**
- * Performs a deep comparison between two values to determine if they are
- * equivalent.
- *
- * **Note:** This method supports comparing arrays, array buffers, booleans,
- * date objects, error objects, maps, numbers, `Object` objects, regexes,
- * sets, strings, symbols, and typed arrays. `Object` objects are compared
- * by their own, not inherited, enumerable properties. Functions and DOM
- * nodes are **not** supported.
- *
- * @category Lang
- * @param value The value to compare.
- * @param other The other value to compare.
- * @returns Returns `true` if the values are equivalent, else `false`.
- * @example
- *
- * var object = { 'user': 'fred' };
- * var other = { 'user': 'fred' };
- *
- * _.isEqual(object, other);
- * // => true
- *
- * object === other;
- * // => false
- */
-export declare const isEqual: (value: any, other: any) => boolean;
-/**
- * Creates an array of values by running each element in collection through iteratee. The iteratee is
- * invoked with three arguments: (value, index|key, collection).
- *
- * Many lodash methods are guarded to work as iteratees for methods like _.every, _.filter, _.map, _.mapValues,
- * _.reject, and _.some.
- *
- * The guarded methods are:
- * ary, callback, chunk, clone, create, curry, curryRight, drop, dropRight, every, fill, flatten, invert, max,
- * min, parseInt, slice, sortBy, take, takeRight, template, trim, trimLeft, trimRight, trunc, random, range,
- * sample, some, sum, uniq, and words
- *
- * @param collection The collection to iterate over.
- * @param iteratee The function invoked per iteration.
- * @return Returns the new mapped array.
- */
-export declare const map: {
-    <T, TResult>(collection: T[] | null | undefined, iteratee: lodash.ArrayIterator<T, TResult>): TResult[];
-    <T, TResult>(collection: lodash.List<T> | null | undefined, iteratee: lodash.ListIterator<T, TResult>): TResult[];
-    <T>(collection: lodash.Dictionary<T> | lodash.NumericDictionary<T> | null | undefined): T[];
-    <T extends object, TResult>(collection: T | null | undefined, iteratee: lodash.ObjectIterator<T, TResult>): TResult[];
-    <T, K extends keyof T>(collection: lodash.Dictionary<T> | lodash.NumericDictionary<T> | null | undefined, iteratee: K): Array<T[K]>;
-    <T>(collection: lodash.Dictionary<T> | lodash.NumericDictionary<T> | null | undefined, iteratee?: string): any[];
-    <T>(collection: lodash.Dictionary<T> | lodash.NumericDictionary<T> | null | undefined, iteratee?: object): boolean[];
-};
-/**
- * Iterates over elements of collection, returning the first element predicate returns truthy for.
- * The predicate is invoked with three arguments: (value, index|key, collection).
- *
- * @param collection The collection to search.
- * @param predicate The function invoked per iteration.
- * @param fromIndex The index to search from.
- * @return Returns the matched element, else undefined.
- */
-export declare const find: {
-    <T, S extends T>(collection: lodash.List<T> | null | undefined, predicate: lodash.ListIteratorTypeGuard<T, S>, fromIndex?: number): S | undefined;
-    <T>(collection: lodash.List<T> | null | undefined, predicate?: lodash.ListIterateeCustom<T, boolean>, fromIndex?: number): T | undefined;
-    <T extends object, S extends T[keyof T]>(collection: T | null | undefined, predicate: lodash.ObjectIteratorTypeGuard<T, S>, fromIndex?: number): S | undefined;
-    <T extends object>(collection: T | null | undefined, predicate?: lodash.ObjectIterateeCustom<T, boolean>, fromIndex?: number): T[keyof T] | undefined;
-};
-/**
- * Recursively merges own and inherited enumerable properties of source
- * objects into the destination object, skipping source properties that resolve
- * to `undefined`. Array and plain object properties are merged recursively.
- * Other objects and value types are overridden by assignment. Source objects
- * are applied from left to right. Subsequent sources overwrite property
- * assignments of previous sources.
- *
- * **Note:** This method mutates `object`.
- *
- * @category Object
- * @param object The destination object.
- * @param [sources] The source objects.
- * @returns Returns `object`.
- * @example
- *
- * var users = {
- *   'data': [{ 'user': 'barney' }, { 'user': 'fred' }]
- * };
- *
- * var ages = {
- *   'data': [{ 'age': 36 }, { 'age': 40 }]
- * };
- *
- * _.merge(users, ages);
- * // => { 'data': [{ 'user': 'barney', 'age': 36 }, { 'user': 'fred', 'age': 40 }] }
- */
-export declare const merge: {
-    <TObject, TSource>(object: TObject, source: TSource): TObject & TSource;
-    <TObject, TSource1, TSource2>(object: TObject, source1: TSource1, source2: TSource2): TObject & TSource1 & TSource2;
-    <TObject, TSource1, TSource2, TSource3>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3): TObject & TSource1 & TSource2 & TSource3;
-    <TObject, TSource1, TSource2, TSource3, TSource4>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4): TObject & TSource1 & TSource2 & TSource3 & TSource4;
-    (object: any, ...otherArgs: any[]): any;
-};
-/**
- * Creates a shallow clone of value.
- *
- * Note: This method is loosely based on the structured clone algorithm and supports cloning arrays,
- * array buffers, booleans, date objects, maps, numbers, Object objects, regex's, sets, strings, symbols,
- * and typed arrays. The own enumerable properties of arguments objects are cloned as plain objects. An empty
- * object is returned for not cloneable values such as error objects, functions, DOM nodes, and WeakMaps.
- *
- * @param value The value to clone.
- * @return Returns the cloned value.
- */
-export declare const clone: <T>(value: T) => T;
-/**
- * This method is like clone except that it recursively clones value.
- *
- * @param value The value to recursively clone.
- * @return Returns the deep cloned value.
- */
-export declare const cloneDeep: <T>(value: T) => T;
-/**
- * Split a package name into namespace and version
- */
-export declare const splitModuleName: (packageName: string) => {
-    packageName: string;
-    namespace: string;
-    version: string;
-};
-/** Remove namespace prefix */
-export declare const removeNamespace: (type: string, namespace: string) => string;
-/** Remove class module name prefix */
-export declare const removeClassModule: (type: string, namespace: string) => string;
-/**
- * Add namespace prefix
- */
-export declare const addNamespace: (type: string, namespace: string) => string;
-/**
- * Removes line breaks and consecutive white spaces from a given string
- * @param str
- * @returns
- */
-export declare const cleanString: (str: string) => string;
-/**
- * Checking whether some variable is iterable
- * @see https://stackoverflow.com/a/32538867
- * @param obj Variable to check for iterable
- * @returns Whether the variable is iterable or not
- */
-export declare const isIterable: (obj: unknown[]) => boolean;
-/**
- * Checking whether a string is numeric
- * @param str The string to check
- * @returns Whether the string is numeric or not
- */
-export declare const isNumeric: (str: string) => boolean;
-/**
- * Get the first character of a string
- * @param str The string to get the first character from
- * @returns The first character
- */
-export declare const getFirstChar: (str: string) => string;
-/**
- * Get the last character of a string
- * @param str The string to get the last character from
- * @returns The last character
- */
-export declare const getLastChar: (str: string) => string;
-/**
- * Check if the first character of a string is numeric
- * @param str The string to check
- * @returns Whether the first character is numeric or not
- */
-export declare const isFirstCharNumeric: (str: string) => boolean;
-/**
- * Convert a string to camelCase, keeps the first alphabet character as it is.
- * @param str The string to convert
- * @returns The converted string
- */
-export declare const camelCase: (str: string) => string;
-/**
- * Convert a string to `lowerCamelCase`
- * @param str The string to convert
- * @returns The converted string
- */
-export declare const lowerCamelCase: (str: string) => string;
-/**
- * Convert a string to `PascalCase`
- * @param str The string to convert
- * @returns The converted string
- */
-export declare const pascalCase: (str: string) => string;
-/** Alias for {@link pascalCase} */
-export declare const upperCamelCase: (str: string) => string;
-/**
- * Convert a string to `snake_case`
- * @param str The string to convert
- * @returns The converted string
- */
-export declare const snakeCase: (str: string) => string;
-/**
- * Convert a string to `kebab-case`
- * @param str The string to convert
- * @returns The converted string
- */
-export declare const kebabCase: (str: string) => string;
-/** Alias for {@link kebabCase} */
-export declare const slugCase: (str: string) => string;
-export declare const underscores: (str: string) => string;
-/**
- * Find a file in a list of directories
- * @param dirs The directories to search in
- * @param filename The filename to search for
- * @returns The file info
- */
-export declare const findFilesInDirs: (dirs: string[], filename: string) => Promise<FileInfo[]>;
-/**
- * Find a file in a list of directories (sync)
- * @param dirs The directories to search in
- * @param filename The filename to search for
- * @returns The file info
- */
-export declare const findFilesInDirsSync: (dirs: string[], filename: string) => FileInfo[];
-/**
- * Read a JSON file
- * @param filePath The path to the JSON file
- * @returns The parsed JSON
- */
-export declare const readJsonFile: <T = unknown>(filePath: string) => Promise<T>;
-/**
- * Union (a ∪ b): create a set that contains the elements of both set a and set b.
- * See https://2ality.com/2015/01/es6-set-operations.html#union
- * @param target
- * @param source
- */
-export declare const union: <T>(target: Set<T> | T[], source: Set<T> | T[]) => Set<T>;
-export declare const stripParamNames: (func: string, ignoreTail?: boolean) => string;
-/**
- * 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 declare const isCommentLine: (line: string) => boolean;
-/**
- * Add indents to a string
- * @param indents The number of indents
- * @param spaceForIndent The number of spaces for each indent
- * @returns The indented string
- */
-export declare const generateIndent: (indents?: number, spaceForIndent?: number) => string;
-/**
- * Convert a GirBoolean to a boolean
- * @param boolStr The GirBoolean string
- * @param defaultVal The default value
- * @returns The boolean value
- */
-export declare const girBool: (boolStr: string | undefined, defaultVal?: boolean) => boolean;
-/**
- * Returns `true` if the definitions in `d1` and `d2` have equivalent signatures
- * @param d1
- * @param d2
- */
-export declare const signaturesMatch: (d1: string, d2: string) => boolean;

package/lib/utils.js

@@ -1,417 +0,0 @@
-/* eslint-disable @typescript-eslint/unbound-method */
-import lodash from 'lodash';
-import { join, dirname } from 'path';
-import { existsSync } from 'fs';
-import { readFile } from 'fs/promises';
-import { glob, globSync } from 'glob';
-import { fileURLToPath } from 'url';
-import { inspect } from 'util';
-import { Logger } from './logger.js';
-import { COMMENT_REG_EXP, PARAM_REG_EXP, OPT_PARAM_REG_EXP } from './constants.js';
-export { inspect };
-// Get __filename on ESM
-export const __filename = fileURLToPath(import.meta.url);
-// Get __dirname on ESM
-export const __dirname = dirname(__filename);
-/**
- * Performs a deep comparison between two values to determine if they are
- * equivalent.
- *
- * **Note:** This method supports comparing arrays, array buffers, booleans,
- * date objects, error objects, maps, numbers, `Object` objects, regexes,
- * sets, strings, symbols, and typed arrays. `Object` objects are compared
- * by their own, not inherited, enumerable properties. Functions and DOM
- * nodes are **not** supported.
- *
- * @category Lang
- * @param value The value to compare.
- * @param other The other value to compare.
- * @returns Returns `true` if the values are equivalent, else `false`.
- * @example
- *
- * var object = { 'user': 'fred' };
- * var other = { 'user': 'fred' };
- *
- * _.isEqual(object, other);
- * // => true
- *
- * object === other;
- * // => false
- */
-export const isEqual = lodash.isEqual;
-/**
- * Creates an array of values by running each element in collection through iteratee. The iteratee is
- * invoked with three arguments: (value, index|key, collection).
- *
- * Many lodash methods are guarded to work as iteratees for methods like _.every, _.filter, _.map, _.mapValues,
- * _.reject, and _.some.
- *
- * The guarded methods are:
- * ary, callback, chunk, clone, create, curry, curryRight, drop, dropRight, every, fill, flatten, invert, max,
- * min, parseInt, slice, sortBy, take, takeRight, template, trim, trimLeft, trimRight, trunc, random, range,
- * sample, some, sum, uniq, and words
- *
- * @param collection The collection to iterate over.
- * @param iteratee The function invoked per iteration.
- * @return Returns the new mapped array.
- */
-export const map = lodash.map;
-/**
- * Iterates over elements of collection, returning the first element predicate returns truthy for.
- * The predicate is invoked with three arguments: (value, index|key, collection).
- *
- * @param collection The collection to search.
- * @param predicate The function invoked per iteration.
- * @param fromIndex The index to search from.
- * @return Returns the matched element, else undefined.
- */
-export const find = lodash.find;
-/**
- * Recursively merges own and inherited enumerable properties of source
- * objects into the destination object, skipping source properties that resolve
- * to `undefined`. Array and plain object properties are merged recursively.
- * Other objects and value types are overridden by assignment. Source objects
- * are applied from left to right. Subsequent sources overwrite property
- * assignments of previous sources.
- *
- * **Note:** This method mutates `object`.
- *
- * @category Object
- * @param object The destination object.
- * @param [sources] The source objects.
- * @returns Returns `object`.
- * @example
- *
- * var users = {
- *   'data': [{ 'user': 'barney' }, { 'user': 'fred' }]
- * };
- *
- * var ages = {
- *   'data': [{ 'age': 36 }, { 'age': 40 }]
- * };
- *
- * _.merge(users, ages);
- * // => { 'data': [{ 'user': 'barney', 'age': 36 }, { 'user': 'fred', 'age': 40 }] }
- */
-export const merge = lodash.merge;
-/**
- * Creates a shallow clone of value.
- *
- * Note: This method is loosely based on the structured clone algorithm and supports cloning arrays,
- * array buffers, booleans, date objects, maps, numbers, Object objects, regex's, sets, strings, symbols,
- * and typed arrays. The own enumerable properties of arguments objects are cloned as plain objects. An empty
- * object is returned for not cloneable values such as error objects, functions, DOM nodes, and WeakMaps.
- *
- * @param value The value to clone.
- * @return Returns the cloned value.
- */
-export const clone = lodash.clone;
-/**
- * This method is like clone except that it recursively clones value.
- *
- * @param value The value to recursively clone.
- * @return Returns the deep cloned value.
- */
-export const cloneDeep = lodash.cloneDeep;
-/**
- * Split a package name into namespace and version
- */
-export const splitModuleName = (packageName) => {
-    // 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, namespace) => {
-    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, namespace) => {
-    if (!type.startsWith(namespace + '.')) {
-        type = namespace + '.' + type;
-    }
-    return type;
-};
-/**
- * Removes line breaks and consecutive white spaces from a given string
- * @param str
- * @returns
- */
-export const cleanString = (str) => {
-    str = str.replace(/\r?\n|\r/g, ' ');
-    str = str.replace(/\s+/g, ' ');
-    return str.trim();
-};
-/**
- * Checking whether some variable is iterable
- * @see https://stackoverflow.com/a/32538867
- * @param obj Variable to check for iterable
- * @returns Whether the variable is iterable or not
- */
-export const isIterable = (obj) => {
-    return obj != null && typeof obj[Symbol.iterator] === 'function';
-};
-/**
- * Checking whether a string is numeric
- * @param str The string to check
- * @returns Whether the string is numeric or not
- */
-export const isNumeric = (str) => {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    return !isNaN(str - parseFloat(str));
-};
-/**
- * Get the first character of a string
- * @param str The string to get the first character from
- * @returns The first character
- */
-export const getFirstChar = (str) => {
-    return str.charAt(0);
-};
-/**
- * Get the last character of a string
- * @param str The string to get the last character from
- * @returns The last character
- */
-export const getLastChar = (str) => {
-    return str.charAt(str.length - 1);
-};
-/**
- * Check if the first character of a string is numeric
- * @param str The string to check
- * @returns Whether the first character is numeric or not
- */
-export const isFirstCharNumeric = (str) => {
-    return isNumeric(getFirstChar(str));
-};
-/**
- * Convert a string to camelCase, keeps the first alphabet character as it is.
- * @param str The string to convert
- * @returns The converted string
- */
-export const camelCase = (str) => {
-    return str
-        .replace(/\s(.)|(\s|-|_|\.)(.)/g, (a) => {
-        return a.toUpperCase();
-    })
-        .replace(/(\s|-|_|\.)/g, '');
-};
-/**
- * Convert a string to `lowerCamelCase`
- * @param str The string to convert
- * @returns The converted string
- */
-export const lowerCamelCase = (str) => {
-    str = camelCase(str);
-    str = getFirstChar(str).toLowerCase() + str.slice(1);
-    return str;
-};
-/**
- * Convert a string to `PascalCase`
- * @param str The string to convert
- * @returns The converted string
- */
-export const pascalCase = (str) => {
-    str = camelCase(str);
-    str = getFirstChar(str).toUpperCase() + str.slice(1);
-    return str;
-};
-/** Alias for {@link pascalCase} */
-export const upperCamelCase = pascalCase;
-/**
- * Convert a string to `snake_case`
- * @param str The string to convert
- * @returns The converted string
- */
-export const snakeCase = (str) => {
-    return str
-        .replace(/([a-z])([A-Z])/g, '$1-$2') // replace camelCase with hyphen-case
-        .replace(/[^a-zA-Z0-9-]+/g, '_') // replace non-alphanumeric characters with underscore
-        .replace(/^_+|_+$/g, '') // remove any leading or trailing underscores
-        .toLowerCase();
-};
-/**
- * Convert a string to `kebab-case`
- * @param str The string to convert
- * @returns The converted string
- */
-export const kebabCase = (str) => {
-    return str
-        .replace(/([a-z])([A-Z])/g, '$1-$2') // replace camelCase with hyphen-case
-        .replace(/[^a-zA-Z0-9-]+/g, '-') // replace non-alphanumeric characters with hyphen
-        .replace(/^-+|-+$/g, '') // remove any leading or trailing hyphens
-        .toLowerCase();
-};
-/** Alias for {@link kebabCase} */
-export const slugCase = kebabCase;
-export const underscores = (str) => {
-    return str.replace(/-|_/g, '_');
-};
-/**
- * Find a file in a list of directories
- * @param dirs The directories to search in
- * @param filename The filename to search for
- * @returns The file info
- */
-export const findFilesInDirs = async (dirs, filename) => {
-    const filesInfo = [];
-    const pattern = dirs.map((dir) => join(dir, filename));
-    const _files = await glob(pattern);
-    // Remove duplicates
-    const files = [...new Set(_files)];
-    for (const filePath of files) {
-        const fileInfo = {
-            path: null,
-            filename,
-            exists: false,
-        };
-        fileInfo.exists = existsSync(filePath);
-        if (fileInfo.exists) {
-            fileInfo.path = filePath;
-            filesInfo.push(fileInfo);
-        }
-    }
-    if (filesInfo.length === 0) {
-        filesInfo.push({
-            path: null,
-            filename,
-            exists: false,
-        });
-    }
-    return filesInfo;
-};
-/**
- * Find a file in a list of directories (sync)
- * @param dirs The directories to search in
- * @param filename The filename to search for
- * @returns The file info
- */
-export const findFilesInDirsSync = (dirs, filename) => {
-    const filesInfo = [];
-    const pattern = dirs.map((dir) => join(dir, filename));
-    const _files = globSync(pattern);
-    // Remove duplicates
-    const files = [...new Set(_files)];
-    for (const filePath of files) {
-        const fileInfo = {
-            path: null,
-            filename,
-            exists: false,
-        };
-        fileInfo.exists = existsSync(filePath);
-        if (fileInfo.exists) {
-            fileInfo.path = filePath;
-            filesInfo.push(fileInfo);
-        }
-    }
-    if (filesInfo.length === 0) {
-        filesInfo.push({
-            path: null,
-            filename,
-            exists: false,
-        });
-    }
-    return filesInfo;
-};
-/**
- * Read a JSON file
- * @param filePath The path to the JSON file
- * @returns The parsed JSON
- */
-export const readJsonFile = async (filePath) => {
-    const fileContent = await readFile(filePath, 'utf8');
-    return JSON.parse(fileContent);
-};
-/**
- * Union (a ∪ b): create a set that contains the elements of both set a and set b.
- * See https://2ality.com/2015/01/es6-set-operations.html#union
- * @param target
- * @param source
- */
-export const union = (target, source) => {
-    return (target = new Set([...target, ...source]));
-};
-export const stripParamNames = (func, ignoreTail = false) => {
-    const g = func;
-    func = func.replace(COMMENT_REG_EXP, '');
-    const lb = func.split('(', 2);
-    if (lb.length < 2)
-        Logger.error(`Bad function definition ${g}`);
-    const rb = lb[1].split(')');
-    const tail = ignoreTail ? '' : rb[rb.length - 1];
-    let params = rb.slice(0, rb.length - 1).join(')');
-    params = params.replace(PARAM_REG_EXP, ':');
-    params = params.replace(OPT_PARAM_REG_EXP, '?:');
-    return `${lb[0]}(${params})${tail}`;
-};
-/**
- * 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) => {
-    const lineTrim = line.trim();
-    return lineTrim.startsWith('//') || (lineTrim.startsWith('/*') && lineTrim.endsWith('*/'));
-};
-/**
- * Add indents to a string
- * @param indents The number of indents
- * @param spaceForIndent The number of spaces for each indent
- * @returns The indented string
- */
-export const generateIndent = (indents = 1, spaceForIndent = 4) => {
-    return ' '.repeat(indents * spaceForIndent);
-};
-/**
- * Convert a GirBoolean to a boolean
- * @param boolStr The GirBoolean string
- * @param defaultVal The default value
- * @returns The boolean value
- */
-export const girBool = (boolStr, defaultVal = false) => {
-    if (boolStr) {
-        if (parseInt(boolStr) === 0)
-            return false;
-        return true;
-    }
-    return defaultVal;
-};
-/**
- * Returns `true` if the definitions in `d1` and `d2` have equivalent signatures
- * @param d1
- * @param d2
- */
-export const signaturesMatch = (d1, d2) => {
-    if (isCommentLine(d1) || isCommentLine(d2))
-        return false;
-    return stripParamNames(d1) == stripParamNames(d2);
-};
-//# sourceMappingURL=utils.js.map