diff --git a/api-extractor.json b/api-extractor.json index 98dc8af2..ce1f970e 100644 --- a/api-extractor.json +++ b/api-extractor.json @@ -12,5 +12,6 @@ }, "docModel": { "enabled": true - } + }, + "newlineKind": "lf" } diff --git a/docs/api/ts-log-adapter-gulplog.gulploglogger._constructor_.md b/docs/api/ts-log-adapter-gulplog.gulploglogger._constructor_.md new file mode 100644 index 00000000..685fde5e --- /dev/null +++ b/docs/api/ts-log-adapter-gulplog.gulploglogger._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@userfrosting/ts-log-adapter-gulplog](./ts-log-adapter-gulplog.md) > [GulpLogLogger](./ts-log-adapter-gulplog.gulploglogger.md) > [(constructor)](./ts-log-adapter-gulplog.gulploglogger._constructor_.md) + +## GulpLogLogger.(constructor) + +Constructs a new instance of the `GulpLogLogger` class + +Signature: + +```typescript +constructor(prefix?: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| prefix | string | Optionally annotate logs with a prefix such as the package name to identify log source. | + diff --git a/docs/api/ts-log-adapter-gulplog.gulploglogger.debug.md b/docs/api/ts-log-adapter-gulplog.gulploglogger.debug.md index 1d7f1486..50397466 100644 --- a/docs/api/ts-log-adapter-gulplog.gulploglogger.debug.md +++ b/docs/api/ts-log-adapter-gulplog.gulploglogger.debug.md @@ -2,22 +2,10 @@ [Home](./index.md) > [@userfrosting/ts-log-adapter-gulplog](./ts-log-adapter-gulplog.md) > [GulpLogLogger](./ts-log-adapter-gulplog.gulploglogger.md) > [debug](./ts-log-adapter-gulplog.gulploglogger.debug.md) -## GulpLogLogger.debug() method +## GulpLogLogger.debug property Signature: ```typescript -debug(message?: any, ...optionalParams: any[]): void; +debug: (message?: any, ...optionalParams: any[]) => void; ``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| message | any | | -| optionalParams | any[] | | - -Returns: - -`void` - diff --git a/docs/api/ts-log-adapter-gulplog.gulploglogger.error.md b/docs/api/ts-log-adapter-gulplog.gulploglogger.error.md index b0a0927d..547b0ea7 100644 --- a/docs/api/ts-log-adapter-gulplog.gulploglogger.error.md +++ b/docs/api/ts-log-adapter-gulplog.gulploglogger.error.md @@ -2,22 +2,10 @@ [Home](./index.md) > [@userfrosting/ts-log-adapter-gulplog](./ts-log-adapter-gulplog.md) > [GulpLogLogger](./ts-log-adapter-gulplog.gulploglogger.md) > [error](./ts-log-adapter-gulplog.gulploglogger.error.md) -## GulpLogLogger.error() method +## GulpLogLogger.error property Signature: ```typescript -error(message?: any, ...optionalParams: any[]): void; +error: (message?: any, ...optionalParams: any[]) => void; ``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| message | any | | -| optionalParams | any[] | | - -Returns: - -`void` - diff --git a/docs/api/ts-log-adapter-gulplog.gulploglogger.info.md b/docs/api/ts-log-adapter-gulplog.gulploglogger.info.md index ed64a5e8..5f35f03c 100644 --- a/docs/api/ts-log-adapter-gulplog.gulploglogger.info.md +++ b/docs/api/ts-log-adapter-gulplog.gulploglogger.info.md @@ -2,22 +2,10 @@ [Home](./index.md) > [@userfrosting/ts-log-adapter-gulplog](./ts-log-adapter-gulplog.md) > [GulpLogLogger](./ts-log-adapter-gulplog.gulploglogger.md) > [info](./ts-log-adapter-gulplog.gulploglogger.info.md) -## GulpLogLogger.info() method +## GulpLogLogger.info property Signature: ```typescript -info(message?: any, ...optionalParams: any[]): void; +info: (message?: any, ...optionalParams: any[]) => void; ``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| message | any | | -| optionalParams | any[] | | - -Returns: - -`void` - diff --git a/docs/api/ts-log-adapter-gulplog.gulploglogger.md b/docs/api/ts-log-adapter-gulplog.gulploglogger.md index 004fb073..3a1b6648 100644 --- a/docs/api/ts-log-adapter-gulplog.gulploglogger.md +++ b/docs/api/ts-log-adapter-gulplog.gulploglogger.md @@ -12,13 +12,19 @@ export declare class GulpLogLogger implements Logger ``` -## Methods +## Constructors -| Method | Modifiers | Description | +| Constructor | Modifiers | Description | | --- | --- | --- | -| [debug(message, optionalParams)](./ts-log-adapter-gulplog.gulploglogger.debug.md) | | | -| [error(message, optionalParams)](./ts-log-adapter-gulplog.gulploglogger.error.md) | | | -| [info(message, optionalParams)](./ts-log-adapter-gulplog.gulploglogger.info.md) | | | -| [trace(message, optionalParams)](./ts-log-adapter-gulplog.gulploglogger.trace.md) | | | -| [warn(message, optionalParams)](./ts-log-adapter-gulplog.gulploglogger.warn.md) | | | +| [(constructor)(prefix)](./ts-log-adapter-gulplog.gulploglogger._constructor_.md) | | Constructs a new instance of the GulpLogLogger class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [debug](./ts-log-adapter-gulplog.gulploglogger.debug.md) | | (message?: any, ...optionalParams: any[]) => void | | +| [error](./ts-log-adapter-gulplog.gulploglogger.error.md) | | (message?: any, ...optionalParams: any[]) => void | | +| [info](./ts-log-adapter-gulplog.gulploglogger.info.md) | | (message?: any, ...optionalParams: any[]) => void | | +| [trace](./ts-log-adapter-gulplog.gulploglogger.trace.md) | | (message?: any, ...optionalParams: any[]) => void | | +| [warn](./ts-log-adapter-gulplog.gulploglogger.warn.md) | | (message?: any, ...optionalParams: any[]) => void | | diff --git a/docs/api/ts-log-adapter-gulplog.gulploglogger.trace.md b/docs/api/ts-log-adapter-gulplog.gulploglogger.trace.md index 575cc5a7..acb3c0e1 100644 --- a/docs/api/ts-log-adapter-gulplog.gulploglogger.trace.md +++ b/docs/api/ts-log-adapter-gulplog.gulploglogger.trace.md @@ -2,22 +2,10 @@ [Home](./index.md) > [@userfrosting/ts-log-adapter-gulplog](./ts-log-adapter-gulplog.md) > [GulpLogLogger](./ts-log-adapter-gulplog.gulploglogger.md) > [trace](./ts-log-adapter-gulplog.gulploglogger.trace.md) -## GulpLogLogger.trace() method +## GulpLogLogger.trace property Signature: ```typescript -trace(message?: any, ...optionalParams: any[]): void; +trace: (message?: any, ...optionalParams: any[]) => void; ``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| message | any | | -| optionalParams | any[] | | - -Returns: - -`void` - diff --git a/docs/api/ts-log-adapter-gulplog.gulploglogger.warn.md b/docs/api/ts-log-adapter-gulplog.gulploglogger.warn.md index 2649cb2d..9be4e173 100644 --- a/docs/api/ts-log-adapter-gulplog.gulploglogger.warn.md +++ b/docs/api/ts-log-adapter-gulplog.gulploglogger.warn.md @@ -2,22 +2,10 @@ [Home](./index.md) > [@userfrosting/ts-log-adapter-gulplog](./ts-log-adapter-gulplog.md) > [GulpLogLogger](./ts-log-adapter-gulplog.gulploglogger.md) > [warn](./ts-log-adapter-gulplog.gulploglogger.warn.md) -## GulpLogLogger.warn() method +## GulpLogLogger.warn property Signature: ```typescript -warn(message?: any, ...optionalParams: any[]): void; +warn: (message?: any, ...optionalParams: any[]) => void; ``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| message | any | | -| optionalParams | any[] | | - -Returns: - -`void` - diff --git a/package-lock.json b/package-lock.json index 40f05e09..b4e5f723 100644 --- a/package-lock.json +++ b/package-lock.json @@ -846,6 +846,25 @@ "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", "dev": true }, + "camelcase-keys": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/camelcase-keys/-/camelcase-keys-4.2.0.tgz", + "integrity": "sha1-oqpfsa9oh1glnDLBQUJteJI7m3c=", + "dev": true, + "requires": { + "camelcase": "^4.1.0", + "map-obj": "^2.0.0", + "quick-lru": "^1.0.0" + }, + "dependencies": { + "camelcase": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-4.1.0.tgz", + "integrity": "sha1-1UVjW+HjPFQmScaRc+Xeas+uNN0=", + "dev": true + } + } + }, "chalk": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.0.0.tgz", @@ -1135,6 +1154,24 @@ "integrity": "sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=", "dev": true }, + "decamelize-keys": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/decamelize-keys/-/decamelize-keys-1.1.0.tgz", + "integrity": "sha1-0XGoeTMlKAfrPLYdwcFEXQeN8tk=", + "dev": true, + "requires": { + "decamelize": "^1.1.0", + "map-obj": "^1.0.0" + }, + "dependencies": { + "map-obj": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/map-obj/-/map-obj-1.0.1.tgz", + "integrity": "sha1-2TPOuSBdgr3PSIb2dCvcK03qFG0=", + "dev": true + } + } + }, "decompress-response": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/decompress-response/-/decompress-response-3.3.0.tgz", @@ -1225,6 +1262,16 @@ } } }, + "del-cli": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/del-cli/-/del-cli-3.0.0.tgz", + "integrity": "sha512-J4HDC2mpcN5aopya4VdkyiFXZaqAoo7ua9VpKbciX3DDUSbtJbPMc3ivggJsAAgS6EqonmbenIiMhBGtJPW9FA==", + "dev": true, + "requires": { + "del": "^5.1.0", + "meow": "^5.0.0" + } + }, "dir-glob": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", @@ -1755,6 +1802,12 @@ "integrity": "sha512-/2UGPSgmtqwo1ktx8NDHjuPwZWmHhO+gj0f93EkhLB5RgW9RZevWYYlIkS6zePc6U2WpOdQYIwHe9YC4DWEBVg==", "dev": true }, + "is-plain-obj": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-1.1.0.tgz", + "integrity": "sha1-caUMhCnfync8kqOQpKA7OfzVHT4=", + "dev": true + }, "is-promise": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/is-promise/-/is-promise-2.1.0.tgz", @@ -2100,6 +2153,16 @@ } } }, + "loud-rejection": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/loud-rejection/-/loud-rejection-1.6.0.tgz", + "integrity": "sha1-W0b4AUft7leIcPCG0Eghz5mOVR8=", + "dev": true, + "requires": { + "currently-unhandled": "^0.4.1", + "signal-exit": "^3.0.0" + } + }, "lowercase-keys": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-1.0.1.tgz", @@ -2132,6 +2195,12 @@ "p-defer": "^1.0.0" } }, + "map-obj": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/map-obj/-/map-obj-2.0.0.tgz", + "integrity": "sha1-plzSkIepJZi4eRJXpSPgISIqwfk=", + "dev": true + }, "matcher": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/matcher/-/matcher-2.1.0.tgz", @@ -2182,6 +2251,40 @@ } } }, + "meow": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/meow/-/meow-5.0.0.tgz", + "integrity": "sha512-CbTqYU17ABaLefO8vCU153ZZlprKYWDljcndKKDCFcYQITzWCXZAVk4QMFZPgvzrnUQ3uItnIE/LoUOwrT15Ig==", + "dev": true, + "requires": { + "camelcase-keys": "^4.0.0", + "decamelize-keys": "^1.0.0", + "loud-rejection": "^1.0.0", + "minimist-options": "^3.0.1", + "normalize-package-data": "^2.3.4", + "read-pkg-up": "^3.0.0", + "redent": "^2.0.0", + "trim-newlines": "^2.0.0", + "yargs-parser": "^10.0.0" + }, + "dependencies": { + "camelcase": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-4.1.0.tgz", + "integrity": "sha1-1UVjW+HjPFQmScaRc+Xeas+uNN0=", + "dev": true + }, + "yargs-parser": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-10.1.0.tgz", + "integrity": "sha512-VCIyR1wJoEBZUqk5PA+oOBF6ypbwh5aNB3I50guxAL/quggdfs4TtNHQrSazFA3fYZ+tEqfs0zIGlv0c/rgjbQ==", + "dev": true, + "requires": { + "camelcase": "^4.1.0" + } + } + } + }, "merge2": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.3.0.tgz", @@ -2225,6 +2328,24 @@ "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", "dev": true }, + "minimist-options": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/minimist-options/-/minimist-options-3.0.2.tgz", + "integrity": "sha512-FyBrT/d0d4+uiZRbqznPXqw3IpZZG3gl3wKWiX784FycUKVwBt0uLBFkQrtE4tZOrgo78nZp2jnKz3L65T5LdQ==", + "dev": true, + "requires": { + "arrify": "^1.0.1", + "is-plain-obj": "^1.1.0" + }, + "dependencies": { + "arrify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/arrify/-/arrify-1.0.1.tgz", + "integrity": "sha1-iYUI2iIm84DfkEcoRWhJwVAaSw0=", + "dev": true + } + } + }, "ms": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", @@ -2614,6 +2735,12 @@ "escape-goat": "^2.0.0" } }, + "quick-lru": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/quick-lru/-/quick-lru-1.1.0.tgz", + "integrity": "sha1-Q2CxfGETatOAeDl/8RQW4Ybc+7g=", + "dev": true + }, "rc": { "version": "1.2.8", "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", @@ -2658,6 +2785,105 @@ } } }, + "read-pkg-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-3.0.0.tgz", + "integrity": "sha1-PtSWaF26D4/hGNBpHcUfSh/5bwc=", + "dev": true, + "requires": { + "find-up": "^2.0.0", + "read-pkg": "^3.0.0" + }, + "dependencies": { + "find-up": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz", + "integrity": "sha1-RdG35QbHF93UgndaK3eSCjwMV6c=", + "dev": true, + "requires": { + "locate-path": "^2.0.0" + } + }, + "load-json-file": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-4.0.0.tgz", + "integrity": "sha1-L19Fq5HjMhYjT9U62rZo607AmTs=", + "dev": true, + "requires": { + "graceful-fs": "^4.1.2", + "parse-json": "^4.0.0", + "pify": "^3.0.0", + "strip-bom": "^3.0.0" + } + }, + "locate-path": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-2.0.0.tgz", + "integrity": "sha1-K1aLJl7slExtnA3pw9u7ygNUzY4=", + "dev": true, + "requires": { + "p-locate": "^2.0.0", + "path-exists": "^3.0.0" + } + }, + "p-limit": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz", + "integrity": "sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==", + "dev": true, + "requires": { + "p-try": "^1.0.0" + } + }, + "p-locate": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-2.0.0.tgz", + "integrity": "sha1-IKAQOyIqcMj9OcwuWAaA893l7EM=", + "dev": true, + "requires": { + "p-limit": "^1.1.0" + } + }, + "p-try": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-1.0.0.tgz", + "integrity": "sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M=", + "dev": true + }, + "path-exists": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", + "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", + "dev": true + }, + "path-type": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-3.0.0.tgz", + "integrity": "sha512-T2ZUsdZFHgA3u4e5PfPbjd7HDDpxPnQb5jN0SrDsjNSuVXHJqtwTnWqG0B1jZrgmJ/7lj1EmVIByWt1gxGkWvg==", + "dev": true, + "requires": { + "pify": "^3.0.0" + } + }, + "pify": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/pify/-/pify-3.0.0.tgz", + "integrity": "sha1-5aSs0sEB/fPZpNB/DbxNtJ3SgXY=", + "dev": true + }, + "read-pkg": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-3.0.0.tgz", + "integrity": "sha1-nLxoaXj+5l0WwA4rGcI3/Pbjg4k=", + "dev": true, + "requires": { + "load-json-file": "^4.0.0", + "normalize-package-data": "^2.3.2", + "path-type": "^3.0.0" + } + } + } + }, "readdirp": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.3.0.tgz", @@ -2667,6 +2893,24 @@ "picomatch": "^2.0.7" } }, + "redent": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/redent/-/redent-2.0.0.tgz", + "integrity": "sha1-wbIAe0LVfrE4kHmzyDM2OdXhzKo=", + "dev": true, + "requires": { + "indent-string": "^3.0.0", + "strip-indent": "^2.0.0" + }, + "dependencies": { + "indent-string": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-3.2.0.tgz", + "integrity": "sha1-Sl/W0nzDMvN+VBmlBNu4NxBckok=", + "dev": true + } + } + }, "registry-auth-token": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/registry-auth-token/-/registry-auth-token-4.1.1.tgz", @@ -2965,6 +3209,12 @@ "integrity": "sha1-IzTBjpx1n3vdVv3vfprj1YjmjtM=", "dev": true }, + "strip-indent": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/strip-indent/-/strip-indent-2.0.0.tgz", + "integrity": "sha1-XvjbKV0B5u1sv3qrlpmNeCJSe2g=", + "dev": true + }, "strip-json-comments": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", @@ -3078,6 +3328,12 @@ "is-number": "^7.0.0" } }, + "trim-newlines": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/trim-newlines/-/trim-newlines-2.0.0.tgz", + "integrity": "sha1-tAPQuRvlDDMd/EuC7s6yLD3hbSA=", + "dev": true + }, "trim-off-newlines": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/trim-off-newlines/-/trim-off-newlines-1.0.1.tgz", diff --git a/package.json b/package.json index 5134738d..83dcc734 100644 --- a/package.json +++ b/package.json @@ -11,14 +11,18 @@ }, "types": "./dist/main.d.ts", "scripts": { - "pretest": "tsc && api-extractor run --local", - "test": "nyc --reporter=text ava", - "prepublishOnly": "tsc", - "preversion": "npm test", - "version": "npm run version:apiDocRefresh && npm run version:changelogBump", - "postversion": "git push && git push --tags", - "version:changelogBump": "changelog-updater && git add CHANGELOG.md", - "version:apiDocRefresh": "api-extractor run && api-documenter markdown -i ./temp -o ./docs/api && git add ./docs/api/*" + "aeCheck": "api-extractor run", + "aeUpdate": "api-extractor run --local", + "purgeDocs": "del-cli ./docs/api/", + "adUpdate": "npm run purgeDocs && api-documenter markdown -i ./temp -o ./docs/api", + "build": "is-ci && npm run build:release || npm run build:dev", + "build:dev": "tsc && npm run aeUpdate && npm run adUpdate", + "build:release": "tsc && npm run aeCheck", + "pretest": "npm run build", + "test": "is-ci && ava || nyc --reporter=text ava", + "prepublishOnly": "npm run build:release && npm run test", + "version": "changelog-updater && git add CHANGELOG.md", + "postversion": "git push && git push --tags" }, "author": "Jordan Mele (https://djmm.me/)", "license": "MIT", @@ -45,7 +49,9 @@ "@types/node": "^13.13.1", "ava": "^3.7.1", "changelog-updater": "^1.1.0", + "del-cli": "^3.0.0", "glogg": "^1.0.2", + "is-ci": "^2.0.0", "nyc": "^15.0.1", "typescript": "^3.8.3" },