Merge branch 'release/v0.4.0'

Author: miguel-rr

.eslintignore

@@ -1,4 +1,4 @@
 node_modules
 next-env.d.ts
 jest.config.js
-dist/
+bin/

.gitignore

@@ -62,4 +62,7 @@ typings/
 .env
 
 # next.js build output
-.next
+.next
+
+# A2R generated content
+.a2r

Dockerfile

@@ -1,19 +1,10 @@
 FROM node:12-alpine
 WORKDIR /usr/src/app
-LABEL Description="A2R API Watcher"
-# Production packages install
+LABEL Description="A2R Watcher"
 COPY ["package.json", "package-lock.json*", "npm-shrinkwrap.json*", "./"]
 RUN npm install --production --silent
-# Copy the source code and build the solution
 COPY . ./src
-RUN cd ./src;npm install --silent;npm run build
-# Copy de compiled version
-RUN cp -r ./src/bin ./bin
-# Remove the sources
-RUN rm -rf ./src
-# Enviroment por production
+RUN rm -rf ./src/server
+VOLUME ["/usr/src/app/src/server"]
 ENV NODE_ENV production
-# Vulumes for mapping
-VOLUME ["/usr/src/app/bin/server"]
-# Start command
-CMD npm start
+CMD cd ./src;npm install --silent;npm run build;cp -r ./bin ../bin;cd ..;rm -rf ./src;npm start

README.md

