qa-control 0.6.7 → 0.6.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/bin/definition/definition.js +105 -47
  2. package/bin/qa-control.js +7 -1
  3. package/package.json +3 -2
package/bin/definition/definition.js CHANGED
@@ -36,6 +36,68 @@ function softRegExp(realRegex) {
36
36
  return new RegExp(re, 'im');
37
37
  }
38
38
 
39
+ /**
40
+ *
41
+ * @param {string} tagText
42
+ * @param {string} colour
43
+ * @param {string|null} [label]
44
+ * @returns
45
+ */
46
+ function stabilityCucarda(tagText, colour, label){
47
+
48
+ return '!['+tagText+'](https://img.shields.io/badge/stability-'+encodeURIComponent(label || tagText)+'-'+colour+'.svg)';
49
+ /*
50
+ var colour = 'red';
51
+ if(/^rc/i.test(lqa)) { colour = 'yellow'; }
52
+ else if(/beta/i.test(lqa)) { colour = 'orange'; }
53
+ var badge =
54
+ cucaFileContent += badge + '\n';
55
+ return cucaFileContent;
56
+ */
57
+ }
58
+
59
+ function cucardaDefinition(colour, tag, type, opts){
60
+ function theTag(packageJson){
61
+ var qaTag = semver.prerelease(packageJson.version)?.[0];
62
+ if(qaTag) {
63
+ var tagText = String(qaTag);
64
+ var lqa = tagText.toLowerCase();
65
+ return lqa;
66
+ }
67
+ return '';
68
+ }
69
+ switch (type) {
70
+ case 'purpose':
71
+ return {
72
+ check: function(packageJson) {
73
+ return packageJson?.['qa-control']?.purpose === tag
74
+ },
75
+ md:'![proof-of-concept](https://img.shields.io/badge/stability-' + (opts||tag) + '-' + colour + '.svg)'
76
+ }
77
+ case 'tag':
78
+ return {
79
+ check: function(packageJson) {
80
+ return !packageJson?.['qa-control']?.purpose &&
81
+ (theTag(packageJson) == tag || tag == 'unkown-tag' && !theTag(packageJson).match(/^(rc|beta|alpha)$/i));
82
+ },
83
+ md: stabilityCucarda(tag, colour, tag)
84
+ }
85
+ case 'version':
86
+ return {
87
+ check: function(packageJson) {
88
+ return !packageJson?.['qa-control']?.purpose && !theTag(packageJson) &&
89
+ semver.satisfies(packageJson.version, opts);
90
+ },
91
+ md: stabilityCucarda(tag, colour, tag)
92
+ }
93
+ default:
94
+ throw new Error('Cucarda mal definida: '+JSON.stringify(arguments))
95
+ }
96
+ }
97
+
98
+ // If package sets an explicit tag in qa-control or top-level tag, use it
99
+
100
+
39
101
  /**
40
102
  * @param {object} qaControl
41
103
  * @returns {QADefinition}
@@ -76,52 +138,15 @@ module.exports = function(qaControl){
76
138
  '.eslintrc.yml':{ presentIf: function(pj) { return pj['qa-control'] && pj['qa-control'].profile !== 'minimum'; } }
77
139
  },
78
140
  cucardas:{
79
- 'proof-of-concept':{
80
- check: function(packageJson){
81
- return packageJson?.['qa-control']?.purpose==='proof-of-concept';
82
- },
83
- md:'![proof-of-concept](https://img.shields.io/badge/stability-proof_of_concept-ff70c0.svg)',
84
- imgExample:'https://img.shields.io/badge/stability-designing-red.svg'
85
- },
86
- designing:{
87
- check: function(packageJson){
88
- return semver.satisfies(packageJson.version,'0.0.x') && !packageJson?.['qa-control']?.purpose;
89
- },
90
- md:'![designing](https://img.shields.io/badge/stability-designing-red.svg)',
91
- imgExample:'https://img.shields.io/badge/stability-designing-red.svg',
92
- docDescription: 'opt. manual'
93
- },
94
- extending:{
95
- check: function(packageJson){
96
- return semver.satisfies(packageJson.version,'0.x.x') &&
97
- !semver.satisfies(packageJson.version,'0.0.x') &&
98
- !packageJson?.['qa-control'].purpose;
99
- },
100
- md:'![extending](https://img.shields.io/badge/stability-extending-orange.svg)',
101
- imgExample:'https://img.shields.io/badge/stability-extending-orange.svg',
102
- docDescription: 'opt. manual'
103
- },
104
- training:{
105
- check: function(packageJson){
106
- return packageJson?.['qa-control']?.purpose==='training';
107
- },
108
- md:'![training](https://img.shields.io/badge/stability-training-ffa0c0.svg)',
109
- imgExample:'https://img.shields.io/badge/stability-training-ffa0c0.svg'
110
- },
111
- example:{
112
- check: function(packageJson){
113
- return packageJson?.['qa-control']?.purpose==='example';
114
- },
115
- md:'![example](https://img.shields.io/badge/stability-example-a0a0f0.svg)',
116
- imgExample:'https://img.shields.io/badge/stability-example-a0a0f0.svg'
117
- },
118
- stable:{
119
- check: function(packageJson){
120
- return semver.satisfies(packageJson.version,'>=1.0.0') && !packageJson?.['qa-control']?.purpose;
121
- },
122
- md:'![stable](https://img.shields.io/badge/stability-stable-blue.svg)',
123
- imgExample:'https://img.shields.io/badge/stability-stable-blue.svg'
124
- },
141
+ 'proof-of-concept': cucardaDefinition('ff70c0', 'proof-of-concept', 'purpose', 'proof_of_concept'),
142
+ rc: cucardaDefinition('yellow', 'rc', 'tag'),
143
+ beta: cucardaDefinition('orange', 'beta', 'tag'),
144
+ alpha: cucardaDefinition('red', 'alpha', 'tag'),
145
+ designing: cucardaDefinition('red', 'designing', 'version', '~0.0.0'),
146
+ extending: cucardaDefinition('orange', 'extending', 'version', '>=0.1.0 <1.0.0'),
147
+ stable: cucardaDefinition('blue', 'stable', 'version', '>=1.0.0'),
148
+ training: cucardaDefinition('ffa0c0', 'training', 'purpose'),
149
+ example: cucardaDefinition('a0a0f0', 'example', 'purpose'),
125
150
  'npm-version':{
126
151
  mandatory:true,
127
152
  md:'[![npm-version](https://img.shields.io/npm/v/yyy.svg)](https://npmjs.org/package/yyy)',
@@ -382,7 +407,11 @@ module.exports = function(qaControl){
382
407
  /*jshint forin: false */
