Voca JavaScript String Library

Common errors

• TypeError: voca.slugify is not a function

  cause Attempting to import `slugify` as a named export from the main `voca` package (`import { slugify } from 'voca';`) when it's a default export from a subpath.
  fix Correct the import statement to `import slugify from 'voca/slugify';`

• ReferenceError: v is not defined

  cause Trying to use `v.someFunction()` in a Node.js or browser environment without properly importing or loading the Voca library first.
  fix In Node.js, add `const v = require('voca');`. In a browser, ensure `<script src="voca.js"></script>` is present before your script, or `import voca from 'voca'` if using a module bundler.

• ReferenceError: require is not defined

  cause Using `require('voca')` or `require('voca/someFunction')` directly in a browser without a CommonJS compatible bundler (like Webpack or Browserify).
  fix For browser-only usage, load `dist/voca.min.js` via a script tag which exposes a global `v` object. If using a bundler, ensure it's configured to handle CommonJS modules.

Warnings

• gotcha Voca functions are imported individually from subpaths (e.g., `import slugify from 'voca/slugify'`) rather than as named exports from the main package (`import { slugify } from 'voca'`). Attempting the latter will result in a runtime error.
  Fix: Always use `import functionName from 'voca/functionName';` for specific functions in ES2015 modules, or `const functionName = require('voca/functionName');` in CommonJS.
• gotcha The global variable for Voca in browser environments is `v`, while the CommonJS require often uses `v`, but the ES2015 default import is typically aliased as `voca`. This inconsistency can lead to confusion if not mindful of the environment and import style.
  Fix: Be explicit about your imports. For ES modules, `import voca from 'voca';` is standard. For CommonJS, `const v = require('voca');` or `const voca = require('voca');` are common, but stick to `v` if mirroring browser usage. For browsers, ensure `voca.js` is loaded to expose the global `v`.

Install

• npm install voca npm
• yarn add voca yarn
• pnpm add voca pnpm

Imports

• voca
  wrong:

  import { voca } from 'voca';

  correct:

  import voca from 'voca';

  The entire library is exposed as a default export in ES2015 modules. Access functions via `voca.someFunction()`.
• v
  wrong:

  const voca = require('voca');

  correct:

  const v = require('voca');

  In CommonJS environments, the library is typically imported as `v` for consistency with browser global usage. Access functions via `v.someFunction()`.
• slugify
  wrong:

  import { slugify } from 'voca';

  correct:

  import slugify from 'voca/slugify';

  To enable tree-shaking and import only specific functions in ES2015 modules, import them directly from their subpath. Each function is a default export from its specific module.
• words
  wrong:

  const { words } = require('voca');

  correct:

  const words = require('voca/words');

  For CommonJS, individual functions are also imported directly from their subpath for modularity and reduced bundle size.

Quickstart

Demonstrates importing the entire Voca library and individual functions, then using several string manipulation utilities.

import voca from 'voca';
import camelCase from 'voca/camelCase';
import sprintf from 'voca/sprintf';
import slugify from 'voca/slugify';

// Using the entire library default export
const sentence = '  Hello wonderful WORLD!  ';
const trimmedSentence = voca.trim(sentence);
console.log(`Trimmed: '${trimmedSentence}'`);

// Using individual function imports for tree-shaking
const camelCased = camelCase('bird flight');
console.log(`Camel Case: '${camelCased}'`);

const formattedString = sprintf('%s costs $%.2f', 'Tea', 1.5);
console.log(`Formatted: '${formattedString}'`);

const urlSlug = slugify('What a wonderful world');
console.log(`Slug: '${urlSlug}'`);

// Example of another function from the main export
const capitalized = voca.capitalize('hello voca');
console.log(`Capitalized: '${capitalized}'`);