@stryke/fs 0.33.8 → 0.33.16

package/dist/list-files.d.ts

@@ -1,46 +0,0 @@
-import type { AssetGlob } from "@stryke/types/file";
-import type { GlobOptions, Path } from "glob";
-export type ListOptions = GlobOptions;
-export type InferListReturnType<TOptions extends GlobOptions> = TOptions["withFileTypes"] extends true ? Path[] : string[];
-/**
- * A files and directories listing helper function
- *
- * @param filesGlob - A glob pattern to match files
- * @returns A list of file paths
- */
-export declare function list<TOptions extends ListOptions>(filesGlob: string | Omit<AssetGlob, "output">, options?: TOptions): Promise<InferListReturnType<TOptions>>;
-/**
- * A synchronous files and directories listing helper function
- *
- * @param filesGlob - A glob pattern to match files
- * @returns A list of file paths
- */
-export declare function listSync<TOptions extends ListOptions>(filesGlob: string | Omit<AssetGlob, "output">, options?: TOptions): InferListReturnType<TOptions>;
-/**
- * A file listing helper function
- *
- * @param filesGlob - A glob pattern to match files
- * @returns A list of file paths
- */
-export declare function listFiles<TOptions extends ListOptions>(filesGlob: string | Omit<AssetGlob, "output">, options?: TOptions): Promise<InferListReturnType<TOptions>>;
-/**
- * A synchronous file listing helper function
- *
- * @param filesGlob - A glob pattern to match files
- * @returns A list of file paths
- */
-export declare function listFilesSync<TOptions extends ListOptions>(filesGlob: string | Omit<AssetGlob, "output">, options?: TOptions): InferListReturnType<TOptions>;
-/**
- * A directories listing helper function
- *
- * @param filesGlob - A glob pattern to match files
- * @returns A list of file paths
- */
-export declare function listDirectories<TOptions extends ListOptions>(filesGlob: string | Omit<AssetGlob, "output">, options?: TOptions): Promise<InferListReturnType<TOptions>>;
-/**
- * A synchronous directories listing helper function
- *
- * @param filesGlob - A glob pattern to match files
- * @returns A list of file paths
- */
-export declare function listDirectoriesSync<TOptions extends ListOptions>(filesGlob: string | Omit<AssetGlob, "output">, options?: TOptions): InferListReturnType<TOptions>;

package/dist/package-fns.d.ts

@@ -1,89 +0,0 @@
-import type { PackageJson } from "@stryke/types/package-json";
-import type { PackageManager } from "@stryke/types/package-manager";
-import type { Range } from "semver";
-import type { ResolveOptions } from "./resolve";
-/**
- * Get the package manager used in the project
- *
- * @param dir - The path to the project
- * @returns The package manager used in the project
- */
-export declare function getPackageManager(dir?: any): PackageManager;
-/**
- * Get package info
- *
- * @param name - The name of the package
- * @param options - The options to use when resolving the package
- * @returns The package info
- */
-export declare function getPackageInfo(name: string, options?: ResolveOptions): Promise<{
-    name: string;
-    version: any;
-    rootPath: any;
-    packageJsonPath: any;
-    packageJson: PackageJson;
-} | undefined>;
-/**
- * Get the package info from the package.json file
- *
- * @param cwd - The current working directory
- * @returns The package info
- */
-export declare function loadPackageJson(cwd?: any): Promise<PackageJson | null>;
-export interface PackageExistsOptions {
-    /**
-     * The current working directory
-     */
-    cwd?: string;
-}
-export interface PackageMatchesOptions extends PackageExistsOptions {
-    /**
-     * The version range of the package to check
-     */
-    version?: string | Range;
-}
-/**
- * Check if a package is listed in the package.json file
- *
- * @param name - The name of the package
- * @param cwd - The current working directory
- * @returns An indicator specifying if the package is listed
- */
-export declare function isPackageListed(name: string, cwd?: string): Promise<boolean>;
-/**
- * Check if a package is listed in the package.json file
- *
- * @param name - The name of the package
- * @param options - The options to use when checking if the package is listed
- * @returns An indicator specifying if the package is listed
- */
-export declare function isPackageListed(name: string, options?: PackageExistsOptions): Promise<boolean>;
-export interface GetPackageListingReturn {
-    version: string;
-    type: "dependencies" | "devDependencies";
-}
-/**
- * Return the package version and dependency type listed in the package.json file
- *
- * @param name - The name of the package
- * @param cwdOrOptions - The current working directory or options to use when checking if the package is listed
- * @returns The version and type of the package if listed, otherwise undefined
- */
-export declare function getPackageListing(name: string, cwdOrOptions?: string | PackageExistsOptions): Promise<GetPackageListingReturn | undefined>;
-/**
- * Check if a package version matches a specific version range
- *
- * @param name - The name of the package
- * @param version - The version to check against
- * @param cwd - The current working directory
- * @returns An indicator specifying if the package version matches the range
- */
-export declare function doesPackageMatch(name: string, version: string, cwd?: string): Promise<boolean>;
-/**
- * Check if a package exists
- *
- * @param name - The name of the package
- * @param options - The options to use when resolving the package
- * @returns An indicator specifying if the package exists
- */
-export declare function isPackageExists(name: string, options?: ResolveOptions): boolean;

package/dist/remove-file.d.ts

@@ -1,12 +0,0 @@
-/**
- * Remove the given content to the given file path
- *
- * @param filePath - The file path to remove to
- */
-export declare const removeFileSync: (filePath: string) => void;
-/**
- * Remove the given content to the given file path
- *
- * @param filePath - The file path to read to
- */
-export declare const removeFile: (filePath: string) => Promise<void>;

