mcdev 5.3.0 → 6.0.1

package/lib/util/config.js

@@ -1,9 +1,12 @@
-const TYPE = require('../../types/mcdev.d');
-const Util = require('./util');
-const File = require('./file');
-const inquirer = require('inquirer');
-const semver = require('semver');
-const path = require('node:path');
+import TYPE from '../../types/mcdev.d.js';
+import { Util } from './util.js';
+import File from './file.js';
+import inquirer from 'inquirer';
+import semver from 'semver';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
 /**
  * Central class for loading and validating properties from config and auth
  */
@@ -300,4 +303,4 @@ const config = {
         return defaultProperties;
     },
 };
-module.exports = config;
+export default config;

package/lib/util/devops.js

@@ -1,13 +1,14 @@
-const TYPE = require('../../types/mcdev.d');
-const File = require('./file');
-const path = require('node:path');
-const inquirer = require('inquirer');
-const Util = require('./util');
-const Cli = require('./cli');
-const git = require('simple-git')();
-const Builder = require('../Builder');
-const MetadataType = require('../MetadataTypeInfo');
-const jsonToTable = require('json-to-table');
+import TYPE from '../../types/mcdev.d.js';
+import File from './file.js';
+import path from 'node:path';
+import inquirer from 'inquirer';
+import { Util } from './util.js';
+import Cli from './cli.js';
+import gitFactory from 'simple-git';
+const git = gitFactory();
+import Builder from '../Builder.js';
+import MetadataType from '../MetadataTypeInfo.js';
+import jsonToTable from 'json-to-table';
 /**
  * DevOps helper class
  */
@@ -570,4 +571,4 @@ const DevOps = {
     },
 };
 
-module.exports = DevOps;
+export default DevOps;

package/lib/util/file.js

@@ -1,18 +1,18 @@
 /* eslint-disable no-control-regex */
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const fs = require('fs-extra');
-const packageJson = require('../../package.json');
-const path = require('node:path');
-const prettier = require('prettier');
-const beautyAmp = require('beauty-amp-core');
-const Util = require('./util');
-const updateNotifier = require('update-notifier');
+import TYPE from '../../types/mcdev.d.js';
+import fs from 'fs-extra';
+
+import path from 'node:path';
+import prettier from 'prettier';
+import beautyAmp from 'beauty-amp-core';
+import { Util } from './util.js';
+import updateNotifier from 'update-notifier';
 
 // inform user when there is an update
 const notifier = updateNotifier({
-    pkg: packageJson,
+    pkg: Util.packageJsonMcdev,
     updateCheckInterval: 1000 * 3600 * 24, // once per day
 });
 // Notify using the built-in convenience method
