atomiqio / atomiq-cli Goto Github PK

View Code? Open in Web Editor NEW

0.0 1.0 0.0 169 KB

Generate, run, test, & debug microservice projects with ES6 and Docker support.

Home Page: http://atomiq.io

JavaScript 100.00%

atomiq-cli's Introduction

Atomiq CLI

Node.js microservice development tailored for Docker environments.

Features

Generate app, API, and library packages with ES6 and Async functions support.
Start services and run tests with commands leveraging standard docker-compose files.
Debug containers with Node Inspector.
API support includes optional directory-based routing conventions to simplify microservice development.
Signal handling for graceful server shutdown in Docker containers.
Includes lint, format, and cover commands based on ESLint, esformatter, and isparta.

Caveats

Primarily for Docker-oriented development
Only testing with latest versions of Node.js and Alpine

Install

npm install -g atomiq-cli

Usage

$ atomiq <command> [options]

To see more command details, run

$ atomiq --help [or -h]

or

$ atomiq <command> --help [or -h]

The CLI is generally silent. To enable debug output, set the DEBUG environment variable for the type of project.

$ DEBUG=atomiq* atomiq <subcommand> [options]

Generating Projects

With the atomiq new command, you can generate api, app, and lib package projects.

API Generator

The API generator uses atomiq to provide lightweight structure and support useful for Express-based microservices. Atomiq is not a framework and doesn't get in the way of Express, but it does offer a nice convention for directory-based routing using ES6 classes that you can leverage if you choose to.

It generates a few sample routes using ES6 classes and provides a simple Node.js make script that supports building, running, and testing locally and in a Docker container.

This is a complete rewrite of the original CLI and also a replacement for the yeoman generator (generator-atomiq).

Atomiq CLI development for contributors

make.js script

This project has a make.js script that supports building, running, and testing both locally and in a Docker container.

node make clean - remove the dist directory
node make babel - transpile src to dist with sourcemaps (ES6 and async/await support)
node make build - transpile, then build a Docker image
node make run [--local] - start in container or start locally
node make test [--local] - run mocha tests in container or locally
node make debug [--local] - run with debugging support in container or locally
node make watch [--local] - when anything in src changes, re-transpile to dist

Development workflow

terminal #1

$ node make build
$ npm ln

# watch for changes in src and update dist
$ node make watch

terminal #2

$ DEBUG=atomiq* atomiq <subcommand> [options]

Testing

  $ node make test [--local]

Debugging

  $ node make debug [--local]

Open node inspector in browser

local:

  $ open http://192.168.99.100:8080/?ws=192.168.99.100:8080&port=5858

container:

 $ IP=$(docker-machine ip <machine>)
 $ open http://$IP:8080/?ws=$IP:8080&port=5858

atomiq-cli's People

Contributors

Watchers

atomiq-cli's Issues

lint and format

I've added linting and formatting to the projects but it should be moved to atomiq lint and atomiq format since atomiq-cli already has the dependencies

Add a -f/--force option to atomiq make commands

Override detection if project doesn't appear to be an atomiq project (for example, to run atomiq make babel on a project that at least has a .babelrc file.

Update lib generator instructions

For the time being, update to specify npm install, npm test until atomiq test actually works for a non-Docker project (ie, uses npm test).

Update the README

Docs are out of date. Also, make sure to mention "missing" dependencies from package.json that are provided by the base image environment.

CLI should use `new` argument as default project name

lib template package.json missing main key

"main": "./dist"

Make `atomiq test` non blocking when using dependencies in docker-compose.test.yml

Currently, atomiq test runs docker-compose up. However, it doesn't work when using dependencies because docker-compose up doesn't exit on container exit when it has live dependencies.
Using docker-compose run circumvents that situation because the docker-compose run exits when the sut exits.

Update template test example to leverage mocha promise support

The current mocha test template example creates an async wrapper that might not be necessary any longer for mocha. Verify mocha promise support and remove the shim if not needed.

Lib project cli instructions

The CLI should not tell the user to run atomiq make build or atomiq up for lib projects.

Implement atomiq lint command

Use the ESLint API

Fix misspelled generator _npmignore files

_nmpigore -> _npmignore

atomiq build needs to copy src to dist

Like the update to the base docker image, need to ensure that a copy of src to dist is performed to ensure that all files are transferred, not just transpiled javascript files.

cp -r src dist && babel src -d dist --source-maps