package/dist/toml.d.ts

@@ -1,77 +0,0 @@
-export type XOptions = null | {
-    readonly keys?: null | RegExp;
-    readonly order?: boolean;
-    readonly exact?: boolean;
-    readonly multi?: boolean;
-    readonly longer?: boolean;
-    readonly string?: boolean;
-    readonly comment?: boolean;
-    readonly literal?: boolean;
-    readonly null?: boolean;
-    readonly tag?: null | (<Table extends object & {
-        [key: string | symbol]: any;
-    }, Key extends string | symbol, Array extends any[], Index extends number, Tag extends string>(this: void, each: {
-        table: Table;
-        key: Key;
-        tag: Tag;
-    } | {
-        array: Array;
-        index: Index;
-        tag: Tag;
-    } | {
-        table: Table;
-        key: Key;
-        array: Array;
-        index: Index;
-        tag: Tag;
-    }) => void);
-};
-export interface TomlReadOptions {
-    specificationVersion?: 1.0 | 0.5 | 0.4 | 0.3 | 0.2 | 0.1;
-    multilineStringJoiner?: string;
-    useBigInt?: boolean | number;
-    xOptions?: XOptions;
-}
-/**
- * Reads a TOML file and returns the object the TOML content represents.
- *
- * @param path - A path to a file.
- * @param options - TOML parse options
- * @returns Object the TOML content of the file represents
- */
-export declare function readTomlFileSync<T extends object = any>(path: string, options?: TomlReadOptions): T;
-/**
- * Reads a TOML file and returns the object the TOML content represents.
- *
- * @param path - A path to a file.
- * @param options - TOML parse options
- * @returns Object the TOML content of the file represents
- */
-export declare function readTomlFile<T extends object = any>(path: string, options?: TomlReadOptions): Promise<T>;
-export interface TomlWriteOptions {
-    integer?: number;
-    newline?: "\n" | "\r\n";
-    newlineAround?: "document" | "section" | "header" | "pairs" | "pair";
-    indent?: string | number;
-    T?: "T" | "t" | " ";
-    Z?: "Z" | "z";
-    xNull?: boolean;
-    xBeforeNewlineInMultilineTable?: "," | "";
-    forceInlineArraySpacing?: 0 | 1 | 2 | 3;
-}
-/**
- * Reads a TOML file and returns the object the TOML content represents.
- *
- * @param path - A path to a file.
- * @param data - data which should be serialized/formatted to TOML and written to the file
- * @param options - TOML parse options
- */
-export declare function writeTomlFileSync<T extends object = any>(path: string, data: T, options?: TomlWriteOptions): void;
-/**
- * Reads a TOML file and returns the object the TOML content represents.
- *
- * @param path - A path to a file.
- * @param data - data which should be serialized/formatted to TOML and written to the file
- * @param options - TOML parse options
- */
-export declare function writeTomlFile<T extends object = any>(path: string, data: T, options?: TomlWriteOptions): Promise<void>;

package/dist/tsconfig.d.ts

@@ -1,8 +0,0 @@
-import type { TsConfigJson } from "@stryke/types/tsconfig";
-/**
- * Loads a tsconfig.json file and returns the parsed JSON object.
- *
- * @param filePath - The directory to start searching for the tsconfig.json file.
- * @returns The parsed tsconfig.json object or null if not found.
- */
-export declare function loadTsConfig(filePath?: string): Promise<TsConfigJson>;

package/dist/write-file.d.ts

@@ -1,30 +0,0 @@
-import type { Abortable } from "node:events";
-import type { WriteFileOptions as FSWriteFileOptions, Mode, ObjectEncodingOptions, OpenMode } from "node:fs";
-import type { Encoding } from "./constants";
-export interface WriteFileOptions {
-    /**
-     * Whether to create the directory if it does not exist
-     *
-     * @defaultValue true
-     */
-    createDirectory?: boolean;
-}
-/**
- * Write the given content to the given file path
- *
- * @param filePath - The file path to write to
- * @param content - The content to write to the file
- */
-export declare const writeFileSync: (filePath: string, content?: string, options?: WriteFileOptions & FSWriteFileOptions) => void;
-/**
- * Read the given content to the given file path
- *
- * @param filePath - The file path to read to
- * @param content - The content to write to the file
- * @returns The content of the file
- */
-export declare const writeFile: (filePath: string, content?: string, options?: WriteFileOptions & ((ObjectEncodingOptions & {
-    mode?: Mode | undefined;
-    flag?: OpenMode | undefined;
-    flush?: boolean | undefined;
-} & Abortable) | Encoding)) => Promise<void>;

package/dist/yaml.d.ts

@@ -1,18 +0,0 @@
-import type { DocumentOptions, ParseOptions, SchemaOptions, ToJSOptions } from "yaml";
-export type YamlReadOptions = ParseOptions & DocumentOptions & SchemaOptions & ToJSOptions;
-/**
- * Reads a YAML file and returns the object the YAML content represents.
- *
- * @param path - A path to a file.
- * @param options - YAML parse options
- * @returns Object the YAML content of the file represents
- */
-export declare function readYamlFileSync<T extends object = any>(path: string, options?: YamlReadOptions): T;
-/**
- * Reads a YAML file and returns the object the YAML content represents.
- *
- * @param path - A path to a file.
- * @param options - YAML parse options
- * @returns Object the YAML content of the file represents
- */
-export declare function readYamlFile<T extends object = any>(path: string, options?: YamlReadOptions): Promise<T>;