383
408
  for(var nombreCucarda in cucardas) {
384
409
  var cucarda = cucardas[nombreCucarda];
385
- var cucaID = cucarda.forbidden ? '!['+nombreCucarda+']' : '!['+/!\[([-a-z]+)]/.exec(cucarda.md)[1]+']';
410
+ try{
411
+ var cucaID = cucarda.forbidden ? '!['+nombreCucarda+']' : '!['+/!\[([-a-z]+)]/.exec(cucarda.md)[1]+']';
412
+ }catch(err){
413
+ console.log('######################################', cucarda, err)
414
+ }
386
415
  var cucaStr = cucarda.md ? cucarda.md.replace(/\bxxx\b/g,repo).replace(/\byyy\b/g,modulo) : '';
387
416
  if(cucarda.forbidden) {
388
417
  if(readme.indexOf(cucaID) !== -1) {
@@ -679,6 +708,35 @@ module.exports = function(qaControl){
679
708
  }
680
709
  }]
681
710
  },
711
+ qa_control_dev_dependency:{
712
+ checks:[{
713
+ warnings:function(info) {
714
+ var warns = [];
715
+ // Only check if project has qa-control section AND has gha configured (but not "skip")
716
+ var qaSection = info.packageJson && info.packageJson['qa-control'];
717
+ if(!qaSection || !qaSection.gha || qaSection.gha === 'skip') { return warns; }
718
+ var devDependencies = info.packageJson.devDependencies || {};
719
+ if(!('qa-control' in devDependencies)) {
720
+ warns.push({warning:'lack_of_qa_control_in_dev_dependencies', scoring:{dependencies:1}});
721
+ return warns;
722
+ }
723
+ var actualVersion = devDependencies['qa-control'];
724
+ var toolPkgPath = Path.join(__dirname, '../../package.json');
725
+ var toolVersion;
726
+ try {
727
+ toolVersion = fs.readJsonSync(toolPkgPath).version;
728
+ } catch(e) {
729
+ try { toolVersion = require('../../package.json').version; } catch(e2) { toolVersion = null; }
730
+ }
731
+ if(!toolVersion) { return warns; }
732
+ var expectedCaret = '^' + toolVersion;
733
+ if(actualVersion !== expectedCaret && actualVersion !== toolVersion && actualVersion !== '~' + toolVersion) {
734
+ warns.push({warning:'qa_control_version_mismatch_in_dev_dependencies_1_expected_2', params:[actualVersion, expectedCaret], scoring:{dependencies:1}});
735
+ }
736
+ return warns;
737
+ }
738
+ }]
739
+ },
682
740
  workflows:{
683
741
  checks:[{
684
742
  warnings:function(info) {
package/bin/qa-control.js CHANGED
@@ -27,6 +27,8 @@ qaControl.msgs={
27
27
  en:{
28
28
  lack_of_mandatory_section_1: 'lack of mandatory section "$1" in qa-control section of package.json',
29
29
  repository_name_not_found: 'packageJson.repository must be in format /{[-a-zA-Z0-9_.]+}\/[-a-zA-Z0-9_.]+/',
30
+ lack_of_qa_control_in_dev_dependencies: 'qa-control must be in devDependencies with the same version as qa-control.package-version',
31
+ qa_control_version_mismatch_in_dev_dependencies_1_expected_2: 'qa-control version in devDependencies is "$1" but expected "$2"',
30
32
  bailing_could_be_more: '--bail(ing)! There could be more issues'
31
33
  },
32
34
  es:{
@@ -63,6 +65,8 @@ qaControl.msgs={
63
65
  non_recomended_dependency_1_in_package_json: 'Dependencia no recomendada "$1" en package.json',
64
66
  lack_of_workflow_file_1: 'falta el archivo de workflow "$1"',
65
67
  workflow_file_1_differs: 'el archivo de workflow "$1" difiere del template de qa-control',
68
+ lack_of_qa_control_in_dev_dependencies: 'qa-control debe estar en devDependencies con la misma versión que qa-control.package-version',
69
+ qa_control_version_mismatch_in_dev_dependencies_1_expected_2: 'La versión de qa-control en devDependencies es "$1" pero se esperaba "$2"',
66
70
  bailing_could_be_more: '¡Qué --bail(e)! Podrían haber más problemas, correr de nuevo después de corregir estos'
67
71
  }
68
72
  };
@@ -117,6 +121,8 @@ qaControl.getRepositoryUrl = function getRepositoryUrl(packageJson) {
117
121
  qaControl.cucaMarker = '<!-- cucardas -->';
118
122
  qaControl.generateCucardas = function generateCucardas(cucardas, packageJson) {
119
123
  var cucaFileContent = qaControl.cucaMarker+'\n';
124
+ /** @type {{tag:string|null}} */
125
+ var info = { tag: null }
120
126
  var modulo=packageJson.name;
121
127
  var repo=qaControl.getRepositoryUrl(packageJson).replace('/'+modulo,'');
122
128
  /*jshint forin: false */
@@ -320,7 +326,7 @@ qaControl.loadProject = function loadProject(projectDir) {
320
326
  /**
321
327
  *
322
328
  * @param {ProjectInfo} info
323
- * @param {QAOptions} opts
329
+ * @param {QAOptions} [opts]
324
330
  * @returns
325
331
  */
326
332
  qaControl.controlInfo=function controlInfo(info, opts){
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "qa-control",
3
3
  "description": "QA control of things that nobody controls",
4
- "version": "0.6.7",
4
+ "version": "0.6.10",
5
5
  "author": "Codenautas <codenautas@googlegroups.com>",
6
6
  "license": "MIT",
7
7
  "repository": "codenautas/qa-control",
@@ -67,6 +67,7 @@
67
67
  "run-in": "server",
68
68
  "stability": "extending",
69
69
  "type": "cmd-tool",
70
- "ecmaVersion": 6
70
+ "ecmaVersion": 6,
71
+ "gha": "all"
71
72
  }
72
73
  }