[BUGFIX] [Docker] [make] yamllint added as tool in docker lint stage, and as "make" action.

Author: Gonzalo Diaz

Dockerfile

@@ -7,49 +7,93 @@ ENV WORKDIR=/app
 WORKDIR ${WORKDIR}
 
 ###############################################################################
-FROM node:20.14.0-alpine3.20 AS lint
+FROM base AS lint
 
 ENV WORKDIR=/app
 WORKDIR ${WORKDIR}
 
+RUN apk add --update --no-cache make nodejs npm
+RUN apk add --update --no-cache yamllint
+
+RUN npm install -g --ignore-scripts markdownlint-cli
+
+# [!TIP] Use a bind-mount to "/app" to override following "copys"
+# for lint and test against "current" sources in this stage
+
+# YAML sources
+COPY ./.github ${WORKDIR}/
+COPY ./compose.yaml ${WORKDIR}/
+
+# Markdown sources
+COPY ./docs ${WORKDIR}/
+COPY ./README.md ${WORKDIR}/
+COPY ./LICENSE.md ${WORKDIR}/
+COPY ./CODE_OF_CONDUCT.md ${WORKDIR}/
+
+# Code source
 COPY ./src ${WORKDIR}/src
-RUN apk add --update --no-cache make
-RUN npm install -g markdownlint-cli
+COPY ./package.json ${WORKDIR}/package.json
+COPY ./package-lock.json ${WORKDIR}/package-lock.json
+COPY ./Makefile ${WORKDIR}/
 
+# code linting conf
+COPY ./.prettierrc ${WORKDIR}/
+COPY ./.prettierignore ${WORKDIR}/
+COPY ./.eslintrc ${WORKDIR}/
+COPY ./.babelrc ${WORKDIR}/
+
+# markdownlint conf
+COPY ./.markdownlint.yaml ${WORKDIR}/
+
+# yamllint conf
+COPY ./.yamllint ${WORKDIR}/
+COPY ./.yamlignore ${WORKDIR}/
+
+CMD ["make", "lint"]
 ###############################################################################
 FROM base AS development
 
-###############################################################################
-FROM development AS builder
+ENV WORKDIR=/app
+WORKDIR ${WORKDIR}
 
 COPY ./src ${WORKDIR}/src
 COPY ./package.json ${WORKDIR}/package.json
 COPY ./package-lock.json ${WORKDIR}/package-lock.json
 COPY ./Makefile ${WORKDIR}/
 
 RUN npm ci --verbose
+RUN ls -alh
+
+# CMD []
+WORKDIR ${WORKDIR}
+###############################################################################
+FROM development AS builder
+
+ENV WORKDIR=/app
+WORKDIR ${WORKDIR}
+
+RUN make clean && npm ci --verbose --omit-dev
+
+# CMD []
 
 ###############################################################################
 ### In testing stage, can't use USER, due permissions issue
 ## in github actions environment:
 ##
 ## https://docs.github.com/en/actions/creating-actions/dockerfile-support-for-github-actions
 ##
-FROM builder AS testing
+FROM development AS testing
 
 ENV LOG_LEVEL=info
 ENV BRUTEFORCE=false
-
-WORKDIR /app
+ENV WORKDIR=/app
+WORKDIR ${WORKDIR}
 
 COPY ./.babelrc /app/.babelrc
-COPY ./.eslintrc /app/.eslintrc
-COPY ./.prettierrc /app/.prettierrc
 COPY ./jest.config.js /app/jest.config.js
-COPY --from=builder /app/node_modules /app/node_modules
 RUN ls -alh
 
-CMD ["npm", "run", "test"]
+CMD ["make", "test"]
 
 ###############################################################################
 ### In production stage
@@ -60,8 +104,10 @@ FROM builder AS production
 
 ENV LOG_LEVEL=info
 ENV BRUTEFORCE=false
+ENV WORKDIR=/app
+WORKDIR ${WORKDIR}
 
-WORKDIR /app
+# TODO find a way to exclude /src/ and exclude *.test.js files
 
 COPY ./.babelrc /app/.babelrc
 COPY ./.eslintrc /app/.eslintrc

Makefile

