Merge pull request #106 from talyssonoc/tooling-and-code-cleanup

Tooling and code cleanup

Author: brunohcastro

README.md

@@ -16,6 +16,7 @@ If you want to just run the application in development mode, use the following c
 
 ```sh
 $ yarn dev
+
 ```
 
 To run the application in debug mode in a way that the execution will stop when a debugger statement is called, use:
@@ -50,6 +51,68 @@ The boilerplate is prepared to run tests using Jest. We usually group the tests
 $ yarn test
 ```
 
+## Docker wrapper
+
+In case you want to use Docker to run it, this project includes a [docker wrapper](https://github.com/brunohcastro/node-base) for development. Any command can be executed by calling the scripts under the `dbin/` folder.
+
+```sh
+$ dbin/yarn dev
+
+$ dbin/yarn debug
+
+$ dbin/yarn cli
+
+$ dbin/yarn remote [server address] [REPL port]
+
+$ dbin/yarn test
+```
+
+The container runs using host networking, so there's no need to map ports. Keep in mind that environment variables should be added to the docker-compose.yml.
+
+### Wrapper commands
+
+```sh
+# Runs the command inside an ephemeral container using the app service described in the docker-compose file as a base (use the --root flag if the command should be run as root)
+$ dbin/run [--root] <command>
+
+# Rebuild the image after any changes to the dockerfile
+$ dbin/build
+
+# Remove all containers and their volumes (WARNING any cache or files not stored in the filesystem will be deleted)
+$ dbin/dispose
+
+# Appends a RUN command to the base image, useful to install new packages
+$ dbin/chimg <command>
+```
+
+### Wrapper Aliases
+
+```sh
+# Creates a new <name> file in dbin to alias the <command> inside the docker container (use the --root flag if the command should be run as root)
+$ dbin/mkalias [--root] <name> <command>
+
+# Opens a new terminal in the project folder (use the --root flag if the shell should assume the root user)
+$ dbin/shell [--root]
+
+# Runs npm in the project folder
+$ dbin/npm
+
+# Runs npx in the project folder
+$ dbin/npx
+
+# Runs yarn in the project folder
+$ dbin/yarn
+```
+
+### Wrapper Helpers
+
+```bash
+# Adds dbin folder to the PATH only for the current terminal session.
+$ source dbin/local-env
+
+# After using this command you can use the any script inside the dbin folder without the dbin/ prefix
+```
+
 ## Dependency injection
 
 We use [Awilix](https://www.npmjs.com/package/awilix) to implement dependency injection and decouple the parts of your application. The boilerplate was developed in a way that each [module](#modules) is able to consume and augment the registered dependencies separately. Click here to know more about [inversion of control and dependency injection](https://www.martinfowler.com/articles/injection.html). The creator of Awilix also has a very good series of posts about the design decisions of the library that you can read [clicking here](https://medium.com/@Jeffijoe/dependency-injection-in-node-js-2016-edition-f2a88efdd427).

dbin/build

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+USER_ID=$(id -u) GROUP_ID=$(id -g) docker-compose build dev

dbin/chimg

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+PARENT_DIR="$(cd "$(dirname "$0")" && cd .. && pwd)"
+
+cp "$PARENT_DIR/docker/Dockerfile.dev" "$PARENT_DIR/docker/Dockerfile.dev.bkp"
+
+echo -e "\nRUN $*" >> "$PARENT_DIR/docker/Dockerfile.dev"
+
+if USER_ID=$(id -u) GROUP_ID=$(id -g) docker-compose build dev; then
+   rm -f "$PARENT_DIR/docker/Dockerfile.dev.bkp"
+else
+   mv "$PARENT_DIR/docker/Dockerfile.dev.bkp" "$PARENT_DIR/docker/Dockerfile.dev"
+fi

dbin/dispose

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+docker-compose down -v

dbin/local-env

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+DIR="$(cd "$(dirname "$0")" && pwd)"
+
+export PATH="$PATH:$DIR"

dbin/mkalias

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+DIR="$(cd "$(dirname "$0")" && pwd)"
+
+if [[ $1 == --root ]] ; then
+  runner="\$DIR/run --root"
+  name=$2
+  shift 2
+else
+  runner="\$DIR/run"
+  name=$1
+  shift 1
+fi
+
+cat >"$DIR/$name" <<EOL
+#!/bin/bash
+
+DIR="\$(cd "\$(dirname "\$0")" && pwd)"
+
+. "$runner" $@ "\$@"
+EOL
+
+chmod +x "$DIR/$name"

dbin/mvroot

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+PARENT_DIR="$(cd "$(dirname "$0")" && cd .. && pwd)"
+
+TARGET_DIR="$1"
+
+mv "$PARENT_DIR/README.md" "$PARENT_DIR/INSTRUCTIONS.md" 2>/dev/null
+
+(shopt -s dotglob; mv "$PARENT_DIR/$TARGET_DIR"/* "$PARENT_DIR")
+
+rm -r "${PARENT_DIR:?}/$TARGET_DIR"

dbin/npm

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+DIR="$(cd "$(dirname "$0")" && pwd)"
+
+. "$DIR/run" npm "$@"

dbin/npx

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+DIR="$(cd "$(dirname "$0")" && pwd)"
+
+. "$DIR/run" npx "$@"

dbin/run

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+user=""
+
+if [[ $1 == --root ]] ; then
+  user="--user root"
+  shift 1
+fi
+
+if docker-compose ps -a | grep -E -i -q 'app(\s*)running'; then
+  USER_ID=$(id -u) GROUP_ID=$(id -g) docker-compose --profile dev exec $user dev "$@"
+else
+  USER_ID=$(id -u) GROUP_ID=$(id -g) docker-compose --profile dev run --rm $user --service-ports dev "$@"
+fi