@simple-reporting/base 0.1.111 → 0.1.112

package/scripts/doPublish.js

@@ -1,43 +1,43 @@
-import { execSync } from 'child_process';
-import { preparePublish } from './preparePublish.js';
-import { packageName } from './config.js';
-
-export async function doPublish(version = null) {
-  try {
-    const publishVersion = await preparePublish(version);
-
-    const tag = `v${publishVersion.split('.')[0]}-lts`;
-
-    await execSync(`npm publish --tag ${tag}`, { stdio: 'inherit' });
-
-    console.log(
-      `Package ${packageName}@${publishVersion} published successfully!`,
-    );
-  } catch (error) {
-    console.error('Error during publishing:', error);
-  }
-}
-
-if (import.meta.url === `file://${process.argv[1]}`) {
-  try {
-    let version = null;
-    const indexVersion = process.argv.indexOf('-v');
-    if (indexVersion !== -1) {
-      if (!process.argv[indexVersion + 1]) {
-        throw new Error('Version argument is missing after -v');
-      }
-
-      const newVersion = process.argv[indexVersion + 1];
-      if (/^\d+\.\d+\.\d+$/.test(newVersion)) {
-        version = newVersion;
-      } else {
-        throw new Error(
-          `Invalid version format ${newVersion}. Use $number.$number.$number`,
-        );
-      }
-    }
-    doPublish(version);
-  } catch (error) {
-    console.error(error);
-  }
-}
+import { execSync } from 'child_process';
+import { preparePublish } from './preparePublish.js';
+import { packageName } from './config.js';
+
+export async function doPublish(version = null) {
+  try {
+    const publishVersion = await preparePublish(version);
+
+    const tag = `v${publishVersion.split('.')[0]}-lts`;
+
+    await execSync(`npm publish --tag ${tag}`, { stdio: 'inherit' });
+
+    console.log(
+      `Package ${packageName}@${publishVersion} published successfully!`,
+    );
+  } catch (error) {
+    console.error('Error during publishing:', error);
+  }
+}
+
+if (import.meta.url === `file://${process.argv[1]}`) {
+  try {
+    let version = null;
+    const indexVersion = process.argv.indexOf('-v');
+    if (indexVersion !== -1) {
+      if (!process.argv[indexVersion + 1]) {
+        throw new Error('Version argument is missing after -v');
+      }
+
+      const newVersion = process.argv[indexVersion + 1];
+      if (/^\d+\.\d+\.\d+$/.test(newVersion)) {
+        version = newVersion;
+      } else {
+        throw new Error(
+          `Invalid version format ${newVersion}. Use $number.$number.$number`,
+        );
+      }
+    }
+    doPublish(version);
+  } catch (error) {
+    console.error(error);
+  }
+}

package/scripts/init.js

@@ -1,45 +1,45 @@
-import { resolve, dirname } from 'node:path';
-import fs from 'fs-extra';
-import { statSync, readFileSync, writeFileSync } from 'node:fs';
-import { fileURLToPath } from 'node:url';
-import { createRequire } from 'node:module';
-import writeJson from 'write-json';
-
-const require = createRequire(import.meta.url);
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-/**
- * Initializes a new project in the given folder with the provided options.
- *
- * @param {string} folder - The path to the folder where the project will be created.
- * @param {object} options - Additional options for the initialization process.
- *
- * @return {Promise<void>} - A promise that resolves when the project initialization is complete.
- */
-async function init(folder, options) {
-  const projectPath = resolve(process.cwd(), folder);
-
-  try {
-    const stat = statSync(projectPath);
-    console.error(`Folder ${projectPath} already exist!`);
-  } catch (e) {
-    await fs.copy(resolve(__dirname, '../dev/'), projectPath).then(async () => {
-      const packageJsonFile = `${projectPath}/package.json`;
-      const packageJson = JSON.parse(await readFileSync(packageJsonFile));
-      packageJson.name = folder;
-      const writeJson = require('write-json');
-      writeJson.sync(packageJsonFile, packageJson);
-
-      await writeFileSync(
-        `${projectPath}/.gitignore`,
-        `/.output/\n/.nswow/\n/node_modules/\n/public/downloads/\n/public/html/\n/public/images/\n/public/json/\n/public/exclude/\n/dev-dist/`,
-      );
-      console.log(`Project has created`);
-      console.log(`cd ${folder}`);
-      console.log(`npm install`);
-    });
-  }
-}
-
-export { init };
+import { resolve, dirname } from 'node:path';
+import fs from 'fs-extra';
+import { statSync, readFileSync, writeFileSync } from 'node:fs';
+import { fileURLToPath } from 'node:url';
+import { createRequire } from 'node:module';
+import writeJson from 'write-json';
+
+const require = createRequire(import.meta.url);
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+/**
+ * Initializes a new project in the given folder with the provided options.
+ *
+ * @param {string} folder - The path to the folder where the project will be created.
+ * @param {object} options - Additional options for the initialization process.
+ *
+ * @return {Promise<void>} - A promise that resolves when the project initialization is complete.
+ */
+async function init(folder, options) {
+  const projectPath = resolve(process.cwd(), folder);
+
+  try {
+    const stat = statSync(projectPath);
+    console.error(`Folder ${projectPath} already exist!`);
+  } catch (e) {
+    await fs.copy(resolve(__dirname, '../dev/'), projectPath).then(async () => {
+      const packageJsonFile = `${projectPath}/package.json`;
+      const packageJson = JSON.parse(await readFileSync(packageJsonFile));
+      packageJson.name = folder;
+      const writeJson = require('write-json');
+      writeJson.sync(packageJsonFile, packageJson);
+
+      await writeFileSync(
+        `${projectPath}/.gitignore`,
+        `/.output/\n/.nswow/\n/node_modules/\n/public/downloads/\n/public/html/\n/public/images/\n/public/json/\n/public/exclude/\n/dev-dist/`,
+      );
+      console.log(`Project has created`);
+      console.log(`cd ${folder}`);
+      console.log(`npm install`);
+    });
+  }
+}
+
+export { init };

