Class FileSystem

Extends the node.NodeFiles class with some custom logic useful to this package.

Since

0.1.0-alpha

Hierarchy

NodeFiles
- FileSystem

Index

Aliases

`Function`mergeArgs

mergeArgs: {
    <D extends object>(
        defaults: D,
        inputs?: undefined,
        recursive?: boolean,
    ): D;
    <D extends object, I extends Partial<D>>(
        defaults: D,
        inputs: I,
        recursive?: false,
    ): D & I;
    <D extends object, I extends Partial<D> | RecursivePartial<D>>(
        defaults: D,
        inputs: I,
        recursive: true,
    ): D & I;
    <D extends object, I extends Partial<D> | RecursivePartial<D>>(
        defaults: D,
        inputs?: I,
        recursive?: boolean,
    ): D | D & I;
}

An alias for this package's mergeArgs().

Type declaration

- <D extends object>(defaults: D, inputs?: undefined, recursive?: boolean): D
- Inputs can be undefined, and if so, the default is returned.
  Type Parameters
  - D extends object
    Default object type.
  Parameters
  - defaults: D
    Default values (if not specified in inputs).
  - Optionalinputs: undefined
    Overriding values (changes to make).
  - Optionalrecursive: boolean
    Optional. Whether to merge the object recursively. Default false.
  Returns D
  Resulting object with all the defaults and inputs keys with either default values or input values, as appropriate.
- <D extends object, I extends Partial<D>>(
      defaults: D,
      inputs: I,
      recursive?: false,
  ): D & I
- Passing recursive as false means that the input type must be a Partial (not RecursivePartial).
  Type Parameters
  - D extends object
  - I extends Partial<D>
  Parameters
  - defaults: D
  - inputs: I
  - Optionalrecursive: false
  Returns D & I
- <D extends object, I extends Partial<D> | RecursivePartial<D>>(
      defaults: D,
      inputs: I,
      recursive: true,
  ): D & I
- Passing recursive as true means that the input type may actually be a RecursivePartial.
  Type Parameters
  - D extends object
  - I extends Partial<D> | RecursivePartial<D>
  Parameters
  - defaults: D
  - inputs: I
  - recursive: true
  Returns D & I
- <D extends object, I extends Partial<D> | RecursivePartial<D>>(
      defaults: D,
      inputs?: I,
      recursive?: boolean,
  ): D | D & I
- Universal overload.
  Type Parameters
  - D extends object
  - I extends Partial<D> | RecursivePartial<D>
  Parameters
  - defaults: D
  - Optionalinputs: I
  - Optionalrecursive: boolean
  Returns D | D & I

Args

`Readonly`args

args: FileSystem.Args

A completed args object.

ARGS_DEFAULT

get ARGS_DEFAULT(): {
    argsRecursive: true;
    copy: {
        force: true;
        glob: { absolute: false; dot: true; filesOnly: false };
        recursive: true;
        rename: true;
    };
    copyFile: { force: true; recursive: false; rename: true };
    glob: {
        absolute: true;
        dot: true;
        ignore: [
            "._*",
            "._*/**",
            "**/._*",
            "**/._*/**",
            "**/.DS_Store",
            "**/.smbdelete**",
        ];
    };
    minify: { css: {}; glob: {}; html: {}; js: {}; json: {} };
    prettier: {
        _: {
            bracketSameLine: false;
            bracketSpacing: true;
            experimentalOperatorPosition: "start";
            experimentalTernaries: false;
            glob: {};
            htmlWhitespaceSensitivity: "strict";
            jsxSingleQuote: false;
            printWidth: 80;
            proseWrap: "preserve";
            semi: true;
            singleAttributePerLine: true;
            singleQuote: true;
            tabWidth: 4;
            trailingComma: "all";
            useTabs: false;
        };
        css: { singleQuote: false };
        html: { printWidth: 10000 };
    };
    readDir: { recursive: false };
    readFile: {};
    root: "./";
    write: { force: boolean; rename: boolean };
}
Default args for this stage.

