Modules.md

Modules

---

Modules are available in Boop version 1.2.0 and above.

---

Just to be very clear before we get started: Boop does not support commonJS/node/ES6 modules. It has a custom import system that may or may not be compatible with some existing modules.

Importing modules

To import a module, use the require function. It'll will return the contents of module.exports:

const test = require('lib/testLib')
const test = require('modules/otherLib.js')

If you do not include a .js extension, the system will add one automatically.

You can also use destructuring to only get a single function out:

const { base64decode } = require('lib/base64')
// or

const { base64encode } = require('lib/base64')

Creating modules

Modules are run in a pseudo-sandbox, in somewhat similar (but not equal) way to CommonJS. The sandbox contains a module object with an exports property. Whatever that property contains is what will be returned by the require function.

// testModule.js

module.exports = "Hello World"

// script.js
const greeting = require('testModule.js')

The above example is essentially the same as:

// script.js
const greeting = "Hello World"

Module imports can also be nested, though you should probably avoid that.

// lib/deepModule.js

module.exports = "Hello World"

// lib/shallowModule.js
const greeting = require('lib/deepModule')

module.exports = greeting

// script.js
const greeting = require('lib/shallowModule')

When using nested requires, the module name is based on the path of your script, not of the current module.

Built in modules

Boop ships with a couple of modules, with the prefix @boop/, which you can use in your own scripts.

Module name	Description
@boop/base64	Base 64 encoding and decoding
@boop/lodash.boop	Subset of lodash string functions (see below)
@boop/he	HTML entities encoder/decoder
@boop/vkBeautify	XML, CSS, and SQL formatter and minifier
@boop/js-yaml	Parses and Stringifies YAML objects
@boop/hashes	Common crypto hashes

If you need a new module that you think could be used by more scripts, feel free to open a PR adding more functionality.

Lodash

The built in lodash module was created with the following command and only includes a few functions and their direct dependencies:

$ lodash include=camelCase,deburr,escapeRegExp,kebabCase,snakeCase,startCase,size

If you'd like to add more functions, feel free to rebuild with additional parameters and submit a PR.