package/scripts/migrate-livingdocs-build/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 mms solutions ag
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 mms solutions ag
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/scripts/migrate-livingdocs-build/bin/build.js

@@ -1,53 +1,53 @@
-#! /usr/bin/env node
-import LivingdocsDesign from '../dev/livingdocs-design.js';
-import configuration from '../dev/configuration.js';
-import logger from '../dev/logger.js';
-import Build from '../dev/build.js';
-
-/**
- * Builds the Livingdocs design and components based on the configuration.
- *
- * @returns {boolean} - Indicates whether the build was successful or not.
- */
-async function build() {
-  try {
-    const designData = LivingdocsDesign.loadDesign(configuration);
-    const componentData = LivingdocsDesign.loadComponents(configuration);
-
-    if (!designData) {
-      throw {
-        message: 'design is empty',
-      };
-    }
-
-    if (!componentData) {
-      throw {
-        message: 'no components found',
-      };
-    }
-
-    if (!!designData && designData['v'] === 2) {
-      logger.info(`Building ${designData.name} on V2`);
-      Build.BuildV2(designData, componentData);
-    } else {
-      logger.info(`Building ${designData.name} on V1`);
-      Build.BuildV1(designData, componentData);
-    }
-
-    Build.zipArchive();
-  } catch (error) {
-    if (error.message) {
-      logger.error(error.message);
-    }
-
-    // show js errors
-    if (error.error) {
-      logger.error(error.error);
-    }
-  }
-
-  return true;
-}
-
-export default build;
-export { build };
+#! /usr/bin/env node
+import LivingdocsDesign from '../dev/livingdocs-design.js';
+import configuration from '../dev/configuration.js';
+import logger from '../dev/logger.js';
+import Build from '../dev/build.js';
+
+/**
+ * Builds the Livingdocs design and components based on the configuration.
+ *
+ * @returns {boolean} - Indicates whether the build was successful or not.
+ */
+async function build() {
+  try {
+    const designData = LivingdocsDesign.loadDesign(configuration);
+    const componentData = LivingdocsDesign.loadComponents(configuration);
+
+    if (!designData) {
+      throw {
+        message: 'design is empty',
+      };
+    }
+
+    if (!componentData) {
+      throw {
+        message: 'no components found',
+      };
+    }
+
+    if (!!designData && designData['v'] === 2) {
+      logger.info(`Building ${designData.name} on V2`);
+      Build.BuildV2(designData, componentData);
+    } else {
+      logger.info(`Building ${designData.name} on V1`);
+      Build.BuildV1(designData, componentData);
+    }
+
+    Build.zipArchive();
+  } catch (error) {
+    if (error.message) {
+      logger.error(error.message);
+    }
+
+    // show js errors
+    if (error.error) {
+      logger.error(error.error);
+    }
+  }
+
+  return true;
+}
+
+export default build;
+export { build };

package/scripts/migrate-livingdocs-build/bin/migrate.js