Returns {
    argsRecursive: true;
    copy: {
        force: true;
        glob: { absolute: false; dot: true; filesOnly: false };
        recursive: true;
        rename: true;
    };
    copyFile: { force: true; recursive: false; rename: true };
    glob: {
        absolute: true;
        dot: true;
        ignore: [
            "._*",
            "._*/**",
            "**/._*",
            "**/._*/**",
            "**/.DS_Store",
            "**/.smbdelete**",
        ];
    };
    minify: { css: {}; glob: {}; html: {}; js: {}; json: {} };
    prettier: {
        _: {
            bracketSameLine: false;
            bracketSpacing: true;
            experimentalOperatorPosition: "start";
            experimentalTernaries: false;
            glob: {};
            htmlWhitespaceSensitivity: "strict";
            jsxSingleQuote: false;
            printWidth: 80;
            proseWrap: "preserve";
            semi: true;
            singleAttributePerLine: true;
            singleQuote: true;
            tabWidth: 4;
            trailingComma: "all";
            useTabs: false;
        };
        css: { singleQuote: false };
        html: { printWidth: 10000 };
    };
    readDir: { recursive: false };
    readFile: {};
    root: "./";
    write: { force: boolean; rename: boolean };
}
Overrides node.NodeFiles.ARGS_DEFAULT
- Defined in lib/00-universal/classes/FileSystem.ts:68

buildArgs

buildArgs(
    args?:
        | Partial<FileSystemType.Args>
        | RecursivePartial<FileSystemType.Args>,
): FileSystem.Args
Build a complete args object.
Parameters
- Optionalargs: Partial<FileSystemType.Args> | RecursivePartial<FileSystemType.Args>
Returns FileSystem.Args
Overrides node.NodeFiles.buildArgs
- Defined in lib/00-universal/classes/FileSystem.ts:104

Classes

`Readonly`console

console: Logger

Instance used to log messages within the class.

`Readonly`nc

nc: NodeConsole

The instance of NodeConsole used within this class.

Constructor

constructor

new FileSystem(console: Logger, args?: Partial<FileSystemType.Args>): FileSystem
Parameters
- console: Logger
  Instance used to log messages and debugging info.
- args: Partial<FileSystemType.Args> = {}
  Override arguments.
Returns FileSystem
Overrides node.NodeFiles.constructor
- Defined in lib/00-universal/classes/FileSystem.ts:178

Exporters

toString

toString(): string
Overrides the default function to return a string representation of this object.

Returns string
See
Object.prototype.toString()
Inherited from node.NodeFiles.toString
- Defined in ../../node_modules/@maddimathon/utility-typescript/dist/classes/abstracts/AbstractConfigurableClass.d.ts:56

Filers

copy

copy(
    globs: string | string[],
    level: number,
    outputDir: string,
    sourceDir?: null | string,
    args?: Partial<FileSystemType.Copy.Args>,
): string[]
Copies files from one directory to another, maintaing their relative directory structure.
Parameters
- globs: string | string[]
  Glob patterns for paths to copy.
- level: number
  Depth level for output to the console.
- outputDir: string
  Path to directory where matched files will be copied.
- OptionalsourceDir: null | string
  Relative source directory. If any, the globs are resolved as relative to that directory and the path/dir structure copied to the outputDir is relative to this sourceDir.
- Optionalargs: Partial<FileSystemType.Copy.Args>
  Overrides for default options.
Returns string[]
Array of paths to the newly-copied files/etc.

Throws
FileSystem.Error — If copying a file fails.
- Defined in lib/00-universal/classes/FileSystem.ts:206

copyFile

copyFile(
    source: string,
    destination: string,
    args?: Partial<CopyFileArgs>,
): string | false
Experimental
Copies a file to another path.
Parameters
- source: string
  Location to write file.
- destination: string
  Location to copy the source path to.
- Optionalargs: Partial<CopyFileArgs>
  Optional configuration.
Returns string | false
Path to file if written, or false on failure.

Since
2.0.0-alpha

Since
2.0.0-alpha.1 — Now checks that the file exists first. If so, returns ''.
Inherited from node.NodeFiles.copyFile
- Defined in ../../node_modules/@maddimathon/utility-typescript/dist/classes/node/NodeFiles.d.ts:69

delete

delete(
    globs: string | string[],
    level: number,
    dryRun?: boolean,
    args?: Partial<FileSystemType.Glob.Args>,
): void
Deletes given globs (via node.NodeFiles.delete).

This catches any errors from node.NodeFiles.delete, ignores ENOTEMPTY errors, and re-throws the rest.
Parameters
- globs: string | string[]
  Glob patterns for paths to delete.
- level: number
  Depth level for output to the console.
- OptionaldryRun: boolean
  If true, files that would be deleted are printed to the console and not deleted.
- Optionalargs: Partial<FileSystemType.Glob.Args>
  Optional glob configuration.
Returns void
Overrides node.NodeFiles.delete
- Defined in lib/00-universal/classes/FileSystem.ts:284

mkdir

mkdir(path: string): undefined | string
Experimental
Creates a directory.
Parameters
- path: string
Returns undefined | string
Since
2.0.0-alpha

