@jscad/core 2.6.12 → 3.0.1-alpha.0

package/src/code-loading/webRequire.test.js

@@ -1,9 +1,9 @@
-const test = require('ava')
+import test from 'ava'
 
-const { registerAllExtensions } = require('../io/registerExtensions')
+import { registerAllExtensions } from '../io/registerExtensions.js'
 
-const makeWebRequire = require('./webRequire')
-const makeFakeFs = require('./makeFakeFs')
+import { makeWebRequire } from './webRequire.js'
+import { makeFakeFs } from './makeFakeFs.js'
 
 test.beforeEach((t) => {
 })
@@ -76,10 +76,9 @@ test('webRequire: should support require, from a directory with dependent files'
 
 test('webRequire: should allow using require.extensions like the native node require (simple)', (t) => {
   const registerJscadExtension = (fs, _require) => {
-    const stripBom = require('strip-bom')
     _require.extensions['.jscad'] = (module, filename) => {
       const content = fs.readFileSync(filename, 'utf8')
-      module._compile(stripBom(content), filename)
+      module._compile(content, filename)
     }
   }
 
@@ -107,7 +106,7 @@ test('webRequire: should allow using require.extensions like the native node req
   t.true(designRootModule.main instanceof Function)
 })
 
-test('webRequire: should allow using require.extensions like the native node require (parser)', (t) => {
+test.skip('webRequire: should allow using require.extensions like the native node require (parser)', (t) => {
   const registerStlExtension = (fs, _require) => {
     const { deserializers } = require('@jscad/io')
     const deserializer = deserializers.stl
@@ -168,7 +167,7 @@ const singleFileJs = [
     fullPath: '/logo.js',
     name: 'logo.js',
     source: `
-      const { cube } = require('@jscad/modeling').primitives
+      const { cube } = require('@jscad/modeling')
 
       const main = () => {
         return cube()
@@ -317,7 +316,7 @@ const directoryWithDependencies = [
         fullPath: '/project/file2.js',
         name: 'file2.js',
         source: `
-          const { cube } = require('@jscad/modeling').primitives
+          const { cube } = require('@jscad/modeling')
 
           const file2 = () => {
             return cube()

package/src/index.js

@@ -1,8 +1,15 @@
-module.exports = {
-  evaluation: require('./code-evaluation'),
-  io: require('./io'),
-  loading: require('./code-loading'),
-  parameters: require('./parameters'),
-  utils: require('./utils'),
-  web: require('./web')
+import * as evaluation from './code-evaluation/index.js'
+import * as io from './io/index.js'
+import * as loading from './code-loading/index.js'
+import * as parameters from './parameters/index.js'
+import * as utils from './utils/index.js'
+import * as web from './web/index.js'
+
+export {
+  evaluation,
+  io,
+  loading,
+  parameters,
+  utils,
+  web
 }

package/src/io/index.js

@@ -1,4 +1,2 @@
-module.exports = {
-  registerAllExtensions: require('./registerExtensions').registerAllExtensions,
-  unRegisterAllExtensions: require('./registerExtensions').unRegisterAllExtensions
-}
+export { registerAllExtensions } from './registerExtensions.js'
+export { unRegisterAllExtensions } from './registerExtensions.js'

package/src/io/registerExtensions.js

@@ -1,8 +1,9 @@
-const { deserializers } = require('@jscad/io')
+import stripBom from 'strip-bom'
+
+import { deserializers } from '@jscad/io'
 
 // FIXME: the unregistering does not work, look into it
 const registerJscadExtension = (fs, _require) => {
-  const stripBom = require('strip-bom')
   _require.extensions['.jscad'] = (module, filename) => {
     const content = fs.readFileSync(filename, 'utf8')
     module._compile(stripBom(content), filename)
@@ -16,17 +17,14 @@ const registerDeserializer = (extension, fs, _require) => {
   const deserializer = deserializers[extension]
   const fileExtension = '.' + extension
   _require.extensions[fileExtension] = (module, filename) => {
-    const fileReadResult = fs.readFileSync(filename)
-
-    // https://nodejs.org/api/buffer.html#bufbuffer: Buffer.buffer is not
+    const fileReadResult = fs.readFileSync(filename) // read into buffer
+    // NOTE: https://nodejs.org/api/buffer.html#bufbuffer: Buffer.buffer is not
     // guaranteed to correspond exactly to the original Buffer.
-    const fileContent = fileReadResult.buffer
-      ? fileReadResult.buffer.slice(
-          fileReadResult.byteOffset,
-          fileReadResult.byteOffset + fileReadResult.length)
-      : fileReadResult
+    const content = fileReadResult.buffer
+      ? fileReadResult.buffer.slice(fileReadResult.byteOffset, fileReadResult.byteOffset + fileReadResult.length)
+      : fileReadResult;
 
-    const parsed = deserializer({ filename, output: 'geometry' }, fileContent)
+    const parsed = deserializer({ filename, output: 'geometry' }, content)
     module.exports = parsed
   }
 }
@@ -35,7 +33,7 @@ const unregisterDeserializer = (extension, fs, _require) => {
   delete _require.extensions[fileExtension]
 }
 
-const registerAllExtensions = (fs, _require) => {
+export const registerAllExtensions = (fs, _require) => {
   registerJscadExtension(fs, _require)
 
   for (const extension of Object.keys(deserializers)) {
@@ -43,15 +41,10 @@ const registerAllExtensions = (fs, _require) => {
   }
 }
 
-const unRegisterAllExtensions = (fs, _require) => {
+export const unRegisterAllExtensions = (fs, _require) => {
   unRegisterJscadExtension(fs, _require)
 
   for (const extension of Object.keys(deserializers)) {
     unregisterDeserializer(extension, fs, _require)
   }
 }
-
-module.exports = {
-  registerAllExtensions,
-  unRegisterAllExtensions
-}

package/src/parameters/applyParameterDefinitions.js

@@ -1,4 +1,3 @@
-
 /**
  * casts the parameters/ get their correct values based on the
  * raw parameters (passed into the CLI tool for example) and the
@@ -7,7 +6,7 @@
  * @param {Array} parameterDefinitions
  * @returns {Object} the parameter values, as an object
  */
-const applyParameterDefinitions = (inputParameters, parameterDefinitions, throwOnNoDefinition = false) => {
+export const applyParameterDefinitions = (inputParameters, parameterDefinitions, throwOnNoDefinition = false) => {
   const values = Object.keys(inputParameters).reduce((paramValues, paramName) => {
     let value = inputParameters[paramName]
 
@@ -71,5 +70,3 @@ const valueForChoices = (inputValue, definition) => {
   value = definition.values.length > 0 && typeof value === 'boolean' ? !!value : value
   return value
 }
-
-module.exports = applyParameterDefinitions

package/src/parameters/getParameterDefinitionsAndValues.js

@@ -1,5 +1,5 @@
-const getParameterValuesFromParameters = require('./getParameterValuesFromParameters')
-const applyParameterDefinitions = require('./applyParameterDefinitions')
+import { getParameterValuesFromParameters } from './getParameterValuesFromParameters.js'
+import { applyParameterDefinitions } from './applyParameterDefinitions.js'
 
 const doesModuleExportParameterDefiniitions = (moduleToCheck) => moduleToCheck && 'getParameterDefinitions' in moduleToCheck
 
@@ -13,7 +13,8 @@ const getRawParameterDefinitionsAndValues = (rootModule, overrides) => {
   return { parameterDefinitions, parameterValues }
 }
 
-/** given the root/main module and optional parameter value overrides,
+/*
+ * given the root/main module and optional parameter value overrides,
  * returns parameterDefinitions & 'default' parameter values
  * the overrides are passed for to enable the parameter definitions to access the PREVIOUS
  * version of the parameter values
@@ -22,12 +23,10 @@ const getRawParameterDefinitionsAndValues = (rootModule, overrides) => {
  * @param  {Object} overrides an object containing parameter values, used as overrides
  * @returns {Object} { parameterValues, parameterDefinitions }
  */
-const getAllParameterDefintionsAndValues = (rootModule, overrides) => {
+export const getParameterDefinitionsAndValues = (rootModule, overrides) => {
   let { parameterDefinitions, parameterValues } = getRawParameterDefinitionsAndValues(rootModule, overrides)
   parameterValues = Object.assign({}, parameterValues, overrides)
   parameterValues = parameterValues ? applyParameterDefinitions(parameterValues, parameterDefinitions) : parameterValues
 
   return { parameterValues, parameterDefinitions }
 }
-
-module.exports = getAllParameterDefintionsAndValues

package/src/parameters/getParameterDefinitionsFromSource.js

@@ -1,4 +1,4 @@
-const JSON5 = require('json5')
+import JSON5 from 'json5'
 
 /* Count leading spaces in a line.
 This helps provide more descriptive comments after the parameter.
@@ -8,17 +8,17 @@ When comment line is indented more than parameter(incl. parameter name)
 it is considered as description of previous parameter and not a group definition.
 
 */
-const countSpaces = (l) => {
+const countSpaces = (line) => {
   let count = 0
-  for (let i = 0; i < l.length; i++) {
-    if (l[i] === ' ') count++
-    else if (l[i] === '\t') count += 2
+  for (let i = 0; i < line.length; i++) {
+    if (line[i] === ' ') count++
+    else if (line[i] === '\t') count += 2
     else break
   }
   return count
 }
 
-const getParameterDefinitionsFromSource = (script) => {
+export const getParameterDefinitionsFromSource = (script) => {
   const lines = []
   script.split('\n').forEach((l, i) => {
     const trim = l.trim()
@@ -94,7 +94,7 @@ const getParameterDefinitionsFromSource = (script) => {
   return defs
 }
 
-const parseOne = (comment, code, line1, line2) => {
+export const parseOne = (comment, code, line1, line2) => {
   let def = parseDef(code, line2)
   const { caption, options } = parseComment(comment, line1, def.name)
   def.caption = caption || def.name
@@ -126,7 +126,7 @@ const extractTextFromComment = (c, lineNum) => {
   return c
 }
 
-const parseComment = (comment, lineNum, paramName) => {
+export const parseComment = (comment, lineNum, paramName) => {
   comment = extractTextFromComment(comment, lineNum)
 
   const ret = {}
@@ -145,7 +145,7 @@ const parseComment = (comment, lineNum, paramName) => {
   return ret
 }
 
-const parseDef = (code, line) => {
+export const parseDef = (code, line) => {
   if (code[code.length - 1] === ',') code = code.substring(0, code.length - 1).trim()
   let idx = code.indexOf('=')
 
@@ -179,7 +179,7 @@ const parseDef = (code, line) => {
   }
 }
 
-const combineParameterDefinitions = (paramDefFromSource, extraDef) => {
+export const combineParameterDefinitions = (paramDefFromSource, extraDef) => {
   const def = [...paramDefFromSource]
   if (extraDef) {
     extraDef.forEach((param) => {
@@ -190,5 +190,3 @@ const combineParameterDefinitions = (paramDefFromSource, extraDef) => {
   }
   return def
 }
-
-module.exports = { getParameterDefinitionsFromSource, parseOne, parseComment, parseDef, combineParameterDefinitions }

package/src/parameters/getParameterDefinitionsFromSource.test.js

@@ -1,7 +1,6 @@
-'use strict'
-const test = require('ava')
+import test from 'ava'
 
-const { getParameterDefinitionsFromSource, parseOne, parseComment, parseDef } = require('./getParameterDefinitionsFromSource.js')
+import { getParameterDefinitionsFromSource, parseOne, parseComment, parseDef } from './getParameterDefinitionsFromSource.js'
 
 const sampleParams = [
   { name: 'width', caption: 'Width', type: 'int', initial: 145 },

package/src/parameters/getParameterValuesFromParameters.js

@@ -1,8 +1,8 @@
-/**
+/*
  * @param  {} parameterDefinitions
  * @param  {} inputParameters
  */
-const getParameterValuesFromParameters = (parameterDefinitions, inputParameters) => {
+export const getParameterValuesFromParameters = (parameterDefinitions, inputParameters) => {
   const parameterValues = {}
   for (const a in parameterDefinitions) { // defaults, given by getParameterDefinitions()
     const x = parameterDefinitions[a]
@@ -19,5 +19,3 @@ const getParameterValuesFromParameters = (parameterDefinitions, inputParameters)
   }
   return parameterValues
 }
-
-module.exports = getParameterValuesFromParameters

package/src/parameters/getParameterValuesFromUIControls.js

@@ -1,10 +1,10 @@
-/**
+/*
  * extracts the parameter
  * @param {Array} paramControls
  * @param {Boolean} onlyChanged
  * @returns {Object} the parameter values, as an object
  */
-const getParameterValuesFromUIControls = (paramControls, parameterDefinitions, onlyChanged) => {
+export const getParameterValuesFromUIControls = (paramControls, parameterDefinitions, onlyChanged) => {
   const parameterValues = {}
   let value
   for (let i = 0; i < paramControls.length; i++) {
@@ -58,5 +58,3 @@ const getParameterValuesFromUIControls = (paramControls, parameterDefinitions, o
   }
   return parameterValues
 }
-
-module.exports = getParameterValuesFromUIControls

package/src/parameters/index.js

@@ -1,6 +1,4 @@
-module.exports = {
-  applyParameterDefinitions: require('./applyParameterDefinitions'),
-  getParameterDefinitionsAndValues: require('./getParameterDefinitionsAndValues'),
-  getParameterValuesFromParameters: require('./getParameterValuesFromParameters'),
-  getParameterValuesFromUIControls: require('./getParameterValuesFromUIControls')
-}
+export { applyParameterDefinitions } from './applyParameterDefinitions.js'
+export { getParameterDefinitionsAndValues } from './getParameterDefinitionsAndValues.js'
+export { getParameterValuesFromParameters } from './getParameterValuesFromParameters.js'
+export { getParameterValuesFromUIControls } from './getParameterValuesFromUIControls.js'

package/src/utils/getFileExtensionFromString.js

@@ -1,8 +1,6 @@
-const getFileExtensionFromString = (input) => {
+export const getFileExtensionFromString = (input) => {
   if (input.indexOf('.') === -1) {
     return undefined
   }
   return (input.substring(input.lastIndexOf('.') + 1)).toLowerCase()
 }
-
-module.exports = getFileExtensionFromString

package/src/utils/index.js

@@ -1,4 +1,2 @@
-module.exports = {
-  getFileExtensionFromString: require('./getFileExtensionFromString'),
-  version: require('./version')
-}
+export { getFileExtensionFromString } from './getFileExtensionFromString.js'
+export { version } from './version.js'

package/src/utils/version.js

@@ -1,3 +1 @@
-const json = require('../../package.json')
-const version = json.version
-module.exports = { version }
+export const version = '[VI]{version}[/VI]' // version is injected by rollup

package/src/web/index.js

@@ -1,3 +1 @@
-module.exports = {
-  walkFileTree: require('./walkFileTree')
-}
+export { walkFileTree } from './walkFileTree.js'

package/src/web/walkFileTree.js

@@ -1,8 +1,10 @@
-const { flatten } = require('@jscad/array-utils')
+import path from 'path'
 
-const { formats } = require('@jscad/io/formats')
+import { flatten } from '@jscad/array-utils'
 
-const getFileExtensionFromString = require('../utils/getFileExtensionFromString')
+import { supportedFormats } from '@jscad/io'
+
+import { getFileExtensionFromString } from '../utils/index.js'
 
 const binaryMimetypes = {
   bmp: 'image/bmp',
@@ -64,7 +66,7 @@ const readFileAsync = (file, fileMeta) => {
 // all known formats are supported
 const isSupportedFormat = (file) => {
   const ext = getFileExtensionFromString(file.name)
-  const mimetype = formats[ext] ? formats[ext].mimetype : binaryMimetypes[ext]
+  const mimetype = supportedFormats[ext] ? supportedFormats[ext].mimetype : binaryMimetypes[ext]
   file.mimetype = file.type && file.type.length ? file.type : mimetype
   return file.mimetype && file.mimetype.length
 }
@@ -161,8 +163,6 @@ const processDirectory = (directory) => {
  * Transform the flat list of files (from HTML input) to a heiarchy of files (from drag-n-drop).
  */
 const transformFileList = (fileList) => {
-  const path = require('path')
-
   if (fileList.length === 1) {
     const file = fileList[0]
     const filePath = file.webkitRelativePath ? file.webkitRelativePath : file.name
@@ -228,7 +228,7 @@ const transformFileList = (fileList) => {
 //    1) walk the tree
 //    2) read the files (readFileAsync)
 //    3) return a flattened list of promises containing all file entries
-const walkFileTree = (fileList) => {
+export const walkFileTree = (fileList) => {
   let items = fileList
   if (fileList.length && (fileList[0] instanceof File)) {
     // transform the flat list of File entries
@@ -236,5 +236,3 @@ const walkFileTree = (fileList) => {
   }
   return processEntries(items)
 }
-
-module.exports = walkFileTree