@substrate-system/debug 0.8.0 → 0.9.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/README.md +42 -4
- package/dist/browser/index.js +1 -1
- package/dist/browser/index.js.map +1 -1
- package/package.json +5 -1
package/README.md
CHANGED
|
@@ -27,11 +27,13 @@ Plus, [see the docs](https://substrate-system.github.io/debug/) generated by typ
|
|
|
27
27
|
|
|
28
28
|
- [config](#config)
|
|
29
29
|
* [namespace](#namespace)
|
|
30
|
+
* [NODE_ENV + Vite](#node_env--vite)
|
|
30
31
|
- [install](#install)
|
|
31
32
|
- [Node JS](#node-js)
|
|
32
33
|
* [NODE_ENV](#node_env)
|
|
33
34
|
- [develop](#develop)
|
|
34
35
|
* [browser](#browser)
|
|
36
|
+
- [test](#test)
|
|
35
37
|
* [node](#node)
|
|
36
38
|
|
|
37
39
|
<!-- tocstop -->
|
|
@@ -39,32 +41,63 @@ Plus, [see the docs](https://substrate-system.github.io/debug/) generated by typ
|
|
|
39
41
|
## config
|
|
40
42
|
|
|
41
43
|
### namespace
|
|
42
|
-
|
|
43
|
-
|
|
44
|
+
Works with `vite` or other systems. This will look at `import.meta.env`, or
|
|
45
|
+
an arbitrary object you can pass in.
|
|
44
46
|
|
|
45
47
|
```js
|
|
46
48
|
import Debug from '@substrate-system/debug'
|
|
49
|
+
|
|
50
|
+
// look at `import.meta.env.VITE_DEBUG`
|
|
47
51
|
const debug = Debug('example')
|
|
52
|
+
|
|
53
|
+
// or call with your own env object
|
|
54
|
+
const debug = Debug('example', { DEBUG: 'example' })
|
|
48
55
|
```
|
|
49
56
|
|
|
50
57
|
If you create an instance without passing in a `namespace` string, then this
|
|
51
|
-
will log iff
|
|
58
|
+
will log iff anything other than `false` is passed as an argument.
|
|
59
|
+
|
|
60
|
+
```js
|
|
61
|
+
import Debug from '@substrate-system/debug'
|
|
62
|
+
|
|
63
|
+
// log b/c we are not calling with `false`
|
|
64
|
+
const debug = Debug()
|
|
65
|
+
|
|
66
|
+
debug('hello')
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
You can use any variable as debug status:
|
|
70
|
+
|
|
71
|
+
```js
|
|
72
|
+
import Debug from '@substrate-system/debug'
|
|
73
|
+
|
|
74
|
+
// in Vite
|
|
75
|
+
const debug = Debug(!!(import.meta.env && import.meta.env.DEV))
|
|
76
|
+
|
|
77
|
+
// in an arbitrary server
|
|
78
|
+
const debug = Debug(window.EXAMPLE_DEBUG_MODE)
|
|
79
|
+
```
|
|
52
80
|
|
|
53
81
|
Use an env variable of `*` to log everything.
|
|
54
82
|
|
|
83
|
+
|
|
84
|
+
### NODE_ENV + Vite
|
|
85
|
+
|
|
55
86
|
Build the site with a `NODE_ENV` variable to set `import.meta.env.DEV`:
|
|
56
87
|
|
|
57
88
|
```sh
|
|
58
89
|
NODE_ENV=development vite build
|
|
59
90
|
```
|
|
60
91
|
|
|
61
|
-
|
|
92
|
+
Any value of `NODE_ENV`, except `production`, wil equate to
|
|
62
93
|
`import.meta.env.DEV` being true.
|
|
63
94
|
|
|
64
95
|
```sh
|
|
65
96
|
NODE_ENV=staging vite build
|
|
66
97
|
```
|
|
67
98
|
|
|
99
|
+
----------------------------------------------------------------------
|
|
100
|
+
|
|
68
101
|
## install
|
|
69
102
|
|
|
70
103
|
```sh
|
|
@@ -74,8 +107,10 @@ npm i -D @substrate-system/debug
|
|
|
74
107
|
Use this with [vite](https://vitejs.dev/) in the [browser](#browser), or
|
|
75
108
|
in [node](#node-JS).
|
|
76
109
|
|
|
110
|
+
|
|
77
111
|
------------------------------------------------------------------
|
|
78
112
|
|
|
113
|
+
|
|
79
114
|
## Node JS
|
|
80
115
|
Run your script with an env variable, `DEBUG`.
|
|
81
116
|
|
|
@@ -116,6 +151,9 @@ Start a `vite` server and log some things. This uses [the example directory](./e
|
|
|
116
151
|
npm start
|
|
117
152
|
```
|
|
118
153
|
|
|
154
|
+
|
|
155
|
+
## test
|
|
156
|
+
|
|
119
157
|
### node
|
|
120
158
|
Run tests:
|
|
121
159
|
|
package/dist/browser/index.js
CHANGED
|
@@ -10,7 +10,7 @@ export default createDebug;
|
|
|
10
10
|
* Need to check it against the env var.
|
|
11
11
|
*/
|
|
12
12
|
function isEnabled(namespace, env) {
|
|
13
|
-
if (env && (env.VITE_DEBUG || env.DEBUG === '*'))
|
|
13
|
+
if (env && (env.VITE_DEBUG === '*' || env.DEBUG === '*'))
|
|
14
14
|
return true;
|
|
15
15
|
// if we were not called with a namespace
|
|
16
16
|
if (namespace === 'DEV') {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/browser/index.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,IAAI,CAAA;AACzB,OAAO,EACH,oBAAoB,EACpB,MAAM,EACN,WAAW,EACX,qBAAqB,EACxB,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAElC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;AAErC,OAAO,EAAE,WAAW,EAAE,CAAA;AACtB,eAAe,WAAW,CAAA;AAE1B;;;;GAIG;AACH,SAAS,SAAS,CACd,SAAgB,EAChB,GAAyC;IAEzC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,KAAK,KAAK,GAAG,CAAC;QAAE,OAAO,IAAI,CAAA;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/browser/index.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,IAAI,CAAA;AACzB,OAAO,EACH,oBAAoB,EACpB,MAAM,EACN,WAAW,EACX,qBAAqB,EACxB,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAElC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;AAErC,OAAO,EAAE,WAAW,EAAE,CAAA;AACtB,eAAe,WAAW,CAAA;AAE1B;;;;GAIG;AACH,SAAS,SAAS,CACd,SAAgB,EAChB,GAAyC;IAEzC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,KAAK,GAAG,IAAI,GAAG,CAAC,KAAK,KAAK,GAAG,CAAC;QAAE,OAAO,IAAI,CAAA;IAErE,yCAAyC;IACzC,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;QACtB,+DAA+D;QAC/D,2CAA2C;QAC3C,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,UAAU,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1C,OAAO,IAAI,CAAA;QACf,CAAC;QAED,OAAO,KAAK,CAAA;IAChB,CAAC;IAED,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,UAAU,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IACzD,MAAM,OAAO,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAA;IAChD,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAA;AACzE,CAAC;AAED;;GAEG;AACH,SAAS,gBAAgB;IACrB,OAAO;QACH,CAAC,EAAE,UAAU,CAAK;YACd,IAAI,CAAC;gBACD,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;YAC5B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,OAAO,8BAA8B,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;YACzD,CAAC;QACL,CAAC;KACJ,CAAA;AACL,CAAC;AAED,SAAS,MAAM,CACX,SAAgB,EAChB,IAAU,EACV,EAAE,QAAQ,EAAE,KAAK,EAAE,EACnB,GAA2B;IAE3B,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAAE,OAAM;IAE3D,uBAAuB;IACvB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAA;IAC/B,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,QAAQ,IAAI,IAAI,CAAC,CAAA;IACtC,QAAQ,GAAG,IAAI,CAAA;IAEf,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;IACzB,MAAM,UAAU,GAAG,gBAAgB,EAAE,CAAA;IAErC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC9B,sCAAsC;QACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IACtB,CAAC;IAED,yCAAyC;IACzC,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;QACzD,wDAAwD;QACxD,cAAc;QACd,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO,GAAG,CAAA;QAE9B,KAAK,EAAE,CAAA;QAEP,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;QACpC,IAAI,OAAO,SAAS,KAAK,UAAU,EAAE,CAAC;YAClC,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAA;YACvB,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;YAEjC,yDAAyD;YACzD,oBAAoB;YACpB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;YACrB,KAAK,EAAE,CAAA;QACX,CAAC;QACD,OAAO,KAAK,CAAA;IAChB,CAAC,CAAC,CAAA;IAEF,+CAA+C;IAC/C,MAAM,KAAK,GAAG,UAAU,CAAC;QACrB,IAAI;QACJ,KAAK;QACL,SAAS,EAAE,eAAe,EAAE;QAC5B,SAAS;KACZ,EAAE,IAAI,CAAC,CAAA;IAER,GAAG,CAAC,GAAG,KAAK,CAAC,CAAA;AACjB,CAAC;AAED,SAAS,eAAe;IACpB,oDAAoD;IACpD,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,CAAC,SAAS;QACvD,SAAS,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,uBAAuB,CAAC,EAAE,CAAC;QACnE,OAAO,KAAK,CAAA;IAChB,CAAC;IAED,wDAAwD;IACxD,yCAAyC;IACzC,uDAAuD;IACvD,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,eAAe;QAClE,QAAQ,CAAC,eAAe,CAAC,KAAK;QAC9B,QAAQ,CAAC,eAAe,CAAC,KAAK,CAAC,gBAAgB,CAAC;QAChD,qBAAqB;QACrB,8EAA8E;QAC9E,CAAC,OAAO,SAAS,KAAK,WAAW;YAC7B,SAAS,CAAC,SAAS;YACnB,SAAS,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC;YACzD,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC;QAClC,mEAAmE;QACnE,CAAC,OAAO,SAAS,KAAK,WAAW;YAC7B,SAAS,CAAC,SAAS;YACnB,SAAS,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAA;AAC3E,CAAC;AAED;;GAEG;AACH,SAAS,UAAU,CAAE,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAKvD,EAAE,IAAI;IACH,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7B,SAAS;QACT,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;QACzB,IAAI,CAAC,CAAC,CAAC;QACP,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;QACzB,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAA;IAExB,IAAI,CAAC,SAAS;QAAE,OAAM;IAEtB,MAAM,CAAC,GAAG,SAAS,GAAG,KAAK,CAAA;IAC3B,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,gBAAgB,CAAC,CAAA;IAEtC,kEAAkE;IAClE,gEAAgE;IAChE,sDAAsD;IACtD,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,EAAE,KAAK,CAAC,EAAE;QACnC,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjB,OAAM;QACV,CAAC;QACD,KAAK,EAAE,CAAA;QACP,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjB,0CAA0C;YAC1C,yCAAyC;YACzC,KAAK,GAAG,KAAK,CAAA;QACjB,CAAC;IACL,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAExB,OAAO,IAAI,CAAA;AACf,CAAC;AAED,SAAS,WAAW,CAAE,SAAyB,EAAE,GAA2B;IACxE,IAAI,SAAS,KAAK,KAAK;QAAE,OAAO,IAAI,CAAA;IACpC,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAA;IACnC,MAAM,KAAK,GAAG,WAAW,CACrB,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,oBAAoB,CAAC,EAAE,CAAC,EACpE,MAAM,CACT,CAAA;IAED,MAAM,KAAK,GAAyB,UAAU,GAAG,IAAU;QACvD,OAAO,MAAM,CACT,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,EACjD,IAAI,EACJ,EAAE,QAAQ,EAAE,KAAK,EAAE,EACnB,GAAG,CACN,CAAA;IACL,CAAC,CAAA;IAED,OAAO,KAAK,CAAA;AAChB,CAAC;AAED,SAAS,IAAI,KAAK,CAAC"}
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@substrate-system/debug",
|
|
3
3
|
"description": "Debug utility",
|
|
4
4
|
"type": "module",
|
|
5
|
-
"version": "0.
|
|
5
|
+
"version": "0.9.0",
|
|
6
6
|
"main": "./dist/node.js",
|
|
7
7
|
"files": [
|
|
8
8
|
"./dist/*"
|
|
@@ -29,6 +29,10 @@
|
|
|
29
29
|
"build-docs": "typedoc ./src/browser.ts ./src/node.ts",
|
|
30
30
|
"toc": "markdown-toc --maxdepth 3 -i README.md",
|
|
31
31
|
"start": "vite --mode=staging",
|
|
32
|
+
"start:star": "VITE_DEBUG=\"*\" vite",
|
|
33
|
+
"start:vite-production": "NODE_EN\"production\" vite",
|
|
34
|
+
"start:bar-production": "NODE_ENV=\"production\" VITE_DEBUG=\"barrr\" vite",
|
|
35
|
+
"start:bar-dev": "VITE_DEBUG=\"barrr\" vite",
|
|
32
36
|
"start:static": "npm run build:static && http-server -p 8888 example/static",
|
|
33
37
|
"build:static": "esbuild ./example/static/index.ts --bundle > ./example/static/bundle.js",
|
|
34
38
|
"preversion": "npm run lint",
|