Feature/configuration (#30)

* Merge two config field * Add configuration settings * Update version * Add new build files
hg-pyun · Jul 14, 2019 · 89ee5ac · 89ee5ac
1 parent ebe1d56
commit 89ee5ac
Show file tree

Hide file tree

Showing 11 changed files with 85 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -84,6 +84,37 @@ instance.interceptors.response.use(AxiosLogger.responseLogger, (err) => {
 });
 ```
 
+## Configuration Settings
+
+You can adjust several features as desired through configuration file.
+If you want to set config globally, using `setGlobalConfig` method.
+
+```javascript
+setGlobalConfig({
+    prefixText: 'your prefix',
+    dateFormat: 'HH:MM:ss',
+    status: false,
+});
+```
+
+Or it can also be passed on as a second argument and applied locally.
+
+```javascript
+instance.interceptors.request.use((config) => {
+    // write down your request intercept.
+    return AxiosLogger.requestLogger(config, {
+        prefixText: 'your prefix',
+        dateFormat: 'HH:MM:ss',
+        status: false,
+    });
+});
+```
+
+#### Enable config list
+
+-   prefixText: string | false (default Axios)
+-   dateFormat: [dateformat](https://github.com/felixge/node-dateformat) | false (default isoDateTime)
+
 ## CONTRIBUTE
 
 I always welcome Feedback and Pull Request :)
diff --git a/lib/common/config.d.ts b/lib/common/config.d.ts
@@ -9,19 +9,15 @@ declare function mergeWithGlobalConfig(config?: RequestLogConfig | ResponseLogCo
     status?: boolean | undefined;
     statusText?: boolean | undefined;
     code?: boolean | undefined;
-    usePrefix?: boolean | undefined;
-    prefixText?: string | undefined;
-    useDate?: boolean | undefined;
-    dateFormat?: string | undefined;
+    prefixText?: string | boolean | undefined;
+    dateFormat?: string | boolean | undefined;
 } | {
     data?: boolean | undefined;
     url?: boolean | undefined;
     method?: boolean | undefined;
     headers?: boolean | undefined;
-    usePrefix?: boolean | undefined;
-    prefixText?: string | undefined;
-    useDate?: boolean | undefined;
-    dateFormat?: string | undefined;
+    prefixText?: string | boolean | undefined;
+    dateFormat?: string | boolean | undefined;
     status?: boolean | undefined;
     statusText?: boolean | undefined;
     code?: boolean | undefined;
@@ -30,20 +26,16 @@ declare function mergeWithGlobalConfig(config?: RequestLogConfig | ResponseLogCo
     status?: boolean | undefined;
     statusText?: boolean | undefined;
     headers?: boolean | undefined;
-    usePrefix?: boolean | undefined;
-    prefixText?: string | undefined;
-    useDate?: boolean | undefined;
-    dateFormat?: string | undefined;
+    prefixText?: string | boolean | undefined;
+    dateFormat?: string | boolean | undefined;
     url?: boolean | undefined;
     method?: boolean | undefined;
     code?: boolean | undefined;
 } | {
     data?: boolean | undefined;
     code?: boolean | undefined;
-    usePrefix?: boolean | undefined;
-    prefixText?: string | undefined;
-    useDate?: boolean | undefined;
-    dateFormat?: string | undefined;
+    prefixText?: string | boolean | undefined;
+    dateFormat?: string | boolean | undefined;
     url?: boolean | undefined;
     method?: boolean | undefined;
     headers?: boolean | undefined;

diff --git a/lib/common/string-builder.d.ts b/lib/common/string-builder.d.ts
@@ -3,7 +3,7 @@ declare class StringBuilder {
     private config;
     private printQueue;
     constructor(config: GlobalLogConfig);
-    makePrefix(logType: string): this;
+    makePrefix(logType: string | false): this;
     makeDateFormat(): this;
     makeUrl(url?: string): this;
     makeMethod(method?: string): this;

diff --git a/lib/common/string-builder.js b/lib/common/string-builder.js
diff --git a/lib/common/types.d.ts b/lib/common/types.d.ts
@@ -1,8 +1,6 @@
 export interface CommonConfig {
-    usePrefix?: boolean;
-    prefixText?: string;
-    useDate?: boolean;
-    dateFormat?: string;
+    prefixText?: string | boolean;
+    dateFormat?: string | boolean;
 }
 export interface GlobalLogConfig extends CommonConfig {
     data?: boolean;

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "axios-logger",
-    "version": "2.0.1",
+    "version": "2.1.0",
     "description": "Beautify Axios Logging Messages",
     "main": "lib/index.js",
     "keywords": [

diff --git a/src/common/string-builder.ts b/src/common/string-builder.ts
@@ -11,13 +11,14 @@ class StringBuilder {
         this.printQueue = [];
     }
 
-    makePrefix(logType: string) {
-        const prefix = this.config.prefixText ? `[${this.config.prefixText}][${logType}]` : `[Axios][${logType}]`;
+    makePrefix(logType: string | false) {
+        const prefix = this.config.prefixText === false ? `[${logType}]` : `[${this.config.prefixText || 'Axios'}][${logType}]`;
         this.printQueue.push(chalk.green(prefix));
         return this;
     }
 
     makeDateFormat() {
+        // @ts-ignore
         const dateFormat = dateformat(new Date(), this.config.dateFormat || 'isoDateTime');
         this.printQueue.push(dateFormat);
         return this;

diff --git a/src/common/types.ts b/src/common/types.ts
@@ -1,8 +1,6 @@
 export interface CommonConfig {
-    usePrefix?: boolean,
-    prefixText?: string,
-    useDate?: boolean,
-    dateFormat?: string,
+    prefixText?: string | boolean,
+    dateFormat?: string | boolean,
 }
 
 export interface GlobalLogConfig extends CommonConfig {

diff --git a/src/logger/__test__/error.spec.js b/src/logger/__test__/error.spec.js
@@ -78,3 +78,14 @@ test('if both global and local config are defined, local config should override
     expect(printLog).toHaveBeenCalled();
     expect(printLog).toBeCalledWith(expect.stringContaining('[local custom prefix]'));
 });
+
+test('if prefixText is false, remove prefix', () => {
+    const globalConfig = {
+        prefixText: false,
+    };
+
+    setGlobalConfig(globalConfig);
+    errorLoggerWithoutPromise(axiosError);
+    expect(printLog).toHaveBeenCalled();
+    expect(printLog).toBeCalledWith(expect.not.stringContaining('[Axios]'));
+});
diff --git a/src/logger/__test__/request.spec.js b/src/logger/__test__/request.spec.js
@@ -66,3 +66,14 @@ test('if both global and local config are defined, local config should override
     expect(printLog).toHaveBeenCalled();
     expect(printLog).toBeCalledWith(expect.stringContaining('[local custom prefix]'));
 });
+
+test('if prefixText is false, remove prefix', () => {
+    const globalConfig = {
+        prefixText: false,
+    };
+
+    setGlobalConfig(globalConfig);
+    requestLogger(axiosRequestConfig);
+    expect(printLog).toHaveBeenCalled();
+    expect(printLog).toBeCalledWith(expect.not.stringContaining('[Axios]'));
+});
diff --git a/src/logger/__test__/response.spec.js b/src/logger/__test__/response.spec.js
@@ -76,3 +76,14 @@ test('if both global and local config are defined, local config should override
     expect(printLog).toHaveBeenCalled();
     expect(printLog).toBeCalledWith(expect.stringContaining('[local custom prefix]'));
 });
+
+test('if prefixText is false, remove prefix', () => {
+    const globalConfig = {
+        prefixText: false,
+    };
+
+    setGlobalConfig(globalConfig);
+    responseLogger(axiosResponse);
+    expect(printLog).toHaveBeenCalled();
+    expect(printLog).toBeCalledWith(expect.not.stringContaining('[Axios]'));
+});