qa-control 0.6.2 → 0.6.4

package/README.md

@@ -6,10 +6,10 @@ 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/actions/workflows/node.js.yml/badge.svg)](https://github.com/codenautas/qa-control/actions/workflows/node.js.yml)
+[![build](https://github.com/codenautas/qa-control/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/codenautas/qa-control/actions/workflows/build-and-test.yml)
 [![coverage](https://img.shields.io/coveralls/codenautas/qa-control/master.svg)](https://coveralls.io/r/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)
+[![qa-control](https://github.com/codenautas/qa-control/actions/workflows/qa-control.yml/badge.svg)](https://github.com/codenautas/qa-control/actions/workflows/qa-control.yml)
 
 
 

package/bin/definition/definition.js

@@ -17,6 +17,15 @@ var fs = require('fs-promise');
 var Path = require('path');
 var yaml = require('js-yaml');
 
+/**
+ * 
+ * @param {PackageJson} packageJson 
+ * @returns boolean
+ */
+function testAppVeyor(packageJson){
+    return !!packageJson?.['qa-control']?.["test-appveyor"];
+}
+
 /** @param {string} realRegex */
 function softRegExp(realRegex) {
     var re=realRegex.replace(/\\/g, '\\\\')
@@ -55,30 +64,28 @@ module.exports = function(qaControl){
         },
         files:{
             'README.md':{ mandatory:true },
-            'LEEME.md':{ mandatory:true },
+            'LEEME.md':{ presentIf: function(pj) { return !(pj['qa-control'] && pj['qa-control'].multilang === 'no'); } },
             '.gitignore':{
                 mandatory:true,
                 mandatoryLines:['local-*','*-local.*']
             },
             'LICENSE':{ mandatory:true },
             'appveyor.yml':{
-                presentIf:function(packageJson){
-                    return !!packageJson['qa-control']["test-appveyor"];
-                }
+                presentIf: testAppVeyor
             },
             '.eslintrc.yml':{ presentIf: function(pj) { return pj['qa-control'] && pj['qa-control'].profile !== 'minimum'; } }
         },
         cucardas:{
             'proof-of-concept':{
                 check: function(packageJson){
-                    return packageJson['qa-control'].purpose==='proof-of-concept';
+                    return packageJson?.['qa-control']?.purpose==='proof-of-concept';
                 },
                 md:'![proof-of-concept](https://img.shields.io/badge/stability-proof_of_concept-ff70c0.svg)',
                 imgExample:'https://img.shields.io/badge/stability-designing-red.svg'
             },
             designing:{
                 check: function(packageJson){
-                    return semver.satisfies(packageJson.version,'0.0.x') && !packageJson['qa-control'].purpose;
+                    return semver.satisfies(packageJson.version,'0.0.x') && !packageJson?.['qa-control']?.purpose;
                 },
                 md:'![designing](https://img.shields.io/badge/stability-designing-red.svg)',
                 imgExample:'https://img.shields.io/badge/stability-designing-red.svg',
@@ -88,7 +95,7 @@ module.exports = function(qaControl){
                 check: function(packageJson){
                     return semver.satisfies(packageJson.version,'0.x.x') &&
                             !semver.satisfies(packageJson.version,'0.0.x') &&
-                            !packageJson['qa-control'].purpose;
+                            !packageJson?.['qa-control'].purpose;
                 },
                 md:'![extending](https://img.shields.io/badge/stability-extending-orange.svg)',
                 imgExample:'https://img.shields.io/badge/stability-extending-orange.svg',
@@ -96,21 +103,21 @@ module.exports = function(qaControl){
             },
             training:{
                 check: function(packageJson){
-                    return packageJson['qa-control'].purpose==='training';
+                    return packageJson?.['qa-control']?.purpose==='training';
                 },
                 md:'![training](https://img.shields.io/badge/stability-training-ffa0c0.svg)',
                 imgExample:'https://img.shields.io/badge/stability-training-ffa0c0.svg'
             },
             example:{
                 check: function(packageJson){
-                    return packageJson['qa-control'].purpose==='example';
+                    return packageJson?.['qa-control']?.purpose==='example';
                 },
                 md:'![example](https://img.shields.io/badge/stability-example-a0a0f0.svg)',
                 imgExample:'https://img.shields.io/badge/stability-example-a0a0f0.svg'
             },
             stable:{
                 check: function(packageJson){
-                    return semver.satisfies(packageJson.version,'>=1.0.0') && !packageJson['qa-control'].purpose;
+                    return semver.satisfies(packageJson.version,'>=1.0.0') && !packageJson?.['qa-control']?.purpose;
                 },
                 md:'![stable](https://img.shields.io/badge/stability-stable-blue.svg)',
                 imgExample:'https://img.shields.io/badge/stability-stable-blue.svg'
@@ -128,32 +135,26 @@ module.exports = function(qaControl){
                 docDescription: ''
             },
             build:{
-                check: function(packageJson){
-                    return !packageJson['qa-control']['test-appveyor'];
-                },
-                md:'[![build](https://github.com/xxx/yyy/actions/workflows/node.js.yml/badge.svg)](https://github.com/xxx/yyy/actions/workflows/node.js.yml)',
+                check: (...args) => !testAppVeyor(...args),
+                md:'[![build](https://github.com/xxx/yyy/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/xxx/yyy/actions/workflows/build-and-test.yml)',
                 imgExample:'https://raw.githubusercontent.com/codenautas/codenautas/master/img/medalla-ejemplo-linux.png',
                 docDescription: 'linux/build'
             },
             linux:{
-                check: function(packageJson){
-                    return !!packageJson['qa-control']['test-appveyor'];
-                },
-                md:'[![linux](https://github.com/xxx/yyy/actions/workflows/node.js.yml/badge.svg)](https://github.com/xxx/yyy/actions/workflows/node.js.yml)',
+                check: testAppVeyor,
+                md:'[![linux](https://github.com/xxx/yyy/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/xxx/yyy/actions/workflows/build-and-test.yml)',
                 imgExample:'https://raw.githubusercontent.com/codenautas/codenautas/master/img/medalla-ejemplo-linux.png',
                 hideInManual: true,
             },
             windows:{
-                check: function(packageJson){
-                    return !!packageJson['qa-control']['test-appveyor'];
-                },
+                check: testAppVeyor,
                 md:'[![windows](https://ci.appveyor.com/api/projects/status/github/xxx/yyy?svg=true)](https://ci.appveyor.com/project/xxx/yyy)',
                 imgExample:'https://ci.appveyor.com/api/projects/status/github/codenautas/pg-promise-strict?svg=true',
                 docDescription: 'casos especiales'
             },
             coverage:{
                 check: function(packageJson){
-                    return packageJson['qa-control'].coverage;
+                    return packageJson?.['qa-control']?.coverage;
                 },
                 md:'[![coverage](https://img.shields.io/coveralls/xxx/yyy/master.svg)](https://coveralls.io/r/xxx/yyy)',
                 imgExample:'https://raw.githubusercontent.com/codenautas/codenautas/master/img/coverage.png',
@@ -167,7 +168,7 @@ module.exports = function(qaControl){
             },
             'qa-control':{
                 mandatory:false,
-                md:'[![qa-control](http://codenautas.com/github/xxx/yyy.svg)](http://codenautas.com/github/xxx/yyy)',
+                md:'[![qa-control](https://github.com/xxx/yyy/actions/workflows/qa-control.yml/badge.svg)](https://github.com/xxx/yyy/actions/workflows/qa-control.yml)',
                 docDescription: ''
             },
             'outdated-deps':{
@@ -206,26 +207,69 @@ module.exports = function(qaControl){
             exist_package_json:{
                 checks:[{
                     warnings:function(info){
-                        if(!info.files['package.json']){
+                        if(!info.files?.['package.json']){
                             return [{warning:'no_package_json', scoring:{fatal:1}}];
                         }
                         return [];
                     }
                 }],
-                shouldAbort:true
+                couldBail:true
             },
             qa_control_section_in_package_json:{
                 checks:[{
                     warnings:function(info){
-                        if(!info.packageJson['qa-control']){
-                            return [{warning:info.files['package.json'].content.match(/codenautas/)?
+                        if(!info.packageJson?.['qa-control']){
+                            return [{warning:info.files?.['package.json']?.content?.match(/codenautas/)?
                                         'no_qa_control_section_in_codenautas_project':
                                         'no_qa_control_section_in_package_json', scoring:{fatal:1}}];
                         }
                         return [];
                     }
                 }],
-                shouldAbort:true
+                mustAbort:true
+            },
+            repository_in_package_json:{
+                checks:[{
+                    warnings:function(info) {
+                        var warns = [];
+                        if(!('repository' in info.packageJson)) {
+                            warns.push({warning:'lack_of_repository_section_in_package_json', scoring:{mandatories:1}});
+                        } else {
+                            if(! qaControl.getRepositoryUrl(info.packageJson).match(/^([-a-zA-Z0-9_.]+\/[-a-zA-Z0-9_.]+)$/)){
+                                return [{warning:'repository_name_not_found', scoring:{mandatories:1}}];
+                            }
+                        }
+                        return warns;
+                    }
+                }],
+                couldBail:true
+            },
+            invalid_repository_in_package_json:{
+                checks:[{
+                    warnings:function(info) {
+                        var warns = [];
+                        var repoParts = qaControl.getRepositoryUrl(info.packageJson).split('/');
+                        var projName = repoParts[repoParts.length-1];
+                        if(projName !== info.packageJson.name) {
+                            return [{warning:'invalid_repository_section_in_package_json', scoring:{repository:1}}];
+                        }
+                        return warns;
+                    }
+                }]
+            },
+            github_repository:{
+                eclipsers:['lack_of_repository_section_in_package_json', 'repository_name_not_found', 'invalid_repository_section_in_package_json'],
+                checks:[{
+                    warnings:function(info) {
+                        if(!qaControl.repoIs) { return []; }
+                        var actual = qaControl.getRepositoryUrl(info.packageJson).replace(/\.git$/, '');
+                        var expected = qaControl.repoIs.replace(/\.git$/, '');
+                        if(actual !== expected) {
+                            return [{warning:'repository_does_not_match_1', params:[expected], scoring:{repository:1}}];
+                        }
+                        return [];
+                    }
+                }]
             },
             mandatory_files:{
                 checks:[{
@@ -247,29 +291,13 @@ module.exports = function(qaControl){
                         return warns;
                     }
                 }],
-                shouldAbort:true
-            },
-            repository_in_package_json:{
-                checks:[{
-                    warnings:function(info) {
-                        var warns = [];
-                        if(!('repository' in info.packageJson)) {
-                            warns.push({warning:'lack_of_repository_section_in_package_json', scoring:{mandatories:1}});
-                        } else {
-                            if(! qaControl.getRepositoryUrl(info.packageJson).match(/^([-a-zA-Z0-9_.]+\/[-a-zA-Z0-9_.]+)$/)){
-                                return [{warning:'repository_name_not_found', scoring:{mandatories:1}}];
-                            }
-                        }
-                        return warns;
-                    }
-                }],
-                shouldAbort:true
+                couldBail:true
             },
             valid_values_for_qa_control_keys:{
                 checks:[{
                     warnings:function(info){
                         var warns=[];
-                        var qaControlSection=info.packageJson['qa-control'];
+                        var qaControlSection=info.packageJson?.['qa-control'] ?? {};
                         var sections=qaControl.definition.sections;
                          /*jshint forin: false */
                         for(var sectionName in sections){
@@ -287,7 +315,18 @@ module.exports = function(qaControl){
                         return warns;
                     }
                 }],
-                shouldAbort:true
+                couldBail:true
+            },
+            cant_continue:{
+                checks:[{
+                    warnings: function(info){
+                        if (info.warningCount) {
+                            return [{warning:'cant_continue', scoring:{fatal:1}}];
+                        }
+                        return []
+                    }
+                }],
+                mustAbort:true
             },
             mandatory_lines:{
                 checks:[{
@@ -315,6 +354,7 @@ module.exports = function(qaControl){
             no_multilang_section_in_1:{
                 checks:[{
                     warnings:function(info){
+                        if(info.packageJson['qa-control'] && info.packageJson['qa-control'].multilang === 'no') { return []; }
                         if(!info.files[qaControl.mainDoc()].content.match(/<!--multilang v[0-9]+\s+(.+)(-->)/)) {
                             return [{
                                 warning:'no_multilang_section_in_1',
@@ -326,23 +366,11 @@ module.exports = function(qaControl){
                     }
                 }]
             },
-            invalid_repository_in_package_json:{
-                checks:[{
-                    warnings:function(info) {
-                        var warns = [];
-                        var repoParts = qaControl.getRepositoryUrl(info.packageJson).split('/');
-                        var projName = repoParts[repoParts.length-1];
-                        if(projName !== info.packageJson.name) {
-                            return [{warning:'invalid_repository_section_in_package_json', scoring:{repository:1}}];
-                        }
-                        return warns;
-                    }
-                }]
-            },
             cucardas:{
                 eclipsers:['invalid_repository_section_in_package_json', 'lack_of_repository_section_in_package_json'],
                 checks:[{
                     warnings:function(info){
+                        if(info.packageJson['qa-control'] && info.packageJson['qa-control'].multilang === 'no') { return []; }
                         var warns=[];
                         var readme=info.files[qaControl.mainDoc()].content;
                         if(readme.indexOf(qaControl.cucaMarker) === -1) {
@@ -430,8 +458,9 @@ module.exports = function(qaControl){
             first_lines:{
                 checks:[{
                     warnings:function(info) {
+                        if(info.packageJson['qa-control'] && info.packageJson['qa-control'].profile === 'minimum') { return []; }
                         var warns=[];
-                        var qaControlSection=info.packageJson['qa-control'];
+                        var qaControlSection=info.packageJson['qa-control'] ?? {};
                         var whichRunIn=qaControlSection['run-in'];
                         var whichType=qaControlSection.type;
                         var firstLines=qaControl.definition.firstLines[whichRunIn][whichType];
@@ -516,6 +545,7 @@ module.exports = function(qaControl){
             multilang:{
                 checks:[{
                     warnings:function(info) {
+                        if(info.packageJson['qa-control'] && info.packageJson['qa-control'].multilang === 'no') { return []; }
                         var warns = [];
                         var defReadme = qaControl.mainDoc();
                         var content = info.files[defReadme].content;
@@ -635,7 +665,7 @@ module.exports = function(qaControl){
                 checks:[{
                     warnings:function(info) {
                         var warns = [];
-                        var nonRecomended = ['best-promise', 'eslint', 'lodash', 'promise-plus'];
+                        var nonRecomended = ['best-promise', 'jslint', 'lodash', 'promise-plus'];
                         var dependencies = info.packageJson.dependencies;
                         var devDependencies = info.packageJson.devDependencies;
                         if(dependencies) {

package/bin/qa-control-run.js

@@ -16,7 +16,9 @@ program
     .option('-v, --verbose', 'Show progress information')
     .option('-L, --list-langs', 'List available languages')
     .option('-c, --cucardas', 'Always generate cucardas.log')
+    .option('-b, --bail', 'Stop at first blocking issue')
     .option('-i, --init', 'Initialize project with qa-control specs')
+    .option('--repo-is <owner_or_org/repo>', 'Expected GitHub repository (owner_or_org/repo)')
     .parse(process.argv);
 
 var opts = program.opts();
@@ -33,6 +35,8 @@ params.verbose = opts.verbose;
 params.listLangs = opts.listLangs;
 params.lang = opts.lang;
 params.cucardas = opts.cucardas;
+params.bail = opts.bail || false;
+params.repoIs = opts.repoIs || process.env.GITHUB_REPOSITORY || null;
 // console.log(opts); process.exit(0);
 // console.log(params); process.exit(0);
 

package/bin/qa-control.js

@@ -25,7 +25,9 @@ function forEach(obj, func) {
 
 qaControl.msgs={
     en:{
-        repository_name_not_found: 'packageJson.repository must be in format /{[-a-zA-Z0-9_.]+}\/[-a-zA-Z0-9_.]+/'
+        lack_of_mandatory_section_1: 'lack of mandatory section "$1" in qa-control section of package.json',
+        repository_name_not_found: 'packageJson.repository must be in format /{[-a-zA-Z0-9_.]+}\/[-a-zA-Z0-9_.]+/',
+        bailing_could_be_more: '--bail(ing)! There could be more issues'
     },
     es:{
         deprecated_version: 'la version es demasiado vieja',
@@ -52,12 +54,14 @@ qaControl.msgs={
         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',
+        repository_does_not_match_1: 'el repositorio no coincide con el esperado "$1"',
         invalid_dependency_version_number_format_in_dep_1: 'El formato del numero de version es incorrecto en "$1"',
         wrong_use_strict_spelling_in_file_1: '"use strict" está mal escrito en "$1"',
         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',
-        non_recomended_dependency_1_in_package_json: 'Dependencia no recomendada "$1" en package.json'
+        non_recomended_dependency_1_in_package_json: 'Dependencia no recomendada "$1" en package.json',
+        bailing_could_be_more: '¡Qué --bail(e)! Podrían haber más problemas, correr de nuevo después de corregir estos'
     }
 };
 
@@ -101,7 +105,7 @@ qaControl.startsWith = function startsWith(bufTest, bufStart) {
 };
 
 qaControl.getRepositoryUrl = function getRepositoryUrl(packageJson) {
-    var repo = packageJson.repository.url ? packageJson.repository.url : packageJson.repository;
+    var repo = packageJson.repository?.url ?? packageJson.repository ?? "";
     var ghRepo = /(https:\/\/github\.com\/)/.exec(repo);
     if(ghRepo) { repo = repo.replace(ghRepo[1], ''); }
     return repo;
@@ -175,6 +179,7 @@ qaControl.nodeVerInTravisRE = /[678]/;
 
 qaControl.verbose = false;
 qaControl.cucardas_always = false;
+qaControl.repoIs = null;
 qaControl.definition = require("./definition/definition.js")(qaControl);
 
 qaControl.lang = process.env.qa_control_lang || 'en';
@@ -310,6 +315,12 @@ qaControl.loadProject = function loadProject(projectDir) {
     });
 };
 
+/**
+ * 
+ * @param {ProjectInfo} info 
+ * @param {QAOptions} opts
+ * @returns 
+ */
 qaControl.controlInfo=function controlInfo(info, opts){
     var resultWarnings=[];
     var existingWarnings={};
@@ -318,6 +329,8 @@ qaControl.controlInfo=function controlInfo(info, opts){
     var silenced = ((info.packageJson || {})['qa-control'] || {}).silenced || [];
     var cadenaDePromesas = Promise.resolve(/** @type {Warning[]} */ ([]));
     info.scoring = opts && opts.scoring;
+    var bailed = false;
+    info.warningCount = 0;
     forEach(rules, function(rule, ruleName) {
         rule.checks.forEach(function(checkInfo){
             cadenaDePromesas = cadenaDePromesas.then(function() {
@@ -333,8 +346,15 @@ qaControl.controlInfo=function controlInfo(info, opts){
                     activeWarnings.forEach(function(warning){
                         existingWarnings[warning.warning]=true;
                     });
-                    if(rule.shouldAbort) { throw new Error("ruleIsAborting"); }
+                    if(rule.couldBail && opts && opts.bail) { 
+                        bailed = true; 
+                        throw new Error("ruleIsAborting"); 
+                    }
+                    if(rule.mustAbort) { 
+                        throw new Error("ruleIsAborting"); 
+                    }
                 }
+                info.warningCount += warningsOfThisRule.length;
                 return resultWarnings;
             });
         });
@@ -344,6 +364,7 @@ qaControl.controlInfo=function controlInfo(info, opts){
             throw err;
         }
     }).then(function(){
+        if(bailed) { resultWarnings.push({warning:'bailing_could_be_more'}); }
         return resultWarnings;
     });
     return cadenaDePromesas;
@@ -377,6 +398,7 @@ qaControl.stringizeWarnings = function stringizeWarnings(warns, lang) {
 qaControl.controlProject=function controlProject(projectDir, opts){
     qaControl.verbose = opts && opts.verbose;
     qaControl.cucardas_always = opts && opts.cucardas;
+    qaControl.repoIs = (opts && opts.repoIs) || null;
     return Promise.resolve().then(function(){
         return qaControl.loadProject(projectDir);
     }).then(function(info){

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "qa-control",
   "description": "QA control of things that nobody controls",
-  "version": "0.6.2",
+  "version": "0.6.4",
   "author": "Codenautas <codenautas@googlegroups.com>",
   "license": "MIT",
   "repository": "codenautas/qa-control",
@@ -49,11 +49,11 @@
     "node": ">= 10"
   },
   "scripts": {
-    "test": "mocha --reporter spec --bail --check-leaks test/",
+    "test": "mocha --reporter spec  --check-leaks test/",
     "test-nc": "mocha --reporter spec --bail --check-leaks --no-colors 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",
+    "start": "node ./bin/qa-control-run.js",
     "report": "nyc report",
     "qac": "node bin/qa-control-run.js . -v",
     "typecheck": "tsc",