metapak-motionbank v2.0.1

Motion Bank Metapak

Skeleton generator :ghost: assisting in JS module development.

About

Our configuration system is built using Metapak, a great module by Nicolas Froidure.

Initial Setup

To create a new module based on our presets first initialize your shiny new module:

mkdir node-fancypants
cd node-fancypants
npm init

After this is complete, edit the package.json file and add the property metapak as follows:

{
  "metapak": {
    "configs": ["eslint"]
  }
}

The configs array allows you to specify case-specific presets in addition to the defaults:

If you choose to select from these, take note that these three are mutually exclusive:

"feathers"    # Adds configuration for APIs and Apps
"quasar"      # Adds configuration for Quasar SPAs
"vue"         # Adds configuration for Vue.js apps

These can be used in any combination:

"eslint"      # Adds basic linting to the module
"babel"       # Adds babel transpiler basics
"readme"      # Generates main README.md from .readme/about.md
"jsdoc"       # Generates docs
"codacy"      # Adds Codacy config
"codeclimate" # Adds codeclimate config
"tidelift"    # Adds Tidelift dependency CI config
"travis"      # Adds Travis dependency CI config

After selecting the presets you can install the configuration module itself with:

npm install --save-dev metapak metapak-motionbank

:sparkles: Then, in a glorious moment of pure automagification the module directory contents will be updated according to the selected configuration presets. :dizzy:

Updating Modules

If this module itself needs to be updated, just run npm update --save-dev metapak-motionbank and then npm install.

Should the changes be only within your created module execute npm run metapak.

License

:copyright: 2021 Mainz University of Applied Sciences (Motion Bank Project) – Released under the MIT license