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

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

📖 Table of Contents

• Tech Stack
• Usage
  • Basic Usage
  • Standalone Usage
• Build Configuration
• Contributions
• License

💡 Tech Stack

✨ Usage

Proceed with next steps if your platform meet following prerequisites.

• Install Node.js on your device.

🔎 Basic Usage

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

npx packer-cli generate my-library

or

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

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

# 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

⚙️ 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
      [--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

⚒️ Build Configuration

Build configuration can be updated after project generation via .packerrc.js. Refer packer configuration options for detailed configuration options list.

🌱 Contributions

Feel free to open an issue or create a PR.

©️ License

Packer-CLI is MIT licensed. Please refer LICENSE for more information.

packer-cli's Issues

Templates directory is remains on src after react support is enabled

Reproduce:
Install packer-cli globally (npm install -g packer-cli) or use npx (npx packer g test-library --skipInstall) to run project generate wizard.
Then 'Are you building a react library?' -> yes -> rest configurations set to default

Issue:
templates directory is remains after success project generate, (.hbs in src/templates) but handlebars are removed from package.json and externals in .packerrc.js"

Expected Result:
templates directory and .hbs support should be removed from src once after react support is enabled.

Packer test failed to run

Reproduce:
Generate project with default configurations -> Run packer test
Issue:
Invalid configuration file. cannot find module karma-mocha. adding karma-mocha to package.json will solve the issue but taking additional space on bundle size.

Remove lint:style from package.json if style support is false

Remove lint:style from scripts if style support (Question 8) is set to false.

Fail to generate project after input project name with capital letter

Steps to Reproduce:

• Generate new project using ''packer g My-lib".

Actual Result:

• Terminate project generation with task failure.

Expected Result:

• Generate project without any issue or give a meaningful error.

Dependency skip install won't work as expected.

npx packer-cli g | generate test-library --skipInstall | -sk commands are not working and still installing dependencies.
Project generated with npx (https://www.npmjs.com/package/npx)

keywords array is empty after generate the project.

Steps to Reproduce:

1. Generate new project using ''packer generate sample-library".
2. Give some keywords seperated by commas (keyword1,keyword2).

Actual Result:

• keywords array of package.json is empty. ( "keywords" : [] )

Expected Result:

• keywords array should be " "keywords": ["keyword1","keyword2"] "

Author's email will not bind to the author when author's name is ignored.

Reproduce Error :

1. Generate new project (refer README.md) then ignore the author's name and provide a valid email.
2. After a successful generate, go to package.json and check if author's email is bind to the author.

Expected Result : Author's email should be bind to the author object or property.

invalid karma-jasmine package version

Project generation will leads to success with a error, due to a wrong version value in package.json
Fix - update karma-jasmine package version from 2.1.0 to 2.0.1 latest release.

Failing to run on newly created lib

Just followed the readme.
Right after running the install script:

> [email protected] watch /Users/agarciag/Documents/Apps/my-lib
> packer watch

node-resolve: setting options.module is deprecated, please override options.mainFields instead
node-resolve: setting options.jsnext is deprecated, please override options.mainFields instead
node-resolve: setting options.main is deprecated, please override options.mainFields instead
[00:04:03:047] [watch] watch - bundling start
[00:04:08:487] [watch] watch - bundling crashed
{ code: 'FATAL',
  error: 
   { Error: [BABEL] /Users/agarciag/Documents/Apps/my-lib/src/index.ts: Invalid Option: module is not a valid top-level option.
        Maybe you meant to use 'modules'? (While processing: "/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/preset-env/lib/index.js")
    at validateTopLevelOptions (/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/preset-env/lib/normalize-options.js:61:13)
    at normalizeOptions (/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/preset-env/lib/normalize-options.js:190:3)
    at _default (/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/preset-env/lib/index.js:109:37)
    at /Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/helper-plugin-utils/lib/index.js:19:12
    at loadDescriptor (/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/core/lib/config/full.js:165:14)
    at cachedFunction (/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/core/lib/config/caching.js:33:19)
    at loadPresetDescriptor (/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/core/lib/config/full.js:235:63)
    at config.presets.reduce (/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/core/lib/config/full.js:77:21)
    at Array.reduce (<anonymous>)
    at recurseDescriptors (/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/core/lib/config/full.js:74:38)
     [stack]: 'Error: [BABEL] /Users/agarciag/Documents/Apps/my-lib/src/index.ts: Invalid Option: module is not a valid top-level option.\n        Maybe you meant to use \'modules\'? (While processing: "/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/preset-env/lib/index.js")\n    at validateTopLevelOptions (/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/preset-env/lib/normalize-options.js:61:13)\n    at normalizeOptions (/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/preset-env/lib/normalize-options.js:190:3)\n    at _default (/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/preset-env/lib/index.js:109:37)\n    at /Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/helper-plugin-utils/lib/index.js:19:12\n    at loadDescriptor (/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/core/lib/config/full.js:165:14)\n    at cachedFunction (/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/core/lib/config/caching.js:33:19)\n    at loadPresetDescriptor (/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/core/lib/config/full.js:235:63)\n    at config.presets.reduce (/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/core/lib/config/full.js:77:21)\n    at Array.reduce (<anonymous>)\n    at recurseDescriptors (/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/core/lib/config/full.js:74:38)',
     [message]: '[BABEL] /Users/agarciag/Documents/Apps/my-lib/src/index.ts: Invalid Option: module is not a valid top-level option.\n        Maybe you meant to use \'modules\'? (While processing: "/Users/agarciag/Documents/Apps/my-lib/node_modules/@babel/preset-env/lib/index.js")',
     code: 'PLUGIN_ERROR',
     plugin: 'babel',
     hook: 'transform',
     id: '/Users/agarciag/Documents/Apps/my-lib/src/index.ts' } }

Did I do something wrong?