fix documentation/configuration layout

Author: anigenero

docs/_includes/sections/pattern-layout.html

@@ -10,14 +10,14 @@ <h2>Specifying a Layout</h2>
 
 {% highlight typescript %}
 configure({
-    patternLayout: '%d [%p] %c - %m', // default
+    layout: '%d [%p] %c - %m', // default
     appenders: [{
         appender: 'Console',
-        patternLayout: '%d{ISO8601} [%p] - %m %exception' // appender
+        layout: '%d{ISO8601} [%p] - %m %exception' // appender
     }],
     loggers: [{
         tag: 'App',
-        patternLayout: '%c.%method (%line:%column) %m %ex' // logger
+        layout: '%c.%method (%line:%column) %m %ex' // logger
     }]
 });
 {% endhighlight %}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@log4js2/core",
-  "version": "2.0.0-beta.4",
+  "version": "2.0.0-beta.5",
   "scripts": {
     "build": "npm run lint && tsc",
     "lint": "tslint -p tsconfig.json -c tslint.json",

src/__mocks__/configuration.ts

@@ -13,7 +13,7 @@ configure({
     appenders: [{
         appender: CustomAppender
     }],
-    patternLayout: '%c - %m',
+    layout: '%c - %m',
     loggers: [{
         level: LogLevel.INFO
     }, {
@@ -22,19 +22,19 @@ configure({
     }, {
         tag: TEST_LOGGER_2,
         level: LogLevel.INFO,
-        patternLayout: '%c [%p] %m'
+        layout: '%c [%p] %m'
     }, {
         tag: ERROR_LOGGER,
         level: LogLevel.ERROR,
-        patternLayout: '%ex'
+        layout: '%ex'
     }, {
         tag: MAP_LOGGER,
         level: LogLevel.INFO,
-        patternLayout: '%K'
+        layout: '%K'
     }, {
         tag: MARKER_LOGGER,
         level: LogLevel.INFO,
-        patternLayout: '%marker'
+        layout: '%marker'
     }, {
         tag: CUSTOM_LOGGER,
         level: LogLevel.TRACE

src/__tests__/appender.spec.ts

@@ -5,7 +5,7 @@ import { configure, getLogger } from '../log4js';
 
 configure({
     level: LogLevel.DEBUG,
-    patternLayout: '%m'
+    layout: '%m'
 });
 
 describe('Logger', () => {

src/__tests__/logging.spec.ts

@@ -6,7 +6,7 @@ describe('Message', () => {
 
     configure({
         level: LogLevel.INFO,
-        patternLayout: '%c - %m'
+        layout: '%c - %m'
     });
 
     // create a log stack we can throw logs into

src/config/appender.config.ts

@@ -9,6 +9,6 @@ export default interface IAppenderConfiguration<C = any, T extends LogAppender<C
     config?: any;
     filters?: Array<IFilterConfiguration<any, LogFilter<any>>>;
     level?: LogLevel | number;
-    patternLayout?: string;
+    layout?: string;
 
 }

src/config/configuration.ts

@@ -10,7 +10,7 @@ export default interface IConfiguration {
     level?: LogLevel;
     appenders?: AppenderConfigurationItem[] | string[];
     loggers?: ILoggerConfiguration[];
-    patternLayout?: string;
+    layout?: string;
     virtualConsole?: boolean;
 
 }

src/config/logger.config.ts

@@ -4,7 +4,7 @@ export default interface ILoggerConfiguration {
 
     appenders?: string[];
     level?: LogLevel | number;
-    patternLayout?: string;
+    layout?: string;
     tag?: string;
 
 }

src/log4js.ts

@@ -32,7 +32,7 @@ const _DEFAULT_CONFIG = ((): IConfiguration => ({
     loggers: [{
         level: LogLevel.ERROR
     }],
-    patternLayout: '%d [%p] %c - %m'
+    layout: '%d [%p] %c - %m'
 }))();
 
 /** @type {?IConfiguration} */
@@ -55,7 +55,7 @@ const _getAppendersForLogger = (logConfig: ILoggerConfiguration) => {
     getLoggerAppenderInstances(logConfig.appenders).forEach((appenderWrapper) => {
 
         appenderWrapper.appender.setLogLevel(logConfig.level);
-        appenderWrapper.appender.setLayout(logConfig.patternLayout);
+        appenderWrapper.appender.setLayout(logConfig.layout);
 
         appenderList.push(appenderWrapper);
 
@@ -86,11 +86,11 @@ const _configureLoggers = (config: IConfiguration): IConfiguration => {
 
             hasMain = hasMain || logger.tag === MAIN_LOGGER;
 
-            if (!logger.patternLayout || typeof logger.patternLayout !== 'string') {
-                logger.patternLayout = config.patternLayout;
+            if (!logger.layout || typeof logger.layout !== 'string') {
+                logger.layout = config.layout;
             }
 
-            logger.patternLayout = logger.patternLayout || _DEFAULT_PATTERN_LAYOUT;
+            logger.layout = logger.layout || _DEFAULT_PATTERN_LAYOUT;
             logger.level = logger.level || config.level || LogLevel.ERROR;
 
             addLogger(logger.tag, new Logger(logger.tag, _getAppendersForLogger(logger)));
@@ -105,7 +105,7 @@ const _configureLoggers = (config: IConfiguration): IConfiguration => {
         const mainLoggerConfig: ILoggerConfiguration = {
             tag: MAIN_LOGGER,
             level: config.level || LogLevel.ERROR,
-            patternLayout: config.patternLayout || _DEFAULT_PATTERN_LAYOUT,
+            layout: config.layout || _DEFAULT_PATTERN_LAYOUT,
         };
 
         loggers.push(mainLoggerConfig);
@@ -200,8 +200,8 @@ const _configureAppenders = (config: IConfiguration): IConfiguration => {
 export function configure(config: IConfiguration) {
 
     // set the default layout
-    if (!config.patternLayout) {
-        config.patternLayout = _DEFAULT_PATTERN_LAYOUT;
+    if (!config.layout) {
+        config.layout = _DEFAULT_PATTERN_LAYOUT;
     }
 
     // configure the appenders

src/logger/index.ts

@@ -37,7 +37,7 @@ export const getLogger = <T>(context: string, config: ILoggerConfiguration): Log
             .map((appenderWrapper) => {
 
                 appenderWrapper.appender.setLogLevel(config.level);
-                appenderWrapper.appender.setLayout(config.patternLayout);
+                appenderWrapper.appender.setLayout(config.layout);
 
                 return appenderWrapper;