Since
2.0.0-alpha.1 — Removed args param and now forces recursion.
Inherited from node.NodeFiles.mkdir
- Defined in ../../node_modules/@maddimathon/utility-typescript/dist/classes/node/NodeFiles.d.ts:142

readDir

readDir(path: string, args?: Partial<ReadDirArgs>): string[]
Experimental
Read the paths within a directory.
Parameters
- path: string
  Directory to read.
- Optionalargs: Partial<ReadDirArgs>
  Optional configuration.
Returns string[]
Paths within the given directory.

Since
2.0.0-alpha

Since
2.0.0-alpha.1 — Now checks that the file exists first. If so, returns ''.
Inherited from node.NodeFiles.readDir
- Defined in ../../node_modules/@maddimathon/utility-typescript/dist/classes/node/NodeFiles.d.ts:159

readFile

readFile(path: string, args?: Partial<ReadFileArgs>): string
Reads a file.
Parameters
- path: string
  File to read.
- Optionalargs: Partial<ReadFileArgs>
  Optional configuration.
Returns string
Contents of the file.

Since
2.0.0-alpha.1 — Now checks that the file exists first. If so, returns ''.
Inherited from node.NodeFiles.readFile
- Defined in ../../node_modules/@maddimathon/utility-typescript/dist/classes/node/NodeFiles.d.ts:173

write

write(
    path: string,
    content: string | string[],
    args?: Partial<WriteFileArgs>,
): string | false
Writes a file.
Parameters
- path: string
  Location to write file.
- content: string | string[]
  Contents to write.
- Optionalargs: Partial<WriteFileArgs>
  Optional configuration.
Returns string | false
Path to file if written, or false on failure.

Since
2.0.0-alpha — Renamed to write from writeFiles.
Inherited from node.NodeFiles.write
- Defined in ../../node_modules/@maddimathon/utility-typescript/dist/classes/node/NodeFiles.d.ts:187

Path-makers

basename

basename(path: string, suffix?: string | false): string
Experimental
Gets the basename of the given path.
Parameters
- path: string
- Optionalsuffix: string | false
Returns string
Since
2.0.0-alpha
Inherited from node.NodeFiles.basename
- Defined in ../../node_modules/@maddimathon/utility-typescript/dist/classes/node/NodeFiles.d.ts:208

changeBaseName

changeBaseName(path: string, newName: string): string
Changes just the file name of a path
Parameters
- path: string
- newName: string
Returns string
Full path with updated basename.
Inherited from node.NodeFiles.changeBaseName
- Defined in ../../node_modules/@maddimathon/utility-typescript/dist/classes/node/NodeFiles.d.ts:198

dirname

dirname(path: string): string
Experimental
Gets the path dirname via node:fs.dirname.
Parameters
- path: string
Returns string
Since
2.0.0-alpha
Inherited from node.NodeFiles.dirname
- Defined in ../../node_modules/@maddimathon/utility-typescript/dist/classes/node/NodeFiles.d.ts:91

exists

exists(path: string): boolean
Experimental
Checks whether a file, directory, or link exists at the given path.
Parameters
- path: string
Returns boolean
Since
2.0.0-alpha
Inherited from node.NodeFiles.exists
- Defined in ../../node_modules/@maddimathon/utility-typescript/dist/classes/node/NodeFiles.d.ts:218

glob

glob(
globs: string | string[],
args?: Partial<FileSystemType.Glob.Args>,
): string[]
Gets the valid paths matched against the input globs.
Parameters
- globs: string | string[]
  Glob patterns to match.
- args: Partial<FileSystemType.Glob.Args> = {}
  Optional glob configuration.
Returns string[]
Matched paths.
- Defined in lib/00-universal/classes/FileSystem.ts:322

isDirectory

isDirectory(path: string): boolean
Experimental
Checks if the given path is a directory.
Parameters
- path: string
Returns boolean
Since
2.0.0-alpha
Inherited from node.NodeFiles.isDirectory
- Defined in ../../node_modules/@maddimathon/utility-typescript/dist/classes/node/NodeFiles.d.ts:111

isFile

isFile(path: string): boolean
Experimental
Checks if the given path is a file.
Parameters
- path: string
Returns boolean
Since
2.0.0-alpha
Inherited from node.NodeFiles.isFile
- Defined in ../../node_modules/@maddimathon/utility-typescript/dist/classes/node/NodeFiles.d.ts:121

isSymLink

isSymLink(path: string): boolean
Experimental
Checks if the given path is a symbolic link.
Parameters
- path: string
Returns boolean
Since
2.0.0-alpha
Inherited from node.NodeFiles.isSymLink
- Defined in ../../node_modules/@maddimathon/utility-typescript/dist/classes/node/NodeFiles.d.ts:131

pathRelative

