qcobjects-cli - npm Package Compare versions

Comparing version 2.4.34 to 2.4.35

package.json

 {
   "name": "qcobjects-cli",
-  "version": "2.4.34",
+  "version": "2.4.35",
   "description": "qcobjects cli command line tool",
@@ -39,2 +39,3 @@ "main": "src/index.cjs",
     "eslint-config-qcobjects": "^0.0.26",
+    "eslint-config-qcobjects-typescript": "^2.4.5",
     "eslint-config-semistandard": "^17.0.0",
@@ -47,3 +48,4 @@ "eslint-config-standard": "^17.0.0",
     "qcobjects": "^2.4.67",
-    "qcobjects-sdk": "^2.4.30"
+    "qcobjects-sdk": "^2.4.30",
+    "qcobjects-tsconfig": "^2.4.10"
   },
@@ -50,0 +52,0 @@ "peerDependencies": {

README.md

@@ -68,1 +68,2 @@ ![logo](https://qcobjects.dev/qcobjects_01.png)
 ```
+

src/org.quickcorp.qcobjects.cli.js

@@ -76,234 +76,118 @@ /**
 
-        const readline = require("readline");
+        let _package_json_content;
 
-        const rl = readline.createInterface({
-          input: process.stdin,
-          output: process.stdout
-        });
+        _package_json_content = `{
+          "name": "${appName}"
+          "version": "1.0.0",
+          "dependencies":{
+            "qcobjectsnewphp": "latest",
+            "qcobjects": "${version.qcobjects}",
+            "qcobjects-sdk": "^${version.sdk}"
+          }
+        }`;
 
-        rl.question(`Please tell me your git repository url
-[press ENTER \u{21b5} to leave it blank or Ctrl+C to cancel]:
-`, (answer) => {
-          logger.info(`your git repository url is ${answer}`);
-          rl.close();
-          let giturl = answer;
+        let createAppCommand;
+        let appTemplateName;
 
-          let createAppCommandCustom = `
-{
-      "name": "${appName.toLowerCase()}",
-      "version": "0.0.1",
-      "repository": {
-        "type": "git",
-        "url": "${giturl}"
-      },
-      "description": "This is a custom NPM template app from ${options.createCustom} generated with QCObjects.",
-      "main": "js/init.js",
-      "license": "LGPL-3.0-or-later",
-      "scripts": {
-        "test": "(npx eslint *.js js/*.js js/packages/*.js --fix) && (npx jasmine)",
-        "sync": "git add . && git commit -am ",
-        "preversion": "npm i --upgrade && npm test",
-        "postversion": "git push && git push --tags",
-        "coverage": "nyc --reporter=lcov --reporter=text-summary npm run test",
-        "start": "node app.js",
-        "build": "exit 0"
-      },
-      "dependencies": {
-        "${options.createCustom}": "latest",
-        "qcobjects": "^${version.qcobjects}",
-        "qcobjects-sdk": "^${version.sdk}"
-      },
-      "devDependencies": {
-        "eslint": "^8.2.0",
-        "eslint-config-qcobjects": "latest",
-        "jasmine": "latest",
-        "qcobjects-cli": "^${version.cli}",
-        "grunt": "^1.4.1",
-        "grunt-contrib-jasmine": "^2.0.2",
-        "nyc": "^15.1.0"
-      }
-}`;
+        if (options.createAmp){
+          appTemplateName = "qcobjects-ecommerce-amp";
+        } else if (options.createPwa){
+          appTemplateName = "qcobjectsnewapp";
+        } else if (options.createPhp){
+          appTemplateName = "qcobjectsnewphp";
+        } else if (options.createCustom){
+          appTemplateName = options.createCustom;
+        } else {
+          appTemplateName = "qcobjectsnewapp";
+        }
+        CONFIG.set("qcobjectsnewapp_path",CONFIG.get("node_modules_path")+"/"+appTemplateName);
 
-          let createAppCommandPWA = `
-{
-      "name": "${appName.toLowerCase()}",
-      "version": "0.0.1",
-      "repository": {
-        "type": "git",
-        "url": "${giturl}"
-      },
-      "description": "Awesome PWA application that will help you achieve your dreams.",
-      "main": "js/init.js",
-      "license": "LGPL-3.0-or-later",
-      "scripts": {
-        "test": "(npx eslint *.js js/*.js js/packages/*.js --fix) && (npx jasmine)",
-        "sync": "git add . && git commit -am ",
-        "preversion": "npm i --upgrade && npm test",
-        "postversion": "git push && git push --tags",
-        "coverage": "nyc --reporter=lcov --reporter=text-summary npm run test",
-        "start": "node app.js",
-        "build": "exit 0"
-      },
-      "dependencies": {
-        "qcobjectsnewapp": "latest",
-        "qcobjects": "^${version.qcobjects}",
-        "qcobjects-sdk": "^${version.sdk}"
-      },
-      "devDependencies": {
-        "eslint": "^8.2.0",
-        "eslint-config-qcobjects": "latest",
-        "jasmine": "latest",
-        "qcobjects-cli": "^${version.cli}",
-        "grunt": "^1.4.1",
-        "grunt-contrib-jasmine": "^2.0.2",
-        "nyc": "^15.1.0"
-      }
-}`;
+        let _package_json_template_fname = path.resolve(CONFIG.get("qcobjectsnewapp_path", "qcobjectsnewapp"), "./package.json");
 
-          let createAppCommandAMP = `echo
-{
-      "name": "${appName.toLowerCase()}",
-      "version": "0.0.1",
-      "repository": {
-        "type": "git",
-        "url": "${giturl}"
-      },
-      "description": "Awesome AMP application that will help you achieve your dreams.",
-      "main": "js/init.js",
-      "license": "LGPL-3.0-or-later",
-      "scripts": {
-        "test": "(npx eslint *.js js/*.js js/packages/*.js --fix) && (npx jasmine)",
-        "sync": "git add . && git commit -am ",
-        "preversion": "npm i --upgrade && npm test",
-        "postversion": "git push && git push --tags",
-        "coverage": "nyc --reporter=lcov --reporter=text-summary npm run test",
-        "start": "node app.js",
-        "build": "exit 0"
-      },
-      "dependencies": {
-        "qcobjects-ecommerce-amp": "latest",
-        "qcobjects": "^${version.qcobjects}",
-        "qcobjects-sdk": "^${version.sdk}"
-      },
-      "devDependencies": {
-        "eslint": "^8.2.0",
-        "eslint-config-qcobjects": "latest",
-        "jasmine": "latest",
-        "qcobjects-cli": "^${version.cli}",
-        "grunt": "^1.4.1",
-        "grunt-contrib-jasmine": "^2.0.2",
-        "nyc": "^15.1.0"
-      }
-}`;
+/*          if (!process.platform.toLowerCase().startsWith("win")){
+          _package_json_content = _package_json_content.replace(/(")/g, String.fromCharCode(92)+"\"");
+        }*/
+        
+        createAppCommand = "npm init -y";
+        let _package_json_file = path.resolve(CONFIG.get("projectPath"),"./package.json");
+        logger.debug("_package_json_file: "+_package_json_file);
+        logger.debug(createAppCommand);
 
-          let createAppCommandPHP = `
-{
-      "name": "${appName.toLowerCase()}",
-      "version": "0.0.1",
-      "repository": {
-          "type": "git",
-          "url": "${giturl}"
-      },
-      "description": "Awesome PHP application that will help you achieve your dreams.",
-      "main": "js/init.js",
-      "license": "LGPL-3.0-or-later",
-      "scripts": {
-        "test": "(npx eslint *.js js/*.js js/packages/*.js --fix) && (npx jasmine)",
-        "sync": "git add . && git commit -am ",
-        "preversion": "npm i --upgrade && npm test",
-        "postversion": "git push && git push --tags",
-        "coverage": "nyc --reporter=lcov --reporter=text-summary npm run test",
-        "start": "node app.js",
-        "build": "exit 0"
-      },
-      "dependencies": {
-        "qcobjectsnewphp": "latest",
-        "qcobjects": "^${version.qcobjects}",
-        "qcobjects-sdk": "^${version.sdk}"
-      },
-      "devDependencies": {
-        "eslint": "^8.2.0",
-        "eslint-config-qcobjects": "latest",
-        "jasmine": "latest",
-        "qcobjects-cli": "^${version.cli}",
-        "grunt": "^1.4.1",
-        "grunt-contrib-jasmine": "^2.0.2",
-        "nyc": "^15.1.0"
-      }
-}`;
+        exec(createAppCommand, (err, stdout, stderr) => {
+          if (err) {
+            throw Error (err.message);
+            process.exit(1);
+            return;
+          }
 
-          let createAppCommand;
-          let appTemplateName;
-          let _package_json_content;
+          exec(`npm i --save-dev ${appTemplateName}`, ()=> {
+            let _package_json_template_file = require (_package_json_template_fname);
+            _package_json_template_file.name = appName;
+            _package_json_template_file.version = "1.0.0";
+            _package_json_template_file.repository = {};
+            fs.writeFileSync(_package_json_file, JSON.stringify(_package_json_template_file,null,4));
+            logger.info("Good! App Templates was installed!");
 
-          if (options.createAmp){
-            appTemplateName = "qcobjects-ecommerce-amp";
-            _package_json_content = createAppCommandAMP;
-          } else if (options.createPwa){
-            appTemplateName = "qcobjectsnewapp";
-            _package_json_content = createAppCommandPWA;
-          } else if (options.createPhp){
-            appTemplateName = "qcobjectsnewphp";
-            _package_json_content = createAppCommandPHP;
-          } else if (options.createCustom){
-            appTemplateName = options.createCustom;
-            _package_json_content = createAppCommandCustom;
-          } else {
-            appTemplateName = "qcobjectsnewapp";
-            _package_json_content = createAppCommandPWA;
-          }
-          CONFIG.set("qcobjectsnewapp_path",CONFIG.get("node_modules_path")+"/"+appTemplateName);
-/*          if (!process.platform.toLowerCase().startsWith("win")){
-            _package_json_content = _package_json_content.replace(/(")/g, String.fromCharCode(92)+"\"");
-          }*/
-          createAppCommand = "npm init -y";
-          let _package_json_file = path.resolve(CONFIG.get("projectPath"),"./package.json");
-          logger.debug("_package_json_file: "+_package_json_file);
-          logger.debug(createAppCommand);
+            console.log(`Starting to copy files from app template ${appTemplateName} to your project...`);
+  
+            switchCommander.copyTemplate(path.resolve(findPackageNodePath(appTemplateName),appTemplateName),path.resolve(CONFIG.get("projectPath"),"./") )
+            .then(()=>{
 
-          exec(createAppCommand, (err, stdout, stderr) => {
-            if (err) {
-              logger.warn(err);
-              process.exit(1);
-              return;
-            }
-            fs.writeFile(_package_json_file, _package_json_content, err => {
-              if (err) {
-                logger.warn(err);
-                process.exit(1);
-                return;
-              }
-
-              exec("npm cache verify && npm i --save-dev --legacy-peer-deps", (err, stdout, stderr) => {
+              exec("npm uninstall "+appTemplateName+" --save && npm cache verify",(err,stdout,stderr)=>{
+                switchCommander.generateServiceWorker(appName);
+                execSync("npm install --save-dev qcobjects-cli ");
+              });
+        
+              exec("npm cache verify && npm i ", (err, stdout, stderr) => {
                 if (err) {
-                  logger.warn(err);
+                  throw Error (err.message);
                   process.exit(1);
                   return;
                 }
+  
+                logger.info("Good! Your application is done. You can play with QCObjects now!");
+                  
+                logger.info("I will create the SSL certificates now. It may take some time...");
+                exec("qcobjects-createcert",(err,stdout,stderr)=>{
+                  logger.info("Test certificates generated");
 
-                Promise.resolve(switchCommander.copyTemplate())
-                .then(()=>{
-                  logger.info("Good! Your application is getting done. You can play with QCObjects now!");
-                  logger.info("In about five seconds your server will start...");
-                  exec("qcobjects-createcert",(err,stdout,stderr)=>{
-                    logger.info("Test certificates generated");
+                  let githubService = New(Service);
+                  githubService.url= "https://raw.githubusercontent.com/QuickCorp/QCObjects/main/.gitignore";
+                  githubService.headers= {
+                    Accept: 'application/vnd.github+json',
+                    'X-GitHub-Api-Version': '2022-11-28',
+                    'User-Agent': 'qcobjects-cli'
+                  };
+                  githubService.done = ()=>{};
+                  serviceLoader(githubService)
+                  .then (({service})=> {
+                    fs.writeFileSync(path.resolve(CONFIG.get("projectPath"),"./.gitignore"),service.template);
+                    try {
+                      execSync("git init");
+                      logger.debug("Git initialized.");
+                    } catch (e){
+                      logger.debug("Could not initialize git.");
+                    }
+                  });
 
-                    exec("npm uninstall "+appTemplateName+" --save && npm cache verify",(err,stdout,stderr)=>{
-                      switchCommander.generateServiceWorker(appName);
-                    });
-
-                  }).stdout.on("data", function(data) {
-                      console.log(data);
-                  });
+                }).stdout.on("data", function(data) {
+                    console.log(data);
                 });
+  
               }).stdout.on("data", function(data) {
                   console.log(data);
               });
-
+  
+            })
+            .catch((e)=>{
+              console.log(e);
             });
-
+  
+  
           }).stdout.on("data", function(data) {
-              console.log("App generation started...");
+            console.log(data);
           });
 
+        }).stdout.on("data", function(data) {
+            console.log("App generation started...");
         });
@@ -430,59 +314,59 @@
 
-    copyTemplate(){
-      var map_files = function (pathname,callback){
-        var _filenames = function (pathname){
-          fs.readdir(pathname,{withFileTypes:true},function (err,files){
-            if (typeof files !== "undefined"){
-              files.filter((f)=>{return f.isFile();}).map((file)=>{
-                callback(pathname+"/"+file.name);
-                _filenames(pathname+"/"+file.name);
+    copyTemplate(source, dest){
+      return new Promise ((resolve, reject)=> {
+
+        const copyDir = (source, dest, exclude) => {
+          source = path.resolve(source);
+          dest = path.resolve(dest);
+          const dname = path.basename(source);
+          const dirExcluded = (exclude.includes(dname));
+
+          const isDir = (d) => {
+            return (fs.existsSync(d) && fs.statSync(d).isDirectory())?(true):(false);
+          };
+
+          const isFile = (d) => {
+            return (fs.existsSync(d) && fs.statSync(d).isFile())?(true):(false);
+          }
+
+          if (isDir(source) && !dirExcluded){
+            fs.mkdirSync(dest, {recursive:true});
+            const paths = fs.readdirSync(source, {withFileTypes:true})
+            const dirs = paths.filter(d=>d.isDirectory());
+            const files = paths.filter(f=>f.isFile());
+            (async function (paths, dirs, files, exclude){
+              files.map((f)=>{
+                const sourceFile = path.resolve(source, f.name);
+                const destFile = path.resolve(dest, f.name);
+                const fileExcluded = exclude.includes(f.name);
+                if (isFile(sourceFile) && !fileExcluded){
+                  logger.debug(`[publish:static] Copying files from ${sourceFile} to ${destFile} excluding ${exclude}...`);
+                  fs.copyFileSync(sourceFile, destFile);
+                  logger.debug(`[publish:static] Copying files from ${sourceFile} to ${destFile} excluding ${exclude}...DONE!`);
+                }
               });
-            }
-          });
-        };
-        return _filenames(pathname);
-      };
-      var map_dirnames = function (pathname,callback){
-        var _main_pathnames = [];
-        var _dirnames = function (pathname){
-          fs.readdir(pathname,{withFileTypes:true},function (err,files){
-            var _pathnames = [];
-            if (typeof files !== "undefined"){
-              files.filter((f)=>{return f.isDirectory();}).map((d)=>{
-                _pathnames.push(pathname+"/"+d.name);
-                callback(pathname+"/"+d.name);
-                _dirnames(pathname+"/"+d.name);
+              dirs.map((d)=>{
+                const sourceDir = path.resolve(source, d.name);
+                const destDir = path.resolve(dest, d.name);
+                copyDir(sourceDir,destDir, exclude);
               });
-            }
-            _main_pathnames = _main_pathnames.concat(_pathnames);
-          });
-          return _main_pathnames;
+            })(paths, dirs, files, exclude);
+          }
+
         };
-        return _dirnames(pathname);
-      };
-      var relativePath = function (dirname){
-        return dirname.replace(CONFIG.get("qcobjectsnewapp_path"),".");
-      };
-      var copyTemplateFile = function (sourceFileName, destFileName){
-        fs.copyFile(sourceFileName, destFileName, (err) => {
-          if (err) throw err;
-          logger.debug("File "+destFileName+" was created successfully");
-        });
-      };
-      map_dirnames(CONFIG.get("qcobjectsnewapp_path"),(dirname)=>{
-        logger.info("Creating path: "+relativePath(dirname));
-        fs.mkdir(relativePath(dirname),()=>{
-          map_files(dirname,(filename)=>{
-            logger.debug("Creating file: "+relativePath(filename));
-            copyTemplateFile(filename,relativePath(filename));
-          });
-        });
-      });
-      map_files(CONFIG.get("qcobjectsnewapp_path"),(filename)=>{
-        if (!["./package.json",
-              "./package-lock.json",
-              "./sw.js"].includes(relativePath(filename))){
-          logger.info("Creating file: "+relativePath(filename));
-          copyTemplateFile(filename,relativePath(filename));
+
+        try {
+          const exclude = [
+            "package.json",
+            "node_modules",
+            ".DS_Store"
+          ]
+          logger.info(`[create] Copying files from ${source} to ${dest} excluding ${exclude}...`);
+          copyDir(source, dest, (typeof exclude !== "undefined") ? (exclude) : ([]));
+          resolve();
+        } catch (e) {
+          logger.warn(`Something went wrong trying to publish static files: ${e.message}`);
+          reject(e);
         }
+        
       });
@@ -489,0 +373,0 @@

src/org.quickcorp.qcobjects.defaultsettings.js

@@ -187,4 +187,26 @@ /**
   const path = require("path");
+  const fs = require ("fs");
   const projectPath = CONFIG.get("projectPath", `${process.cwd()}/`);
   logger.debug(`CONFIG.projectPath is set to ${projectPath}`);
+  const findPath = (p) => {
+    const packagePath = path.resolve(findPackageNodePath(p), p);
+    return packagePath;
+  };
+
+  const getPackageJSON = (p) => {
+    let _json;
+    try {
+      let packagePath = findPath(p);
+      if (typeof packagePath !== "undefined"){
+        _json = JSON.parse(fs.readFileSync(path.resolve(`${packagePath}`,"./package.json")).toString());
+      } else {
+        _json = {};
+      }
+    } catch (e){
+      logger.debug(`It was impossible to get the package.json from ${p}: ${e}`);
+      _json = {}
+    }
+    return _json;
+  };
+
   const hasKeyword = (p, keyword) => {
@@ -194,7 +216,8 @@ if (typeof hasKeyword.keywords === "undefined"){
     }
-    if (typeof hasKeyword.keywords[p] === "undefined"){
-      const {
-        keywords
-      } = require(`${findPackageNodePath(p)}/${p}/package.json`);
-      hasKeyword.keywords[p] = keywords;
+    try {
+      if (typeof hasKeyword.keywords[p] === "undefined"){
+        hasKeyword.keywords[p] = getPackageJSON(p).keywords;
+      }  
+    } catch (e){
+      throw Error (`Something went wrong when trying to get the keywords of ${p}`);
     }
@@ -206,3 +229,3 @@ return typeof hasKeyword.keywords[p] !== "undefined" && hasKeyword.keywords[p].includes(keyword);
     if (typeof dependencies.deps === "undefined"){
-      dependencies.deps = Object.keys(require(`${projectPath}/package.json`).dependencies);
+      dependencies.deps = Object.keys(JSON.parse(fs.readFileSync(path.resolve(`${projectPath}`,"./package.json")).toString()).dependencies);
     }
@@ -212,2 +235,9 @@ return dependencies.deps;
 
+  const devDependencies = () => {
+    if (typeof devDependencies.deps === "undefined"){
+      devDependencies.deps = Object.keys(JSON.parse(fs.readFileSync(path.resolve(`${projectPath}`,"./package.json")).toString()).devDependencies);
+    }
+    return devDependencies.deps;
+  };
+
   const loadLibs = () => {
@@ -219,3 +249,3 @@ let _ret_;
         logger.debug(`Plugin Libs found: ${libs}`);
-        _ret_ = Promise.all(libs.map((p) => {return Import(p);})).then(() => logger.info("Libs loaded"));
+        _ret_ = Promise.all(libs.map((p) => {return require(findPath(p));})).then(() => logger.info("Libs loaded"));
       } else {
@@ -237,3 +267,3 @@ logger.debug("No Plugin Libs found.");
         logger.debug(`Plugin Handlers found: ${handlers}`);
-        _ret_ = Promise.all(handlers.map((p) => {return Import(p);})).then(() => logger.info("Handlers loaded"));
+        _ret_ = Promise.all(handlers.map((p) => {return require(findPath(p));})).then(() => logger.info("Handlers loaded"));
       } else {
@@ -256,3 +286,3 @@ logger.debug("No Plugin Handlers found.");
         logger.debug(`Plugin Commands found: ${commands}`);
-        _ret_ = Promise.all(commands.map((p) => {return Import(p);})).then(() => logger.info("Commands loaded"));  
+        _ret_ = Promise.all(commands.map((p) => {return require(findPath(p));})).then(() => logger.info("Commands loaded"));  
       } else {
@@ -268,2 +298,21 @@ logger.debug("No Plugin Commands found.");
   };
+  const loadDevCommands = () => {
+    let _ret_;
+    logger.debug(`Looking for custom commands as dev dependencies in: ${projectPath}/package.json`);
+    if (CONFIG.get("autodiscover", false) || CONFIG.get("autodiscover_commands", false)) {
+      const commands = devDependencies().filter((p) => hasKeyword(p, "qcobjects-command"));
+      if (commands.length>0){
+        logger.debug(`Dev Plugin Commands found: ${commands}`);
+        _ret_ = Promise.all(commands.map((p) => {return require(findPath(p));})).then(() => logger.info("Commands loaded"));  
+      } else {
+        logger.debug("No Plugin Commands found in dev dependencies.");
+        _ret_ = Promise.resolve();
+      }
+    } else {
+      logger.debug("To load commands, set autodiscover_commands to true in your config.json");
+      _ret_ = Promise.resolve();
+    }
+    return _ret_;
+  };
+
   if (CONFIG.get("autodiscover", false) ||
@@ -300,3 +349,10 @@ CONFIG.get("autodiscover_libs", false) ||
   }
+  try {
+    logger.debug("Loading Dev Commands...");
+    loadDevCommands();
+  } catch (e) {
+    throw Error(`Something went wrong trying to load Dev commands: ${e.message}`);
+  }
+
   logger.info("Dependencies loaded");
 })();

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Improved metrics

Number of package files

52

increased by4%

Number of lines in readme file

69

increased by1.47%

Number of medium supply chain risk alerts

15

decreased by-6.25%

Worsened metrics

Total package byte prevSize

195680

decreased by-0.54%

Dev dependency count

17

increased by13.33%

Lines of code

4374

decreased by-1.71%

Number of low supply chain risk alerts

62

increased by6.9%

No dependency changes