From 399ef16a59fa9ba00b4cf994e614dcf5b4393121 Mon Sep 17 00:00:00 2001
From: Guillaume WANG <guillaume.wang@polytechnique.edu>
Date: Tue, 29 Jan 2019 13:55:18 +0100
Subject: [PATCH] minor typo fixes and precisions

---
 README.md              | 9 +--------
 ldap_config.json       | 1 +
 src/app.ts             | 2 +-
 src/config_passport.js | 2 +-
 4 files changed, 4 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index fee78e2..5ea57f7 100644
--- a/README.md
+++ b/README.md
@@ -36,19 +36,12 @@ Pour installer les dépendances spécifiées dans `package.json` il faut donc la
 npm install
 ```
 
-Certaines d'entre elles, comme KnexJS ou Webpack, *doivent être installées globalement* :
-```bash
-npm install -g knex
-npm install -g webpack
-npm install -g eslint
-```
-
 Les dépendances principales utilisées sont 
 - *knex.js*, qui permet de construire des requêtes SQL facilement,
 - *GraphQL*, qui fournit une couche d'abstraction pour l'échange de données frontend-backend,
 - *ldap.js*, qui permet d'interroger un serveur LDAP, 
 - *webpack*, qui compile et optimise tout le code source javascript en un `bundle.js`,
-- *ESlint*, pour le développement, outil de vérification syntaxique.
+- *ESLint* et *TSLint*, pour le développement, outils de vérification syntaxique.
 
 Et une dépendance supplémentaire, PostgreSQL (linux est supposé) :
 ```bash
diff --git a/ldap_config.json b/ldap_config.json
index 80b551a..8e4cd00 100644
--- a/ldap_config.json
+++ b/ldap_config.json
@@ -1,5 +1,6 @@
 {
 	"comment_1": "Tout ce fichier sert à protéger les vrais champs du LDAP dans les scripts dans src/ldap. Les champs ci-dessous contiennent le nécessaire à une première connexion par exemple.",
+	"comment_1bis": "Ce fichier est importé par src/ldap/internal/config.ts ; comme indiqué dans config.ts, la présence d'une variable d'environnement correspondante peut override les paramètres donnés ici.",
 	"server_prod_old": "ldap://frankiz.eleves.polytechnique.fr:389",
 	"server_dev_old": "ldap://localhost:389",
 	"server_prod": "ldap://bloaziadur.eleves.polytechnique.fr:389",
diff --git a/src/app.ts b/src/app.ts
index b2da460..45dcd6f 100644
--- a/src/app.ts
+++ b/src/app.ts
@@ -189,7 +189,7 @@ import { MessageModel } from './graphql/connectors/messageModel';
 import { RequestModel } from './graphql/connectors/requestModel';
 const context = async ({ req }): Promise<Context> => {
     // set a special uid for non-authenticated requests
-    // /!\ FOR DEVELOPMENT ONLY: use the one in the ldap config .json file
+    // /!\ FOR DEVELOPMENT ONLY: use the one in the ldap_credentials.json file (imported by config.ts)
     // for production, replace with a "publicUser" or "notLoggedInUser" or something.
     let uid = credentialsLdapConfig.dn.split("=")[1].split(",")[0];
     
diff --git a/src/config_passport.js b/src/config_passport.js
index 33a86aa..c9b9a85 100644
--- a/src/config_passport.js
+++ b/src/config_passport.js
@@ -1,7 +1,7 @@
 /**
  * @file Configuration de passport pour utiliser l'authentification LDAP
  * @author kadabra
- * 
+ * @desc
  * http://toon.io/on-passportjs-specific-use-cases/#howtosplituppassportjsconfigurationbetweenmultiplefiles
  * 
  * On utilise passport avec la strategie 'ldapauth' pour transmettre une tentative d'authentification au LDAP.
-- 
GitLab