pathRelative(path: string): string
Returns relative paths, based on the root defined the the opts.
Parameters
- path: string
  Path to make relative.
Returns string
Inherited from node.NodeFiles.pathRelative
- Defined in ../../node_modules/@maddimathon/utility-typescript/dist/classes/node/NodeFiles.d.ts:226

pathResolve

pathResolve(...paths: string[]): string
Resolves relative to the root defined the the opts.
Parameters
- ...paths: string[]
  Paths to resolve.
Returns string
Inherited from node.NodeFiles.pathResolve
- Defined in ../../node_modules/@maddimathon/utility-typescript/dist/classes/node/NodeFiles.d.ts:234

uniquePath

uniquePath(inputPath: string): string
Returns a unique version of the inputPath (i.e., where no file exists) by appending a number.
Parameters
- inputPath: string
  Path to make unique.
Returns string
Absolute, unique version of the given inputPath.

See
NodeFiles.changeBaseName Used to update the basename to test for uniqueness.
Inherited from node.NodeFiles.uniquePath
- Defined in ../../node_modules/@maddimathon/utility-typescript/dist/classes/node/NodeFiles.d.ts:247

Transformers

minify

minify(
    globs: string | string[],
    format: FileSystemType.Minify.Format,
    level: number,
    args?: Partial<FileSystemType.Minify.Args>,
    renamer?: (path: string) => string,
): Promise<{ output: string; source: string }[]>
Runs minify on the given file globs.
Parameters
- globs: string | string[]
  Glob patterns for paths to minify.
- format: FileSystemType.Minify.Format
  File format for the input globs.
- level: number
  Depth level for output to the console.
- Optionalargs: Partial<FileSystemType.Minify.Args>
  Overrides for default options.
- Optionalrenamer: (path: string) => string
  Function used to define the new basename for the minified files, if any.
Returns Promise<{ output: string; source: string }[]>
Paths to the minified files (both source and output).
- Defined in lib/00-universal/classes/FileSystem.ts:348

prettier

prettier(
    globs: string | string[],
    format: FileSystemType.Prettier.Format,
    args?: Partial<FileSystemType.Prettier.Args>,
): Promise<string[]>
Runs prettier on the given file globs.
Parameters
- globs: string | string[]
  Glob patterns for paths to run through prettier.
- format: FileSystemType.Prettier.Format
  File format for the input globs.
- Optionalargs: Partial<FileSystemType.Prettier.Args>
  Overrides for default options.
Returns Promise<string[]>
Paths to the formatted files.

Throws
FileSystem.Error — If no parser was given or could be automatically assigned based on the format (this is unlikely if you respect the FileSystemType.Prettier.Format type).
- Defined in lib/00-universal/classes/FileSystem.ts:465

replaceInFiles

replaceInFiles(
    globs: string | string[],
    replace: [string | RegExp, string] | [string | RegExp, string][],
    level: number,
    args?: Partial<FileSystemType.Glob.Args>,
): string[]
Replaces the given text or regex in the given file globs.
Parameters
- globs: string | string[]
  Glob patterns for paths to replace in.
- replace: [string | RegExp, string] | [string | RegExp, string][]
  Replacements to make. The first tuple item is a string or RegExp to find and the second item is a string to replace.
- level: number
  Depth level for output to the console.
- Optionalargs: Partial<FileSystemType.Glob.Args>
  Optional glob configuration.
Returns string[]
Paths to the replaced files.
- Defined in lib/00-universal/classes/FileSystem.ts:553

Class FileSystem

Since

Hierarchy

Index

Aliases

Args

Classes

Constructor

Exporters

Filers

Meta

Path-makers

Transformers

Aliases

FunctionmergeArgs

Type declaration

Type Parameters

Parameters

Returns D

Type Parameters

Parameters

Returns D & I

Type Parameters

Parameters

Returns D & I

Type Parameters

Parameters

Returns D | D & I

Args

Readonlyargs

ARGS_DEFAULT

buildArgs

Parameters

Returns FileSystem.Args

Classes

Readonlyconsole

Readonlync

Constructor

constructor

Parameters

Returns FileSystem

Exporters

toString

Returns string

See

Filers

copy

Parameters

Returns string[]

Throws

copyFile

Parameters

Returns string | false

Since

Since

delete

Parameters

Returns void

mkdir

Parameters

Returns undefined | string

Since

Since

readDir

Parameters

Returns string[]

Since

Since

readFile

Parameters

Returns string

Since

write

Parameters

Returns string | false

Since

Meta

getStats

Parameters

Returns undefined | Stats

`Function`mergeArgs

`Readonly`args

`Readonly`console

`Readonly`nc