UNPKG

@the-hw-app/logger

Version:

A logger made for internal use by The Homework App.

github.com/the-hw-app/libraries/tree/release/logger

the-hw-app/libraries

105 lines (69 loc) • 2.27 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# @the-hw-app/logger ## Installation ### Yarn (Recommended) ``` $ yarn add @the-hw-app/logger ``` ### NPM ``` $ npm install @the-hw-app/logger ``` ## Scripts ### Test `test` will run the tests. ```bash yarn test ``` ### Prepare `prepare` will run both BEFORE the package is packed and published, and on local npm install. Perfect for running building the code. ```bash yarn prepare ``` ### PrepublishOnly `prepublishOnly` will run BEFORE **prepare** and ONLY on **npm publish**. Here we will run our test and lint to make sure we don’t publish bad code ```bash yarn prepublishOnly ``` ### Preversion `preversion` will run before bumping a new package version. To be extra sure that we’re not bumping a version with bad code ```bash yarn preversion ``` ### Version `version` will run after a new version has been bumped. If your package has a git repository, like in our case, a commit and a new version-tag will be made every time you bump a new version. This command will run BEFORE the commit is made. One idea is to run the formatter here and so no ugly code will pass into the new version ```bash yarn version ``` ### Postversion `postversion` will run after the commit has been made. A perfect place for pushing the commit as well as the tag. ```bash yarn postversion ``` ## Usage ### Build ``` $ yarn build ``` *Note: If you want to build on change (watch mode) use `yarn build -w`* ### Experiment The best way to experiment is by writing testing testing cases and running them. ### Test ``` $ yarn test ``` or ``` $ yarn test [file_name] ``` ## Log Levels | Code | Severity | Description | | ---- |-------------- | -------------------------------- | | 0 | Emergency | system is unusable | | 1 | Alert | action must be taken immediately | | 2 | Critical | critical conditions | | 3 | Error | error conditions | | 4 | Warning | warning conditions | | 5 | Notice | normal but significant condition | | 6 | Informational | informational messages | | 7 | Debug | debug-level messages | As stated in [RFC 5424](https://datatracker.ietf.org/doc/html/rfc5424).