packer-cli

Full-fledged CLI tool to generate and package library Node modules compliant with Browser and NodeJS. Packer CLI support all modern style, unit test and script transpiler tools.

Packer CLI is using itself to compile self source.

:book: Table of Contents

• Features
• Usage
  • Basic Usage
  • Standalone Usage
• Build Configuration
• Contributions
• License

:bulb: Features

:ballot_box_with_check: Managed build configuration
:ballot_box_with_check: Encapsulated build process
:ballot_box_with_check: Both NPM and Yarn support
:ballot_box_with_check: Travis CI support
:ballot_box_with_check: Typescript and Babel based code transpilation
:ballot_box_with_check: TS Lint based Typescript code analysis
:ballot_box_with_check: ES Lint based Javascript code analysis
:ballot_box_with_check: Style lint based style sheet code analysis
:ballot_box_with_check: Precompiled handlebars templating
:ballot_box_with_check: Support SCSS, SASS, LESS and Stylus and vanilla CSS
:ballot_box_with_check: Post CSS based image inline and auto prefixing
:ballot_box_with_check: Karma unit test runner
:ballot_box_with_check: Jasmine, Mocha and Jest unit test frameworks
:ballot_box_with_check: Rollup and Gulp based build process
:ballot_box_with_check: ES5, ESNext, UMD, AMD, SYSTEM, IIFE and CommonJS bundle build output
:ballot_box_with_check: Emmit type definitions for typescript projects
:ballot_box_with_check: Ready to publish as Node module
:ballot_box_with_check: Inline and bundle styles
:ballot_box_with_check: Theme packaging
:ballot_box_with_check: Source import path replace
:ballot_box_with_check: Exclude external peer dependencies in bundle
:ballot_box_with_check: Bundle peer dependencies
:ballot_box_with_check: Ignore imports
:ballot_box_with_check: Copy static assets to build dir
:ballot_box_with_check: Library summary banner generation
:ballot_box_with_check: Library dependency license extraction
:ballot_box_with_check: Node CLI project support
:ballot_box_with_check: JSX and TSX support
:ballot_box_with_check: Custom rollup plugin integration support

:sparkles: Usage

Before the Packer-CLI installation there are few pre-requisites to be complete. If your device meet the below requisites then you can proceed to the next section.

• Install Node.js on your device.
• Run npm install -g npx to install npx globally. (optional)

:mag_right: Basic Usage

You can simply run the following command in a preferred directory to generate a new project using Packer CLI,

npx packer-cli generate my-library

or

npm install packer-cli -g && packer generate my-library

Then CLI will query questions associated to custom project generation,

# Description about the library
Give us a small description about the library (optional)? Client compliant node module

# Comma separated package keywords to be included in package config
Give us a set of comma separated package keywords (optional)? lib,awesome library,my library

# Name of the library author
Author's name (optional)? Yohan Gomez

# Name of the library author.
Author's email address (optional)? [e-mail]

# Github username of the library author.
Author's github username (optional)? yohangz

# Web home page of the library. This must be a valid URL.
Library homepage link (optional)? http://www.my-project.com

# Script transpiler to be used. Select none to use vanilla javascript.
What's the script pre processor you want to use?
- typescript
- none

# Support CSS bundling if yes.  
Do you want style sheet support? (Y/n) Yes

# Style preprocessor to be used. Select none if not required.
What's the style pre processor you want to use?
- scss
- sass
- less
- stylus
- none

# Inline bundle style sheets within bundled script files. Select none to disable support.
Do you want to inline bundle styles within script? (y/N) No

# Target build process to support browser compliant bundling if yes
Are you building a browser compliant library? (Y/n) Yes

# If yes, react framework support will be enabled. Select none to disable support.
Are you building a react library? (y/N) No

# You can chose from the browser compliant flat bundle formats options list.
What's the build bundle format you want to use? umd
- umd
- amd
- iife
- system

# Custom AMD id can be provided if flat bundle format is UMD or AMD. Applicable for "amd" module format only.
What's the AMD id you want to use? my-lib

# Library namespace will be used when exposing the library via global scope. Applicable for "umd" | "iife" | "systemjs" module formats.
What's the library namespace you want to use? my.lib

# You can chose either Jasmine or Mocha unit test framework.
Which unit test framework do you want to use?
- jasmine
- mocha
- jest

# Target unit test execution environment.
Choose the test environment that will be used for testing?
- browser
- jsdom
- node

# Library copyright year to be included in license file.
What's the library copyright year (optional)? 2018

# Generate license file for the project.
What's the license you want to use?
- MIT License
- Apache License 2.0
- Mozilla Public License 2.0
- BBSD 2-Clause FreeBSD License
- BSD 3-Clause Revised License
- Internet Systems Consortium (ISC) License
- GNU Lesser General Public License v3.0 only
- GNU General Public License v3.0 only
- The Unlicense

# Use yarn package manager instead of NPM CLI if true.
Do you want to use yarn as package manager? (Y/n) Yes

Once project is generated and dependencies are installed, you can use the following CLI commands:

# Run project on watch mode
npm run watch

# Production build
npm run build

# Run Style and script lint tasks
npm run lint

# Run style lint task
npm run lint:style

# Run script lint task
npm run lint:script

# Run unit test suite on development envrionemnt watch mode
npm run test

# Run unit test suite with coverage on development envrionemnt watch mode
npm run test:coverage

# Run unit test suite on continues integration environment mode
npm run test:ci

# Run unit test suite with coverage mode on continues integration environment mode
npm run test:coverage:ci

# Bump package version and push updated package config
npm version major|minor|patch

# Build project and publish to NPM
npm run release

Generated project structure can be viewed here

:gear: Standalone Usage

You can also use packer CLI standalone on any packer compliant project to customize the NPM scripts generated.

Usage: packer [--version | -v] | [--help | -h] | <command>[<args>]

  Arguments supported with all commands

  + Logging flags
    [--trace]          set console log level to trace
    [--info]           set console log level to information
    [--warn]           set console log level to warning
    [--error]          set console log level to error
    [--silent]         set console log level to silent

  + Other Flags
    [--config | -c]    dynamic packer config path

  Generate a new library project via packer

  generate | g <project name>
    [--skipInstall | -sk]   skip dependency install after project

  These are packer commands can be used on generated project
    build | b                trigger build
    watch | w                trigger serve on watch mode
    test | t                 execute project test suite
      [--watch | -W]         execute test on watch mode
      [--coverage | -C]      execute test suite with coverage
    clean | c                clean project build artifacts and temporary files generated
    lint | l                 execute lint for project source
      [--style | -sc]        execute only style lint
      [--script | -sr]       execute only script lint

:hammer_and_pick: Build Configuration

Build configuration can be updated after project generation via .packerrc.js. Refer packer configuratin options for more details.

:seedling: Contributions

Feel free to open an issue or create a PR.

:copyright: License

Packer-CLI was license under MIT. Please refer LICENSE for more information.