use dist paths

Author: rohit-gohri

.gitignore

@@ -8,3 +8,9 @@ dist/
 cypress-coverage/
 yarn.lock
 .parcel-cache
+
+
+# dist
+./*.js
+./middleware
+./lib

README.md

@@ -14,7 +14,7 @@ Then add the code below to the `supportFile` and `setupNodeEvents` function.
 
 ```js
 // cypress/support/e2e.js
-import 'cypress-code-coverage-v8/support'
+import 'cypress-code-coverage-v8/dist/support'
 ```
 
 ```js
@@ -26,7 +26,7 @@ module.exports = defineConfig({
   // the e2e or component configuration
   e2e: {
     setupNodeEvents(on, config) {
-      require('cypress-code-coverage-v8/plugins')(on, config)
+      require('cypress-code-coverage-v8/dist/plugins')(on, config)
       // include any other plugin code...
 
       // It's IMPORTANT to return the config object
@@ -131,7 +131,7 @@ You can also instrument your server-side code and produce a combined coverage re
 ```js
 const express = require('express')
 const app = express()
-require('cypress-code-coverage-v8/middleware/express')(app)
+require('cypress-code-coverage-v8/dist/middleware/express')(app)
 ```
 
 For any other server, define the endpoint yourself and return the coverage object:

package-lock.json

@@ -3,32 +3,6 @@
   "version": "0.0.0-development",
   "description": "Saves the code coverage collected during Cypress tests",
   "main": "dist/support.js",
-  "exports": {
-    ".": {
-      "default": "./dist/support.js",
-      "types": "./dist/support.d.ts"
-    },
-    "./*": {
-      "default": "./dist/*.js",
-      "types": "./dist/*.d.ts"
-    },
-    "./middleware/*": {
-      "default": "./dist/middleware/*.js",
-      "types": "./dist/middleware/*.d.ts"
-    },
-    "./plugins": {
-      "default": "./dist/plugins.js",
-      "types": "./dist/plugins.d.ts"
-    },
-    "./register": {
-      "default": "./dist/register.js",
-      "types": "./dist/register.d.ts"
-    },
-    "./support": {
-      "default": "./dist/support.js",
-      "types": "./dist/support.d.ts"
-    }
-  },
   "scripts": {
     "start": "parcel serve cypress/index.html",
     "coverage:verify": "npx nyc report --check-coverage true --lines 80",
@@ -91,7 +65,7 @@
     "@types/debug": "^4.1.12",
     "@types/express": "^4.17.21",
     "@types/js-yaml": "^4.0.9",
-    "@types/koa": "^2.15.0",
+    "@types/koa": "2.13.4",
     "@types/node": "^20.11.19",
     "check-code-coverage": "1.10.5",
     "console-log-div": "0.6.3",

package.json

@@ -1,15 +1,16 @@
 const { isCoverageEnabled } = require('../lib/common/isEnabled')
-const { debug } = require('../lib/common/common-utils');
+const { debug } = require('../lib/common/common-utils')
 
 /**
  * for Express.js
  *
  * @example Use like
  * ```ts
+ * require('cypress-code-coverage-v8/dist/register');
  * const express = require('express')
  * const app = express()
  * // @see https://github.com/rohit-gohri/cypress-code-coverage-v8
- * require('cypress-code-coverage-v8/middleware/express')(app)
+ * require('cypress-code-coverage-v8/dist/middleware/express')(app)
  * ```
  *
  * Then add to your cypress.json an environment variable pointing at the API
@@ -23,7 +24,7 @@ const { debug } = require('../lib/common/common-utils');
  *   }
  * }
  * ```
- * 
+ *
  * @param {import('express').Application} app
  */
 module.exports = (app) => {
@@ -32,9 +33,7 @@ module.exports = (app) => {
     return
   }
 
-  const {
-    takePreciseCoverage
-  } = require('../lib/register/v8Interface')
+  const { takePreciseCoverage } = require('../lib/register/v8Interface')
 
   // expose "GET __coverage__" endpoint that just returns
   // global coverage information (if the application has been instrumented)

src/middleware/express.js

@@ -1,13 +1,14 @@
 const { isCoverageEnabled } = require('../lib/common/isEnabled')
-const { debug } = require('../lib/common/common-utils');
+const { debug } = require('../lib/common/common-utils')
 
 /**
  * for Hapi.js
  *
  *  * @example Use like
  * ```ts
+ * require('cypress-code-coverage-v8/dist/register');
  * const Hapi = require('@hapi/hapi');
- * const coverageRoutes = require('cypress-code-coverage-v8/middleware/hapi');
+ * const coverageRoutes = require('cypress-code-coverage-v8/dist/middleware/hapi');
  *
  * const init = async () => {
  *   const server = Hapi.server({
@@ -22,7 +23,7 @@ const { debug } = require('../lib/common/common-utils');
  *   console.log('Server running on %s', server.info.uri);
  * };
  * ```
- * 
+ *
  * Then add to your cypress.json an environment variable pointing at the API
  * ```json
  * {
@@ -53,7 +54,6 @@ module.exports = (server) => {
     method: 'GET',
     path: '/__coverage__',
     async handler() {
-
       return { coverage: (await takePreciseCoverage()) || null }
     }
   })

src/middleware/hapi.js

@@ -1,19 +1,19 @@
 const { isCoverageEnabled } = require('../lib/common/isEnabled')
-const { debug } = require('../lib/common/common-utils');
+const { debug } = require('../lib/common/common-utils')
 
 /**
  * for Koa
  *
  * @example Use like
- * 
+ *
  * ```ts
- * require('cypress-code-coverage-v8/register');
+ * require('cypress-code-coverage-v8/dist/register');
  * const Koa = require('koa')
  * const app = new Koa();
  * // @see https://github.com/rohit-gohri/cypress-code-coverage-v8
- * require('cypress-code-coverage-v8/middleware/koa')(app)
+ * require('cypress-code-coverage-v8/dist/middleware/koa')(app)
  * ```
- * 
+ *
  * Then add to your cypress.json an environment variable pointing at the API
  * ```json
  * {
@@ -34,7 +34,7 @@ module.exports = (app) => {
     return
   }
   debug('adding koa middleware, code coverage is enabled')
-  
+
   const { takePreciseCoverage } = require('../lib/register/v8Interface')
   // expose "GET __coverage__" endpoint that just returns
   // global coverage information (if the application has been instrumented)

src/middleware/koa.js

@@ -11,10 +11,10 @@ if (isCoverageEnabled()) {
  *
  * @example in your pages/api/__coverage__.js
  * ```ts
- * import coverageHandler from 'cypress-code-coverage-v8/middleware/nextjs';
+ * import coverageHandler from 'cypress-code-coverage-v8/dist/middleware/nextjs';
  * export default coverageHandler;
  * ```
- * 
+ *
  * Then add to your cypress.json an environment variable pointing at the API
  * ```json
  * {
@@ -29,7 +29,7 @@ if (isCoverageEnabled()) {
  *
  * @see https://nextjs.org/docs#api-routes
  * @see https://github.com/rohit-gohri/cypress-code-coverage-v8
- * 
+ *
  * @param {import('next').NextApiRequest} _req
  * @param {import('next').NextApiResponse} res
  */
@@ -42,9 +42,19 @@ module.exports = async function returnCodeCoverageNext(_req, res) {
   }
 
   const { takePreciseCoverage } = require('../lib/register/v8Interface')
+  const coverage = await takePreciseCoverage()
 
-  // only GET is supported
-  res.status(200).json({
-    coverage: (await takePreciseCoverage()) || null
-  })
+  if (!coverage) {
+    // only GET is supported
+    res.status(200).json({
+      coverage: null
+    })
+  } else {
+    console.error(coverage)
+    // TODO: Convert webpack paths to files, convert package alias to file path
+    // example:
+    res.status(200).json({
+      coverage
+    })
+  }
 }

src/middleware/nextjs.js

@@ -10,7 +10,7 @@ const addTasks = require('./lib/plugin/task')
     // your plugins file
     
     module.exports = (on, config) => {
-      require('cypress-code-coverage-v8/plugins').coveragePlugin(on, config)
+      require('cypress-code-coverage-v8/dist/plugins').coveragePlugin(on, config)
       // IMPORTANT to return the config object
       // with the any changed environment variables
       return config