Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yohangz/packer-cli

:boom: Full-fledged CLI tool to generate and package node modules compliant with Browser and NodeJS. Packer CLI support all modern style, unit test and script transpiler tools
https://github.com/yohangz/packer-cli

babel build-tool eslint gulp handlebars istambul jasmine jest jsdom less mocha nodejs reactjs rollupjs sass spdx stylelint stylus tslint typescript

Last synced: 3 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/yohangz/packer-cli
Owner: yohangz
License: mit
Created: 2018-09-18T10:28:18.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2023-01-07T03:26:48.000Z (about 2 years ago)
Last Synced: 2024-11-05T20:05:46.501Z (4 months ago)
Topics: babel, build-tool, eslint, gulp, handlebars, istambul, jasmine, jest, jsdom, less, mocha, nodejs, reactjs, rollupjs, sass, spdx, stylelint, stylus, tslint, typescript
Language: HTML
Homepage: http://bit.ly/packer-cli
Size: 5.56 MB
Stars: 85
Watchers: 3
Forks: 3
Open Issues: 22
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


  

  

  

    

  

  

    

    

  

    

  



> Packer CLI helps you to kick start new node module projects compliant with NodeJS and Browser, prescribing best practices. Packer encapsulating file-watching, live-reloading, transpiling, bundling and unit test framework integration with coverage and much more, so you don't have to. You will get to enjoy the latest latest JavaScript awesomeness with flexibility to custom fit your project needs.

  To do so, we provide a generator ecosystem via command line to scaffold complete projects with full control over all exposed workflows.

  

  Explained in detail: [Build Node Modules Like a Pro with Packer CLI](http://bit.ly/packer-cli)

  

## :book: Table of Contents

  

  

  

  - [Tech Stack](#bulb-tech-stack)

  - [Usage](#sparkles-usage)

    - [Basic Usage](#mag_right-basic-usage)

    - [Standalone Usage](#gear-standalone-usage)

  - [Build Configuration](#hammer_and_pick-build-configuration)

  - [Contributions](#seedling-contributions)

  - [License](#copyright-license)

  

  

## :bulb: Tech Stack

[![Rollup](https://image.ibb.co/djqwR9/rollup.png)](https://rollupjs.org/)

[![Gulp](https://image.ibb.co/j8A7Yp/gulp.png)](https://gulpjs.com/)

[![Babel](https://image.ibb.co/hNSXzU/babel.png)](https://babeljs.io/)

[![ES Lint](https://image.ibb.co/iGhzeU/eslint.png)](https://eslint.org/)

[![Typescript](https://image.ibb.co/fjR369/typescript.png)](https://www.typescriptlang.org/)

[![TS Lint](https://image.ibb.co/ddVVm9/ts-lint.png)](https://palantir.github.io/tslint/)

[![Postcss](https://image.ibb.co/bSSbR9/postcss.png)](https://postcss.org/)

[![LESS](https://image.ibb.co/mXSXzU/less.png)](http://lesscss.org/)

[![SASS](https://image.ibb.co/jBLwR9/sass.png)](https://sass-lang.com/)

[![Stylus](https://image.ibb.co/jteZDp/stylus.png)](http://stylus-lang.com/)

[![Style Lint](https://image.ibb.co/hqySYp/stylelint.png)](https://stylelint.io/)

[![Karma](https://image.ibb.co/hq8i69/karma.png)](https://karma-runner.github.io)

[![Mocha](https://image.ibb.co/nn2XzU/mocha.png)](https://mochajs.org/)

[![Chai](https://i.ibb.co/drY8ryr/chaijs.png)](https://www.chaijs.com/)

[![Jest](https://i.ibb.co/ftLCJ50/jest.png)](https://jestjs.io/)

[![Jasmine](https://image.ibb.co/jrGEDp/jasmine.png)](https://jasmine.github.io/)

[![Istanbul](https://image.ibb.co/fOsbR9/istanbul.png)](https://istanbul.js.org/)

[![React](https://i.ibb.co/zHccJ3r/react.png)](https://reactjs.org/)

[![JSdom](https://i.ibb.co/FKDXFxM/jsdom.png)](https://github.com/jsdom/jsdom)

[![Handlebars](https://image.ibb.co/g2Di69/handlebars.png)](https://handlebarsjs.com/)

[![Prettier](https://i.ibb.co/WgG8y3H/prettier.png)](https://prettier.io/)

[![SPDX](https://image.ibb.co/jSgEDp/spdx.png)](https://spdx.org/)

[![NPM](https://image.ibb.co/m2HMtp/npm.png)](https://www.npmjs.com/)

[![YARN](https://image.ibb.co/g1aVm9/yarn.png)](https://yarnpkg.com/)

[![Travis CI](https://image.ibb.co/fGqKeU/travis-ci.png)](https://travis-ci.org/)

## :sparkles: Usage

Proceed with next steps if your platform meet following prerequisites. 

- Install [Node.js](https://nodejs.org/en/) on your device. 

## :mag_right: Basic Usage



  



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

```sh

npx packer-cli generate my-library

```

or

```sh

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

```

Once project is generated and dependencies are installed, you can use the following NPM scripts:

```sh

# 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 auto format source task

npm run format

# 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](docs/STRUCTURE.md)

## :gear: Standalone Usage

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

```text

Usage: packer [--version | -v] | [--help | -h] | []

  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 

    [--skipInstall | -sk]   skip dependency install after project

  These are packer commands can be used on generated project

    build | b                trigger build

      [--perf | -P]          execute build task with rollup performance monitoring

    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

    format | f               auto format project source

```

## :hammer_and_pick: Build Configuration

Build configuration can be updated after project generation via ``.packerrc.js``. Refer [packer configuration options](docs/BUILD_CONFIGURATION.md) for detailed configuration options list.

                                                                                                                                                                 

## :seedling: Contributions

Feel free to open an issue or create a PR.

## :copyright: License

Packer-CLI is MIT licensed. Please refer [LICENSE](https://github.com/yohangz/packer-cli/blob/master/LICENSE) for more information.