@@ -1,5 +1,5 @@
-# A2R API Watcher
+# A2R Watcher
 
 [![Build Status](https://travis-ci.org/acttoreact/api-watcher.svg?branch=master)](https://travis-ci.org/acttoreact/api-watcher) [![Coverage Status](https://coveralls.io/repos/github/acttoreact/api-watcher/badge.svg?branch=master)](https://coveralls.io/github/acttoreact/api-watcher) [![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/acttoreact/api-watcher)](https://snyk.io/test/github/acttoreact/api-watcher) [![Docker Image Version (latest by date)](https://img.shields.io/docker/v/act2react/api-watcher?sort=date)](https://hub.docker.com/r/act2react/api-watcher) [![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/act2react/api-watcher?sort=date)](https://hub.docker.com/r/act2react/api-watcher) [![GitHub](https://img.shields.io/github/license/acttoreact/api-watcher)](https://github.com/acttoreact/api-watcher/blob/develop/license.md) [![Documentation](https://img.shields.io/badge/documentation-ready-green)](https://htmlpreview.github.io/?https://github.com/acttoreact/api-watcher/blob/develop/docs/jsdocs/index.html#readDir)
 
-A2R Framework API Watcher
+A2R Framework API and model watcher

index.ts

@@ -90,7 +90,7 @@ export const start = async (): Promise<chokidar.FSWatcher[]> =>
 export const restart = start;
 
 /**
- * Inits API Watcher by ensuring destination path and running start process
+ * Inits watchers by ensuring destination path and running start process
  */
 const init = async (): Promise<void> => {
   await ensureDir(proxyDestPath);

jest.config.js

@@ -9,7 +9,7 @@ module.exports = {
   collectCoverageFrom: [
     "**/*.{ts,tsx}",
     "!**/node_modules/**",
-    "!**/dist/**",
+    "!**/bin/**",
     "!**/test/mocks/**"
   ],
   coverageReporters: ['text', 'lcov', 'json', 'html'],

jsdoc.json

@@ -2,7 +2,7 @@
   "source": {
     "include": ["./"],
     "includePattern": "\\.(jsx|js|ts|tsx)$",
-    "excludePattern": "(dist|tests|tmp|node_modules)"
+    "excludePattern": "(bin|tests|tmp|node_modules)"
   },
   "plugins": [
     "plugins/markdown",

package-lock.json

@@ -1,20 +1,20 @@
 {
   "name": "watcher",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "API and model watcher",
   "engines": {
     "node": ">=12"
   },
   "scripts": {
     "build": "tsc",
     "dev": "NODE_ENV=development ts-node-dev --debug --respawn --transpileOnly ./index.ts",
-    "docker-build": "IMAGE=$npm_package_name:latest;docker build --rm --pull -f \"./Dockerfile\" -t $IMAGE \".\"",
-    "docker-start": "IMAGE=$npm_package_name:latest;docker run -it -v $INIT_CWD/server:/usr/src/app/server $IMAGE",
-    "docker-start-from-hub": "IMAGE=act2react/watcher:version-$npm_package_version;docker run -it -v $INIT_CWD/server:/usr/src/app/server $IMAGE",
+    "docker-build": "npm run build;IMAGE=$npm_package_name:latest;docker build --rm --pull -f \"./Dockerfile\" -t $IMAGE \".\"",
+    "docker-start": "IMAGE=$npm_package_name:latest;docker run -it -d -v $INIT_CWD/server:/usr/src/app/server $IMAGE",
+    "docker-start-from-hub": "IMAGE=act2react/watcher:version-$npm_package_version;docker run -it -d -v $INIT_CWD/server:/usr/src/app/server $IMAGE",
     "start": "node ./bin/index.js",
     "lint": "npx eslint --config ./.eslintrc ./**/*.ts",
     "test": "jest",
-    "test-clear": "rm -rf coverage;rm -rf dist",
+    "test-clear": "rm -rf coverage;rm -rf bin",
     "test-dev": "NODE_ENV=development npx jest --watch",
     "test-coverage": "jest --coverage",
     "test-coverage-dev": "NODE_ENV=development jest --coverage --watchAll",
@@ -54,7 +54,7 @@
     "@types/rimraf": "^3.0.0",
     "@typescript-eslint/eslint-plugin": "^2.33.0",
     "@typescript-eslint/parser": "^2.33.0",
-    "babel-jest": "^25.4.0",
+    "babel-jest": "^25.5.1",
     "better-docs": "^2.0.1",
     "coveralls": "^3.0.11",
     "eslint": "^7.0.0",
@@ -63,7 +63,7 @@
     "eslint-plugin-import": "^2.18.2",
     "eslint-plugin-jsx-a11y": "^6.2.3",
     "eslint-plugin-react": "^7.20.0",
-    "jest": "^25.4.0",
+    "jest": "^25.5.1",
     "jsdoc": "^3.6.3",
     "ts-jest": "^25.5.1",
     "ts-node-dev": "^1.0.0-pre.40",

package.json

@@ -57,19 +57,19 @@ const methodWrapper = (method: string, ...args: any[]): Promise<any> => {
  * Gets data from server
  * @returns {Promise<model.Data>}
  */
-const getData = (data: Data2, blas: Blas): Promise<Data> => methodWrapper('modelImports2', data, blas);
+const getData = (data: Data2, blas: Blas): Promise<Data> => methodWrapper('model-imports-2', data, blas);
 
 /**
  * Gets data from server
  * @returns {Promise<model.Data>}
  */
-const getData2 = (): Promise<Data3> => methodWrapper('modelImports3');
+const getData2 = (): Promise<Data3> => methodWrapper('model-imports-3');
 
 /**
  * Gets data from server
  * @returns {Promise<model.Data>}
  */
-const getData3 = (data: Data2, juan: Juan): Promise<Data> => methodWrapper('modelImports', data, juan);
+const getData3 = (data: Data2, juan: Juan): Promise<Data> => methodWrapper('model-imports', data, juan);
 
 const api = {
   modelImports2: getData,

test/mocks/.a2r/model-imports/api/index.ts

@@ -12,7 +12,6 @@ test('Get exports identifiers', async (): Promise<void> => {
   const sourceFile = ts.createSourceFile(filePath, content, ts.ScriptTarget.Latest, true);
   const fileNodes = sourceFile.getChildren();
   const identifiers = getExportsIdentifiersFromNodes(fileNodes);
-  console.log(identifiers);
   expect(identifiers.length).toBe(1);
   expect(identifiers).toContain('Data');
 });

test/tests/ts/getExportsIdentifiersFromNodes.ts

@@ -23,7 +23,7 @@ const writeSeveralFiles = async (
   nFiles = 5,
 ): Promise<void> => {
   const files = new Array(nFiles)
-    .fill(null)
+    .fill(true)
     .map((_val, i) => path.resolve(filePath, `file-${i}.ts`));
   await Promise.all(files.map(file => writeFile(file, '// test file')));
 };

test/tests/validations/stressValidator.ts

@@ -4,7 +4,6 @@ import path from 'path';
 import { ModuleInfo } from '../model/api';
 
 import { readFile } from '../tools/fs';
-import cleanText from '../tools/cleanText';
 import getMainMethodName from './getMainMethodName';
 import getMainMethodNode from './getMainMethodNode';
 import getFunctionDocContainer from './getFunctionDocContainer';
@@ -39,8 +38,7 @@ const getModuleInfo = async (filePath: string, apiSourcePath: string): Promise<M
   const keys = path
     .relative(apiSourcePath, filePath)
     .replace(/\.ts$/, '')
-    .split(path.sep)
-    .map(s => cleanText(s, false, true, true, true, '-'));
+    .split(path.sep);
   return {
     mainMethodDocs,
     mainMethodName,

utils/getModuleInfo.ts

@@ -1,5 +1,7 @@
 import { ApiNamespace } from '../model/api';
 
+import cleanText from '../tools/cleanText';
+
 const updateApiObject = (
   structure: ApiNamespace,
   keys: string[],
@@ -9,17 +11,18 @@ const updateApiObject = (
   const lastIndex = keys.length - 1;
   return keys.reduce(
     (t: ApiNamespace, key: string, i: number): ApiNamespace => {
+      const cleanKey = cleanText(key, false, true, true, true, '-');
       if (i === lastIndex) {
         t.methods.push({
-          key,
+          key: cleanKey,
           methodName,
         });
         return newApiObject;
       }
-      let namespace = t.namespaces.find((n): boolean => n.key === key);
+      let namespace = t.namespaces.find((n): boolean => n.key === cleanKey);
       if (!namespace) {
         namespace = {
-          key,
+          key: cleanKey,
           namespaces: [],
           methods: [],
         };