qa-control 0.6.2 → 0.6.3

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

@@ -55,7 +55,7 @@ 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.*']
@@ -131,7 +131,7 @@ module.exports = function(qaControl){
                 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)',
+                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'
             },
@@ -139,7 +139,7 @@ module.exports = function(qaControl){
                 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)',
+                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,
             },
@@ -167,7 +167,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':{
@@ -227,6 +227,49 @@ module.exports = function(qaControl){
                 }],
                 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
+            },
+            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:[{
                     warnings:function(info) {
@@ -249,22 +292,6 @@ module.exports = function(qaControl){
                 }],
                 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
-            },
             valid_values_for_qa_control_keys:{
                 checks:[{
                     warnings:function(info){
@@ -315,6 +342,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 +354,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,6 +446,7 @@ 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 whichRunIn=qaControlSection['run-in'];
@@ -516,6 +533,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 +653,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

@@ -17,6 +17,7 @@ program
     .option('-L, --list-langs', 'List available languages')
     .option('-c, --cucardas', 'Always generate cucardas.log')
     .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 +34,7 @@ params.verbose = opts.verbose;
 params.listLangs = opts.listLangs;
 params.lang = opts.lang;
 params.cucardas = opts.cucardas;
+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,6 +25,7 @@ function forEach(obj, func) {
 
 qaControl.msgs={
     en:{
+        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_.]+/'
     },
     es:{
@@ -52,6 +53,7 @@ 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',
@@ -175,6 +177,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';
@@ -377,6 +380,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.3",
   "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",