metapak-motionbank

2.0.1 verified Fri May 01 auth: no javascript maintenance

Skeleton generator plugin for Metapak, adding Motion Bank presets for JS module development. Version 2.0.1 is current. It extends Metapak with configs for ESLint, Babel, JSDoc, Codacy, CodeClimate, Tidelift, Travis, as well as mutually exclusive presets for Feathers, Quasar, and Vue.js apps. Must be paired with metapak@1.0.3. Differentiators: opinionated defaults for Motion Bank projects; automates boilerplate generation; integrates multiple CI and documentation tools. No recent updates since 2021.

Common errors

error Error [ERR_REQUIRE_ESM]: require() of ES Module /path/to/metapak-motionbank/index.js from /path/to/project not supported. ↓

cause Using require() on ESM-only package v2.0.0+.

fix

Change to import or use dynamic import().

error npm ERR! ERESOLVE unable to resolve dependency tree: Found: metapak@2.0.0 but peer dep requires 'metapak@1.0.3'. ↓

cause Incompatible metapak version installed.

fix

Install metapak@1.0.3 explicitly: npm install --save-dev metapak@1.0.3

error metapak-motionbank: unknown config 'Eslint'. Available: eslint, babel, ... ↓

cause Config name is case-sensitive; 'Eslint' not recognized.

fix

Use lowercase 'eslint' in configs array.

Warnings

breaking Package is ESM-only since v2.0.0; require() will throw ERR_REQUIRE_ESM. ↓

fix Use import or dynamic import() instead of require().

breaking Peer dependency metapak@1.0.3 required; incompatible with metapak >=2.0.0. ↓

fix Ensure metapak version is exactly 1.0.3.

deprecated Greenkeeper badge in README; Greenkeeper is deprecated in favor of Renovate or Dependabot. ↓

fix Replace Greenkeeper badge with Dependabot or Renovate badge.

gotcha Multiple configs are mutually exclusive: feathers, quasar, vue cannot be combined. ↓

fix Choose only one of feathers, quasar, or vue if using any.

gotcha Config name 'codacy' and 'codeclimate' are case-sensitive; must be lowercase exactly. ↓

fix Use exactly 'codacy' or 'codeclimate' not 'Codacy' or 'CodeClimate'.

Install

npm install metapak-motionbank

yarn add metapak-motionbank

pnpm add metapak-motionbank

Imports

default

wrong

const metapakMotionbank = require('metapak-motionbank')

correct

import metapakMotionbank from 'metapak-motionbank'

Package is ESM-only from v2.0.0; no CommonJS export.

getConfig

wrong

import getConfig from 'metapak-motionbank'

correct

import { getConfig } from 'metapak-motionbank'

getConfig is a named export, not default.

MotionbankConfig

wrong

import { MotionbankConfig } from 'metapak-motionbank'

correct

import type { MotionbankConfig } from 'metapak-motionbank'

MotionbankConfig is a TypeScript type, use type import to avoid runtime issues.

Quickstart

Install metapak and metapak-motionbank, configure presets in package.json, and generate skeleton.

npm install --save-dev metapak@1.0.3 metapak-motionbank@2.0.1

# In package.json, add:
{
  "metapak": {
    "configs": ["eslint", "babel"]
  }
}

# Then run:
npm run metapak