WIP: comments and tests

Makefile

@@ -5,24 +5,25 @@ list:
 	@echo ""
 	@echo "Useful targets:"
 	@echo ""
-	@echo "  rebuild          > rebuild all images and start containers for dev only"
-	@echo "  start            > start containers"
-	@echo "  restart          > restart containers"
-	@echo "  stop             > stop and kill running containers"
-	@echo "  status           > display stack containers status"
-	@echo "  logs             > display containers logs"
-	@echo "  install_client   > install client dependencies"
-	@echo "  shell_client     > shell into angular client container"
-	@echo "  build_client     > generate the angular client dist application (html, css, js)"
+	@echo "  rebuild          > Rebuild all images and start containers for dev only"
+	@echo "  start            > Start containers"
+	@echo "  restart          > Restart containers"
+	@echo "  stop             > Stop and kill running containers"
+	@echo "  status           > Display stack containers status"
+	@echo "  logs             > Display containers logs"
+	@echo "  install_client   > Install client dependencies"
+	@echo "  shell_client     > Shell into angular client container"
+	@echo "  build_client     > Generate the angular client dist application (html, css, js)"
 	@echo "  test_client      > Starts the angular client unit tests"
+	@echo "  test_client-live > Run the angular client unit tests on every file change"
 	@echo "  client_coverage  > Run nginx web server test client coverage"
-	@echo "  install_server   > install server dependencies"
-	@echo "  shell_server     > shell into php server container"
+	@echo "  install_server   > Install server dependencies"
+	@echo "  shell_server     > Shell into php server container"
 	@echo "  test_server      > Starts the server php unit tests"
-	@echo "  phpcs            > run php code sniffer test suite"
-	@echo "  shell_services   > shell into python services"
-	@echo "  create-db        > create a database for dev only (need token_enabled=0)"
-	@echo "  remove-pgdata    > remove the anis-next database"
+	@echo "  phpcs            > Run php code sniffer test suite"
+	@echo "  shell_services   > Shell into python services"
+	@echo "  create-db        > Create a database for dev only (need token_enabled=0)"
+	@echo "  remove-pgdata    > Remove the anis-next database"
 	@echo ""
 
 rebuild:
@@ -57,6 +58,9 @@ build_client:
 test_client:
 	@docker-compose exec client npx jest
 
+test_client-live:
+	@docker-compose exec client npx jest --watchAll
+
 client_coverage:
 	@docker run --name anis-client-code-coverage -d -p 8888:80 -v $(CURDIR)/client/coverage/anis-client:/usr/share/nginx/html:ro nginx
 

client/src/app/instance/documentation/documentation-routing.module.ts

@@ -10,14 +10,18 @@
 import { NgModule } from '@angular/core';
 import { Routes, RouterModule } from '@angular/router';
 
-import { DatasetListComponent } from "./containers/dataset-list.component";
-import { DocumentationComponent } from "./containers/documentation.component";
+import { DatasetListComponent } from './containers/dataset-list.component';
+import { DocumentationComponent } from './containers/documentation.component';
 
 const routes: Routes = [
     { path: '', component: DatasetListComponent },
     { path: ':dname', component: DocumentationComponent },
 ];
 
+/**
+ * @class
+ * @classdesc Documentation routing module.
+ */
 @NgModule({
     imports: [RouterModule.forChild(routes)],
     exports: [RouterModule]

client/src/app/instance/documentation/documentation.module.ts

@@ -13,6 +13,10 @@ import { SharedModule } from 'src/app/shared/shared.module';
 import { DocumentationRoutingModule, routedComponents } from './documentation-routing.module';
 import { dummiesComponents } from './components';
 
+/**
+ * @class
+ * @classdesc Documentation module.
+ */
 @NgModule({
     imports: [
         SharedModule,