Merge pull request #2 from StatelessStudio/v1.0.2

V1.0.2

CHANGELOG.md

@@ -1,5 +1,10 @@
 # ts-tiny-log
 
+## [1.0.2]
+
+### Fixes
+- Export default instance from `/default`
+
 ## [1.0.1]
 
 Initial Release

README.md

@@ -5,7 +5,7 @@
 `npm i ts-tiny-log`
 
 ```typescript
-import { log } from 'ts-tiny-log';
+import { log } from 'ts-tiny-log/default';
 
 log.info('Test!');
 ```
@@ -15,7 +15,7 @@ log.info('Test!');
 There are 5 log-levels, `fatal`, `error`, `warn`, `info`, and `debug`. Each one accepts any number of arguments, and also accepts any type of variable, object, array, error, etc.
 
 ```typescript
-import { log } from 'ts-tiny-log';
+import { log } from 'ts-tiny-log/default';
 
 // info level with a string variable
 log.info('Hello, ', env.APP_TITLE);
@@ -34,12 +34,13 @@ catch (e) {
 
 ## Settings
 
-Configure the log by passing a new instance to `setLog()`
+Configure the log by creating a new instance. Export this so you can import your custom logger in your application.
 
+`src/log.ts`
 ```typescript
-import { Log, setLog } from 'ts-tiny-log';
+import { Log } from 'ts-tiny-log';
 
-setLog(new Log({
+export const log: Log = new Log({
 	shouldWriteTimestamp: false
 }));
 ```
@@ -52,10 +53,10 @@ Set the level that will be logged. Any level below this will also be logged. For
 **Example:**
 
 ```typescript
-import { Log, log, setLog } from 'ts-tiny-log';
+import { Log } from 'ts-tiny-log';
 import { LogLevel } from 'ts-tiny-log/levels';
 
-setLog(new Log({
+export const log: Log = new Log({
 	// Set the level to warn
 	level: LogLevel.warn
 }));
@@ -83,10 +84,11 @@ Turn on/off timestamp column per log entry
 
 **Example:**
 
+`src/log.ts`
 ```typescript
-import { Log, log, setLog } from '../src';
+import { Log } from '../src';
 
-setLog(new Log({
+export const log: Log = new Log({
 	// Don't write timestamps
 	shouldWriteTimestamp: false
 }));
@@ -111,9 +113,9 @@ Turn on/off log-level column per log entry
 **Example:**
 
 ```typescript
-import { Log, log, setLog } from '../src';
+import { Log } from '../src';
 
-setLog(new Log({
+export const log: Log = new Log({
 	// Don't write log-level
 	shouldWriteLogLevel: false
 }));
@@ -139,9 +141,9 @@ Determines how metadata columns (such as log-level and timestamp) are displayed.
 **Example:**
 
 ```typescript
-import { Log, log, setLog } from '../src';
+import { Log } from '../src';
 
-setLog(new Log({
+export const log: Log = new Log({
 	// Use square brackets for columns
 	metadataFormat: str => `[${str.trim().toUpperCase()}]`
 }));
@@ -165,7 +167,7 @@ Stream log output to a custom function.
 In this example, output will be streamed to a file via a custom `streamToFile()` function:
 
 ```typescript
-import { Log, log, setLog } from '../src';
+import { Log } from '../src';
 import { appendFileSync } from 'fs';
 
 /**
@@ -178,7 +180,7 @@ function streamToFile(...data: any[]): void {
 }
 
 // Set our custom Log
-setLog(new Log({
+export const log: Log = new Log({
 	standardOut: streamToFile,
 	standardError: streamToFile,
 }));

example/index.ts

@@ -1,6 +1,5 @@
 import { LogLevel } from '../src/levels';
-import { log } from '../src/log';
-import './log';
+import { log } from './log';
 
 log.fatal('Abort!');
 log.error('An error!', new Error('Broken!'));

example/log.ts

@@ -1,5 +1,5 @@
-import { Log, setLog } from '../src';
+import { Log } from '../src';
 
-setLog(new Log({
+export const log: Log = new Log({
 	// Add log settings here!
-}));
+});

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ts-tiny-log",
-	"version": "1.0.1",
+	"version": "1.0.2",
 	"ts-project-version": "1.2.4",
 	"private": "true",
 	"scripts": {

src/default.ts

@@ -0,0 +1,3 @@
+import { Log } from './log';
+
+export const log: Log = new Log();

src/index.ts

@@ -1,2 +1,2 @@
-export { Log, log, setLog } from './log';
+export { Log } from './log';
 export { LogContract } from './contract';

src/log.ts

@@ -212,10 +212,3 @@ export class Log implements LogContract {
 		return line;
 	}
 }
-
-/**
- * Internal log
- */
-let log: Log = new Log();
-export { log };
-export const setLog = (l: Log) => log = l;

test/spec/default.spec.ts

@@ -0,0 +1,9 @@
+import { Log } from '../../src';
+import { log } from '../../src/default';
+
+describe('default', () => {
+	it('exports a default log instance', () => {
+		expect(log).toBeDefined();
+		expect(log instanceof Log).toBeTrue();
+	});
+});

test/spec/index.spec.ts

@@ -12,13 +12,4 @@ describe('index', () => {
 
 		expect(something).toBeDefined();
 	});
-
-	it('exports a log function', () => {
-		expect(index.log).toBeDefined();
-	});
-
-	it('exports a setLog function', () => {
-		const log = new index.Log();
-		expect(index.setLog(log)).toBe(log);
-	});
 });

test/spec/log.spec.ts

@@ -1,5 +1,5 @@
 import { LogLevel } from '../../src/levels';
-import { Log, log, setLog } from '../../src/log';
+import { Log } from '../../src/log';
 import { captureLog } from '../utils/log/capture-log';
 import { testLogLevelMethod } from '../utils/log/test-log-level-method';
 import { timestampRegex } from '../utils/regex/timestamp';
@@ -11,17 +11,6 @@ describe('Log', () => {
 		expect(log).toBeDefined();
 	});
 
-	it('exposes the log instance', () => {
-		const oldLog = log;
-		const newLog = new Log();
-
-		setLog(newLog);
-		expect(log).toBe(newLog);
-
-		setLog(oldLog);
-		expect(log).toBe(oldLog);
-	});
-
 	it('can accept settings', () => {
 		const log: Log = new Log({
 			shouldWriteLogLevel: true,