@@ -1,43 +1,43 @@
-#! /usr/bin/env node
-
-import configuration from '../dev/configuration.js';
-import LivingdocsDesign from '../dev/livingdocs-design.js';
-import logger from '../dev/logger.js';
-import Migrate from '../dev/migrate.js';
-
-console.log('migrate command here');
-
-try {
-  const designData = LivingdocsDesign.loadDesign(configuration);
-  const componentData = LivingdocsDesign.loadComponents(configuration);
-
-  if (!designData) {
-    throw {
-      message: 'design is empty',
-    };
-  }
-
-  if (!componentData) {
-    throw {
-      message: 'no components found',
-    };
-  }
-
-  const v2Design = Migrate.migrateDesign(designData);
-  // logger.info(JSON.stringify(v2Design));
-  const v2Components = Migrate.migrateComponents(componentData);
-
-  Migrate.writeDesign(v2Design);
-  Migrate.writeComponents(v2Components);
-
-  Migrate.writeManualReviews();
-} catch (error) {
-  if (error.message) {
-    logger.error(error.message);
-  }
-
-  // show js errors
-  if (error.error) {
-    logger.error(error.error);
-  }
-}
+#! /usr/bin/env node
+
+import configuration from '../dev/configuration.js';
+import LivingdocsDesign from '../dev/livingdocs-design.js';
+import logger from '../dev/logger.js';
+import Migrate from '../dev/migrate.js';
+
+console.log('migrate command here');
+
+try {
+  const designData = LivingdocsDesign.loadDesign(configuration);
+  const componentData = LivingdocsDesign.loadComponents(configuration);
+
+  if (!designData) {
+    throw {
+      message: 'design is empty',
+    };
+  }
+
+  if (!componentData) {
+    throw {
+      message: 'no components found',
+    };
+  }
+
+  const v2Design = Migrate.migrateDesign(designData);
+  // logger.info(JSON.stringify(v2Design));
+  const v2Components = Migrate.migrateComponents(componentData);
+
+  Migrate.writeDesign(v2Design);
+  Migrate.writeComponents(v2Components);
+
+  Migrate.writeManualReviews();
+} catch (error) {
+  if (error.message) {
+    logger.error(error.message);
+  }
+
+  // show js errors
+  if (error.error) {
+    logger.error(error.error);
+  }
+}

package/scripts/migrate-livingdocs-build/dev/build/v1.js

@@ -1,51 +1,51 @@
-import configuration from '../configuration.js';
-import lib from '../lib.js';
-import fs from 'fs';
-
-/**
- * Builds and packages a design version.
- *
- * @param {object} designData - The design data object.
- * @param {object} components - The components object.
- * @returns {void}
- */
-const BuildV1 = (designData, components) => {
-  // critical tests
-  lib.testComponentExistV1(designData, components);
-  lib.testPropertyExistV1(designData, components);
-
-  // // logs when thing is never used
-  lib.testComponentsAllUsedV1(designData, components);
-  lib.testDesignPropertiesV1(designData, components);
-
-  // // cleanup dist and dest zip
-  lib.removeFolder(configuration.build.dist);
-  lib.removeFile(configuration.build.dest + configuration.build.archiveName);
-
-  // // create and make dist
-  fs.mkdirSync(configuration.build.dist);
-
-  // // copy folders
-  configuration.build.requiredFolders.forEach((folder) => {
-    const splitPath = folder.split('/');
-    fs.cpSync(
-      folder,
-      configuration.build.dist + '/' + splitPath[splitPath.length - 1],
-      { recursive: true },
-    );
-  });
-
-  const newDesignData = lib.mergeDesignV1(designData, components);
-
-  // // write json files
-  fs.writeFileSync(
-    configuration.build.dist + '/design.json',
-    JSON.stringify(newDesignData),
-  );
-  fs.writeFileSync(
-    configuration.build.dist + '/design.js',
-    `(function () { var designJSON = ${JSON.stringify(newDesignData)}; if(typeof module !== 'undefined' && module.exports) {return module.exports = designJSON;} else { this.design = this.design || {}; this.design['${newDesignData.name}'] = designJSON;} }).call(this);`,
-  );
-};
-
-export default BuildV1;
+import configuration from '../configuration.js';
+import lib from '../lib.js';
+import fs from 'fs';
+
+/**
+ * Builds and packages a design version.
+ *
+ * @param {object} designData - The design data object.
+ * @param {object} components - The components object.
+ * @returns {void}
+ */
+const BuildV1 = (designData, components) => {
+  // critical tests
+  lib.testComponentExistV1(designData, components);
+  lib.testPropertyExistV1(designData, components);
+
+  // // logs when thing is never used
+  lib.testComponentsAllUsedV1(designData, components);
+  lib.testDesignPropertiesV1(designData, components);
+
+  // // cleanup dist and dest zip
+  lib.removeFolder(configuration.build.dist);
+  lib.removeFile(configuration.build.dest + configuration.build.archiveName);
+
+  // // create and make dist
+  fs.mkdirSync(configuration.build.dist);
+
+  // // copy folders
+  configuration.build.requiredFolders.forEach((folder) => {
+    const splitPath = folder.split('/');
+    fs.cpSync(
+      folder,
+      configuration.build.dist + '/' + splitPath[splitPath.length - 1],
+      { recursive: true },
+    );
+  });
+
+  const newDesignData = lib.mergeDesignV1(designData, components);
+
+  // // write json files
+  fs.writeFileSync(
+    configuration.build.dist + '/design.json',
+    JSON.stringify(newDesignData),
+  );
+  fs.writeFileSync(
+    configuration.build.dist + '/design.js',
+    `(function () { var designJSON = ${JSON.stringify(newDesignData)}; if(typeof module !== 'undefined' && module.exports) {return module.exports = designJSON;} else { this.design = this.design || {}; this.design['${newDesignData.name}'] = designJSON;} }).call(this);`,
+  );
+};
+
+export default BuildV1;

