@byaga/cdk-patterns 0.9.2 → 0.10.0

package/lib/methods/{empty-directory.js → copy-files.js}

@@ -26,21 +26,28 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.copyFiles = void 0;
+const path = __importStar(require("path"));
 const fse = __importStar(require("fs-extra"));
 const duration_1 = __importDefault(require("./duration"));
-const walk_directory_1 = __importDefault(require("./walk-directory"));
-function emptyDirSync(parentFolder, options) {
-    const rmComplete = (0, duration_1.default)();
-    const files = (0, walk_directory_1.default)(parentFolder, options);
-    files
-        .forEach((file) => {
-        try {
-            fse.removeSync(file.fullpath());
-        }
-        catch (err) {
-            console.error('Error deleting file:', err);
-        }
+/**
+ * Copies files from the source directory to the build directory.
+ * @function copyFiles
+ * @param {string[]} files - The files to copy.
+ * @param {string} srcDir - The source directory.
+ * @param {string} buildDir - The build directory.
+ */
+function copyFiles(files, srcDir, buildDir) {
+    // Measure the duration of the copy process
+    const copyComplete = (0, duration_1.default)();
+    // For each file, calculate the relative path from the source directory,
+    // resolve the target path in the build directory, and copy the file
+    files.forEach((filePath) => {
+        const relativePath = path.relative(srcDir, filePath);
+        const targetPath = path.resolve(buildDir, relativePath);
+        fse.copySync(filePath, targetPath);
     });
-    console.log('Empty Directory Complete (ms)', parentFolder, rmComplete());
+    // Log the duration of the copy process
+    console.log('Copy Duration (ms)', copyComplete());
 }
-exports.default = emptyDirSync;
+exports.copyFiles = copyFiles;

package/lib/methods/duration.d.ts

@@ -1,8 +1,10 @@
-declare const duration: (() => {
+/**
+ * Creates a function that, when called, returns the elapsed time in milliseconds since the function was created.
+ * @function hrDuration
+ * @returns {function} - A function that returns the elapsed time in milliseconds.
+ */
+export declare const hrDuration: () => {
     (): number;
     time: [number, number];
-}) | (() => {
-    (): number;
-    time: number;
-});
-export default duration;
+};
+export default hrDuration;

package/lib/methods/duration.js

@@ -1,22 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.hrDuration = void 0;
+/**
+ * Creates a function that, when called, returns the elapsed time in milliseconds since the function was created.
+ * @function hrDuration
+ * @returns {function} - A function that returns the elapsed time in milliseconds.
+ */
 const hrDuration = () => {
+    // The high-resolution real time at which the function was created
     const startTime = process.hrtime();
+    /**
+     * Returns the elapsed time in milliseconds since the function was created.
+     * @function duration
+     * @returns {number} - The elapsed time in milliseconds.
+     */
     const onEnd = function duration() {
+        // The high-resolution real time at which the function was called
         const hrTime = process.hrtime(startTime);
+        // Calculate and return the elapsed time in milliseconds
         return hrTime[0] * 1000 + hrTime[1] / 1000000;
     };
+    // Attach the start time to the function for reference
     onEnd.time = startTime;
     return onEnd;
 };
-const msDuration = () => {
-    const startTime = Date.now();
-    const onEnd = function duration() {
-        return Date.now() - startTime;
-    };
-    onEnd.time = startTime;
-    return onEnd;
-};
-// @ts-ignore
-const duration = process.hrtime ? hrDuration : msDuration;
-exports.default = duration;
+exports.hrDuration = hrDuration;
+exports.default = exports.hrDuration;

package/lib/methods/generate-hash.d.ts

@@ -1,15 +1,7 @@
-import { IIgnoreOptions } from './walk-directory';
-interface HashOptions {
-    ignore: IIgnoreOptions;
-}
-export interface HashResult {
-    hash?: string;
-    children?: HashItem[];
-}
-export interface HashItem {
-    hash: string;
-    path: string;
-    name: string;
-}
-export declare function generateHash(folder: string, opt: HashOptions): string;
-export {};
+/**
+ * Generates a hash for each file in the provided file paths and combines them into a single hash.
+ * @function generateHash
+ * @param {string[]} filePaths - The file paths to generate hashes for.
+ * @returns {string} - The combined hash of all the files.
+ */
+export declare function generateHash(filePaths: string[]): string;

package/lib/methods/generate-hash.js

@@ -1,59 +1,31 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateHash = void 0;
-const crypto = __importStar(require("crypto"));
-const path = __importStar(require("path"));
-const fs = __importStar(require("fs"));
-const walk_directory_1 = __importDefault(require("./walk-directory"));
-const ALGO = 'sha1';
-const ENCODING = 'base64';
-function generateHash(folder, opt) {
-    const files = (0, walk_directory_1.default)(folder, opt.ignore);
-    const hash = crypto.createHash(ALGO);
-    const children = files
-        .sort((a, b) => a.fullpath().localeCompare(b.fullpath()))
-        .map((child) => {
-        const relPath = path.relative(process.cwd(), child.fullpath());
-        const fileHash = crypto.createHash(ALGO);
-        fileHash.update(relPath);
-        fileHash.update(fs.readFileSync(child.fullpath()));
-        const file = {
-            name: child.name,
-            path: relPath,
-            hash: fileHash.digest(ENCODING)
-        };
-        hash.update(file.hash);
-        return file;
+const crypto_1 = require("crypto");
+const fs_1 = require("fs");
+/**
+ * Generates a hash for each file in the provided file paths and combines them into a single hash.
+ * @function generateHash
+ * @param {string[]} filePaths - The file paths to generate hashes for.
+ * @returns {string} - The combined hash of all the files.
+ */
+function generateHash(filePaths) {
+    // Map over each file path
+    const hashes = filePaths.map((filePath) => {
+        // Create a new hash object
+        const hash = (0, crypto_1.createHash)('sha256');
+        // Read the file data
+        const data = (0, fs_1.readFileSync)(filePath);
+        // Update the hash with the file data
+        hash.update(data);
+        // Compute the hash digest
+        return hash.digest('hex');
     });
-    return JSON.stringify({
-        hash: hash.digest(ENCODING),
-        children
-    }, null, '\t');
+    // Create a new hash object for the combined hash
+    const combinedHash = (0, crypto_1.createHash)('sha256');
+    // Update the combined hash with each individual file hash
+    hashes.forEach((hash) => combinedHash.update(hash));
+    // Return the combined hash digest
+    return combinedHash.digest('hex');
 }
 exports.generateHash = generateHash;

package/lib/methods/get-files.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Returns an array of file paths from a directory, excluding files specified in an ignore file.
+ *
+ * @param {string} dir - The directory to get files from.
+ * @param {string} [ignoreFile='.cdkignore'] - The ignore file in the directory. Defaults to '.cdkignore'.
+ *
+ * @returns {string[]} An array of file paths.
+ */
+export declare const getFiles: (dir: string, ignoreFile?: string) => string[];

package/lib/methods/get-files.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFiles = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const ignore_1 = __importDefault(require("ignore"));
+const glob_1 = require("glob");
+/**
+ * Returns an array of file paths from a directory, excluding files specified in an ignore file.
+ *
+ * @param {string} dir - The directory to get files from.
+ * @param {string} [ignoreFile='.cdkignore'] - The ignore file in the directory. Defaults to '.cdkignore'.
+ *
+ * @returns {string[]} An array of file paths.
+ */
+const getFiles = (dir, ignoreFile = '.cdkignore') => {
+    // Create a new ignore manager
+    const ig = (0, ignore_1.default)();
+    // Resolve the path to the ignore file
+    const ignoreFilePath = (0, path_1.resolve)(dir, ignoreFile);
+    // If the ignore file exists, add its contents to the ignore manager
+    if ((0, fs_1.existsSync)(ignoreFilePath)) {
+        ig.add((0, fs_1.readFileSync)(ignoreFilePath, 'utf8'));
+    }
+    // Get all files in the directory
+    const files = (0, glob_1.sync)('**', {
+        cwd: dir,
+        nodir: true,
+        dot: false,
+        absolute: true
+    });
+    // Filter out the files that should be ignored
+    return files.filter(file => !ig.ignores((0, path_1.relative)(dir, file)));
+};
+exports.getFiles = getFiles;

package/lib/methods/get-source-directory.d.ts

@@ -1,4 +1,18 @@
 export declare const sourceRoot: string;
 export declare const distributionRoot: string;
-export declare function getSourceDirectory(type: string, id: string): string;
-export declare function getBuildDirectory(type: string, id: string): string;
+/**
+ * Returns the source directory path for a given type and id.
+ * @param {string} type - The type of the source.
+ * @param {string} id - The id of the source.
+ * @param {string} [subdir=''] - An optional subdirectory.
+ * @returns {string} The source directory path.
+ */
+export declare function getSourceDirectory(type: string, id: string, subdir?: string): string;
+/**
+ * Returns the build directory path for a given type and id.
+ * @param {string} type - The type of the build.
+ * @param {string} id - The id of the build.
+ * @param {string} [subdir=''] - An optional subdirectory.
+ * @returns {string} The build directory path.
+ */
+export declare function getBuildDirectory(type: string, id: string, subdir?: string): string;

package/lib/methods/get-source-directory.js

@@ -1,37 +1,38 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getBuildDirectory = exports.getSourceDirectory = exports.distributionRoot = exports.sourceRoot = void 0;
-const path = __importStar(require("path"));
-exports.sourceRoot = path.resolve(process.cwd(), "../src");
-exports.distributionRoot = path.resolve(process.cwd(), "../dist");
-function getSourceDirectory(type, id) {
-    return path.join(exports.sourceRoot, type, id);
+const path_1 = require("path");
+// The root directory for the source files
+exports.sourceRoot = (0, path_1.resolve)(process.cwd(), "../src");
+// The root directory for the distribution files
+exports.distributionRoot = (0, path_1.resolve)(process.cwd(), "../dist");
+/**
+ * Returns the source directory path for a given type and id.
+ * @param {string} type - The type of the source.
+ * @param {string} id - The id of the source.
+ * @param {string} [subdir=''] - An optional subdirectory.
+ * @returns {string} The source directory path.
+ */
+function getSourceDirectory(type, id, subdir = '') {
+    return joinPopulated(exports.sourceRoot, type, id, subdir);
 }
 exports.getSourceDirectory = getSourceDirectory;
-function getBuildDirectory(type, id) {
-    return path.join(exports.distributionRoot, type, id);
+/**
+ * Returns the build directory path for a given type and id.
+ * @param {string} type - The type of the build.
+ * @param {string} id - The id of the build.
+ * @param {string} [subdir=''] - An optional subdirectory.
+ * @returns {string} The build directory path.
+ */
+function getBuildDirectory(type, id, subdir = '') {
+    return joinPopulated(exports.distributionRoot, type, id, subdir);
 }
 exports.getBuildDirectory = getBuildDirectory;
+/**
+ * Joins the given parts into a path, ignoring any empty parts.
+ * @param {...string} parts - The parts to join.
+ * @returns {string} The joined path.
+ */
+function joinPopulated(...parts) {
+    return (0, path_1.join)(...parts.filter(part => !!part));
+}

package/lib/methods/hash-file.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The root directory for the hash.
+ */
+export declare const hashRoot: string;
+/**
+ * Retrieves the stored hash for the specified source code.
+ * @param {string} type - The type of the source code.
+ * @param {string} id - The ID of the source code.
+ * @returns {string} - The stored hash, or an empty string if no hash is stored.
+ */
+export declare function getStoredHash(type: string, id: string): string;
+/**
+ * Stores a hash for the specified source code.
+ * @param {string} type - The type of the source code.
+ * @param {string} id - The ID of the source code.
+ * @param {string} hash - The hash to store.
+ */
+export declare function storeHash(type: string, id: string, hash: string): void;

package/lib/methods/hash-file.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.storeHash = exports.getStoredHash = exports.hashRoot = void 0;
+const path_1 = require("path");
+const fs_extra_1 = require("fs-extra");
+const fs_1 = require("fs");
+const get_source_directory_1 = require("./get-source-directory");
+/**
+ * The root directory for the hash.
+ */
+exports.hashRoot = (0, path_1.join)(get_source_directory_1.distributionRoot, "hash");
+/**
+ * Constructs the file path for the hash file.
+ * @param {string} type - The type of the source code.
+ * @param {string} id - The ID of the source code.
+ * @returns {string} - The file path for the hash file.
+ */
+function getHashFilePath(type, id) {
+    return (0, path_1.join)(exports.hashRoot, `${type}-${id}-hash.txt`);
+}
+/**
+ * Retrieves the stored hash for the specified source code.
+ * @param {string} type - The type of the source code.
+ * @param {string} id - The ID of the source code.
+ * @returns {string} - The stored hash, or an empty string if no hash is stored.
+ */
+function getStoredHash(type, id) {
+    const hashFilePath = getHashFilePath(type, id);
+    const folderExists = (0, fs_extra_1.existsSync)((0, get_source_directory_1.getBuildDirectory)(type, id));
+    const hashFileExists = folderExists && (0, fs_extra_1.existsSync)(hashFilePath);
+    return hashFileExists ? (0, fs_extra_1.readFileSync)(hashFilePath).toString() : '';
+}
+exports.getStoredHash = getStoredHash;
+/**
+ * Stores a hash for the specified source code.
+ * @param {string} type - The type of the source code.
+ * @param {string} id - The ID of the source code.
+ * @param {string} hash - The hash to store.
+ */
+function storeHash(type, id, hash) {
+    const hashFilePath = getHashFilePath(type, id);
+    (0, fs_extra_1.ensureDirSync)((0, path_1.dirname)(hashFilePath));
+    (0, fs_1.writeFileSync)(hashFilePath, hash);
+}
+exports.storeHash = storeHash;

package/lib/methods/install-node-modules.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Installs node modules in a specified directory.
+ *
+ * This function runs the `npm install` command in the specified directory,
+ * omitting certain types of dependencies if specified.
+ * It also measures and logs the duration of the `npm install` command.
+ *
+ * @function installNodeModules
+ * @param {string} dir - The directory in which to run `npm install`.
+ * @param {string[]} [omit=[]] - The types of dependencies to omit. Possible values are 'dev', 'optional', and 'peer'.
+ */
+export declare function installNodeModules(dir: string, omit?: string[]): void;

package/lib/methods/install-node-modules.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.installNodeModules = void 0;
+const child_process_1 = require("child_process");
+const duration_1 = __importDefault(require("./duration"));
+/**
+ * Installs node modules in a specified directory.
+ *
+ * This function runs the `npm install` command in the specified directory,
+ * omitting certain types of dependencies if specified.
+ * It also measures and logs the duration of the `npm install` command.
+ *
+ * @function installNodeModules
+ * @param {string} dir - The directory in which to run `npm install`.
+ * @param {string[]} [omit=[]] - The types of dependencies to omit. Possible values are 'dev', 'optional', and 'peer'.
+ */
+function installNodeModules(dir, omit = []) {
+    // Start measuring the duration of the `npm install` command
+    const installComplete = (0, duration_1.default)();
+    // Run the `npm install` command in the specified directory, omitting certain types of dependencies if specified
+    (0, child_process_1.execSync)(`npm i${omit.join(' --omit=')} --quite`, {
+        cwd: dir
+    });
+    // Log the duration of the `npm install` command
+    console.log('NPM Install Duration (ms)', installComplete());
+}
+exports.installNodeModules = installNodeModules;

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@byaga/cdk-patterns",
-  "version": "0.9.2",
+  "version": "0.10.0",
   "description": "Collection of common patterns used when making AWS CloudFormation templates using CDK",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "scripts": {
-    "build": "tsc"
+    "clean": "rimraf ./lib",
+    "build": "npm run clean && tsc",
+    "lint": "eslint . --ext .ts",
+    "test": "jest ./src",
+    "preversion": "npm run lint && npm test && npm run build"
   },
   "keywords": [
     "CDK",
@@ -15,14 +19,30 @@
   "author": "VeryFineHat",
   "license": "MIT",
   "dependencies": {
-    "@types/fs-extra": "^11.0.3",
-    "aws-cdk": "^2.103.1",
-    "aws-cdk-lib": "^2.103.1",
+    "aws-cdk": "^2.122.0",
+    "aws-cdk-lib": "^2.122.0",
     "constructs": "^10.3.0",
-    "fs-extra": "^11.1.1"
+    "fs-extra": "^11.2.0",
+    "glob": "^10.3.10",
+    "ignore": "^5.3.0"
   },
   "devDependencies": {
-    "@types/node": "^20.8.10",
-    "typescript": "^5.2.2"
+    "@types/fs-extra": "^11.0.4",
+    "@types/glob": "^8.1.0",
+    "@types/jest": "^29.5.11",
+    "@types/node": "^20.11.5",
+    "@typescript-eslint/eslint-plugin": "^6.19.0",
+    "@typescript-eslint/parser": "^6.19.0",
+    "eslint": "^8.56.0",
+    "jest": "^29.7.0",
+    "jest-html-reporters": "^3.1.7",
+    "jest-junit": "^16.0.0",
+    "ts-jest": "^29.1.1",
+    "ts-mockito": "^2.6.1",
+    "typescript": "^5.3.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/veryfine-hat/byaga-cdk-patterns"
   }
 }

package/tsconfig.json

@@ -31,5 +31,5 @@
     ]
   },
   "include": ["src/**/*"],
-  "exclude": [ "node_modules" ]
+  "exclude": [ "node_modules", "*.spec.ts" ]
 }

package/lib/IDeployStack.d.ts

@@ -1,20 +0,0 @@
-import { Stack } from 'aws-cdk-lib';
-import IStackArguments from './IStackArguments';
-import { IConstruct } from "constructs";
-export declare class IDeployStack extends Stack {
-    registry: {
-        [t: string]: {
-            [n: string]: any;
-        };
-    };
-    stage: string;
-    name: string;
-    genName(...name: string[]): string;
-    genId(...name: string[]): string;
-    static genStackResourceName(stackName: string, resource: string, stage?: string): string;
-    static genStackResourceId(stackName: string, resource: string, stage?: string): string;
-    constructor(scope: IConstruct, props: IStackArguments);
-    get(type: string, name: string): any;
-    set(type: string, name: string, instance: any): any;
-}
-export default IDeployStack;

package/lib/IDeployStack.js

@@ -1,48 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IDeployStack = void 0;
-const aws_cdk_lib_1 = require("aws-cdk-lib");
-class IDeployStack extends aws_cdk_lib_1.Stack {
-    registry = {};
-    stage;
-    name;
-    genName(...name) {
-        return IDeployStack.genStackResourceName(this.name, this.stage, name.filter(n => !!n).join('-'));
-    }
-    genId(...name) {
-        return IDeployStack.genStackResourceId(this.name, this.stage, name.filter(n => !!n).join('-'));
-    }
-    static genStackResourceName(stackName, resource, stage = 'develop') {
-        let name = stackName[0].toLowerCase() + stackName.substr(1);
-        name = name.replace(/[A-Z]/g, v => '-' + v.toLowerCase());
-        return `${name}-${resource}-${stage}`.toLowerCase();
-    }
-    static genStackResourceId(stackName, resource, stage = 'develop') {
-        const constructName = `${stackName}-${resource}-${stage}`;
-        return constructName[0].toUpperCase() + constructName.substr(1).replace(/-./g, v => (v[1] || '').toUpperCase());
-    }
-    constructor(scope, props) {
-        const options = (props || {});
-        const { stage = 'develop' } = options;
-        super(scope, props.stackName + '-' + stage, {
-            ...props,
-            stackName: props.stackName + '-' + stage
-        });
-        const stack = this;
-        stack.name = props.stackName || '';
-        stack.stage = stage;
-        stack.tags.setTag('Stage', stage);
-        stack.tags.setTag('Stack', this.genName('ui-stack'));
-    }
-    get(type, name) {
-        const items = this.registry[type];
-        return (items && items[name]) || null;
-    }
-    set(type, name, instance) {
-        this.registry[type] = this.registry[type] || {};
-        this.registry[type][name] = instance;
-        return instance;
-    }
-}
-exports.IDeployStack = IDeployStack;
-exports.default = IDeployStack;

package/lib/methods/empty-directory.d.ts

@@ -1,2 +0,0 @@
-import { IIgnoreOptions } from "./walk-directory";
-export default function emptyDirSync(parentFolder: string, options: IIgnoreOptions): void;

package/lib/methods/walk-directory.d.ts

@@ -1,14 +0,0 @@
-/// <reference types="node" />
-import * as fs from 'fs';
-export interface IIgnoreOptions {
-    excluded?: (stat: fs.Dirent) => boolean;
-    included?: (stat: fs.Dirent) => boolean;
-    childrenExcluded?: (stat: fs.Dirent) => boolean;
-    childrenIncluded?: (stat: fs.Dirent) => boolean;
-}
-export declare const yes: () => boolean;
-export declare const no: () => boolean;
-export default function walkDirectory(directory: string, options: IIgnoreOptions, filepaths?: DirentExtended[]): DirentExtended[];
-export interface DirentExtended extends fs.Dirent {
-    fullpath: () => string;
-}