Refactoring project to use an external

configuration.

Author: cyrilverloop

.gitignore

@@ -1,14 +1,14 @@
 /ci/c8/
 /ci/jsdoc/
-/lib/easy/**/*.*
-/lib/expert/**/*.*
-/lib/hard/**/*.*
-/lib/medium/**/*.*
+/lib/easy/
+/lib/expert/
+/lib/hard/
+/lib/medium/
 /node_modules/
-/test/easy/**/*.*
-/test/expert/**/*.*
-/test/hard/**/*.*
-/test/medium/**/*.*
+/test/easy/
+/test/expert/
+/test/hard/
+/test/medium/
 /.ashrc
 /.env
 /docker-compose.override.yml

CHANGELOG.md

@@ -7,7 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 ### Changed
 - Node 21 => 22.
-- Configurations, inputs, outputs and default codes are now in a separate project.
+- Configurations, inputs, outputs and default codes are now in a separated project.
+- Default codes and tests are now generated in the `easy`, `medium`, `hard` and `expert` sub-directories
+of the `lib` and `test` directories.
 
 ## [2.0.0] - 2024-04-22
 ### Added

README.md

@@ -54,7 +54,7 @@ A test executes the `execute()` method. You can add your code in and arround it.
 
 Executing tests for a specific code :
 ```shellsession
-user@host codingame-js-tests$ docker compose run --rm app npm test ./test/training/easy/unary/
+user@host codingame-js-tests$ docker compose run --rm app npm test ./test/easy/ASCIIArt/
 ```
 
 

lib/configuration/ConfigurationConvertor.js

@@ -1,6 +1,6 @@
 import { readFile } from 'node:fs/promises';
-import GeneratorCodeConfiguration from '../generator/GeneratorCodeConfiguration.js';
-import GeneratorTestConfiguration from '../generator/GeneratorTestConfiguration.js';
+import CodeGeneratorConfiguration from '../generator/CodeGeneratorConfiguration.js';
+import TestGeneratorConfiguration from '../generator/TestGeneratorConfiguration.js';
 import ParsedConfiguration from '../parser/ParsedConfiguration.js';
 
 /**
@@ -14,10 +14,10 @@ export default class ConfigurationConvertor {
      * Returns the code configuration for the generator.
      * @param {ParsedConfiguration} parsedConfiguration - the parsed configuration.
      * @param {string} defaultCodeFile - the file with the default code.
-     * @return {GeneratorCodeConfiguration} the code configuration for the generator.
+     * @return {CodeGeneratorConfiguration} the code configuration for the generator.
      * @throws Error if the default code file is not readable.
      */
