qa-control 0.6.0 → 0.6.2

package/README.md

@@ -6,10 +6,9 @@ Quality assurance tool for node/npm projects
 ![extending](https://img.shields.io/badge/stability-extending-orange.svg)
 [![npm-version](https://img.shields.io/npm/v/qa-control.svg)](https://npmjs.org/package/qa-control)
 [![downloads](https://img.shields.io/npm/dm/qa-control.svg)](https://npmjs.org/package/qa-control)
-[![build](https://github.com/codenautas/qa-control/workflows/node.js.yml/badge.svg)](https://github.com/codenautas/qa-control/workflows/node.js.yml)
+[![build](https://github.com/codenautas/qa-control/actions/workflows/node.js.yml/badge.svg)](https://github.com/codenautas/qa-control/actions/workflows/node.js.yml)
 [![coverage](https://img.shields.io/coveralls/codenautas/qa-control/master.svg)](https://coveralls.io/r/codenautas/qa-control)
-[![climate](https://img.shields.io/codeclimate/github/codenautas/qa-control.svg)](https://codeclimate.com/github/codenautas/qa-control)
-[![dependencies](https://img.shields.io/david/codenautas/qa-control.svg)](https://david-dm.org/codenautas/qa-control)
+[![dependencies](https://snyk.io/test/github/codenautas/qa-control/badge.svg)](https://snyk.io/test/github/codenautas/qa-control)
 [![qa-control](http://codenautas.com/github/codenautas/qa-control.svg)](http://codenautas.com/github/codenautas/qa-control)
 
 

package/bin/definition/definition.js

@@ -2,7 +2,6 @@
 
 var stripBom = require("strip-bom-string");
 var semver = require("semver");
-var jsh = require('jshint');
 var esl = require('eslint');
 var eslintLinter = new esl.Linter();
 function eslintrcToFlatConfig(rc) {
@@ -10,7 +9,7 @@ function eslintrcToFlatConfig(rc) {
     if (rc.rules) { flat.rules = rc.rules; }
     var sourceType = (rc.env && rc.env.node) ? 'commonjs' : 'script';
     flat.languageOptions = { ecmaVersion: 'latest', sourceType: sourceType };
-    flat.linterOptions = { reportUnusedDisableDirectives: 'off' };
+    flat.linterOptions = { reportUnusedDisableDirectives: false };
     return flat;
 }
 var multilang = require('multilang');
@@ -18,6 +17,20 @@ var fs = require('fs-promise');
 var Path = require('path');
 var yaml = require('js-yaml');
 
+/** @param {string} realRegex */
+function softRegExp(realRegex) {
+    var re=realRegex.replace(/\\/g, '\\\\')
+                    .replace(/\s*(=+)\s*/g,'\\s*$1\\s*')
+                    .replace(/ /g, '\\s+')
+                    .replace(/\(/g, '\\(')
+                    .replace(/\)/g, '\\)');
+    return new RegExp(re, 'im');
+}
+
+/**
+ * @param {object} qaControl
+ * @returns {QADefinition}
+ */
 module.exports = function(qaControl){
     return {
         fileNameMainDoc: 'LEEME.md',
@@ -53,7 +66,6 @@ module.exports = function(qaControl){
                     return !!packageJson['qa-control']["test-appveyor"];
                 }
             },
-            '.jshintrc':{ presentIf: function(pj) { return pj['qa-control'] && pj['qa-control'].profile !== 'minimum'; } },
             '.eslintrc.yml':{ presentIf: function(pj) { return pj['qa-control'] && pj['qa-control'].profile !== 'minimum'; } }
         },
         cucardas:{
@@ -119,7 +131,7 @@ module.exports = function(qaControl){
                 check: function(packageJson){
                     return !packageJson['qa-control']['test-appveyor'];
                 },
-                md:'[![build](https://github.com/xxx/yyy/workflows/node.js.yml/badge.svg)](https://github.com/xxx/yyy/workflows/node.js.yml)',
+                md:'[![build](https://github.com/xxx/yyy/actions/workflows/node.js.yml/badge.svg)](https://github.com/xxx/yyy/actions/workflows/node.js.yml)',
                 imgExample:'https://raw.githubusercontent.com/codenautas/codenautas/master/img/medalla-ejemplo-linux.png',
                 docDescription: 'linux/build'
             },
@@ -127,7 +139,7 @@ module.exports = function(qaControl){
                 check: function(packageJson){
                     return !!packageJson['qa-control']['test-appveyor'];
                 },
-                md:'[![linux](https://github.com/xxx/yyy/workflows/node.js.yml/badge.svg)](https://github.com/xxx/yyy/workflows/node.js.yml)',
+                md:'[![linux](https://github.com/xxx/yyy/actions/workflows/node.js.yml/badge.svg)](https://github.com/xxx/yyy/actions/workflows/node.js.yml)',
                 imgExample:'https://raw.githubusercontent.com/codenautas/codenautas/master/img/medalla-ejemplo-linux.png',
                 hideInManual: true,
             },
@@ -147,14 +159,6 @@ module.exports = function(qaControl){
                 imgExample:'https://raw.githubusercontent.com/codenautas/codenautas/master/img/coverage.png',
                 docDescription: ''
             },
-            climate:{
-                check: function(packageJson){
-                    return packageJson['qa-control'].coverage || ! packageJson['qa-control'].purpose;
-                },
-                md:'[![climate](https://img.shields.io/codeclimate/github/xxx/yyy.svg)](https://codeclimate.com/github/xxx/yyy)',
-                imgExample:'https://raw.githubusercontent.com/codenautas/codenautas/master/img/climate.png',
-                docDescription: ''
-            },
             dependencies:{
                 mandatory:true,
                 md:'[![dependencies](https://snyk.io/test/github/xxx/yyy/badge.svg)](https://snyk.io/test/github/xxx/yyy)',
@@ -165,17 +169,15 @@ module.exports = function(qaControl){
                 mandatory:false,
                 md:'[![qa-control](http://codenautas.com/github/xxx/yyy.svg)](http://codenautas.com/github/xxx/yyy)',
                 docDescription: ''
+            },
+            'outdated-deps':{
+                forbidden:true
+            },
+            'climate':{
+                forbidden:true
             }
         },
         customs:{
-            softRegExp:function(realRegex) {
-                var re=realRegex.replace(/\\/g, '\\\\')
-                                .replace(/\s*(=+)\s*/g,'\\s*$1\\s*')
-                                .replace(/ /g, '\\s+')
-                                .replace(/\(/g, '\\(')
-                                .replace(/\)/g, '\\)');
-                return new RegExp(re, 'im');
-            },
             funtion_eid:{
                 detect:'function eid',
                 match:'function eid(id){ return document.getElementById(id); }'
@@ -190,7 +192,6 @@ module.exports = function(qaControl){
                 match:"var Path = require('path');"
             }
         },
-        jshint_options: { "asi": false, "curly": true, "forin": true },
         eslint_options: {
             "env": {
               "node": false
@@ -353,9 +354,13 @@ module.exports = function(qaControl){
                          /*jshint forin: false */
                         for(var nombreCucarda in cucardas) {
                             var cucarda = cucardas[nombreCucarda];
-                            var cucaID = '!['+/!\[([-a-z]+)]/.exec(cucarda.md)[1]+']';
-                            var cucaStr = cucarda.md.replace(/\bxxx\b/g,repo).replace(/\byyy\b/g,modulo);
-                            if(readme.indexOf(cucaID) === -1) {
+                            var cucaID = cucarda.forbidden ? '!['+nombreCucarda+']' : '!['+/!\[([-a-z]+)]/.exec(cucarda.md)[1]+']';
+                            var cucaStr = cucarda.md ? cucarda.md.replace(/\bxxx\b/g,repo).replace(/\byyy\b/g,modulo) : '';
+                            if(cucarda.forbidden) {
+                                if(readme.indexOf(cucaID) !== -1) {
+                                    warns.push({warning:'forbidden_cucarda_1', params:[nombreCucarda], scoring:{cucardas:1}});
+                                }
+                            } else if(readme.indexOf(cucaID) === -1) {
                                 if(cucarda.mandatory) {
                                     warns.push({warning:'lack_of_mandatory_cucarda_1', params:[nombreCucarda], scoring:{cucardas:1}});
                                 }
@@ -396,7 +401,7 @@ module.exports = function(qaControl){
                                     if(isMatchFunc) {
                                         return str.indexOf(strOrRegexp) !== -1;
                                     } else {
-                                        return customs.softRegExp(strOrRegexp).test(str);
+                                        return softRegExp(strOrRegexp).test(str);
                                     }
                                 };
                             }
@@ -481,35 +486,6 @@ module.exports = function(qaControl){
                     }
                 }]
             },
-            jshint:{
-                eclipsers:['packagejson_main_file_1_does_not_exists', 'first_lines_does_not_match_in_file_1'],
-                mandatory:false,
-                checks:[{
-                    warnings:function(info){
-                        if(info.packageJson['qa-control'] && info.packageJson['qa-control'].profile === 'minimum') { return []; }
-                        var warns = [];
-                        var jshintOpts = JSON.parse(info.files['.jshintrc'].content);
-                        for(var file in info.files) {
-                            if(file.match(/(.js)$/)) {
-                                var content = info.files[file].content;
-                                jsh.JSHINT(content, jshintOpts , false);
-                                var data = jsh.JSHINT.data();
-                                if(data.errors) {
-                                    if(qaControl.verbose){
-                                        console.log('JSHINT output:');
-                                        console.log('jshintOpts',jshintOpts);
-                                        console.log('There are '+data.length+ " JSHINT errors");
-                                        console.log(data.errors);
-                                        //console.log(data);
-                                    }
-                                    warns.push({warning:'jshint_warnings_in_file_1', params:[file], scoring:{jshint:1}});
-                                }
-                            }
-                        }
-                        return warns;
-                    }
-                }]
-            },
             eslint:{
                 eclipsers:['packagejson_main_file_1_does_not_exists', 'first_lines_does_not_match_in_file_1'],
                 checks:[{
@@ -520,7 +496,7 @@ module.exports = function(qaControl){
                         for(var file in info.files) {
                             if(file.match(/(.js)$/)) {
                                 var content = info.files[file].content;
-                                var data = eslintLinter.verify(content, eslintOpts);
+                                var data = eslintLinter.verify(content || '', eslintOpts);
                                 if(data.length) {
                                     if(qaControl.verbose){
                                         console.log('ESLINT output:');
@@ -574,7 +550,8 @@ module.exports = function(qaControl){
                         for(var file in info.files) {
                             if(file.match(/(.js)$/)) {
                                 var content = info.files[file].content;
-                                var lines = info.files[file].content.split(/\r?\n/);
+                                if(content === undefined) { continue; }
+                                var lines = content.split(/\r?\n/);
                                 var prevLine = null;
                                 for(var l=0; l<lines.length; ++l) {
                                     var line = lines[l];
@@ -647,9 +624,6 @@ module.exports = function(qaControl){
                 checks:[{
                     warnings:function(info) {
                         var warns = [];
-                        if('jshintConfig' in info.packageJson) {
-                            warns.push({warning:'unexpected_jshintconfig_section_in_package_json', scoring:{conventions:1}});
-                        }
                         if('eslintConfig' in info.packageJson) {
                             warns.push({warning:'unexpected_eslintconfig_section_in_package_json', scoring:{conventions:1}});
                         }
@@ -661,12 +635,12 @@ module.exports = function(qaControl){
                 checks:[{
                     warnings:function(info) {
                         var warns = [];
-                        var nonRecomended = ['best-promise', 'lodash', 'promise-plus'];
+                        var nonRecomended = ['best-promise', 'eslint', 'lodash', 'promise-plus'];
                         var dependencies = info.packageJson.dependencies;
                         var devDependencies = info.packageJson.devDependencies;
                         if(dependencies) {
                             nonRecomended.forEach(function(badDep) {
-                                if(badDep in dependencies || badDep in devDependencies) {
+                                if(badDep in (dependencies||{}) || (devDependencies && badDep in devDependencies)) {
                                     warns.push({warning:'non_recomended_dependency_1_in_package_json', params:[badDep], scoring:{dependencies:1}});
                                 }
                             });

package/bin/qa-control-run.js

@@ -9,7 +9,7 @@ var fs = require('fs-promise');
 var path = require('path');
 
 program
-    .version(require('../package').version)
+    .version(require('../package.json').version)
     .argument('[projectDirectory]', 'Project directory to check')
     .usage('[[options] projectDirectory|--list-langs]')
     .option('-l, --lang [lang]', 'Language to generate')
@@ -21,7 +21,7 @@ program
 
 var opts = program.opts();
 
-if( ( !opts.init && !opts.listLangs && (""==program.args && !opts.projectDir))
+if( ( !opts.init && !opts.listLangs && (program.args.length===0 && !opts.projectDir))
     || (opts.lang && false === opts.lang in qaControl.msgs) )
 {
     program.help();

package/bin/qa-control.js

@@ -41,16 +41,14 @@ qaControl.msgs={
         lack_of_cucarda_marker_in_readme:'falta la sección "cucardas" en README.md',
         lack_of_mandatory_cucarda_1: 'falta la cucarda oblicatoria $1',
         wrong_format_in_cucarda_1: 'la cucarda "$1" tiene formato incorrecto',
+        forbidden_cucarda_1: 'la cucarda "$1" no debe usarse en README.md',
         lack_of_mandatory_line_1_in_file_2: 'falta la linea obligatoria $1 en el archivo $2',
         file_1_does_not_match_custom_2: '$1 no respeta la custombre $2',
         first_lines_does_not_match_in_file_1: 'las primeras líneas no coinciden en $1',
         repository_name_not_found: 'packageJson.repository no tiene el formato /{[-a-zA-Z0-9_.]+}\/[-a-zA-Z0-9_.]+/',
         using_normal_promise_in_file_1: 'se han usado Promise(s) normales en "$1"',
         packagejson_main_file_1_does_not_exists: 'no existe el archivo "main" ($1) declarado en package.json',
-        jshint_warnings_in_file_1: 'el archivo "$1" tiene warnings de JSHint',
         eslint_warnings_in_file_1: 'el archivo "$1" tiene warnings de ESLint',
-        lack_of_jshintconfig_section_in_package_json: 'falta la sección "jshintConfig" en package.json',
-        incorrect_jshintconfig_option_1_in_package_json: 'la opcion "$1" en "jshintConfig" es incorrecta en package.json',
         readme_multilang_not_sincronized_with_file_1: 'README.md no esta sincronizado con "$1" para multilang',
         lack_of_repository_section_in_package_json: 'Falta la sección "repository" en package.json',
         invalid_repository_section_in_package_json: 'La sección "repository" en package.json es inválida',
@@ -59,7 +57,6 @@ qaControl.msgs={
         lack_of_files_section_in_package_json: 'Falta la sección "files" en package.json',
         invalid_files_section_in_package_json: 'La sección "files" en package.json es inválida',
         incorrect_ecmascript_versions_in_package_json: 'Las versiones de ECMAScript utilizadas en package.json son incorrectas',
-        unexpected_jshintconfig_section_in_package_json: 'No se esperaba la sección jshintConfig en package.json',
         non_recomended_dependency_1_in_package_json: 'Dependencia no recomendada "$1" en package.json'
     }
 };
@@ -120,6 +117,7 @@ qaControl.generateCucardas = function generateCucardas(cucardas, packageJson) {
     /*eslint-disable guard-for-in */
     for(var nombreCucarda in cucardas) {
         var cucarda = cucardas[nombreCucarda];
+        if(cucarda.forbidden) { continue; }
         if(!cucarda.check || cucarda.check(packageJson)) {
             var cucaStr = cucarda.md.replace(/\bxxx\b/g,repo).replace(/\byyy\b/g,modulo);
             cucaFileContent += cucaStr +'\n';
@@ -239,7 +237,7 @@ var configReading=(function(){
 });
 
 qaControl.loadProject = function loadProject(projectDir) {
-    var info = {projectDir:projectDir};
+    var info = /** @type {ProjectInfo} */ ({projectDir:projectDir});
     var cmsgs = qaControl.cmdMsgs[qaControl.lang];
     if(qaControl.verbose) { process.stdout.write(cmsgs.msg_starting+projectDir+"'...\n"); }
     return Promise.resolve().then(function(){
@@ -266,7 +264,7 @@ qaControl.loadProject = function loadProject(projectDir) {
          /*jshint forin: true */
          /*eslint-enable guard-for-in */
         if(files.indexOf('package.json') !== -1) {
-            info.packageJson = {};
+            info.packageJson = /** @type {PackageJson} */ ({});
         }
         return Promise.all(files.map(function(file){
             var iFile = Path.normalize(projectDir+'/'+file);
@@ -318,7 +316,7 @@ qaControl.controlInfo=function controlInfo(info, opts){
     var cmsgs = qaControl.cmdMsgs[qaControl.lang];
     var rules = qaControl.definition.rules;
     var silenced = ((info.packageJson || {})['qa-control'] || {}).silenced || [];
-    var cadenaDePromesas = Promise.resolve().then();
+    var cadenaDePromesas = Promise.resolve(/** @type {Warning[]} */ ([]));
     info.scoring = opts && opts.scoring;
     forEach(rules, function(rule, ruleName) {
         rule.checks.forEach(function(checkInfo){
@@ -364,7 +362,7 @@ qaControl.stringizeWarnings = function stringizeWarnings(warns, lang) {
             if(numParams) {
                 //console.log(warn.warning, msg, " tiene ", numParams.length, " parametros y params tiene ", warn.params)
                  for(var p=0; p<numParams.length; ++p) {
-                    msg = msg.replace('$'+parseInt(p+1,10), warn.params[p]);
+                    msg = msg.replace('$'+(p+1), warn.params[p]);
                 }
             }
             if(qaControl.verbose) {

package/bin/qac-init.js

@@ -102,7 +102,7 @@ qacInit.ask = function ask(param, msgs, callback) {
     stdin.resume();
     var prompt = param.prompt || param.name.substring(0,1).toUpperCase()+param.name.substring(1);
     stdout.write(prompt+def+ ": ");
-    stdin.once('data', function(data) {
+    stdin.once('data', function(/** @type {any} */ data) {
         data = data.toString().trim();
         if(data === '') { data = param.def; }
         if((param.valid && param.valid(data)) || (! param.valid  && data !== '')) {
@@ -254,7 +254,7 @@ qacInit.configParams = [
         },
         post: function(ctx) {
             var contributors = ctx.input.existingJson.contributors || [];
-            var nae = this.parseNE(ctx.result[this.name]);
+            var nae = /** @type {{name: string, email: string}} */ (this.parseNE(ctx.result[this.name]));
             contributors.push({'name':nae.name, 'email':nae.email});
             return contributors.length ? contributors : null;
         },
@@ -293,8 +293,8 @@ qacInit.init = function init(initParams) {
     var inputParams;
     var tplData = {
         vars: {},
-        tpls: [],
-        other: []
+        tpls: /** @type {string[]} */ ([]),
+        other: /** @type {string[]} */ ([])
     };
     var packageJS;
     return qacInit.initDefaults(initParams).then(function(initResult) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "qa-control",
   "description": "QA control of things that nobody controls",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "author": "Codenautas <codenautas@googlegroups.com>",
   "license": "MIT",
   "repository": "codenautas/qa-control",
@@ -19,25 +19,31 @@
     "qa-control": "./bin/qa-control-run.js"
   },
   "main": "./bin/qa-control.js",
+  "overrides": {
+    "diff": ">=8.0.2",
+    "serialize-javascript": ">=7.0.0",
+    "uuid": ">=14.0.0"
+  },
   "dependencies": {
-    "commander": "~14.0.3",
-    "eslint": "~10.3.0",
-    "fs-extra": "~11.3.5",
-    "fs-promise": "~2.0.3",
-    "js-yaml": "~4.1.1",
-    "jshint": "~2.13.6",
-    "parameters": "~0.8.1",
-    "semver": "~7.8.0",
-    "strip-bom-string": "~1.0.0",
-    "best-globals": "~2.1.3",
-    "multilang": "~1.2.0"
+    "best-globals": "^2.1.4",
+    "commander": "^14.0.3",
+    "eslint": "^10.3.0",
+    "fs-extra": "^11.3.5",
+    "fs-promise": "^2.0.3",
+    "js-yaml": "^4.1.1",
+    "multilang": "^1.2.1",
+    "semver": "^7.8.0",
+    "strip-bom-string": "^1.0.0"
   },
   "devDependencies": {
-    "expect.js": "~0.3.1",
-    "istanbul": "~0.4.5",
-    "mocha": "~11.7.5",
-    "sinon": "~22.0.0",
-    "expect-called": "~0.4.0"
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^25.7.0",
+    "expect-called": "^0.4.0",
+    "expect.js": "^0.3.1",
+    "mocha": "^11.7.5",
+    "nyc": "^18.0.0",
+    "sinon": "^22.0.0",
+    "typescript": "^6.0.3"
   },
   "engines": {
     "node": ">= 10"
@@ -45,11 +51,12 @@
   "scripts": {
     "test": "mocha --reporter spec --bail --check-leaks test/",
     "test-nc": "mocha --reporter spec --bail --check-leaks --no-colors test/",
-    "test-ci": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter spec --check-leaks test/",
-    "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot --check-leaks test/",
+    "test-ci": "nyc --reporter=lcov mocha --reporter spec --check-leaks test/",
+    "test-cov": "nyc mocha --reporter dot --check-leaks test/",
     "start": "node example/server.js",
-    "report": "istanbul report",
+    "report": "nyc report",
     "qac": "node bin/qa-control-run.js . -v",
+    "typecheck": "tsc",
     "all": "npm test && npm run test-cov && npm run report && npm run qac"
   },
   "files": [