feat: support for multiline comment for languages that use JS regex

example-project/languages/ocaml.ml → example-project/languages/ocaml-lang.ml

@@ -1,2 +1,2 @@
-/* cc:main function */
+(* cc:main function *)
 let hello = () => "Hello, World!";

example-project/src-client/auth/actions.js

@@ -10,7 +10,9 @@ import {
 
 function authenticate(provider) {
   return dispatch => {
-    //cc:signin#1;firebase sign in;+1;call to firebase with auth provider, proceed if success response
+    /*
+    * cc:signin#1;firebase sign in;+1;call to firebase with auth provider, proceed if success response
+    */
     firebaseAuth.signInWithPopup(provider)
       .then(result => dispatch(signInSuccess(result)))
       .catch(error => dispatch(signInError(error)));

package.json

@@ -49,6 +49,7 @@
     "redux-persist": "^5.10.0",
     "redux-saga": "^0.16.0",
     "redux-thunk": "^2.2.0",
+    "regex-comment": "^1.0.2",
     "reselect": "^4.0.0",
     "watchpack": "^1.6.0",
     "websocket": "1.0.27"

src/server/code-parse/language/default/codecrumbs.js

@@ -1,7 +1,8 @@
+const compact = require('lodash/compact');
 const { CC_NODE_TYPE, NO_TRAIL_FLOW } = require('../../../shared-constants');
 
-const CRUMB = 'codecrumb',
-  CRUMB_SHORT_HANDLER = 'cc';
+const CRUMB_REGEX = /cc|codecrumb/;
+import { DEFAULT_REGEX } from "regex-comment/lib/index";
 
 const getCommentNodeValue = node => (node.value || '').trim();
 
@@ -38,12 +39,7 @@ const parseCodecrumbComment = (node = {}) => {
   return cc;
 };
 
-const isCodecrumb = node => {
-  if (!node) return false;
-
-  const comment = getCommentNodeValue(node);
-  return comment.startsWith(CRUMB) || comment.startsWith(CRUMB_SHORT_HANDLER);
-};
+const isCodecrumb = node => CRUMB_REGEX.test(getCommentNodeValue(node));
 
 const buildCrumb = (params, crumbNodeLines, path) => ({
   type: CC_NODE_TYPE,
@@ -57,22 +53,21 @@ const buildCrumb = (params, crumbNodeLines, path) => ({
 });
 
 const setupGetCommentsFromCode = regex => fileCode => {
-  if (!fileCode) return [];
-
-  return fileCode.split('\n').reduce((comments, item, i) => {
-    const codeLine = item.trim();
-    if (!codeLine) return comments;
-
-    const matches = regex.exec(codeLine);
-    if (matches) {
-      const lineNumber = i + 1;
-      return [
-        ...comments,
-        { value: matches[matches.length - 1], nodeLines: [lineNumber, lineNumber] }
-      ];
-    }
+  if (!fileCode) {
+    return [];
+  }
+
+  const result = fileCode.match(regex) || [];
+
+  return result.reduce((comments, value) => {
+    value = value.trim()
+    const index = fileCode.indexOf(value);
+    const tempString = fileCode.substring(0, index);
+    const matchLineNumber = tempString.split('\n').length;
 
-    return comments;
+    const commentStringCount = value.split('\n').length
+    const nodeLines = [matchLineNumber, matchLineNumber + commentStringCount - 1];
+    return [...comments, { value, nodeLines }]
   }, []);
 };
 
@@ -99,8 +94,7 @@ const setupGetCrumbs = getCommentsFromCode => (fileCode, path) => {
   }
 };
 
-const DEFAULT_COMMENT_REGEX = /^([^\/\/]*)\/\/(.*)$/;
-const getCrumbs = setupGetCrumbs(setupGetCommentsFromCode(DEFAULT_COMMENT_REGEX));
+const getCrumbs = setupGetCrumbs(setupGetCommentsFromCode(DEFAULT_REGEX));
 
 module.exports = {
   getCrumbs,

src/server/code-parse/language/fortran/codecrumbs.js

@@ -1,7 +1,7 @@
 const { setupGetCrumbs, setupGetCommentsFromCode } = require('../default/codecrumbs');
 
-const FORTRAN_COMMENT_REGEX = /^([^!]*)!(.*)$/;
-const getCrumbs = setupGetCrumbs(setupGetCommentsFromCode(FORTRAN_COMMENT_REGEX));
+import { FORTRAN_REGEX } from "regex-comment/lib/index";
+const getCrumbs = setupGetCrumbs(setupGetCommentsFromCode(FORTRAN_REGEX));
 
 // replace with own implementation if needed
 module.exports = {

src/server/code-parse/language/haskell/codecrumbs.js

@@ -1,9 +1,10 @@
 const { setupGetCrumbs, setupGetCommentsFromCode } = require('../default/codecrumbs');
+import { HASKELL_REGEX } from "regex-comment/lib/index";
 
-const HASKELL_COMMENT_REGEX = /^([^--]*)--(.*)$/;
-const getCrumbs = setupGetCrumbs(setupGetCommentsFromCode(HASKELL_COMMENT_REGEX));
+const getCrumbs = setupGetCrumbs(setupGetCommentsFromCode(HASKELL_REGEX));
 
 // replace with own implementation if needed
 module.exports = {
   getCrumbs
 };
+console.log('//foo')

src/server/code-parse/language/lua/codecrumbs.js

@@ -1,7 +1,7 @@
 const { setupGetCrumbs, setupGetCommentsFromCode } = require('../default/codecrumbs');
 
-const LUA_COMMENT_REGEX = /^([^--]*)--(.*)$/;
-const getCrumbs = setupGetCrumbs(setupGetCommentsFromCode(LUA_COMMENT_REGEX));
+import { LUA_REGEX } from "regex-comment/lib/index";
+const getCrumbs = setupGetCrumbs(setupGetCommentsFromCode(LUA_REGEX));
 
 // replace with own implementation if needed
 module.exports = {

src/server/code-parse/language/ocaml/codecrumbs.js

@@ -1,8 +1,7 @@
 const { setupGetCrumbs, setupGetCommentsFromCode } = require('../default/codecrumbs');
 
-const OCAML_COMMENT_REGEX = /\/\*(.*?)\*\//;
-
-const getCrumbs = setupGetCrumbs(setupGetCommentsFromCode(OCAML_COMMENT_REGEX));
+import { OCAML_REGEX } from "regex-comment/lib/index";
+const getCrumbs = setupGetCrumbs(setupGetCommentsFromCode(OCAML_REGEX));
 
 // replace with own implementation if needed
 module.exports = {

src/server/code-parse/language/perl/codecrumbs.js

@@ -1,7 +1,7 @@
 const { setupGetCrumbs, setupGetCommentsFromCode } = require('../default/codecrumbs');
 
-const PERL_COMMENT_REGEX = /^([^#]*)#(.*)$/;
-const getCrumbs = setupGetCrumbs(setupGetCommentsFromCode(PERL_COMMENT_REGEX));
+import { PERL_REGEX } from "regex-comment/lib/index";
+const getCrumbs = setupGetCrumbs(setupGetCommentsFromCode(PERL_REGEX));
 
 // replace with own implementation if needed
 module.exports = {

src/server/code-parse/language/python/codecrumbs.js

@@ -1,7 +1,7 @@
 const { setupGetCrumbs, setupGetCommentsFromCode } = require('../default/codecrumbs');
 
-const PYTHON_COMMENT_REGEX = /^([^#]*)#(.*)$/;
-const getCrumbs = setupGetCrumbs(setupGetCommentsFromCode(PYTHON_COMMENT_REGEX));
+import { PYTHON_REGEX } from "regex-comment/lib/index";
+const getCrumbs = setupGetCrumbs(setupGetCommentsFromCode(PYTHON_REGEX));
 
 // replace with own implementation if needed
 module.exports = {

src/server/code-parse/language/ruby/codecrumbs.js

@@ -1,7 +1,7 @@
 const { setupGetCrumbs, setupGetCommentsFromCode } = require('../default/codecrumbs');
 
-const RUBY_COMMENT_REGEX = /^([^#]*)#(.*)$/;
-const getCrumbs = setupGetCrumbs(setupGetCommentsFromCode(RUBY_COMMENT_REGEX));
+import { RUBY_REGEX } from "regex-comment/lib/index";
+const getCrumbs = setupGetCrumbs(setupGetCommentsFromCode(RUBY_REGEX));
 
 // replace with own implementation if needed
 module.exports = {

src/server/utils/logger.js

@@ -6,7 +6,12 @@ const logAdapter = (msg, force) => (isDebugModeEnabled || force) && console.log(
 module.exports = {
   getText: e => {
     try {
-      return typeof e === 'object' ? JSON.stringify(e) : e;
+      if (typeof e === 'object') {
+        const stringifiedError = JSON.stringify(e);
+        return stringifiedError === '{}' ? e : stringifiedError;
+      } else {
+        return e;
+      }
     } catch (e) {
       return `COULD NOT PARSE ERROR ${e}`;
     }