Merge pull request #246 from codeceptjs/some-improvements

- handle errors when cannot load the docs - open the links in new browser tab - improve some scripts
codeceptjs · Feb 8, 2024 · bb86601 · bb86601
2 parents 4b8f413 + d6ea3de
commit bb86601
Show file tree

Hide file tree

Showing 5 changed files with 9,190 additions and 36,360 deletions.
diff --git a/lib/api/list-actions.js b/lib/api/list-actions.js
@@ -8,37 +8,34 @@ const codeceptjsFactory = require('../model/codeceptjs-factory');
 const { methodsOfObject } = require('codeceptjs/lib/utils');
 
 module.exports = (req, res) => {
+  const { container } = codeceptjsFactory.getInstance();
+  const docsWebApiFolderPath = path.join(path.dirname(require.resolve('codeceptjs')), '/../docs/webapi');
+  const docFileList = [];
   try {
-    const { container } = codeceptjsFactory.getInstance();
-    const docsWebApiFolderPath = path.join(path.dirname(require.resolve('codeceptjs')), '/../docs/webapi');
-    const docFileList = [];
     fs.readdirSync(docsWebApiFolderPath).map(fileName => {
       docFileList.push(path.basename(fileName,'.mustache'));
     });
-    const helpers = container.helpers();
-    const actions = {};
-    for (const name in helpers) {
-      const helper = helpers[name];
-      methodsOfObject(helper).forEach((action) => {
-
-        if(docFileList.includes(action)) {
-          let filePath = path.join(docsWebApiFolderPath, action + '.mustache');
-          let fn = helper[action].toString().replace(/\n/g,' ').replace(/\{.*\}/gm,'{}');
-          try{
-            let docData = fs.readFileSync(filePath, 'utf-8');
-            let params = parser.parse(fn);
-            actions[action] = { params: params, actionDoc: docData };
-          } catch(err) {
-            debug('Error in fetching doc for file content', fn, err);
-          }
-        }
-
-      });
-    }
-
-    res.send({ actions });
   } catch (e) {
-    debug(`Could not fetch documentation due to: ${e.message}`);
+    debug(`No documentation found due to ${e.message}`);
   }
+  const helpers = container.helpers();
+  const actions = {};
+  for (const name in helpers) {
+    const helper = helpers[name];
+    methodsOfObject(helper).forEach((action) => {
 
+      if (docFileList.includes(action)) {
+        let filePath = path.join(docsWebApiFolderPath, action + '.mustache');
+        let fn = helper[action].toString().replace(/\n/g, ' ').replace(/\{.*\}/gm, '{}');
+        try {
+          let docData = fs.readFileSync(filePath, 'utf-8');
+          let params = parser.parse(fn);
+          actions[action] = {params: params, actionDoc: docData};
+        } catch (err) {
+          debug('Error in fetching doc for file content', fn, err);
+        }
+      }
+    });
+  }
+  res.send({ actions });
 };
diff --git a/lib/app.js b/lib/app.js
@@ -1,7 +1,7 @@
 'use strict';
 
 const path = require('path');
-const { BrowserWindow, app } = require('electron');
+const { BrowserWindow, app, shell } = require('electron');
 const { getPort } = require('./config/env');
 
 const NAME = 'CodeceptUI';
@@ -24,14 +24,14 @@ function createWindow() {
   const x = screenWidth - Math.max(width, 500);
   // Create the browser window.
   win = new BrowserWindow({
-    width,
+    width: screenWidth / 1.2,
     height: screenHeight,
     minWidth: 500,
     x,
     y: 0,
     title: NAME,
     autoHideMenuBar: true,
-    icon: path.join(__dirname, '../build/icons/64x64.png'),
+    icon: path.join(__dirname, '/build/icons/64x64.png'),
     webPreferences: {
       nodeIntegration: true,
       nodeIntegrationInWorker: true,
@@ -46,6 +46,11 @@ function createWindow() {
   win.on('closed', () => {
     win = null;
   });
+
+  win.webContents.setWindowOpenHandler(({ url }) => {
+    // open url in a browser and prevent default
+    shell.openExternal(url);
+  });
 }
 
 // Quit when all windows are closed.