supertape 6.3.1 → 6.7.0

package/ChangeLog

@@ -1,10 +1,38 @@
+2021.09.18, v6.7.0
+
+feature:
+- (supertape) add --check-scopes flag that checks that test message contains scope
+
+
+2021.09.16, v6.6.0
+
+feature:
+- (supertape) add ability to show path of a duplicate
+
+
+2021.09.15, v6.5.0
+
+feature:
+- (supertape) add support of file links to WebStorm: at: -> at
+
+
+2021.09.15, v6.4.0
+
+fix:
+- (supertape) improve at when found duplicates
+
+feature:
+- (supertape) add ability to toggle check duplicates with env variables SUPERTAPE_CHECK_DUPLICATES
+- (@supertape/formatter-progress-bar) add support of SUPERTAPE_PROGRESS_BAR_STACK'
+
+
 2021.09.15, v6.3.1
 
 fix:
 - (supertape) improve at when found duplicates
 
 feature:
-- (@supertape/formatter-progress-bar) add support of SUPERTAPE_PROGRESS_BAR_SHORT'
+- (@supertape/formatter-progress-bar) add support of SUPERTAPE_PROGRESS_BAR_STACK'
 
 
 2021.09.14, v6.3.0

package/README.md

@@ -2,8 +2,8 @@
 
 [NPMURL]: https://npmjs.org/package/supertape "npm"
 [NPMIMGURL]: https://img.shields.io/npm/v/supertape.svg?style=flat&longCache=true
-[BuildStatusURL]: https://github.com/coderaiser/putout/actions?query=workflow%3A%22Node+CI%22 "Build Status"
-[BuildStatusIMGURL]: https://github.com/coderaiser/putout/workflows/Node%20CI/badge.svg
+[BuildStatusURL]: https://github.com/coderaiser/supertape/actions?query=workflow%3A%22Node+CI%22 "Build Status"
+[BuildStatusIMGURL]: https://github.com/coderaiser/supertape/workflows/Node%20CI/badge.svg
 [DependencyStatusURL]: https://david-dm.org/coderaiser/supertape?path=packages/supertape "Dependency Status"
 [DependencyStatusIMGURL]: https://img.shields.io/david/coderaiser/supertape.svg?path=packages/supertape&style=flat&longCache=true
 [CoverageURL]: https://coveralls.io/github/coderaiser/supertape?branch=master
