Sync with javascript analyzer

* Create CODE_OF_CONDUCT (originally @SleeplessByte exercism/javascript-analyzer#5)

* Add dockerfile for automated mentoring support (originally @depsir exercism/javascript-analyzer#12)

* Initial smoke for usage of jest (originally: @SleeplessByte exercism/javascript-analyzer#17)

* Apply design and proper interface and structure (originally: @SleeplessByte exercism/javascript-analyzer#18)

* Fixes issues in the README.md (originally: @zeckdude exercism/javascript-analyzer#19)

Author: SleeplessByte

.babelrc

@@ -0,0 +1,6 @@
+{
+  "presets": [
+    ["@babel/preset-env", { "targets": { "node": "current" } } ],
+    "@babel/preset-typescript",
+  ],
+}

.dockerignore

@@ -0,0 +1,4 @@
+test
+dist
+node_modules
+.git

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at derk-jan+exercism@karrenbeld.info. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

Dockerfile

@@ -0,0 +1,25 @@
+FROM node:lts-alpine as builder
+
+# Install SSL ca certificates
+RUN apk update && apk add ca-certificates
+
+# Create appuser
+RUN adduser -D -g '' appuser
+
+# get the source code
+WORKDIR /typescript-analyzer
+COPY . .
+
+# build
+RUN yarn install && yarn build && yarn install --prod
+
+# Build a minimal and secured container
+FROM node:lts-alpine
+COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
+COPY --from=builder /etc/passwd /etc/passwd
+COPY --from=builder /typescript-analyzer/bin /opt/analyzer/bin
+COPY --from=builder /typescript-analyzer/dist /opt/analyzer/dist
+COPY --from=builder /typescript-analyzer/node_modules /opt/analyzer/node_modules
+USER appuser
+WORKDIR /opt/analyzer
+ENTRYPOINT ["/opt/analyzer/bin/analyze.sh"]

README.md

@@ -17,13 +17,15 @@ yarn build
 ## Usage
 
 You can run this either via `yarn`:
+
 ```
 yarn analyze:bat --debug --console two-fer ~/path/to/solution/folder
 ```
 
 Or directly via the provided shell script:
+
 ```
-./bin/analyze.sh two_fer ~/path/to/solution
+./bin/analyze.sh --debug --console two-fer ~/path/to/solution
 ```
 
 Add the `--debug` and `--console` flags to get output in the terminal window.

bin/analyze.bat

@@ -1,4 +1,4 @@
 @REM Usage:
-@REM ./bin/analyze.bat two_fer ~/test/
+@REM ./bin/analyze.bat two-fer ~/test/
 
 node -r esm ./dist/analyze.js %*

bin/analyze.sh

@@ -1,6 +1,6 @@
-#!/bin/bash
+#!/usr/bin/env sh
 
 # Usage:
-# ./bin/analyze.sh two_fer ~/test/
+# ./bin/analyze.sh two-fer ~/folder/to/solution
 
 node -r esm ./dist/analyze.js "$@"

bin/batch-runner

@@ -0,0 +1,4 @@
+@REM Usage:
+@REM ./bin/batch.bat two-fer
+
+node -r esm ./dist/batch.js %*

bin/batch.bat

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+
+# Usage:
+# ./bin/batch.sh two-fer
+
+node -r esm ./dist/batch.js "$@"