refactoring

Sergii.Kliuchnyk · Sergii.Kliuchnyk · commit 4dc2a4234a7d · 2021-02-18T10:45:34.000+02:00
diff --git a/.npmignore b/.npmignore
@@ -1,3 +1,4 @@
+.idea
 ./bin
 ./data
 ./tests
diff --git a/README.md b/README.md
@@ -155,8 +155,13 @@ It's a function which takes three arguments:
  * `callback` - optional Node style callback which will receive html string as second argument
 
 If you pass to `engine` only path and locals then it will return html.
+```js
+engine('/path/to/view', {prop: 'value'}, (err, html) => console.log(html));
+
+const html = engine('/path/to/view', {prop: 'value'});
+```
 
-Also it has method `setOptions` which can modify [options](#options)
+Also, it has method `engine.setOptions(options)` which can modify [options](#options)
 
 ### options
 
@@ -167,44 +172,67 @@ const options = require('express-engine-jsx/options');
 Object with optional properties:
 
  * `doctype` - string which will be prepended to output html, default value is `"<!DOCTYPE html>\n"`
- * `replace` - function which will take output html (without doctype) and it should return new html
+ * `replace` - function which will take output html (without doctype), and it should return new html
  * `templatePath` - path to wrapper of compiled jsx, default value is `express-engine-jsx/template.jsx`. Undefined variable `BODY` will be replaced with your compiled jsx code.
  * `parserOptions` - options for [babel.parser](https://babeljs.io/docs/en/babel-parser#options)
+ * `templateOptions` - options for [babel.template](https://babeljs.io/docs/en/babel-template#options)
 
 ### require
 
 ```javascript
-const requireJSX = require('express-engine-jsx/require');
+const requireJSX = engine.require || require('express-engine-jsx/require');
 ```
 
 This is a function which you can use as regular `require` but this one can run jsx files. It checks if path is jsx file and if it is then `requireJSX` will [convert](#convert) this file to js code and then run it.
 
-Every compiled jsx file will be cached to `requireJSX.cache` object where key will be path to jsx file and value will be [vm.Script](https://nodejs.org/api/vm.html#vm_class_vm_script). 
+It also takes optional second parameter - `currentWorkingDir` which should be an absolute path to file directory which calls `require` in case when main path is relative.
+
+Every compiled jsx file will be cached to `requireJSX.cache` object where key will be path to jsx file and value will be value of `module.exports` inside jsx file, usually react component. 
 You can delete any key in this cache, requireJSX will recompile jsx file on next call.
 
 ### convert
 
 ```javascript
-const convert = require('express-engine-jsx/convert');
+const convert = engine.convert || require('express-engine-jsx/convert');
 ```
 
-It is a function which can convert jsx view files to [vm.Script](https://nodejs.org/api/vm.html#vm_class_vm_script).
-```js
-const script = convert('/path/to/view.jsx');
-
-const context = {
-   module: {
-      exports: {}
-   },
-   __dirname: script.dirname,
-   require: requireJSX,
-};
+It is a function which can convert jsx template code to js code.
+
+Arguments:
+
+ * `code` - string of jsx code
+ * `options`
+   * `parserOptions` - options for [babel.parser](https://babeljs.io/docs/en/babel-parser#options)
+   * `template` - string of jsx code wrapper
+   * `templatePath` - string, path to jsx code wrapper
+   * `templateOptions` - options for [babel.template](https://babeljs.io/docs/en/babel-template#options)
+    
+It also has `convert.cache` object for compiled templates where keys are `templatePath` and values are functions created by [babel.template](https://babeljs.io/docs/en/babel-template)
 
-script.runInNewContext(context);
+## run
 
-const ViewComponent = context.module.exports;
+```javascript
+const run = engine.run || require('express-engine-jsx/run');
+```
+
+Function which can execute js code with independent context and returns result of `module.exports` inside js code.
+
+Arguments:
+
+ * `code` - string of js code
+ * `options`
+   * `path` - string, path to file, usually path to jsx file
+   * `context` - object which properties will be global variables inside js code
+   * `scriptOptions` - object options for [vm.Script](https://nodejs.org/api/vm.html#vm_class_vm_script)
+    
+## Context
+
+```javascript
+const Context = engine.Context || require('express-engine-jsx/Context');
 ```
 
+React context which used to bypass locals to components
+
 ## attr-map
 
 ```javascript
@@ -246,14 +274,14 @@ In javascript you can omit `;` and write like this
 "second"
 ```
 
-It do nothing but it's valid code. In JSX you can't do same thing with elements
+It does nothing, but it's valid code. In JSX you can't do same thing with elements
 
 ```html
 <div>first</div>
 <div>second</div>
 ```
 
-It will throw compilation error. It waiting for `;` after first element. You have three options to solve this problem.
+It will throw compilation error. It's waiting for `;` after first element. You have three options to solve this problem.
 
 First - use `;`
 
diff --git a/convert.js b/convert.js
@@ -1,20 +1,24 @@
 const babel = require('@babel/core');
 const parser = require('@babel/parser');
 const traverse = require('@babel/traverse').default;
-const template = require('@babel/template').default;
+const createTemplate = require('@babel/template').default;
 const t = require('@babel/types');
 const fs = require('fs');
-const {basename} = require('path');
-const vm = require('vm');
 const attrMap = require('./attr-map');
 const options = require('./options');
 
-var createExportFunction;
+module.exports = convert;
 
-module.exports = function convert(jsxPath) {
-	const code = fs.readFileSync(jsxPath).toString();
+convert.cache = {};
 
-	let ast = parser.parse(code, options.parserOptions);
+function convert(code, params = {}) {
+	if (code instanceof Buffer) {
+		code = code.toString();
+	}
+
+	let {parserOptions, template, templatePath, templateOptions} = params;
+
+	var ast = parser.parse(code, parserOptions || options.parserOptions);
 
 	traverse(ast, {
 		enter: function prepare(path) {
@@ -55,19 +59,33 @@ module.exports = function convert(jsxPath) {
 		}
 	});
 
-	if (!createExportFunction) {
-		createExportFunction = template(
-			fs.readFileSync(options.templatePath).toString(),
-			{
-				parser: {
-					strictMode: false
-				},
-				strictMode: false
-			}
+	templatePath = templatePath || options.templatePath;
+
+	if (templatePath && !template) {
+		if (convert.cache[templatePath]) {
+			template = convert.cache[templatePath];
+		}
+		else {
+			template = fs.readFileSync(templatePath).toString();
+		}
+	}
+
+	if (template instanceof Buffer) {
+		template = template.toString();
+	}
+
+	if (typeof template === 'string') {
+		template = createTemplate(
+			template,
+			templateOptions || options.templateOptions
 		);
 	}
 
-	ast = createExportFunction({
+	if (typeof template !== 'function') {
+		throw new Error('Undefined template');
+	}
+
+	ast = template({
 		BODY: ast.program.body
 	});
 
@@ -80,9 +98,5 @@ module.exports = function convert(jsxPath) {
 		]
 	});
 
-	const script = new vm.Script(res.code, {
-		filename: basename(jsxPath)
-	});
-
-	return script;
-};
+	return res.code;
+}
diff --git a/index.d.ts b/index.d.ts
@@ -6,10 +6,31 @@ declare namespace engine {
         doctype?: string;
         replace?: (html: string) => string;
         templatePath?: string;
-        parserOptions?: object;
+        parserOptions?: import('@babel/parser/typings/babel-parser').ParserOptions;
     }
 
-    export function setOptions(params: Options);
+    interface ConvertOptions {
+        parserOptions?: import('@babel/parser/typings/babel-parser').ParserOptions,
+        template?: string | Buffer | (({BODY}) => any),
+        templatePath?: string,
+        templateOptions?: import('babylon').BabylonOptions,
+    }
+
+    interface RunOptions {
+        path?: string,
+        context?: object,
+        scriptOptions?: import('node:vm').ScriptOptions,
+    }
+
+    export function setOptions(options: Options): void;
+
+    export function require(path: string, currentWorkingDir?: string): any;
+
+    export function convert(code: string|Buffer, options?: ConvertOptions): any;
+
+    export function run(code: string|Buffer, options?: RunOptions): any;
+
+    export const Context: import('react').Context<{ locales: object, settings: object }>;
 }
 
 export = engine;
diff --git a/index.js b/index.js
@@ -2,6 +2,8 @@ const React = require('react');
 const ReactDOM = require('react-dom/server');
 const options = require('./options');
 const requireJSX = require('./require');
+const convert = require('./convert');
+const run = require('./run');
 const Context = require('./Context');
 
 module.exports = engine;
@@ -44,4 +46,9 @@ engine.setOptions = function (params) {
 	}
 
 	return engine;
-};
+};
+
+engine.require = requireJSX;
+engine.convert = convert;
+engine.run = run;
+engine.Context = Context;
diff --git a/options.js b/options.js
@@ -8,6 +8,9 @@ module.exports = {
 			'jsx'
 		],
 	},
+	templateOptions: {
+		strictMode: false
+	},
 	doctype: "<!DOCTYPE html>\n",
 	replace: null,
 	templatePath: resolve(__dirname, 'template.jsx'),
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "express-engine-jsx",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "JSX engine for ExpressJS",
   "main": "index.js",
   "types": "index.d.ts",
@@ -32,6 +32,9 @@
     "@babel/types": "^7.12.13"
   },
   "devDependencies": {
+    "@types/babylon": "^6.16.5",
+    "@types/node": "^14.14.28",
+    "@types/react": "^17.0.2",
     "chai": "^4.3.0",
     "mocha": "^8.3.0"
   },
diff --git a/require.js b/require.js
diff --git a/run.js b/run.js

-Original file line number
+Diff line change
@@ @@ -1,3 +1,4 @@ @@
 +.idea
 ./bin
 ./data
 ./tests