-    static async getGeneratorCodeConfiguration(parsedConfiguration, defaultCodeFile) {
+    static async getCodeGeneratorConfiguration(parsedConfiguration, defaultCodeFile) {
 
         if((typeof defaultCodeFile) !== "string") {
             throw new Error("The default code file is not a string.");
@@ -27,8 +27,7 @@ export default class ConfigurationConvertor {
             let defaultCode = await readFile(defaultCodeFile, { encoding: 'utf8' });
             defaultCode = defaultCode.replace(/\n/g, "\n    ").replace(/\n    \n/g, "\n\n");
 
-            return new GeneratorCodeConfiguration(
-                parsedConfiguration.path,
+            return new CodeGeneratorConfiguration(
                 parsedConfiguration.name,
                 parsedConfiguration.link,
                 defaultCode
@@ -41,10 +40,10 @@ export default class ConfigurationConvertor {
     /**
      * Returns the test configuration for the generator.
      * @param {ParsedConfiguration} parsedConfiguration - the parsed configuration.
-     * @return {GeneratorTestConfiguration} the test configuration for the generator.
+     * @return {TestGeneratorConfiguration} the test configuration for the generator.
      */
-    static getGeneratorTestConfiguration(parsedConfiguration) {
-        return new GeneratorTestConfiguration(
+    static getTestGeneratorConfiguration(parsedConfiguration) {
+        return new TestGeneratorConfiguration(
             parsedConfiguration.path,
             parsedConfiguration.name,
             parsedConfiguration.testConfigurations

lib/generator/CGCodeGenerator.js

@@ -22,7 +22,7 @@ export default class CGCodeGenerator extends FileGenerator {
 
     /**
      * Generates the code.
-     * @param {GeneratorCodeConfiguration} configuration - the code configuration.
+     * @param {CodeGeneratorConfiguration} configuration - the code configuration.
      * @param {string} toPath - the path where to put the generated code.
      */
     async generate(configuration, toPath) {

lib/generator/CGTestGenerator.js

@@ -33,7 +33,7 @@ export default class CGTestGenerator extends FileGenerator {
 
     /**
      * Generates the test.
-     * @param {GeneratorTestConfiguration} configuration - the test configuration.
+     * @param {TestGeneratorConfiguration} configuration - the test configuration.
      * @param {string} fromPath - the path where the config file is.
      * @param {string} toPath - the path where to put the generated test.
      */

…/generator/GeneratorCodeConfiguration.js …/generator/CodeGeneratorConfiguration.jslib/generator/GeneratorCodeConfiguration.js renamed to lib/generator/CodeGeneratorConfiguration.js lib/generator/GeneratorCodeConfiguration.js renamed to lib/generator/CodeGeneratorConfiguration.js

@@ -1,11 +1,10 @@
 /**
- * The generator code configuration.
+ * The code generator configuration.
  */
-export default class GeneratorCodeConfiguration {
+export default class CodeGeneratorConfiguration {
 
     // Properties :
 
-    #path;
     #name;
     #link;
     #defaultCode;
@@ -15,18 +14,15 @@ export default class GeneratorCodeConfiguration {
 
     /**
      * The constructor.
-     * @param {string} path - the path.
      * @param {string} name - the name.
      * @param {string} link - the link.
      * @param {string} defaultCode - the default code.
      */
     constructor(
-        path,
         name,
         link,
         defaultCode
     ) {
-        this.#path = path;
         this.#name = name;
         this.#link = link;
         this.#defaultCode = defaultCode;
@@ -35,15 +31,6 @@ export default class GeneratorCodeConfiguration {
 
     // Accessors :
 
-    /**
-     * Returns the path.
-     * @returns {string} - the path.
-     */
-    get path()
-    {
-        return this.#path;
-    }
-
     /**
      * Returns the name.
      * @returns {string} - the name.

lib/generator/FileGenerator.js

@@ -26,7 +26,7 @@ export default class FileGenerator {
 
     /**
      * Generates the file.
-     * @param {GeneratorCodeConfiguration|GeneratorTestConfiguration} configuration - the configuration.
+     * @param {CodeGeneratorConfiguration|TestGeneratorConfiguration} configuration - the configuration.
      * @param {string} toPath - the path where to put the generated file.
      * @throws {Error} this method must be implemented in sub-classes.
      */
@@ -36,7 +36,7 @@ export default class FileGenerator {
 
     /**
      * Generates the file content.
-     * @param {GeneratorCodeConfiguration|GeneratorTestConfiguration} configuration - the  configuration.
+     * @param {CodeGeneratorConfiguration|TestGeneratorConfiguration} configuration - the  configuration.
      * @param {string} path - the path.
      * @param {string} file - the file.
      * @param {string} templateFile - the template file.

lib/generator/FilesGenerator.js

@@ -11,10 +11,15 @@ import path from 'path';
  */
 const CONFIG_FILE = 'config.json';
 
+/**
+ * The default code directory.
+ */
+const DEFAULT_CODE_DIRECTORY = 'code' + path.sep;
+
 /**
  * The default code file.
  */
-const DEFAULT_CODE_FILE = 'CGCode.dist';
+const DEFAULT_CODE_FILE = 'CGCode.js';
 
 
 /**
@@ -51,29 +56,18 @@ export default class FilesGenerator {
      * @param {string} testPath - the equivalent path of pathToScan in the tests directory.
      */
     async generate(pathToScan, srcPath, testPath) {
-        let pathContent = await readdir(pathToScan);
-        pathContent = pathContent.filter(this.#removeInputOutputDirectories.bind(this));
-
-        const pathContentCount = pathContent.length;
+        const difficultyDirectories = await readdir(pathToScan);
 
-        for(let pathContentIndex = 0; pathContentIndex < pathContentCount; pathContentIndex++) {
-            const element = pathContent[pathContentIndex];
+        for(const difficultyDirectory of difficultyDirectories) {
+            const puzzleDirectories = await readdir(pathToScan + difficultyDirectory);
 
-            const elementStats = await stat(pathToScan + element);
-
-            if (elementStats.isDirectory() === true) {
-                this.generate(
-                    pathToScan + element + path.sep,
-                    srcPath + element + path.sep,
-                    testPath + element + path.sep
-                );
-            }
+            for(const puzzleDirectory of puzzleDirectories) {
+                const puzzlePath = difficultyDirectory + path.sep + puzzleDirectory + path.sep;
 
-            if (element === CONFIG_FILE) {
                 this.#generateFilesForConfiguration(
-                    pathToScan,
-                    srcPath,
-                    testPath
+                    pathToScan + puzzlePath,
+                    srcPath + puzzlePath,
+                    testPath + puzzlePath
                 );
             }
         }
@@ -103,16 +97,16 @@ export default class FilesGenerator {
     async #generateFilesForConfiguration(configurationPath, srcPath, testPath) {
         const parsedConfiguration = await this.#configurationParser.getConfigurationFromFile(configurationPath + CONFIG_FILE);
 
-        const codeConfiguration = await ConfigurationConvertor.getGeneratorCodeConfiguration(
+        const codeConfiguration = await ConfigurationConvertor.getCodeGeneratorConfiguration(
             parsedConfiguration,
-            configurationPath + DEFAULT_CODE_FILE
+            configurationPath + DEFAULT_CODE_DIRECTORY + DEFAULT_CODE_FILE
         );
         this.#codeGenerator.generate(
             codeConfiguration,
             srcPath
         );
 
-        const testConfiguration = await ConfigurationConvertor.getGeneratorTestConfiguration(parsedConfiguration);
+        const testConfiguration = await ConfigurationConvertor.getTestGeneratorConfiguration(parsedConfiguration);
         this.#testGenerator.generate(
             testConfiguration,
             configurationPath,

…/generator/GeneratorTestConfiguration.js …/generator/TestGeneratorConfiguration.jslib/generator/GeneratorTestConfiguration.js renamed to lib/generator/TestGeneratorConfiguration.js lib/generator/GeneratorTestConfiguration.js renamed to lib/generator/TestGeneratorConfiguration.js

@@ -1,7 +1,7 @@
 /**
  * The generator test configuration.
  */
-export default class GeneratorTestConfiguration {
+export default class TestGeneratorConfiguration {
 
     // Properties :