escover 1.0.3 → 1.1.1

package/ChangeLog

@@ -1,3 +1,27 @@
+2022.01.11, v1.1.1
+
+feature:
+-  escover: bin only shows report
+
+
+2022.01.11, v1.1.0
+
+feature:
+- (escover) add bin
+
+
+2022.01.08, v1.0.5
+
+feature:
+- escover: report
+
+
+2022.01.08, v1.0.4
+
+feature:
+- escover: add support of AssignmentExpression
+
+
 2022.01.08, v1.0.3
 
 feature:

package/README.md

@@ -9,20 +9,44 @@
 [CoverageURL]: https://coveralls.io/github/coderaiser/escover?branch=master
 [CoverageIMGURL]: https://coveralls.io/repos/coderaiser/escover/badge.svg?branch=master&service=github
 
-Explosive coverage tool
+Coverage for EcmaScript Modules based on 🐊[`Putout`](https://github.com/coderaiser/putout) and [loaders](https://nodejs.org/dist/latest-v16.x/docs/api/esm.html#loaders).
+
+# Why another coverage tool?
+
+When you want to use `ESM` in `Node.js` without transpiling to `CommonJS` (that's what `jest`, `ava`, `tap` does),
+you have a couple problems to solve.
+
+🤷‍ What test runner does no transpiling to `CommonJS`?
+☝️ that's easy! 📼 [`Supertape`](https://github.com/coderaiser/supertape) supports `ESM` from the box;
+
+🤷‍  How to mock modules without [mock-require](https://github.com/boblauer/mock-require) (we in `ESM`!);
+☝️ that's solved! [`mock-import`](https://github.com/coderaiser/mock-import) does the thing using `loaders`;
+
+🤷‍  How to get coverage when `nyc` doesn't supported?
+☝️ `c8` could help, but [no](https://github.com/coderaiser/c8-reproduce) it supports no `query paramters`
+which are needed to load module again, and apply mocks.
+
+🤷‍  How to get coverage when mocks are used?
+☝️ Use 🎩 `ESCover`! It supports loaders, `ESM` and collects coverage as a loader!
 
 ## Install
 
 ```
-npm i escover -g
+npm i escover -D
 ```
 
-Then run using:
+Run to collect coverage:
 
 ```sh
 NODE_OPTIONS="'--loader escover'" escover npm test
 ```
 
+Run to show coverage report:
+
+```sh
+escover
+```
+
 ## How it looks like?
 
 When everything is covered:
@@ -33,6 +57,26 @@ When some lines missing coverage:
 
 ![image](https://user-images.githubusercontent.com/1573141/147944130-9b901646-05ff-4a76-86c9-30631b0a0dd4.png)
 
+## What if I want to use with `mock-import`?
+
+Experimental `loaders` supports only one, for now. So [zenload](https://github.com/coderaiser/zenload) should be used.
+
+Install it with:
+
+```sh
+npm i escover mock-import zenload
+```
+
+Then run:
+
+```sh
+NODE_OPTIONS="'--loader zenlend'" ZENLOAD='escover,mock-import' escover npm test
+```
+
+This configuration will add coverage collectors and then apply mocks with help of `mock-import`.
+Of course the most comfortable way of doing this things will be [madrun](https://github.com/coderaiser/madrun).
+Run you `package-scripts` in `JavaScript` :)!
+
 ## License
 
 MIT

package/bin/escover.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+
+import {cli} from '../lib/cli/cli.js';
+import {read} from '../lib/config.js';
+
+cli({
+    argv: process.argv,
+    exit: process.exit,
+    read,
+});
+

package/lib/c4.js

@@ -5,10 +5,10 @@ export const createFileEntry = (url) => {
     files.set(url, lines);
     
     return {
-        mark: (line, column) => {
+        '🧨': (line, column) => {
             lines.set(`${line}:${column}`, true);
         },
-        init: (line, column) => {
+        'init': (line, column) => {
             lines.set(`${line}:${column}`, false);
         },
     };

package/lib/cli/cli.js

@@ -0,0 +1,24 @@
+import yargsParser from 'yargs-parser';
+
+import {version} from './version.js';
+import {report} from '../report.js';
+
+export const cli = ({argv, exit, read}) => {
+    const args = yargsParser(argv.slice(2), {
+        boolean: [
+            'version',
+        ],
+        alias: {
+            v: 'version',
+        },
+        configuration: {},
+    });
+    
+    if (args.version) {
+        console.log(`v${version()}`);
+        return exit();
+    }
+    
+    const coverage = read();
+    report(coverage);
+};

package/lib/cli/version.js

@@ -0,0 +1,12 @@
+import {readFileSync} from 'fs';
+const {parse} = JSON;
+
+const packageJson = new URL('../../package.json', import.meta.url);
+
+export const version = () => {
+    const data = readFileSync(packageJson, 'utf8');
+    const {version} = parse(data);
+    
+    return version;
+};
+

package/lib/config.js

@@ -0,0 +1,43 @@
+import tryCatch from 'try-catch';
+import {
+    writeFileSync,
+    readFileSync,
+} from 'fs';
+import {getFiles} from './c4.js';
+import {transform} from './transform.js';
+import {merge} from './merge.js';
+import findCacheDir from 'find-cache-dir';
+
+const {
+    stringify,
+    parse,
+} = JSON;
+
+const NAME = 'escover';
+const buildName = (a) => `${a}/${NAME}.json`;
+
+export const write = () => {
+    const files = getFiles();
+    const parsed = transform(files);
+    const merged = merge(parsed);
+    const name = findCacheDir({
+        name: NAME,
+        create: true,
+    });
+    
+    writeFileSync(buildName(name), stringify(merged, null, 4));
+};
+
+export const read = () => {
+    const name = findCacheDir({
+        name: NAME,
+    });
+    
+    const [error, data] = tryCatch(readFileSync, buildName(name), 'utf8');
+    
+    if (error)
+        return [];
+    
+    return parse(data);
+};
+

package/lib/escover.js

@@ -8,6 +8,8 @@ import {createFileEntry} from './c4.js';
 
 global.__createC4 = createFileEntry;
 
+process.once('exit', exit);
+
 export async function load(url, context, defaultLoad) {
     const {format, source: rawSource} = await defaultLoad(url, context, defaultLoad);
     
@@ -27,13 +29,9 @@ export async function load(url, context, defaultLoad) {
         ${instrument(url, rawSource)}
     `;
     
-    console.log(source);
-    
     return {
         format,
         source,
     };
 }
 
-process.once('exit', exit);
-

package/lib/exit.js

@@ -1,9 +1,6 @@
 import once from 'once';
-
-import {save} from './save.js';
-import {report} from './report.js';
+import {write} from './config.js';
 
 export const exit = once(() => {
-    save();
-    report();
+    write();
 });

package/lib/instrument/plugin-mark/fixture/arrow-fix.js

@@ -1,6 +1,6 @@
 export const nothing = (a, b) => {
-    return __c4.mark(2, 4);
+    return __c4['🧨'](2, 4);
 };
 export const sum = (a, b) => {
-    return __c4.mark(5, 4), a + b;
+    return __c4['🧨'](5, 4), a + b;
 };

package/lib/instrument/plugin-mark/fixture/assignment-fix.js

@@ -1 +1,2 @@
-const [error, {packageJson} = (__c4.mark(1, 14), {})] = (__c4.mark(1, 36), tryCatch(readPackageUpSync));
+const [error, {packageJson} = (__c4['🧨'](1, 14), {})] = (__c4['🧨'](1, 36), tryCatch(readPackageUpSync));
+data += (__c4['🧨'](2, 0), 'fix:' + '\n');

package/lib/instrument/plugin-mark/fixture/assignment.js

@@ -1 +1,2 @@
 const [error, {packageJson} = {}] = tryCatch(readPackageUpSync);
+data += 'fix:' + '\n';

package/lib/instrument/plugin-mark/fixture/if-fix.js

@@ -1,3 +1,6 @@
 if (error) {
-    throw (__c4.mark(2, 4), `error reading package.json: ${error.message}`);
+    throw (__c4['🧨'](2, 4), `error reading package.json: ${error.message}`);
 }
+
+if (error)
+    throw (__c4['🧨'](6, 4), (__c4.mark(11, 8), `error reading package.json: ${error.message}`));

package/lib/instrument/plugin-mark/fixture/if.js

@@ -1,3 +1,6 @@
 if (error) {
     throw `error reading package.json: ${error.message}`;
 }
+
+if (error)
+    throw (__c4.mark(11, 8), `error reading package.json: ${error.message}`);

package/lib/instrument/plugin-mark/fixture/logical-fix.js

@@ -1,3 +1,3 @@
-if ((__c4.mark(1, 4), a) || (__c4.mark(1, 9), b)) {
-  __c4.mark(1, 12);
+if ((__c4['🧨'](1, 4), a) || (__c4['🧨'](1, 9), b)) {
+  __c4['🧨'](1, 12);
 }

package/lib/instrument/plugin-mark/fixture/mark-line-fix.js

@@ -1,30 +1,30 @@
 const a = () => {
-    a = 5;
-    __c4.mark(3, 4), console.log(5);
+    a = (__c4['🧨'](2, 4), 5);
+    __c4['🧨'](3, 4), console.log(5);
 };
 
 
 function x() {
     
     if (a > 2) {
-        __c4.mark(9, 14), a();
+        __c4['🧨'](9, 14), a();
     } else {
-        __c4.mark(10, 9), b();
+        __c4['🧨'](10, 9), b();
     }
 }
 
 for (const x of y) {
-    __c4.mark(13, 19);
+    __c4['🧨'](13, 19);
 }
 
-const ax = ((__c4.mark(16, 12), a()), (__c4.mark(16, 17), b()));
-const bx = (c, (__c4.mark(17, 15), d()));
+const ax = ((__c4['🧨'](16, 12), a()), (__c4['🧨'](16, 17), b()));
+const bx = (c, (__c4['🧨'](17, 15), d()));
 
-if ((__c4.mark(19, 4), a) || (__c4.mark(19, 9), b)) {
-    __c4.mark(19, 12);
+if ((__c4['🧨'](19, 4), a) || (__c4['🧨'](19, 9), b)) {
+    __c4['🧨'](19, 12);
 }
 
 
-function x1(a, b = (__c4.mark(23, 15), 5)) {
-    __c4.mark(23, 22);
+function x1(a, b = (__c4['🧨'](23, 15), 5)) {
+    __c4['🧨'](23, 22);
 }

package/lib/instrument/plugin-mark/fixture/new-fix.js

@@ -1 +1 @@
-const files = (__c4.mark(1, 14), new Map());
+const files = (__c4['🧨'](1, 14), new Map());

package/lib/instrument/plugin-mark/fixture/no-loc-fix.js

@@ -1,8 +1,8 @@
-__c4.mark(1, 0), cli({
+__c4['🧨'](1, 0), cli({
     stdout,
     stderr,
     exit,
-    cwd: (__c4.mark(5, 9), process.cwd()),
-    argv: (__c4.mark(6, 10), process.argv.slice(2))
+    cwd: (__c4['🧨'](5, 9), process.cwd()),
+    argv: (__c4['🧨'](6, 10), process.argv.slice(2))
 });
 

package/lib/instrument/plugin-mark/index.js

@@ -5,6 +5,7 @@ import {
 } from 'putout';
 import {addMarkToReturn} from './return.js';
 import {addMarkToArrowFunction} from './arrow.js';
+import {addMarkToThrow} from './throw.js';
 
 const {
     NumericLiteral,
@@ -13,12 +14,11 @@ const {
 } = types;
 
 const {
-    replaceWithMultiple,
     replaceWith,
     compareAny,
 } = operator;
 
-const LINE = '__c4.mark(__l, __c)';
+const LINE = `__c4['🧨'](__l, __c)`;
 const buildLineNode = template(LINE, {
     placeholderPattern: /^__[a-z]$/,
 });
@@ -80,11 +80,11 @@ export const fix = (path, {options}) => {
         return;
     }
     
-    if (path.isAssignmentPattern()) {
-        replaceWithMultiple(path.get('right'), [
-            lineNode,
+    if (path.isAssignmentPattern() || path.isAssignmentExpression()) {
+        replaceWith(path.get('right'), SequenceExpression([
+            lineNode.expression,
             node.right,
-        ]);
+        ]));
         return;
     }
     
@@ -99,16 +99,13 @@ export const fix = (path, {options}) => {
     if (path.isReturnStatement())
         return addMarkToReturn(path, lineNode);
     
-    if (path.isArrowFunctionExpression())
+    if (path.isArrowFunctionExpression()) {
         return addMarkToArrowFunction(path, lineNode);
-    
-    if (path.isThrowStatement()) {
-        return replaceWith(path.get('argument'), SequenceExpression([
-            lineNode.expression,
-            node.argument,
-        ]));
     }
     
+    if (path.isThrowStatement())
+        return addMarkToThrow(path, lineNode);
+    
     replaceWith(path, BlockStatement([
         node,
     ]));
@@ -132,7 +129,7 @@ export const include = () => [
 ];
 
 export const traverse = ({push}) => ({
-    AssignmentPattern(path) {
+    'AssignmentPattern|AssignmentExpression'(path) {
         if (compareAny(path.get('right'), EXCLUDE))
             return;
         
@@ -170,7 +167,7 @@ export const traverse = ({push}) => ({
         const consequentPath = path.get('consequent');
         const alternatePath = path.get('alternate');
         
-        if (!consequentPath.isBlockStatement())
+        if (!consequentPath.isBlockStatement() && !compareAny(consequentPath, EXCLUDE))
             push(consequentPath);
         
         if (!alternatePath.node)

package/lib/report.js

@@ -1,12 +1,7 @@
 import chalk from 'chalk';
-import {readFileSync} from 'fs';
-
-const {parse} = JSON;
 const {entries} = Object;
 
-export const report = () => {
-    const coverageFile = parse(readFileSync('./coverage.json', 'utf8'));
-    
+export const report = (coverageFile) => {
     const files = [];
     const coverage = {
         files,
@@ -14,7 +9,7 @@ export const report = () => {
         uncoveredCount: 0,
     };
     
-    console.log('# TAP version 13');
+    console.log('# CAP version 13');
     console.log('');
     
     for (const {name, lines} of coverageFile) {
@@ -45,26 +40,30 @@ export const report = () => {
     for (const {name, covered, uncoveredLines} of files) {
         if (!covered) {
             console.log(`# ${name}`);
-            console.log('❌ should be covered');
+            console.log('🧨 should be covered');
             console.log('---');
-            console.log(`lines: ${chalk.red(uncoveredLines.join(','))}`);
+            console.log(`lines:`);
+            for (const line of uncoveredLines) {
+                console.log(`️- ${chalk.red(line)} at file://${name}:${line}`);
+            }
+            console.log('');
         }
     }
     
-    if (coverage.uncoveredCount)
-        console.log('');
-    
     console.log(`1..${files.length}`);
     console.log(`# files: ${files.length}`);
     console.log(`# covered: ${coverage.coveredCount}`);
     
+    console.log('');
+    
     if (!coverage.uncoveredCount) {
-        console.log('');
-        console.log('# ☘️  ok');
+        console.log('#️ 🌴 ok');
     }
     
     if (coverage.uncoveredCount) {
         console.log(`# 🧨 fail: ${coverage.uncoveredCount}`);
     }
+    
+    console.log('');
 };
 

package/lib/{parse.js → transform.js}

@@ -1,4 +1,4 @@
-export const parse = (files) => {
+export const transform = (files) => {
     const result = [];
     
     for (const [rawName, places] of files.entries()) {

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "escover",
-  "version": "1.0.3",
+  "version": "1.1.1",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "Coverage for EcmaScript Modules",
   "main": "lib/escover.js",
   "type": "module",
+  "bin": {
+    "escover": "bin/escover.js"
+  },
   "repository": {
     "type": "git",
     "url": "git://github.com/coderaiser/escover.git"
@@ -15,8 +18,11 @@
     "loader"
   ],
   "scripts": {
+    "loader": "madrun loader",
     "test": "madrun test",
+    "test:only": "madrun test:only",
     "coverage": "madrun coverage",
+    "c4": "madrun c4",
     "lint": "madrun lint",
     "fresh:lint": "madrun fresh:lint",
     "lint:fresh": "madrun lint:fresh",
@@ -30,9 +36,13 @@
   },
   "dependencies": {
     "chalk": "^5.0.0",
+    "find-cache-dir": "^3.3.2",
+    "find-up": "^6.2.0",
     "montag": "^1.2.1",
     "once": "^1.4.0",
-    "putout": "^23.5.0"
+    "putout": "^23.5.0",
+    "try-catch": "^3.0.0",
+    "yargs-parser": "^21.0.0"
   },
   "engines": {
     "node": ">=14"
@@ -41,6 +51,7 @@
   "devDependencies": {
     "@putout/test": "^4.1.0",
     "c8": "^7.8.0",
+    "escover": ".",
     "eslint": "^8.3.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-putout": "^12.2.0",

package/c4.json

@@ -1,15 +0,0 @@
-[{
-    "name": "changelog.js",
-    "lines": {
-        "1": false,
-        "7": false,
-        "9": false
-    }
-}, {
-    "name": "simple.js",
-    "lines": {
-        "1": true,
-        "7": true,
-        "9": true
-    }
-}]

package/coverage.json

@@ -1,8 +0,0 @@
-[
-    {
-        "name": "/Users/coderaiser/escover/example/example.js",
-        "lines": {
-            "1": true
-        }
-    }
-]

package/lib/save.js

@@ -1,14 +0,0 @@
-import {writeFileSync} from 'fs';
-import {getFiles} from './c4.js';
-import {parse} from './parse.js';
-import {merge} from './merge.js';
-
-const {stringify} = JSON;
-
-export const save = () => {
-    const files = getFiles();
-    const parsed = parse(files);
-    const merged = merge(parsed);
-    
-    writeFileSync('./coverage.json', stringify(merged, null, 4));
-};