package/scripts/migrate-livingdocs-build/dev/build/v2.js

@@ -1,44 +1,44 @@
-import configuration from '../configuration.js';
-import lib from '../lib.js';
-import fs from 'fs';
-
-const BuildV2 = (designData, components) => {
-  // critical tests
-  lib.testComponentExistV2(designData, components);
-  lib.testPropertyExistV2(designData, components);
-
-  // logs when thing is never used
-  lib.testComponentsAllUsedV2(designData, components);
-  lib.testDesignPropertiesV2(designData, components);
-
-  // cleanup dist and dest zip
-  lib.removeFolder(configuration.build.dist);
-  lib.removeFile(configuration.build.dest + configuration.build.archiveName);
-
-  // create and make dist
-  fs.mkdirSync(configuration.build.dist);
-
-  // copy folders
-  configuration.build.requiredFolders.forEach((folder) => {
-    const splitPath = folder.split('/');
-    fs.cpSync(
-      folder,
-      configuration.build.dist + '/' + splitPath[splitPath.length - 1],
-      { recursive: true },
-    );
-  });
-
-  const newDesignData = lib.mergeDesignV2(designData, components);
-
-  // write json files
-  fs.writeFileSync(
-    configuration.build.dist + '/design.json',
-    JSON.stringify(newDesignData),
-  );
-  fs.writeFileSync(
-    configuration.build.dist + '/design.js',
-    `(function () { var designJSON = ${JSON.stringify(newDesignData)}; if(typeof module !== 'undefined' && module.exports) {return module.exports = designJSON;} else { this.design = this.design || {}; this.design['${newDesignData.name}'] = designJSON;} }).call(this);`,
-  );
-};
-
-export default BuildV2;
+import configuration from '../configuration.js';
+import lib from '../lib.js';
+import fs from 'fs';
+
+const BuildV2 = (designData, components) => {
+  // critical tests
+  lib.testComponentExistV2(designData, components);
+  lib.testPropertyExistV2(designData, components);
+
+  // logs when thing is never used
+  lib.testComponentsAllUsedV2(designData, components);
+  lib.testDesignPropertiesV2(designData, components);
+
+  // cleanup dist and dest zip
+  lib.removeFolder(configuration.build.dist);
+  lib.removeFile(configuration.build.dest + configuration.build.archiveName);
+
+  // create and make dist
+  fs.mkdirSync(configuration.build.dist);
+
+  // copy folders
+  configuration.build.requiredFolders.forEach((folder) => {
+    const splitPath = folder.split('/');
+    fs.cpSync(
+      folder,
+      configuration.build.dist + '/' + splitPath[splitPath.length - 1],
+      { recursive: true },
+    );
+  });
+
+  const newDesignData = lib.mergeDesignV2(designData, components);
+
+  // write json files
+  fs.writeFileSync(
+    configuration.build.dist + '/design.json',
+    JSON.stringify(newDesignData),
+  );
+  fs.writeFileSync(
+    configuration.build.dist + '/design.js',
+    `(function () { var designJSON = ${JSON.stringify(newDesignData)}; if(typeof module !== 'undefined' && module.exports) {return module.exports = designJSON;} else { this.design = this.design || {}; this.design['${newDesignData.name}'] = designJSON;} }).call(this);`,
+  );
+};
+
+export default BuildV2;