0.4.0 • Published 5 years ago
metal-band-generator v0.4.0
metal-band-generator :metal: :guitar:
Randomly generates ficional metal band names and members
Usage
Install with npm i band-name-generator
or yarn add band-name-generator
import getBand, {
getBandMembers,
getBandName,
getGenre,
getMember,
getMemberName,
getMemberInstrument,
} from 'metal-band-generator';
getBand(); // returns a complete band object, with name, genre and members
getBandMembers(); // returns an array of band members
getBandName(); // returns a random band name
getGenre(); // returns a random genre
getMember(); // returns a random member, with name and instrument
getMemberName(); // returns a random member name
getMemberInstrument(); // returns a random instrument
Example band:
{ name: 'Dark Decadence',
genre: 'Glam Heavy Atmospheric Metal',
members:
[ { name: 'Axl Rose', instrument: 'drums' },
{ name: 'Jorn Hetfield', instrument: 'harsh vocals' },
{ name: 'Alissa Hetfield', instrument: 'keyboard' },
{ name: 'Maria Hetfield', instrument: 'rhythm guitar' },
{ name: 'Jorn Hetfield', instrument: 'drums' },
{ name: 'Jorn Kakko', instrument: 'keyboard' } ] }
Scripts
build
: transpiles and minifies all code in./src
into./lib
using babel;lint
: lints code in./src
usingeslint
;precommit
: (automatic) runs linter before every commit;prepublish
: (automatic) runs tests before attempting to publish the package;test
: runs tests in__tests__
usingjest
.
Metal is for everyone - Freedom Call