Merge pull request #6 from astrohelm/dev

Isolation v1.6.0

Author: shuritch

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [Unreleased][unreleased]
 
+## [1.6.0][] - 2023-11-26
+
+- Code quality improvements
+- Changelog linking fixes
+- Npm published
+
 ## [1.5.0][] - 2023-10-30
 
 - Depth field, now you can limit depth
@@ -85,6 +91,11 @@
 - Quality of life improvements
 - Massive README update, documentation improvement
 
-[unreleased]: https://github.com/astrohelm/astroctx/compare/v1.1.0...HEAD
+[unreleased]: https://github.com/astrohelm/astroctx/compare/v1.6.0...HEAD
+[1.6.0]: https://github.com/astrohelm/astroctx/compare/v1.5.0...v1.6.0
+[1.5.0]: https://github.com/astrohelm/astroctx/compare/v1.4.0...v1.5.0
+[1.4.0]: https://github.com/astrohelm/astroctx/compare/v1.3.0...v1.4.0
+[1.3.0]: https://github.com/astrohelm/astroctx/compare/v1.2.0...v1.3.0
+[1.2.0]: https://github.com/astrohelm/astroctx/compare/v1.1.0...v1.2.0
 [1.1.0]: https://github.com/astrohelm/astroctx/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/astrohelm/astroctx/releases/tag/v1.0.0

lib/parser.js

@@ -1,47 +1,49 @@
 'use strict';
 
-const [REGEXP_JS, READDIR_OPTS] = [/^\.[cme]?js$/, { withFileTypes: true }];
-const [Script, { checkAccess }] = [require('./script'), require('./utils')];
 const { basename, extname, join, dirname } = require('node:path');
 const { readFile, readdir, stat } = require('node:fs').promises;
+const { prepare, execute } = require('./script');
+const { checkAccess } = require('./utils');
+const READ_OPTS = { withFileTypes: true };
+const JS_EXT = /^\.[cme]?js$/;
+module.exports = from;
 
-const from = async (src, options = {}) => {
+async function from(src, options = {}) {
   if (src !== '.' && src !== '..' && basename(src) === src) {
     const { prepare, ...estimated } = options;
-    if (prepare) return Script.prepare(src, estimated);
-    return new Script(src, estimated);
+    if (prepare) return prepare(src, estimated);
+    return execute(src, estimated);
   }
   const reader = (await stat(src)).isDirectory() ? from.dir : from.file;
-  const result = await reader(src, options);
-  return result;
-};
+  return reader(src, options);
+}
 
 from.file = async (path, options = {}) => {
   const src = await readFile(path, 'utf8');
   if (!src) throw new SyntaxError(`File ${path} is empty`);
-  const [filename, dir] = [basename(path), dirname(path)];
-  const runner = options.prepare ? Script.prepare : Script.execute;
+  const { 0: filename, 1: dir } = [basename(path), dirname(path)];
+  const runner = options.prepare ? prepare : execute;
   return runner(src, { ...options, filename, dir, prepare: undefined });
 };
 
 from.dir = (src, options = {}) => {
-  const { depth: max = true, ...estimated } = options;
-  const isAllowed = checkAccess.bind(null, 'reader', estimated.access);
-  const pull = async (src, depth) => {
-    const dontGoDeep = typeof max === 'number' && depth + 1 > max;
-    const files = await readdir(src, READDIR_OPTS);
+  const { depth: max = true, access } = options;
+  const isAllowed = checkAccess.bind(null, 'reader', access);
+  const pull = async (src, depth = 1) => {
+    const futher = typeof max === 'number' && depth + 1 > max;
+    const files = await readdir(src, READ_OPTS);
     const scripts = {};
     // prettier-ignore
     await Promise.all(files.map(async file => {
-      const [path, isDir, ext] = [join(src, file.name), file.isDirectory(), extname(file.name)];
-      if (!isAllowed(path) || (isDir && dontGoDeep)) return;
+      const isDir = file.isDirectory();
+      const path = join(src, file.name);
+      if (!isAllowed(path) || (isDir && futher)) return;
       const promise = isDir ? pull(path, depth + 1) : from.file(path, options);
-      const name = basename(file.name, ext.match(REGEXP_JS) ? ext : '');
+      const ext = extname(file.name);
+      const name = basename(file.name, ext.match(JS_EXT) ? ext : '');
       scripts[name] = await promise;
     }));
     return Object.assign({}, scripts);
   };
-  return pull(src, 1);
+  return pull(src);
 };
-
-module.exports = from;

lib/script.js

@@ -1,35 +1,34 @@
 'use strict';
 
+const { Script: VM, createContext } = require('node:vm');
+const createRequire = require('./require');
+module.exports = Script;
+
 const RSTRICT = /['"]use strict['"];\n?/g;
-const [{ Script: VM, createContext }, createRequire] = [require('node:vm'), require('./require')];
 const cjs = src => `((exports, require, module, __filename, __dirname) => {\n${src}\n});`;
 const wrap = src => `'use strict';\n` + cjs(src.replace(RSTRICT, ''));
 
-const Script = function (src, opts = {}) {
+function Script(src, opts = {}) {
   if (!new.target) return new Script(src, opts);
-  const { script = {}, run = {}, ctx = {}, filename = 'ISO', dir = process.cwd() } = opts;
-  const machine = new VM(wrap(src), { filename, lineOffset: -1 - !src.match(RSTRICT), ...script });
+  const { script = {}, run = {}, ctx = {}, filename = 'Astro', dir = process.cwd() } = opts;
+  const lineOffset = src.includes('use strict') ? -1 : -2;
+  const machine = new VM(wrap(src), { filename, lineOffset, ...script });
   const require = createRequire({ ...opts, dir }, Script.execute);
-  const context = Script.sandbox(ctx);
+  const context = Script.sandbox(Object.freeze(ctx));
 
-  [this.name, this.dir] = [filename, dir];
+  this.name = filename;
+  this.dir = dir;
   this.execute = (ctx = context) => {
     const module = { exports: {} };
     const closure = machine.runInContext(Script.sandbox(ctx), { timeout: 1000, ...run });
     return closure(module.exports, require, module, this.name, this.dir), module.exports;
   };
-
-  return this;
-};
+}
 
 Script.prepare = (src, opts) => new Script(src, opts);
 Script.execute = (src, opts) => new Script(src, opts).execute();
 Script.sandbox = Object.assign((ctx, mode = false) => {
   if (!ctx) return Script.sandbox.EMPTY;
-  return createContext(ctx, {
-    ...Script.sandbox.OPTIONS,
-    preventEscape: mode ? 'afterEvaluate' : '',
-  });
+  const preventEscape = mode ? 'afterEvaluate' : '';
+  return createContext(ctx, { ...Script.sandbox.OPTIONS, preventEscape });
 }, require('./ctx'));
-
-module.exports = Script;