nightingale-markdown-formatter 15.0.0 → 16.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/README.md +11 -9
- package/lib/index.js +3 -0
- package/package.json +11 -55
- package/dist/definitions/index.d.ts +0 -4
- package/dist/definitions/index.d.ts.map +0 -1
- package/dist/definitions/index.test.d.ts +0 -2
- package/dist/definitions/index.test.d.ts.map +0 -1
- package/dist/index-browser.es.js +0 -26
- package/dist/index-browser.es.js.map +0 -1
- package/dist/index-node18.mjs +0 -26
- package/dist/index-node18.mjs.map +0 -1
- package/src/.eslintrc.json +0 -27
- package/src/index.test.ts +0 -19
- package/src/index.ts +0 -28
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,28 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [16.1.0](https://github.com/christophehurpeau/nightingale/compare/v16.0.0...v16.1.0) (2025-03-30)
|
|
7
|
+
|
|
8
|
+
Version bump for dependency: nightingale
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## [16.0.0](https://github.com/christophehurpeau/nightingale/compare/v15.0.0...v16.0.0) (2025-03-30)
|
|
12
|
+
|
|
13
|
+
### ⚠ BREAKING CHANGES
|
|
14
|
+
|
|
15
|
+
* drop node 18
|
|
16
|
+
|
|
17
|
+
### Features
|
|
18
|
+
|
|
19
|
+
* drop node 18 ([1b11a55](https://github.com/christophehurpeau/nightingale/commit/1b11a55dd24c9435be50519a748316079f554414))
|
|
20
|
+
|
|
21
|
+
### Bug Fixes
|
|
22
|
+
|
|
23
|
+
* fix lib exports ([5b562b2](https://github.com/christophehurpeau/nightingale/commit/5b562b245aac1aa86b728a9433f3c9d28c62fe04))
|
|
24
|
+
|
|
25
|
+
Version bump for dependency: nightingale
|
|
26
|
+
|
|
27
|
+
|
|
6
28
|
## [15.0.0](https://github.com/christophehurpeau/nightingale/compare/v14.2.1...v15.0.0) (2023-12-25)
|
|
7
29
|
|
|
8
30
|
|
package/README.md
CHANGED
|
@@ -1,27 +1,29 @@
|
|
|
1
|
-
<
|
|
1
|
+
<h1 align="center">
|
|
2
2
|
nightingale-markdown-formatter
|
|
3
|
-
</
|
|
3
|
+
</h1>
|
|
4
4
|
|
|
5
5
|
<p align="center">
|
|
6
|
-
|
|
6
|
+
Deprecated: use MarkdownFormatter from nightingale
|
|
7
7
|
</p>
|
|
8
8
|
|
|
9
9
|
<p align="center">
|
|
10
|
-
<a href="https://npmjs.org/package/nightingale-markdown-formatter"><img src="https://img.shields.io/npm/v/nightingale-markdown-formatter.svg?style=flat-square"></a>
|
|
11
|
-
<a href="https://npmjs.org/package/nightingale-markdown-formatter"><img src="https://img.shields.io/npm/dw/nightingale-markdown-formatter.svg?style=flat-square"></a>
|
|
12
|
-
<a href="https://npmjs.org/package/nightingale-markdown-formatter"><img src="https://img.shields.io/node/v/nightingale-markdown-formatter.svg?style=flat-square"></a>
|
|
13
|
-
<a href="https://npmjs.org/package/nightingale-markdown-formatter"><img src="https://img.shields.io/npm/types/nightingale-markdown-formatter.svg?style=flat-square"></a>
|
|
10
|
+
<a href="https://npmjs.org/package/nightingale-markdown-formatter"><img src="https://img.shields.io/npm/v/nightingale-markdown-formatter.svg?style=flat-square" alt="npm version"></a>
|
|
11
|
+
<a href="https://npmjs.org/package/nightingale-markdown-formatter"><img src="https://img.shields.io/npm/dw/nightingale-markdown-formatter.svg?style=flat-square" alt="npm downloads"></a>
|
|
12
|
+
<a href="https://npmjs.org/package/nightingale-markdown-formatter"><img src="https://img.shields.io/node/v/nightingale-markdown-formatter.svg?style=flat-square" alt="node version"></a>
|
|
13
|
+
<a href="https://npmjs.org/package/nightingale-markdown-formatter"><img src="https://img.shields.io/npm/types/nightingale-markdown-formatter.svg?style=flat-square" alt="types"></a>
|
|
14
14
|
<a href="https://codecov.io/gh/christophehurpeau/nightingale"><img src="https://img.shields.io/codecov/c/github/christophehurpeau/nightingale/master.svg?style=flat-square"></a>
|
|
15
15
|
</p>
|
|
16
16
|
|
|
17
17
|
## Install
|
|
18
18
|
|
|
19
19
|
```sh
|
|
20
|
-
npm install --save nightingale
|
|
20
|
+
npm install --save nightingale
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
## Usage
|
|
24
24
|
|
|
25
25
|
```js
|
|
26
|
-
import
|
|
26
|
+
import { MarkdownFormatter } from "nightingale";
|
|
27
|
+
|
|
28
|
+
MarkdownFormatter.format(record);
|
|
27
29
|
```
|
package/lib/index.js
ADDED
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "nightingale-markdown-formatter",
|
|
3
|
-
"version": "
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "16.1.0",
|
|
4
|
+
"description": "Deprecated: use MarkdownFormatter from nightingale",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"nightingale",
|
|
7
7
|
"nightingale-formatter"
|
|
@@ -16,72 +16,28 @@
|
|
|
16
16
|
"homepage": "https://github.com/christophehurpeau/nightingale",
|
|
17
17
|
"type": "module",
|
|
18
18
|
"engines": {
|
|
19
|
-
"node": ">=
|
|
19
|
+
"node": ">=20.9.0"
|
|
20
20
|
},
|
|
21
|
-
"
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
"> 0.2%",
|
|
25
|
-
"not ie < 12",
|
|
26
|
-
"not safari < 10",
|
|
27
|
-
"not ios_saf < 10"
|
|
28
|
-
]
|
|
29
|
-
},
|
|
30
|
-
"main": "./dist/index-node18.mjs",
|
|
31
|
-
"types": "./dist/definitions/index.d.ts",
|
|
32
|
-
"module": "./dist/index-browser.es.js",
|
|
33
|
-
"browser": "./dist/index-browser.es.js",
|
|
21
|
+
"sideEffects": false,
|
|
22
|
+
"main": "./lib/index.js",
|
|
23
|
+
"types": "./lib/index.d.ts",
|
|
34
24
|
"exports": {
|
|
35
25
|
"./package.json": "./package.json",
|
|
36
|
-
".":
|
|
37
|
-
"types": "./dist/definitions/index.d.ts",
|
|
38
|
-
"node": {
|
|
39
|
-
"import": "./dist/index-node18.mjs"
|
|
40
|
-
},
|
|
41
|
-
"browser": {
|
|
42
|
-
"import": "./dist/index-browser.es.js"
|
|
43
|
-
}
|
|
44
|
-
}
|
|
26
|
+
".": "./lib/index.js"
|
|
45
27
|
},
|
|
46
|
-
"sideEffects": false,
|
|
47
28
|
"files": [
|
|
48
|
-
"
|
|
49
|
-
"dist"
|
|
29
|
+
"lib"
|
|
50
30
|
],
|
|
51
31
|
"scripts": {
|
|
52
|
-
"build": "yarn clean:build && rollup --config rollup.config.mjs && yarn run build:definitions",
|
|
53
|
-
"build:definitions": "tsc -p tsconfig.json",
|
|
54
32
|
"clean": "yarn clean:build",
|
|
55
|
-
"clean:build": "pob-babel-clean-out dist",
|
|
56
33
|
"lint": "yarn run lint:eslint",
|
|
57
|
-
"lint:eslint": "yarn ../.. run eslint --
|
|
34
|
+
"lint:eslint": "yarn ../.. run eslint --quiet packages/nightingale-markdown-formatter",
|
|
58
35
|
"test": "yarn ../../ run test -- packages/nightingale-markdown-formatter",
|
|
59
36
|
"watch": "yarn clean:build && rollup --config rollup.config.mjs --watch"
|
|
60
37
|
},
|
|
38
|
+
"pob": {},
|
|
61
39
|
"prettier": "@pob/root/prettier-config",
|
|
62
|
-
"pob": {
|
|
63
|
-
"babelEnvs": [
|
|
64
|
-
{
|
|
65
|
-
"target": "node",
|
|
66
|
-
"version": "18"
|
|
67
|
-
},
|
|
68
|
-
{
|
|
69
|
-
"target": "browser"
|
|
70
|
-
}
|
|
71
|
-
],
|
|
72
|
-
"entries": [
|
|
73
|
-
"index"
|
|
74
|
-
]
|
|
75
|
-
},
|
|
76
40
|
"dependencies": {
|
|
77
|
-
"nightingale
|
|
78
|
-
"nightingale-types": "15.0.0"
|
|
79
|
-
},
|
|
80
|
-
"devDependencies": {
|
|
81
|
-
"@babel/core": "7.23.6",
|
|
82
|
-
"@babel/preset-env": "7.23.6",
|
|
83
|
-
"nightingale-levels": "15.0.0",
|
|
84
|
-
"pob-babel": "38.0.0",
|
|
85
|
-
"typescript": "5.3.3"
|
|
41
|
+
"nightingale": "16.1.0"
|
|
86
42
|
}
|
|
87
43
|
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAErE,wBAAgB,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAkB5D;AAED,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,CAAC,SAAS,QAAQ,EAC/C,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,GACnB,MAAM,CAER"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../src/index.test.ts"],"names":[],"mappings":""}
|
package/dist/index-browser.es.js
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
import { formatRecordToString } from 'nightingale-formatter';
|
|
2
|
-
|
|
3
|
-
function style(styles, string) {
|
|
4
|
-
if (!styles || styles.length === 0 || !string) {
|
|
5
|
-
return string;
|
|
6
|
-
}
|
|
7
|
-
|
|
8
|
-
// eslint-disable-next-line unicorn/no-array-reduce
|
|
9
|
-
return styles.reduce((part, styleName) => {
|
|
10
|
-
switch (styleName) {
|
|
11
|
-
case 'bold':
|
|
12
|
-
return `*${part}*`;
|
|
13
|
-
case 'italic':
|
|
14
|
-
return `_${part}_`;
|
|
15
|
-
case 'strikethrough':
|
|
16
|
-
return `~${part}~`;
|
|
17
|
-
}
|
|
18
|
-
return part;
|
|
19
|
-
}, string);
|
|
20
|
-
}
|
|
21
|
-
function format(record) {
|
|
22
|
-
return formatRecordToString(record, style);
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
export { format as default, style };
|
|
26
|
-
//# sourceMappingURL=index-browser.es.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index-browser.es.js","sources":["../src/index.ts"],"sourcesContent":["import { formatRecordToString } from 'nightingale-formatter';\nimport type { Styles, LogRecord, Metadata } from 'nightingale-types';\n\nexport function style(styles: Styles, string: string): string {\n if (!styles || styles.length === 0 || !string) {\n return string;\n }\n\n // eslint-disable-next-line unicorn/no-array-reduce\n return styles.reduce((part, styleName) => {\n switch (styleName) {\n case 'bold':\n return `*${part}*`;\n case 'italic':\n return `_${part}_`;\n case 'strikethrough':\n return `~${part}~`;\n }\n\n return part;\n }, string);\n}\n\nexport default function format<T extends Metadata>(\n record: LogRecord<T>,\n): string {\n return formatRecordToString(record, style);\n}\n"],"names":["style","styles","string","length","reduce","part","styleName","format","record","formatRecordToString"],"mappings":";;AAGO,SAASA,KAAKA,CAACC,MAAc,EAAEC,MAAc,EAAU;EAC5D,IAAI,CAACD,MAAM,IAAIA,MAAM,CAACE,MAAM,KAAK,CAAC,IAAI,CAACD,MAAM,EAAE;AAC7C,IAAA,OAAOA,MAAM,CAAA;AACf,GAAA;;AAEA;EACA,OAAOD,MAAM,CAACG,MAAM,CAAC,CAACC,IAAI,EAAEC,SAAS,KAAK;AACxC,IAAA,QAAQA,SAAS;AACf,MAAA,KAAK,MAAM;QACT,OAAQ,CAAA,CAAA,EAAGD,IAAK,CAAE,CAAA,CAAA,CAAA;AACpB,MAAA,KAAK,QAAQ;QACX,OAAQ,CAAA,CAAA,EAAGA,IAAK,CAAE,CAAA,CAAA,CAAA;AACpB,MAAA,KAAK,eAAe;QAClB,OAAQ,CAAA,CAAA,EAAGA,IAAK,CAAE,CAAA,CAAA,CAAA;AACtB,KAAA;AAEA,IAAA,OAAOA,IAAI,CAAA;GACZ,EAAEH,MAAM,CAAC,CAAA;AACZ,CAAA;AAEe,SAASK,MAAMA,CAC5BC,MAAoB,EACZ;AACR,EAAA,OAAOC,oBAAoB,CAACD,MAAM,EAAER,KAAK,CAAC,CAAA;AAC5C;;;;"}
|
package/dist/index-node18.mjs
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
import { formatRecordToString } from 'nightingale-formatter';
|
|
2
|
-
|
|
3
|
-
function style(styles, string) {
|
|
4
|
-
if (!styles || styles.length === 0 || !string) {
|
|
5
|
-
return string;
|
|
6
|
-
}
|
|
7
|
-
|
|
8
|
-
// eslint-disable-next-line unicorn/no-array-reduce
|
|
9
|
-
return styles.reduce((part, styleName) => {
|
|
10
|
-
switch (styleName) {
|
|
11
|
-
case 'bold':
|
|
12
|
-
return `*${part}*`;
|
|
13
|
-
case 'italic':
|
|
14
|
-
return `_${part}_`;
|
|
15
|
-
case 'strikethrough':
|
|
16
|
-
return `~${part}~`;
|
|
17
|
-
}
|
|
18
|
-
return part;
|
|
19
|
-
}, string);
|
|
20
|
-
}
|
|
21
|
-
function format(record) {
|
|
22
|
-
return formatRecordToString(record, style);
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
export { format as default, style };
|
|
26
|
-
//# sourceMappingURL=index-node18.mjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index-node18.mjs","sources":["../src/index.ts"],"sourcesContent":["import { formatRecordToString } from 'nightingale-formatter';\nimport type { Styles, LogRecord, Metadata } from 'nightingale-types';\n\nexport function style(styles: Styles, string: string): string {\n if (!styles || styles.length === 0 || !string) {\n return string;\n }\n\n // eslint-disable-next-line unicorn/no-array-reduce\n return styles.reduce((part, styleName) => {\n switch (styleName) {\n case 'bold':\n return `*${part}*`;\n case 'italic':\n return `_${part}_`;\n case 'strikethrough':\n return `~${part}~`;\n }\n\n return part;\n }, string);\n}\n\nexport default function format<T extends Metadata>(\n record: LogRecord<T>,\n): string {\n return formatRecordToString(record, style);\n}\n"],"names":["style","styles","string","length","reduce","part","styleName","format","record","formatRecordToString"],"mappings":";;AAGO,SAASA,KAAKA,CAACC,MAAc,EAAEC,MAAc,EAAU;EAC5D,IAAI,CAACD,MAAM,IAAIA,MAAM,CAACE,MAAM,KAAK,CAAC,IAAI,CAACD,MAAM,EAAE;AAC7C,IAAA,OAAOA,MAAM,CAAA;AACf,GAAA;;AAEA;EACA,OAAOD,MAAM,CAACG,MAAM,CAAC,CAACC,IAAI,EAAEC,SAAS,KAAK;AACxC,IAAA,QAAQA,SAAS;AACf,MAAA,KAAK,MAAM;QACT,OAAQ,CAAA,CAAA,EAAGD,IAAK,CAAE,CAAA,CAAA,CAAA;AACpB,MAAA,KAAK,QAAQ;QACX,OAAQ,CAAA,CAAA,EAAGA,IAAK,CAAE,CAAA,CAAA,CAAA;AACpB,MAAA,KAAK,eAAe;QAClB,OAAQ,CAAA,CAAA,EAAGA,IAAK,CAAE,CAAA,CAAA,CAAA;AACtB,KAAA;AAEA,IAAA,OAAOA,IAAI,CAAA;GACZ,EAAEH,MAAM,CAAC,CAAA;AACZ,CAAA;AAEe,SAASK,MAAMA,CAC5BC,MAAoB,EACZ;AACR,EAAA,OAAOC,oBAAoB,CAACD,MAAM,EAAER,KAAK,CAAC,CAAA;AAC5C;;;;"}
|
package/src/.eslintrc.json
DELETED
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"root": true,
|
|
3
|
-
"parser": "@typescript-eslint/parser",
|
|
4
|
-
"parserOptions": {
|
|
5
|
-
"project": "packages/nightingale-markdown-formatter/tsconfig.json"
|
|
6
|
-
},
|
|
7
|
-
"plugins": ["@typescript-eslint"],
|
|
8
|
-
"extends": ["@pob/eslint-config-typescript"],
|
|
9
|
-
"ignorePatterns": ["*.d.ts"],
|
|
10
|
-
"overrides": [
|
|
11
|
-
{
|
|
12
|
-
"files": ["**/*.test.ts", "__tests__/**/*.ts"],
|
|
13
|
-
"extends": ["@pob/eslint-config-typescript/test"],
|
|
14
|
-
"env": {
|
|
15
|
-
"jest": true
|
|
16
|
-
},
|
|
17
|
-
"rules": {
|
|
18
|
-
"import/no-extraneous-dependencies": [
|
|
19
|
-
"error",
|
|
20
|
-
{
|
|
21
|
-
"devDependencies": true
|
|
22
|
-
}
|
|
23
|
-
]
|
|
24
|
-
}
|
|
25
|
-
}
|
|
26
|
-
]
|
|
27
|
-
}
|
package/src/index.test.ts
DELETED
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
import { Level } from 'nightingale-levels';
|
|
2
|
-
import format, { style } from '.';
|
|
3
|
-
|
|
4
|
-
test('style: blue bold color', () => {
|
|
5
|
-
expect(style(['blue', 'bold'], 'test')).toBe('*test*');
|
|
6
|
-
});
|
|
7
|
-
|
|
8
|
-
test('format simple message', () => {
|
|
9
|
-
const record = {
|
|
10
|
-
key: 'record.key',
|
|
11
|
-
level: Level.INFO,
|
|
12
|
-
datetime: new Date(2000, 1, 1, 1, 0, 0),
|
|
13
|
-
message: 'test',
|
|
14
|
-
metadata: {},
|
|
15
|
-
extra: {},
|
|
16
|
-
};
|
|
17
|
-
|
|
18
|
-
expect(format(record)).toBe('record.key *01:00:00* → test');
|
|
19
|
-
});
|
package/src/index.ts
DELETED
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
import { formatRecordToString } from 'nightingale-formatter';
|
|
2
|
-
import type { Styles, LogRecord, Metadata } from 'nightingale-types';
|
|
3
|
-
|
|
4
|
-
export function style(styles: Styles, string: string): string {
|
|
5
|
-
if (!styles || styles.length === 0 || !string) {
|
|
6
|
-
return string;
|
|
7
|
-
}
|
|
8
|
-
|
|
9
|
-
// eslint-disable-next-line unicorn/no-array-reduce
|
|
10
|
-
return styles.reduce((part, styleName) => {
|
|
11
|
-
switch (styleName) {
|
|
12
|
-
case 'bold':
|
|
13
|
-
return `*${part}*`;
|
|
14
|
-
case 'italic':
|
|
15
|
-
return `_${part}_`;
|
|
16
|
-
case 'strikethrough':
|
|
17
|
-
return `~${part}~`;
|
|
18
|
-
}
|
|
19
|
-
|
|
20
|
-
return part;
|
|
21
|
-
}, string);
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
export default function format<T extends Metadata>(
|
|
25
|
-
record: LogRecord<T>,
|
|
26
|
-
): string {
|
|
27
|
-
return formatRecordToString(record, style);
|
|
28
|
-
}
|