@qneyraud/q-lib

Library starter

CLI tool to create library project with documentation, local development server, eslint and build ready (minified, polyfilled)

Usage

# Install package and create project
npm install -g @qneyraud/q-lib
q-lib create-new [directory]

# Or use npx
npx @qneyraud/q-lib create-new [directory]

Then, follow instructions

Features

Eslint

npm run lint
npm run lint:fix

Personal config is extended by default but it can be changed in .eslintrc.js.

Example for testing in development

npm run dev

Go to http://localhost:1234 to test your code.
Exported functions in src/index.js are imported example/index.js so you can test your library with live-reload.

Build polyfilled version

Create polyfilled version of your library for older browsers. Edit .babelrc browsers target to what you need.

Documentation

npm run docs

Go to http://localhost:3000 to view your documentation.
Write your documentation in markdown in docs/README.md. See Docsify documentation for configuration and examples.

Build

yarn build

Deploy on npm

npm version [patch | minor | major]
npm publish

Deploy documentation

1. Set up GitHub Pages to use /docs folder

2. git push

Or use other Deploy methods

Resources links

• Docsify
• Rollup
• Parcel
• Babel-preset-env
• Eslint