@mimik/local 7.0.3 → 7.0.4

package/README.md

@@ -119,7 +119,7 @@ The following is an example of start.json file for `mIT`:
  }
 ```
 While all the files use the `.json` extension it is still possible to add comments `//` in the file to make the file more explicit or to remove some parameters.
-There are reserved environement variables used by the library for configuration:
+There are reserved environment variables used by the library for configuration:
 - `oauthImplicitNeeded`: if the service handles user token the implicit configuration is needed
 - `mIDNeeded`: if the service has mID as a target
 - `locationNeeded`: if location translation is needed
@@ -131,7 +131,7 @@ For test in json file (`server-test.json`) is created in `.`.
 This file contains informations needed to start the test:
 ``` javascript
  {
-   "start": "information needed to setup the environement variables for the test",
+   "start": "information needed to setup the environment variables for the test",
    "CUSTOMER_NAME": "name of the customer to setup customer config",
    "CUSTOMER_CODE": "code of the customer to setup coustomer config, `not available for MST`",
    "BASE_PATH": "base path of the API",
@@ -152,8 +152,8 @@ import { mSTTestSetup, mSTSetup, mITTestSetup, mITSetup, testSetup, setup, dotFi
 * [local](#module_local)
     * [~mSTTestSetup()](#module_local..mSTTestSetup) ⇒
     * [~mSTSetup()](#module_local..mSTSetup) ⇒
-    * [~testSetup()](#module_local..testSetup) ⇒
-    * [~setup()](#module_local..setup) ⇒
+    * [~mITTestSetup()](#module_local..mITTestSetup) ⇒
+    * [~mITSetup()](#module_local..mITSetup) ⇒
     * [~testSetup()](#module_local..testSetup) ⇒
     * [~setup()](#module_local..setup) ⇒
 
@@ -181,7 +181,7 @@ The following files are needed to perform these actions:
 | `../s3Log.json` | The S3 information
 | `../mSTConfig.json` | The config for mST
 | `../mITConfig.json` | The config for mIT
-| `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if sart.json does not exist start-example.json will be used to create start.json  
+| `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if start.json does not exist start-example.json will be used to create start.json  
 **Category**: sync  
 <a name="module_local..mSTSetup"></a>
 
@@ -209,9 +209,9 @@ The following files are needed to perform these actions:
 | `../mITConfig.json` | The config for mIT
 | `./local/start.json` | The local configuration. If it does not exist start-example.json will be used to create start.json  
 **Category**: sync  
-<a name="module_local..testSetup"></a>
+<a name="module_local..mITTestSetup"></a>
 
-### local~testSetup() ⇒
+### local~mITTestSetup() ⇒
 Setup mIT for test.
 
 **Kind**: inner method of [<code>local</code>](#module_local)  
@@ -251,11 +251,11 @@ The following files are needed to perform these actions:
 | `../s3Log.json` | The S3 information
 | `../mSTConfig.json` | The config for mST
 | `../mITConfig.json` | The config for mIT
-| `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if sart.json does not exist start-example.json will be used to create start.json  
+| `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if start.json does not exist start-example.json will be used to create start.json  
 **Category**: sync  
-<a name="module_local..setup"></a>
+<a name="module_local..mITSetup"></a>
 
-### local~setup() ⇒
+### local~mITSetup() ⇒
 Setup mIT.
 
 **Kind**: inner method of [<code>local</code>](#module_local)  
@@ -339,7 +339,7 @@ The following files are needed to perform these actions:
 | `../mITConfig.json` | The config for mIT
 | `../mIDConfig.json` | The config for mID
 | `../customerConfig.json` | The mST customer config
-| `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if sart.json does not exist start-example.json will be used to create start.json  
+| `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if start.json does not exist start-example.json will be used to create start.json  
 **Category**: sync  
 <a name="module_local..setup"></a>
 

package/index.js

@@ -177,7 +177,7 @@ const getBasePath = apiDef => apiDef.basePath || apiDef.servers[FIRST].url;
  *  }
  * ```
  * While all the files use the `.json` extension it is still possible to add comments `//` in the file to make the file more explicit or to remove some parameters.