@@ -218,9 +218,9 @@ const File = {
      * @param {string} filename name of the file without suffix
      * @param {string} filetype filetype ie. JSON or SSJS
      * @param {string} content filecontent
-     * @returns {string} original string on error; formatted string on success
+     * @returns {Promise.<string>} original string on error; formatted string on success
      */
-    _beautify_prettier: function (directory, filename, filetype, content) {
+    _beautify_prettier: async function (directory, filename, filetype, content) {
         let formatted = '';
         try {
             if (!FileFs.prettierConfig) {
@@ -275,13 +275,14 @@ const File = {
                 }
                 case 'sql': {
                     FileFs.prettierConfig.parser = 'sql';
+                    FileFs.prettierConfig.plugins = ['prettier-plugin-sql'];
                     break;
                 }
                 default: {
                     FileFs.prettierConfig.parser = 'babel';
                 }
             }
-            formatted = prettier.format(content, FileFs.prettierConfig);
+            formatted = await prettier.format(content, FileFs.prettierConfig);
         } catch (ex) {
             const warnMsg = `Potential Code issue found in ${this.normalizePath([
                 ...directory,
@@ -506,7 +507,7 @@ const File = {
      */
     async saveConfigFile(properties) {
         // we want to save to save the full version here to allow us to upgrade configs properly in the future
-        properties.version = packageJson.version;
+        properties.version = Util.packageJsonMcdev.version;
 
         await this.writeJSONToFile('', Util.configFileName.split('.json')[0], properties);
         Util.logger.info(`✔️  ${Util.configFileName} and ${Util.authFileName} saved successfully`);
@@ -550,4 +551,4 @@ const FileFs = { ...fs, ...File };
 FileFs.prettierConfig = null;
 FileFs.prettierConfigFileType = null;
 
-module.exports = FileFs;
+export default FileFs;

package/lib/util/init.config.js

@@ -1,13 +1,15 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const Cli = require('./cli');
-const File = require('./file');
-const config = require('./config');
-const Util = require('./util');
-const inquirer = require('inquirer');
-const path = require('node:path');
-const semver = require('semver');
+import TYPE from '../../types/mcdev.d.js';
+import Cli from './cli.js';
+import File from './file.js';
+import config from './config.js';
+import { Util } from './util.js';
+import inquirer from 'inquirer';
+import path from 'node:path';
+import semver from 'semver';
+import { fileURLToPath } from 'node:url';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 /**
  * CLI helper class
@@ -425,4 +427,4 @@ const Init = {
     },
 };
 
-module.exports = Init;
+export default Init;

package/lib/util/init.git.js

@@ -1,10 +1,11 @@
 'use strict';
-// const TYPE = require('../../types/mcdev.d');
-const File = require('./file');
-const inquirer = require('inquirer');
-const Util = require('./util');
-const commandExists = require('command-exists');
-const git = require('simple-git')();
+import File from './file.js';
+
+import inquirer from 'inquirer';
+import { Util } from './util.js';
+import commandExists from 'command-exists';
+import gitFactory from 'simple-git';
+const git = gitFactory();
 
 /**
  * CLI helper class
@@ -259,4 +260,4 @@ const Init = {
     },
 };
 
-module.exports = Init;
+export default Init;

package/lib/util/init.js

@@ -1,15 +1,15 @@
 'use strict';
-const TYPE = require('../../types/mcdev.d');
-const Cli = require('./cli');
-const File = require('./file');
-const config = require('./config');
-const InitGit = require('./init.git');
-const InitNpm = require('./init.npm');
-const InitConfig = require('./init.config');
-const inquirer = require('inquirer');
-const Util = require('./util');
-const fs = require('node:fs');
-const path = require('node:path');
+import TYPE from '../../types/mcdev.d.js';
+import Cli from './cli.js';
+import File from './file.js';
+import config from './config.js';
+import InitGit from './init.git.js';
+import InitNpm from './init.npm.js';
+import InitConfig from './init.config.js';
+import inquirer from 'inquirer';
+import { Util } from './util.js';
+import fs from 'node:fs';
+import path from 'node:path';
 
 /**
  * CLI helper class
@@ -506,4 +506,4 @@ const Init = {
     },
 };
 
-module.exports = Init;
+export default Init;

package/lib/util/init.npm.js

@@ -1,9 +1,11 @@
 'use strict';
 
-const File = require('./file');
-const path = require('node:path');
-const Util = require('./util');
-const semver = require('semver');
+import File from './file.js';
+import path from 'node:path';
+import { Util } from './util.js';
+import semver from 'semver';
+import { fileURLToPath } from 'node:url';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 /**
  * CLI helper class
@@ -79,10 +81,10 @@ const Init = {
             versionsDefault[name] = Object.keys(Util.packageJsonMcdev.dependencies).includes(name)
                 ? Util.packageJsonMcdev.dependencies[name]
                 : // then check mcdev.devDependencies
-                Object.keys(Util.packageJsonMcdev.devDependencies).includes(name)
-                ? Util.packageJsonMcdev.devDependencies[name]
-                : // fallback to using latest version if not found
-                  'latest';
+                  Object.keys(Util.packageJsonMcdev.devDependencies).includes(name)
+                  ? Util.packageJsonMcdev.devDependencies[name]
+                  : // fallback to using latest version if not found
+                    'latest';
         }
 
         const versionsProject = {};
@@ -154,4 +156,4 @@ const Init = {
     },
 };
 
-module.exports = Init;
+export default Init;

package/lib/util/util.js

@@ -1,17 +1,21 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataDefinitions = require('./../MetadataTypeDefinitions');
-const packageJsonMcdev = require('../../package.json');
-const child_process = require('node:child_process');
-const process = require('node:process');
-const toposort = require('toposort');
-const winston = require('winston');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataDefinitions from './../MetadataTypeDefinitions.js';
+import process from 'node:process';
+import toposort from 'toposort';
+import winston from 'winston';
+import child_process from 'node:child_process';
+import path from 'node:path';
+// import just to resolve cyclical - TO DO consider if could move to file or context
+import { readJsonSync } from 'fs-extra/esm';
+import { fileURLToPath } from 'node:url';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 /**
  * Util that contains logger and simple util methods
  */
-const Util = {
+export const Util = {
     authFileName: '.mcdev-auth.json',
     boilerplateDirectory: '../../boilerplate',
     configFileName: '.mcdevrc.json',
@@ -19,7 +23,7 @@ const Util = {
     standardizedSplitChar: '/',
     /** @type {TYPE.skipInteraction} */
     skipInteraction: false,
-    packageJsonMcdev: packageJsonMcdev,
+    packageJsonMcdev: readJsonSync(path.join(__dirname, '../../package.json')),
     OPTIONS: {},
     changedKeysMap: {},
     /**
@@ -390,7 +394,7 @@ const Util = {
 
         const processArgv = process.argv.slice(2);
         Util.logger.debug(
-            `:: mcdev ${packageJsonMcdev.version} :: ⚡ mcdev ${processArgv.join(' ')}`
+            `:: mcdev ${Util.packageJsonMcdev.version} :: ⚡ mcdev ${processArgv.join(' ')}`
         );
     },
     /**
@@ -801,9 +805,9 @@ const Util = {
         // \s*      whitespace characters, zero or more times
         // [^>]*?   any character that is not a >, zero or more times, un-greedily
         // (.*)     capture any character, zero or more times
-        // /ms      multiline and dotall flags
+        // /s      dotall flag
         // ideally the code looks like <script runat="server">...</script>
-        const scriptRegex = /^<\s*script [^>]*?>(.*)<\/\s*script\s*>$/ms;
+        const scriptRegex = /^<\s*script [^>]*?>(.*)<\/\s*script\s*>$/s;
         code = code.trim();
         const regexMatches = scriptRegex.exec(code);
         if (regexMatches?.length > 1) {
@@ -891,5 +895,3 @@ const Util = {
 };
 
 Util.startLogger(false, true);
-
-module.exports = Util;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mcdev",
-    "version": "5.3.0",
+    "version": "6.0.1",
     "description": "Accenture Salesforce Marketing Cloud DevTools",
     "author": "Accenture: joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
     "license": "MIT",
@@ -8,7 +8,7 @@
         "type": "git",
         "url": "https://github.com/Accenture/sfmc-devtools.git"
     },
-    "homepage": "https://github.com/Accenture/sfmc-devtools#readme",
+    "homepage": "https://github.com/Accenture/sfmc-devtools/wiki",
     "bugs": {
         "url": "https://github.com/Accenture/sfmc-devtools/issues",
         "email": "joern.berkefeld@accenture.com"
@@ -31,11 +31,17 @@
         "rest"
     ],
     "main": "./lib/index.js",
+    "exports": {
+        ".": {
+            "default": "./lib/index.js"
+        },
+        "./*": "./*.js"
+    },
     "bin": {
         "mcdev": "./lib/cli.js"
     },
     "engines": {
-        "node": ">=15.0.0"
+        "node": ">=18.16.0"
     },
     "scripts": {
         "start": "node lib/cli.js",
@@ -48,59 +54,57 @@
         "lint-lib": "eslint lib/**/*.js",
         "lint-type": "eslint types/*.js",
         "lint-test": "eslint test/**/*.js",
-        "upgrade": "npm-check --update",
         "manual-prepare": "husky install",
         "lint-and-test": "run-s lint test",
         "test": "mocha --reporter-option maxDiffSize=25000",
-        "coverage": "nyc npm run test",
+        "coverage": "c8 npm run test",
         "version:major": "npm version --no-commit-hooks major",
         "version:minor": "npm version --no-commit-hooks minor",
         "version:patch": "npm version --no-commit-hooks patch"
     },
     "dependencies": {
         "beauty-amp-core": "0.3.7",
-        "cli-progress": "3.11.2",
+        "cli-progress": "3.12.0",
         "command-exists": "1.2.9",
-        "conf": "10.2.0",
+        "conf": "11.0.1",
         "console.table": "0.10.0",
         "deep-equal": "2.2.2",
-        "fs-extra": "11.1.0",
-        "inquirer": "8.2.6",
+        "fs-extra": "11.1.1",
+        "inquirer": "9.2.6",
         "json-to-table": "4.2.1",
         "mustache": "4.2.0",
-        "p-limit": "3.1.0",
-        "prettier": "2.8.8",
-        "prettier-plugin-sql": "0.14.0",
+        "p-limit": "4.0.0",
+        "prettier": "3.1.1",
+        "prettier-plugin-sql": "0.15.1",
         "semver": "7.5.4",
-        "sfmc-sdk": "1.0.1",
-        "simple-git": "3.18.0",
+        "sfmc-sdk": "2.0.1",
+        "simple-git": "3.22.0",
         "toposort": "2.0.2",
-        "update-notifier": "5.1.0",
-        "winston": "3.10.0",
+        "update-notifier": "6.0.2",
+        "winston": "3.11.0",
         "yargs": "17.7.2"
     },
     "devDependencies": {
-        "assert": "2.0.0",
-        "axios-mock-adapter": "1.21.5",
-        "chai": "4.3.8",
+        "assert": "2.1.0",
+        "axios-mock-adapter": "1.22.0",
+        "c8": "8.0.1",
+        "chai": "4.3.10",
         "chai-files": "1.4.0",
-        "eslint": "8.48.0",
+        "eslint": "8.56.0",
         "eslint-config-prettier": "9.0.0",
         "eslint-config-ssjs": "1.1.11",
-        "eslint-plugin-jsdoc": "46.5.0",
-        "eslint-plugin-mocha": "10.1.0",
-        "eslint-plugin-prettier": "4.2.1",
-        "eslint-plugin-unicorn": "48.0.0",
-        "fast-xml-parser": "4.2.7",
+        "eslint-plugin-jsdoc": "48.0.2",
+        "eslint-plugin-mocha": "10.2.0",
+        "eslint-plugin-prettier": "5.1.2",
+        "eslint-plugin-unicorn": "50.0.1",
+        "fast-xml-parser": "4.3.2",
         "husky": "8.0.3",
         "jsdoc-to-markdown": "8.0.0",
-        "lint-staged": "14.0.1",
+        "lint-staged": "15.2.0",
         "mocha": "10.2.0",
         "mock-fs": "5.2.0",
-        "npm-check": "6.0.1",
         "npm-run-all": "4.1.5",
-        "nyc": "15.1.0",
-        "prettier-eslint": "15.0.1"
+        "prettier-eslint": "16.2.0"
     },
     "optionalDependencies": {
         "fsevents": "*"
@@ -109,5 +113,6 @@
         "*.{js,jsx,ts,tsx}": [
             "eslint --fix"
         ]
-    }
+    },
+    "type": "module"
 }

package/test/general.test.js

@@ -1,10 +1,8 @@
-const chai = require('chai');
-const chaiFiles = require('chai-files');
-const assert = chai.assert;
-const expect = chai.expect;
+import chai, { assert, expect } from 'chai';
+import chaiFiles from 'chai-files';
+import * as testUtils from './utils.js';
+import handler from '../lib/index.js';
 chai.use(chaiFiles);
-const testUtils = require('./utils');
-const handler = require('../lib/index');
 
 describe('GENERAL', () => {
     beforeEach(() => {

package/test/mockRoot/.mcdevrc.json

@@ -78,5 +78,5 @@
             "triggeredSend"
         ]
     },
-    "version": "5.3.0"
+    "version": "6.0.1"
 }