Skip to content

Commit

Permalink
feat(file-system): Added a new package to support manipulation of fil…
Browse files Browse the repository at this point in the history
…es and package management
  • Loading branch information
sullivanpj committed Dec 6, 2023
1 parent 426030a commit dc2b9d9
Show file tree
Hide file tree
Showing 32 changed files with 2,347 additions and 46 deletions.
171 changes: 171 additions & 0 deletions docs/api-reports/packages/file-system/api-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
## API Report File for "@storm-stack/file-system"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />

import { CopySyncOptions } from "node:fs";
import { ExecOptions } from "child_process";
import { Readable } from "node:stream";
import { ReleaseType } from "semver";
import { semverClassesSemver } from "semver/classes/semver";
import { StdioOptions } from "child_process";

// @public
const copyFile: (file: string, dest: string) => string | Buffer | undefined;
export { copyFile };
export { copyFile as copyFile_alias_1 };
export { copyFile as copyFile_alias_2 };

// @public
const copyFiles: (
from: string,
to: string,
options?: CopySyncOptions
) => string | Buffer | undefined;
export { copyFiles };
export { copyFiles as copyFiles_alias_1 };
export { copyFiles as copyFiles_alias_2 };

// @public (undocumented)
function createCliOptions(
obj: Record<string, string | number | boolean>
): string[];
export { createCliOptions };
export { createCliOptions as createCliOptions_alias_1 };
export { createCliOptions as createCliOptions_alias_2 };

// @public (undocumented)
function createCliOptionsString(
obj: Record<string, string | number | boolean>
): string;
export { createCliOptionsString };
export { createCliOptionsString as createCliOptionsString_alias_1 };
export { createCliOptionsString as createCliOptionsString_alias_2 };

// @public (undocumented)
const deriveNewSemverVersion: (
currentSemverVersion: string,
semverSpecifier: string,
preid?: string
) => string;
export { deriveNewSemverVersion };
export { deriveNewSemverVersion as deriveNewSemverVersion_alias_1 };
export { deriveNewSemverVersion as deriveNewSemverVersion_alias_2 };

// @public (undocumented)
function ensurePackage(
pkg: string,
dev: boolean,
pkgManager?: PackageManagers | undefined,
tag?: string,
projectPath?: string,
exactVersion?: boolean
): void;
export { ensurePackage };
export { ensurePackage as ensurePackage_alias_1 };
export { ensurePackage as ensurePackage_alias_2 };

// @public (undocumented)
const execute: (
command: string,
options?: ExecOptions,
env?: Record<string, string>,
stdio?: StdioOptions
) => string | Buffer | Readable | undefined;
export { execute };
export { execute as execute_alias_1 };
export { execute as execute_alias_2 };

// @public (undocumented)
const executeAsync: (
command: string,
options?: ExecOptions,
env?: Record<string, string>,
stdio?: StdioOptions
) => Promise<string | Buffer | undefined>;
export { executeAsync };
export { executeAsync as executeAsync_alias_1 };
export { executeAsync as executeAsync_alias_2 };

// @public
const exists: (filePath: string) => boolean;
export { exists };
export { exists as exists_alias_1 };
export { exists as exists_alias_2 };

// @public
function findFileName(filePath: string): string;
export { findFileName };
export { findFileName as findFileName_alias_1 };
export { findFileName as findFileName_alias_2 };

// @public
function findFilePath(filePath: string): string;
export { findFilePath };
export { findFilePath as findFilePath_alias_1 };
export { findFilePath as findFilePath_alias_2 };

// @public
export const forwardedHeaders: (request: Request) => Record<string, string>;

// @public (undocumented)
const getWorkspaceRoot: () => any;
export { getWorkspaceRoot };
export { getWorkspaceRoot as getWorkspaceRoot_alias_1 };
export { getWorkspaceRoot as getWorkspaceRoot_alias_2 };

// @public (undocumented)
function installPackage(
pkg: string,
dev: boolean,
pkgManager?: PackageManagers | undefined,
tag?: string,
projectPath?: string,
exactVersion?: boolean
): void;
export { installPackage };
export { installPackage as installPackage_alias_1 };
export { installPackage as installPackage_alias_2 };

// @public (undocumented)
const isRelativeVersionKeyword: (val: string) => val is ReleaseType;
export { isRelativeVersionKeyword };
export { isRelativeVersionKeyword as isRelativeVersionKeyword_alias_1 };
export { isRelativeVersionKeyword as isRelativeVersionKeyword_alias_2 };

// @public (undocumented)
type PackageManagers = "npm" | "yarn" | "pnpm" | "bun";

// @public (undocumented)
const PackageManagers: {
NPM: PackageManagers;
YARN: PackageManagers;
PNPM: PackageManagers;
BUN: PackageManagers;
};
export { PackageManagers };
export { PackageManagers as PackageManagers_alias_1 };
export { PackageManagers as PackageManagers_alias_2 };

// @public (undocumented)
const parseVersion: (semver: string) => semverClassesSemver | null;
export { parseVersion };
export { parseVersion as parseVersion_alias_1 };
export { parseVersion as parseVersion_alias_2 };

// @public
function renameFile(filePath: string, newFileName: string): string;
export { renameFile };
export { renameFile as renameFile_alias_1 };
export { renameFile as renameFile_alias_2 };

// @public
function resolvePath(filePath: string, basePath?: string): string;
export { resolvePath };
export { resolvePath as resolvePath_alias_1 };
export { resolvePath as resolvePath_alias_2 };

// (No @packageDocumentation comment for this package)
```

0 comments on commit dc2b9d9

Please sign in to comment.