@foal/cli 5.1.3 → 5.2.0

package/lib/{generate/file-system.d.ts → services/generator/generator.d.ts}

@@ -1,5 +1,7 @@
+import { FileSystemService } from '../file-system';
+import { LoggerService } from '../logger';
 /**
- * Error thrown by the FileSystem which aims to be pretty
+ * Error thrown by the Generator which aims to be pretty
  * printed without the stacktrace.
  *
  * @export
@@ -10,21 +12,24 @@ export declare class ClientError extends Error {
     readonly name = "ClientError";
 }
 /**
- * This class provides more methods that Node std "fs".
+ * This class provides more methods that Node std "generator".
  * It also allows to create an isolated directory during directory.
  *
  * @export
- * @class FileSystem
+ * @class Generator
  */
-export declare class FileSystem {
+export declare class Generator {
+    private readonly fileSystem;
+    private readonly logger;
     currentDir: string;
     private readonly testDir;
     private logs;
+    constructor(fileSystem: FileSystemService, logger: LoggerService);
     /**
      * Do not show create and update logs.
      *
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     hideLogs(): this;
     /**
@@ -32,7 +37,7 @@ export declare class FileSystem {
      *
      * @param {string} path - Relative path of the directory.
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     cd(path: string): this;
     /**
@@ -43,7 +48,7 @@ export declare class FileSystem {
      * as dependency.
      *
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     cdProjectRootDir(): this;
     /**
@@ -51,7 +56,7 @@ export declare class FileSystem {
      *
      * @param {string} path - The path relative to the client directory.
      * @returns {boolean}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     exists(path: string): boolean;
     /**
@@ -60,7 +65,7 @@ export declare class FileSystem {
      *
      * @param {string} path - The path relative to the client directory.
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     ensureDir(path: string): this;
     /**
@@ -70,7 +75,7 @@ export declare class FileSystem {
      * @param {boolean} condition - The condition.
      * @param {string} path - The path relative to the client directory.
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     ensureDirOnlyIf(condition: boolean, path: string): this;
     /**
@@ -78,7 +83,7 @@ export declare class FileSystem {
      *
      * @param {string} path - The path relative to the client directory.
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     ensureFile(path: string): this;
     /**
@@ -87,9 +92,9 @@ export declare class FileSystem {
      * @param {string} src - The source path relative to the `templates/` directory.
      * @param {string} dest - The destination path relative to the client directory.
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
-    copy(src: string, dest: string): this;
+    copyTemplate(src: string, dest: string): this;
     /**
      * Copies a file from the `templates` directory if the condition is true.
      *
@@ -97,9 +102,9 @@ export declare class FileSystem {
      * @param {string} src - The source path relative to the `templates/` directory.
      * @param {string} dest - The destination path relative to the client directory.
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
-    copyOnlyIf(condition: boolean, src: string, dest: string): this;
+    copyTemplateOnlyIf(condition: boolean, src: string, dest: string): this;
     /**
      * Copies and renders a template from the `templates` directory.
      *
@@ -107,7 +112,7 @@ export declare class FileSystem {
      * @param {string} dest - The destination path relative to the client directory.
      * @param {*} locals - The template variables.
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     render(src: string, dest: string, locals: any): this;
     /**
@@ -118,7 +123,7 @@ export declare class FileSystem {
      * @param {string} dest - The destination path relative to the client directory.
      * @param {*} locals - The template variables.
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     renderOnlyIf(condition: boolean, src: string, dest: string, locals: any): this;
     /**
@@ -127,7 +132,7 @@ export declare class FileSystem {
      * @param {string} path - The path relative to the client directory.
      * @param {(content: string) => string} callback - The callback that modifies the content.
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     modify(path: string, callback: (content: string) => string): this;
     /**
@@ -137,7 +142,7 @@ export declare class FileSystem {
      * @param {string} path - The path relative to the client directory.
      * @param {(content: string) => string} callback - The callback that modifies the content.
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     modifyOnlyfIf(condition: boolean, path: string, callback: (content: string) => string): this;
     /**
@@ -147,7 +152,7 @@ export declare class FileSystem {
      * @param {string} specifier - The import specifier.
      * @param {string} source - The import source.
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     addNamedExportIn(path: string, specifier: string, source: string): this;
     /**
@@ -160,7 +165,7 @@ export declare class FileSystem {
      * @param {string} specifier - The import specifier.
      * @param {string} source - The import source.
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     addOrExtendNamedImportIn(path: string, specifier: string, source: string, options?: {
         logs: boolean;
@@ -175,7 +180,7 @@ export declare class FileSystem {
      * @param {string} propertyName - The property name.
      * @param {string} element - The item to add to the array.
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     addOrExtendClassArrayPropertyIn(path: string, propertyName: string, element: string, options?: {
         logs: boolean;
@@ -186,7 +191,7 @@ export declare class FileSystem {
      *
      * @param {string} name - The name of the dependency.
      * @returns {boolean}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     projectHasDependency(name: string): boolean;
     /**
@@ -228,24 +233,12 @@ export declare class FileSystem {
     /************************
         Testing Methods
     ************************/
-    /**
-     * Creates the test client directory. Sets current directory to none.
-     *
-     * @memberof FileSystem
-     */
-    setUp(): void;
-    /**
-     * Empties and removes the test client directory. Sets current directory to none.
-     *
-     * @memberof FileSystem
-     */
-    tearDown(): void;
     /**
      * Throws an error if the file or directory does not exist.
      *
      * @param {string} path - The path relative to the client directory.
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     assertExists(path: string): this;
     /**
@@ -253,14 +246,14 @@ export declare class FileSystem {
      *
      * @param {string} path - The path relative to the client directory.
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     assertNotExists(path: string): this;
     /**
      * Throws an error if the directory is not empty.
      *
      * @param {string} path - The path relative to the client directory.
-     * @memberof FileSystem
+     * @memberof Generator
      */
     assertEmptyDir(path: string): void;
     /**
@@ -270,7 +263,7 @@ export declare class FileSystem {
      * @param {string} expected - The path relative to the `specs/` directory.
      * @param {{ binary: boolean }} [{ binary }={ binary: true }] - Specify if the file is binary.
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     assertEqual(actual: string, expected: string, { binary }?: {
         binary: boolean;
@@ -281,14 +274,14 @@ export declare class FileSystem {
      * @param {string} src - The source path relative to the `fixtures/` directory.
      * @param {string} dest - The destination path relative to the client directory.
      * @returns {this}
-     * @memberof FileSystem
+     * @memberof Generator
      */
     copyFixture(src: string, dest: string): this;
     /**
      * Removes a file.
      *
      * @param {string} path - The path relative to the client directory.
-     * @memberof FileSystem
+     * @memberof Generator
      */
     rmfile(path: string): void;
     private isTestingEnvironment;