@@ -26,6 +26,7 @@ NPM_UPDATABLE_MODULES = $(shell npm outdated | cut -d' ' -f 1 | sed '1d' | xargs
 
 # DOCKER
 BUILDKIT_PROGRESS=plain
+DOCKER_BUILDKIT=1
 
 .MAIN: test
 .PHONY: all clean dependencies help list test outdated
@@ -44,7 +45,7 @@ env:
 	@echo "################################################################################"
 
 clean:
-	npm run jest:clean
+	${NPM} run jest:clean
 	rm -vfr ./node_modules
 	rm -vfr ./coverage
 	mkdir -p ./coverage
@@ -57,43 +58,60 @@ dependencies:
 	test -x ./node_modules ||  npm install --verbose
 	@echo "################################################################################"
 
-mdlint:
+lint/markdown:
 	markdownlint '**/*.md' --ignore node_modules && echo '✔  Your code looks good.'
 
-lint: test/static mdlint
+lint/yaml:
+	yamllint --stric . && echo '✔  Your code looks good.'
+
+lint: lint/markdown lint/yaml test/styling test/static
 
 test/static: dependencies
-	npm run lint
+	${NPM} run lint
+
+test/styling: dependencies
+	${NPM} run style:check
+
+format: dependencies
+	${NPM} run style:format
 
-test: env dependencies test/static
-	npm run jest:ci
+test: env dependencies
+	${NPM} run jest:ci
 
-coverage: test
+coverage: dependencies test
 
-coverage/html: coverage
+coverage/html: dependencies test
 
 outdated:
-	-npm outdated
+	-${NPM}  outdated
 
 update: dependencies outdated
-	npm install $(NPM_UPDATABLE_MODULES)
+	${NPM}  install $(NPM_UPDATABLE_MODULES)
 
 upgrade: update
 
 compose/build: env
+	docker-compose --profile lint build
 	docker-compose --profile testing build
 
 compose/rebuild: env
+	docker-compose --profile lint build --no-cache
 	docker-compose --profile testing build --no-cache
 
-compose/mdlint: env
+compose/lint/markdown: compose/build
 	docker-compose --profile lint build
-	docker-compose --profile lint run --rm algorithm-exercises-js-mdlint make mdlint
+	docker-compose --profile lint run --rm algorithm-exercises-js-lint make lint/markdown
+
+compose/lint/yaml: compose/build
+	docker-compose --profile lint run --rm algorithm-exercises-js-lint make lint/yaml
+
+compose/test/styling: compose/build
+	docker-compose --profile lint run --rm algorithm-exercises-js-lint make test/styling
 
 compose/test/static: compose/build
-	docker-compose --profile testing run --rm algorithm-exercises-js make test/static
+	docker-compose --profile lint run --rm algorithm-exercises-js-lint make test/static
 
-compose/lint: compose/test/static compose/mdlint
+compose/lint: compose/lint/markdown compose/lint/yaml compose/test/styling compose/test/static
 
 compose/run: compose/build
 	docker-compose --profile testing run --rm algorithm-exercises-js make test

compose.yaml

@@ -1,3 +1,5 @@
+---
+
 services:
   algorithm-exercises-js:
     image: algorithm-exercises-js:latest
@@ -11,14 +13,14 @@ services:
       - ./coverage:/app/coverage
     profiles: ["testing"]
 
-  algorithm-exercises-js-mdlint:
-    image: algorithm-exercises-ts:mdlint
+  algorithm-exercises-js-lint:
+    image: algorithm-exercises-ts:lint
     build:
       context: .
       target: lint
     # environment:
-      # LOG_LEVEL: ${LOG_LEVEL:-info} ## (1) ## info | debug
-      # BRUTEFORCE: ${BRUTEFORCE:-false} ## (1) ## true | false
+    #   LOG_LEVEL: ${LOG_LEVEL:-info} ## (1) ## info | debug
+    #   BRUTEFORCE: ${BRUTEFORCE:-false} ## (1) ## true | false
     volumes:
       - ./:/app
     profiles: ["lint"]
@@ -35,6 +37,15 @@ services:
       - ./:/app
     profiles: ["development"]
 
+  algorithm-exercises-js-prod:
+    image: algorithm-exercises-js:prod
+    build:
+      context: .
+      target: production
+    volumes:
+      - ./:/app
+    profiles: ["production"]
+
 ## REFERENCES:
 ## (1) Passing Environment variable with fallback value:
 ##    https://stackoverflow.com/a/70772707/6366150

package.json

@@ -11,7 +11,8 @@
     "jest:clean": "jest --clearCache && watchman watch-del-all",
     "jest:bruteforce": "BRUTEFORCE=true node --experimental-vm-modules ./node_modules/.bin/jest --no-cache --ci --color --detectOpenHandles --forceExit --runInBand --debug",
     "jest:watch": "node --experimental-vm-modules ./node_modules/.bin/jest --no-cache --ci --color --detectOpenHandles --forceExit --runInBand --debug --watchAll",
-    "prettier": "npx prettier --write 'src/**/*.js'",
+    "style:format": "npx prettier --write 'src/**/*.js'",
+    "style:check": "npx prettier --check 'src/**/*.js'",
     "test": "jest",
     "test:all": "npm run lint && npm run jest && echo 'Done.'",
     "test:watch": "concurrently -k -s first --names \"LINT,TEST\" -p \"[{name}]\" \"npm run lint:watch\" \"npm run jest:watch\"",