- * There are reserved environement variables used by the library for configuration:
+ * There are reserved environment variables used by the library for configuration:
  * - `oauthImplicitNeeded`: if the service handles user token the implicit configuration is needed
  * - `mIDNeeded`: if the service has mID as a target
  * - `locationNeeded`: if location translation is needed
@@ -189,7 +189,7 @@ const getBasePath = apiDef => apiDef.basePath || apiDef.servers[FIRST].url;
  * This file contains informations needed to start the test:
  * ``` javascript
  *  {
- *    "start": "information needed to setup the environement variables for the test",
+ *    "start": "information needed to setup the environment variables for the test",
  *    "CUSTOMER_NAME": "name of the customer to setup customer config",
  *    "CUSTOMER_CODE": "code of the customer to setup coustomer config, `not available for MST`",
  *    "BASE_PATH": "base path of the API",
@@ -396,7 +396,7 @@ const serverInit = (confType) => {
  * | `../s3Log.json` | The S3 information
  * | `../mSTConfig.json` | The config for mST
  * | `../mITConfig.json` | The config for mIT
- * | `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if sart.json does not exist start-example.json will be used to create start.json
+ * | `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if start.json does not exist start-example.json will be used to create start.json
  */
 export const mSTTestSetup = () => mSTInit(TEST);
 
@@ -433,7 +433,7 @@ export const mSTSetup = () => mSTInit();
  *
  * Setup mIT for test.
  *
- * @function testSetup
+ * @function mITTestSetup
  * @category sync
  *
  * @return `null`.
@@ -472,7 +472,7 @@ export const mSTSetup = () => mSTInit();
  * | `../s3Log.json` | The S3 information
  * | `../mSTConfig.json` | The config for mST
  * | `../mITConfig.json` | The config for mIT
- * | `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if sart.json does not exist start-example.json will be used to create start.json
+ * | `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if start.json does not exist start-example.json will be used to create start.json
  */
 export const mITTestSetup = () => mITInit(TEST);
 
@@ -480,7 +480,7 @@ export const mITTestSetup = () => mITInit(TEST);
  *
  * Setup mIT.
  *
- * @function setup
+ * @function mITSetup
  * @category sync
  *
  * @return `null`.
@@ -518,7 +518,7 @@ export const mITTestSetup = () => mITInit(TEST);
  * | `../mITConfig.json` | The config for mIT
  * | `./local/start.json` | The local configuration. If it does not exist start-example.json will be used to create start.json
  */
-const mITSetup = () => mITInit();
+export const mITSetup = () => mITInit();
 
 /**
  *
@@ -566,7 +566,7 @@ const mITSetup = () => mITInit();
  * | `../mITConfig.json` | The config for mIT
  * | `../mIDConfig.json` | The config for mID
  * | `../customerConfig.json` | The mST customer config
- * | `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if sart.json does not exist start-example.json will be used to create start.json
+ * | `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if start.json does not exist start-example.json will be used to create start.json
  */
 export const testSetup = () => serverInit(TEST);
 
@@ -658,7 +658,7 @@ export const unScripts = () => {
   write(packageFilename, packageFile, 'package.json', INSTALL, true);
 };
 
-export { testJsonFile };
+export { commitCheckMsg, start2process, testJsonFile };
 
 export default {
   commitCheckMsg,

package/lib/helpers.js

@@ -138,7 +138,7 @@ const baseUrl = (serverType, regType, config, literal) => {
  *````
  * Will exit 1 if there is an error.
  * sourceFilenameSupp is only used when sourceFilename exists.
- * If an environment variables exists in sourceFilename and sourceFilenameSupp, the environment variable in sourceFilename will be commented out.
+ * If an environment variable exists in sourceFilename and sourceFilenameSupp, the environment variable in sourceFilename will be commented out.
  *
  */
 const retrieve = (regType, filename, options) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/local",
-  "version": "7.0.3",
+  "version": "7.0.4",
   "description": "Local setup configuration for normal and test opreration",
   "main": "./index.js",
   "type": "module",