@@ -49,6 +49,19 @@ Options
    --no-check-duplicates       do not check messages for duplicates
 ```
 
+## Environment variables
+
+- `SUPERTAPE_TIMEOUT` - timeout for long running processes;
+- `SUPERTAPE_CHECK_DUPLICATES` - toggle check duplicates;
+- `SUPERTAPE_CHECK_SCOPES` - check that test message has a scope: `scope: subject`
+
+```js
+test('tape: error', (t) => {
+    t.equal(error.code, 'ENOENT');
+    t.end();
+});
+```
+
 ## Codemod
 
 You can convert your codebase from `tape` to `supertape` with help of a [putout](https://github.com/coderaiser/putout) and built-in [@putout/plugin-tape](https://github.com/coderaiser/putout/tree/master/packages/plugin-tape).

package/help.json

@@ -3,5 +3,6 @@
     "-v, --version              ": "output version information and exit",
     "-f, --format               ": "use a specific output format - default: progress-bar/tap on CI",
     "-r, --require              ": "require module",
+    "--check-scopes             ": "check that messages contains scope: 'scope: message'",
     "--no-check-duplicates      ": "do not check messages for duplicates"
 }

package/lib/cli.js

@@ -30,6 +30,11 @@ const maybeArray = (a) => isArray(a) ? a : [a];
 const removeDuplicates = (a) => Array.from(new Set(a));
 const filesCount = fullstore(0);
 
+const {
+    SUPERTAPE_CHECK_DUPLICATES = '1',
+    SUPERTAPE_CHECK_SCOPES = '0',
+} = process.env;
+
 module.exports = async ({argv, cwd, stdout, stderr, exit}) => {
     const {isStop} = keypress();
     const [error, result] = await tryToCatch(cli, {
@@ -83,6 +88,7 @@ const yargsOptions = {
         'version',
         'help',
         'check-duplicates',
+        'check-scopes',
     ],
     alias: {
         version: 'v',
@@ -90,11 +96,13 @@ const yargsOptions = {
         help: 'h',
         require: 'r',
         checkDuplicates: 'd',
+        checkScopes: 's',
     },
     default: {
         format: 'progress-bar',
         require: [],
-        checkDuplicates: true,
+        checkDuplicates: SUPERTAPE_CHECK_DUPLICATES !== '0',
+        checkScopes: SUPERTAPE_CHECK_SCOPES === '1',
     },
 };
 
@@ -139,6 +147,7 @@ async function cli({argv, cwd, stdout, isStop}) {
     const {
         format,
         checkDuplicates,
+        checkScopes,
     } = args;
     
     supertape.init({
@@ -147,6 +156,7 @@ async function cli({argv, cwd, stdout, isStop}) {
         format,
         isStop,
         checkDuplicates,
+        checkScopes,
     });
     
     supertape.createStream().pipe(stdout);

package/lib/format.js

@@ -13,7 +13,7 @@ module.exports.parseAt = (stack, {reason}) => {
     
     const line = lines[reason === 'user' ? REASON_USER : REASON_EXCEPTION];
     
-    return line.trim().replace('at', 'at:');
+    return line.trim();
 };
 
 module.exports.addSpaces = addSpaces;

package/lib/run-tests.js

@@ -6,7 +6,7 @@ const tryToCatch = require('try-to-catch');
 const once = require('once');
 
 const isDebug = require('./is-debug');
-const duplicator = require('./duplicator');
+const {createValidator} = require('./validator');
 
 const inc = wraptile((store) => store(store() + 1));
 const isOnly = ({only}) => only;
@@ -76,7 +76,7 @@ async function runTests(tests, {formatter, operators, skiped, isStop}) {
     });
     
     const wasStop = fullstore();
-    const getDuplicatesMessage = duplicator({
+    const getValidationMessage = createValidator({
         tests,
     });
     
@@ -99,7 +99,7 @@ async function runTests(tests, {formatter, operators, skiped, isStop}) {
             incCount,
             incFailed,
             incPassed,
-            getDuplicatesMessage,
+            getValidationMessage,
             
             extensions: {
                 ...operators,
@@ -123,7 +123,7 @@ async function runTests(tests, {formatter, operators, skiped, isStop}) {
     };
 }
 
-async function runOneTest({message, fn, extensions, formatter, count, total, failed, incCount, incPassed, incFailed, getDuplicatesMessage}) {
+async function runOneTest({message, fn, extensions, formatter, count, total, failed, incCount, incPassed, incFailed, getValidationMessage}) {
     formatter.emit('test', {
         test: message,
     });
@@ -159,10 +159,10 @@ async function runOneTest({message, fn, extensions, formatter, count, total, fai
         failed: failed(),
     });
     
-    const duplicateAt = getDuplicatesMessage(message);
+    const [validationMessage, at] = getValidationMessage(message);
     
-    if (duplicateAt) {
-        t.fail('Duplicate message', duplicateAt);
+    if (at) {
+        t.fail(validationMessage, at);
         t.end();
     }
 }

package/lib/supertape.js

@@ -6,7 +6,7 @@ const {createSimport} = require('simport');
 
 const options = require('../supertape.json');
 
-const {getDuplicatesMessage} = require('./duplicator');
+const {getAt, setValidations} = require('./validator');
 const runTests = require('./run-tests');
 const createFormatter = once(require('./formatter').createFormatter);
 
@@ -35,20 +35,21 @@ const defaultOptions = {
     getOperators,
     isStop: () => false,
     checkDuplicates: true,
+    checkScopes: false,
 };
 
 function _createEmitter({quiet, format, getOperators, isStop}) {
     const tests = [];
     const emitter = new EventEmitter();
     
-    emitter.on('test', (message, fn, {skip, only, extensions, duplicatesMessage}) => {
+    emitter.on('test', (message, fn, {skip, only, extensions, at}) => {
         tests.push({
             message,
             fn,
             skip,
             only,
             extensions,
-            duplicatesMessage,
+            at,
         });
     });
     
@@ -108,17 +109,20 @@ function test(message, fn, options = {}) {
         getOperators,
         isStop,
         checkDuplicates,
+        checkScopes,
     } = {
         ...defaultOptions,
         ...initedOptions,
         ...options,
     };
     
-    const duplicatesMessage = getDuplicatesMessage({
-        message,
+    setValidations({
         checkDuplicates,
+        checkScopes,
     });
     
+    const at = getAt();
+    
     const emitter = createEmitter({
         format,
         quiet,
@@ -132,7 +136,7 @@ function test(message, fn, options = {}) {
         skip,
         only,
         extensions,
-        duplicatesMessage,
+        at,
     });
     
     if (run)

package/lib/validator.js

@@ -0,0 +1,117 @@
+'use strict';
+
+const once = require('once');
+const StackTracey = require('stacktracey');
+
+const getDuplicatesMessage = ([, a]) => a;
+const getMessage = ({message, at}) => [message, at];
+const getMessagesList = (tests) => tests.map(getMessage);
+const compareMessage = (a) => ([b]) => a === b;
+
+const SCOPE_DEFINED = /^\w+:/;
+const processedList = new Set();
+
+const validations = {
+    checkDuplicates: true,
+    checkScopes: false,
+};
+
+const validators = {
+    checkDuplicates,
+    checkScopes,
+};
+
+const {
+    assign,
+    values,
+    entries,
+} = Object;
+
+const findByMessage = (msg, tests) => {
+    const getMessages = once(getMessagesList);
+    const filtered = getMessages(tests).filter(compareMessage(msg));
+    
+    return filtered;
+};
+
+module.exports.setValidations = ({checkDuplicates, checkScopes}) => {
+    assign(validations, {
+        checkDuplicates,
+        checkScopes,
+    });
+};
+
+const isValidationEnabled = (a) => values(a).filter(Boolean).length;
+
+module.exports.createValidator = ({tests}) => (msg) => {
+    if (!isValidationEnabled(validations))
+        return [];
+    
+    for (const [name, enabled] of entries(validations)) {
+        if (!enabled)
+            continue;
+        
+        const filtered = findByMessage(msg, tests);
+        
+        if (!filtered.length)
+            throw Error('☝️Looks like message cannot be fined in tests, this should never happen');
+        
+        const [message, at] = validators[name](msg, filtered);
+        
+        if (at)
+            return [message, at];
+    }
+    
+    return [];
+};
+
+module.exports.getAt = () => {
+    const {
+        checkDuplicates,
+        checkScopes,
+    } = validations;
+    
+    if (!checkDuplicates && !checkScopes)
+        return '';
+    
+    return getFileName();
+};
+
+const CALLS_FROM_TEST = 3;
+
+function getFileName() {
+    const {items} = new StackTracey(Error());
+    
+    for (const {beforeParse, file} of items.slice(CALLS_FROM_TEST)) {
+        if (file.includes('node_modules'))
+            continue;
+        
+        return beforeParse;
+    }
+    
+    return '';
+}
+
+function checkScopes(msg, filtered) {
+    const [message, at] = filtered[0];
+    
+    if (!SCOPE_DEFINED.test(message))
+        return [`Scope should be defined before first colon: 'scope: subject', example: 'supertape: validator: enabled'`, at];
+    
+    return [];
+}
+
+function checkDuplicates(msg, filtered) {
+    if (filtered.length < 2)
+        return [];
+    
+    const [first, second] = filtered.map(getDuplicatesMessage);
+    
+    if (processedList.has(first))
+        return [];
+    
+    processedList.add(first);
+    
+    return [`Duplicate ${first}`, second];
+}
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "supertape",
-  "version": "6.3.1",
+  "version": "6.7.0",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "tape compatible test runner with superpowers",
   "homepage": "http://github.com/coderaiser/supertape",
@@ -87,7 +87,8 @@
     "nodemon": "^2.0.2",
     "pullout": "^4.0.0",
     "putout": "^20.0.1",
-    "runsome": "^1.0.0"
+    "runsome": "^1.0.0",
+    "try-catch": "^3.0.0"
   },
   "license": "MIT",
   "engines": {

package/lib/duplicator.js

@@ -1,50 +0,0 @@
-'use strict';
-
-const once = require('once');
-const StackTracey = require('stacktracey');
-
-const getMessage = ({message, duplicatesMessage}) => [message, duplicatesMessage];
-const getMessagesList = (tests) => tests.map(getMessage);
-const compareMessage = (a) => ([b]) => a === b;
-const processedList = new Set();
-
-module.exports = ({tests}) => (msg) => {
-    const getMessages = once(getMessagesList);
-    const duplicates = getMessages(tests).filter(compareMessage(msg));
-    
-    if (duplicates.length < 2)
-        return '';
-    
-    const [, duplicatesMessage] = duplicates.pop();
-    
-    if (processedList.has(duplicatesMessage))
-        return '';
-    
-    processedList.add(duplicatesMessage);
-    return duplicatesMessage;
-};
-
-const messages = new Set();
-const CALLS_FROM_TEST = 2;
-
-module.exports.getDuplicatesMessage = ({message, checkDuplicates}) => {
-    if (!checkDuplicates)
-        return '';
-    
-    if (!messages.has(message)) {
-        messages.add(message);
-        return '';
-    }
-    
-    const {items} = new StackTracey(Error());
-    
-    for (const {beforeParse, file} of items.slice(CALLS_FROM_TEST)) {
-        if (file.includes('node_modules'))
-            continue;
-        
-        return beforeParse.replace('at', 'at: ');
-    }
-    
-    return '';
-};
-