@substrate-system/debug 0.9.8 → 0.9.12
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 +38 -0
- package/dist/browser/index.d.ts +2 -1
- package/dist/browser/index.d.ts.map +1 -1
- package/dist/browser/index.js +1 -1
- package/dist/browser/index.js.map +1 -1
- package/package.json +7 -17
package/README.md
CHANGED
|
@@ -33,6 +33,7 @@ generated by typescript.
|
|
|
33
33
|
|
|
34
34
|
- [Install](#install)
|
|
35
35
|
- [Browser](#browser)
|
|
36
|
+
* [Factor out of production](#factor-out-of-production)
|
|
36
37
|
- [Node JS](#node-js)
|
|
37
38
|
- [Config](#config)
|
|
38
39
|
* [Namespace](#namespace)
|
|
@@ -41,6 +42,7 @@ generated by typescript.
|
|
|
41
42
|
* [Force logging with boolean true](#force-logging-with-boolean-true)
|
|
42
43
|
- [Develop](#develop)
|
|
43
44
|
* [browser](#browser)
|
|
45
|
+
* [Run the Node example](#run-the-node-example)
|
|
44
46
|
- [Test](#test)
|
|
45
47
|
* [Node](#node)
|
|
46
48
|
|
|
@@ -70,6 +72,23 @@ debug('hello logs')
|
|
|
70
72
|
// will log, because DEBUG in localStorage matches 'myapp:*'
|
|
71
73
|
```
|
|
72
74
|
|
|
75
|
+
### Factor out of production
|
|
76
|
+
|
|
77
|
+
Use dynamic imoprts to keep this out of your production code.
|
|
78
|
+
|
|
79
|
+
```ts
|
|
80
|
+
import type { Debugger } from '@substrate-system/debug'
|
|
81
|
+
|
|
82
|
+
let debug:Debugger
|
|
83
|
+
if (import.meta.env.DEV) {
|
|
84
|
+
const Debug = await import('/example/debug.js')
|
|
85
|
+
debug = Debug('myApplication:abc')
|
|
86
|
+
} else {
|
|
87
|
+
debug = function noop (...args:any[]) {}
|
|
88
|
+
}
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
|
|
73
92
|
## Node JS
|
|
74
93
|
Run your script with an env variable, `DEBUG`.
|
|
75
94
|
|
|
@@ -136,6 +155,25 @@ Start a `vite` server and log some things. This uses
|
|
|
136
155
|
npm start
|
|
137
156
|
```
|
|
138
157
|
|
|
158
|
+
### Run the Node example
|
|
159
|
+
|
|
160
|
+
```sh
|
|
161
|
+
npx esbuild --platform=node --bundle ./example/node.ts | DEBUG="hello:*" node
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
Try it with a different env var to see different logs:
|
|
165
|
+
|
|
166
|
+
```sh
|
|
167
|
+
npx esbuild --platform=node --bundle ./example/node.ts | DEBUG="hello:*,abc123:*" node
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
or
|
|
172
|
+
|
|
173
|
+
```sh
|
|
174
|
+
npm run example:node
|
|
175
|
+
```
|
|
176
|
+
|
|
139
177
|
|
|
140
178
|
## Test
|
|
141
179
|
|
package/dist/browser/index.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export { createDebug };
|
|
2
2
|
export default createDebug;
|
|
3
|
-
|
|
3
|
+
export type Debugger = (...args: any[]) => void;
|
|
4
|
+
declare function createDebug(namespace?: string | boolean): Debugger;
|
|
4
5
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/browser/index.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,WAAW,EAAE,CAAA;AACtB,eAAe,WAAW,CAAA;AA2K1B,iBAAS,WAAW,CAAE,SAAS,CAAC,EAAC,MAAM,GAAC,OAAO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/browser/index.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,WAAW,EAAE,CAAA;AACtB,eAAe,WAAW,CAAA;AA2K1B,MAAM,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;AAE/C,iBAAS,WAAW,CAAE,SAAS,CAAC,EAAC,MAAM,GAAC,OAAO,GAAE,QAAQ,CAsBxD"}
|
package/dist/browser/index.js
CHANGED
|
@@ -14,7 +14,7 @@ function isEnabled(namespace, forcedEnabled) {
|
|
|
14
14
|
// If explicitly forced to be enabled via boolean true
|
|
15
15
|
if (forcedEnabled === true)
|
|
16
16
|
return true;
|
|
17
|
-
const DEBUG = localStorage
|
|
17
|
+
const DEBUG = localStorage?.getItem('DEBUG');
|
|
18
18
|
// Check for wildcard
|
|
19
19
|
if (DEBUG === '*')
|
|
20
20
|
return true;
|
|
@@ -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;;;;;GAKG;AACH,SAAS,SAAS,CAAE,SAAgB,EAAE,aAAsB;IACxD,sDAAsD;IACtD,IAAI,aAAa,KAAK,IAAI;QAAE,OAAO,IAAI,CAAA;IAEvC,MAAM,KAAK,GAAG,YAAY,
|
|
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;;;;;GAKG;AACH,SAAS,SAAS,CAAE,SAAgB,EAAE,aAAsB;IACxD,sDAAsD;IACtD,IAAI,aAAa,KAAK,IAAI;QAAE,OAAO,IAAI,CAAA;IAEvC,MAAM,KAAK,GAAG,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;IAE5C,qBAAqB;IACrB,IAAI,KAAK,KAAK,GAAG;QAAE,OAAO,IAAI,CAAA;IAE9B,yCAAyC;IACzC,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;QACtB,iDAAiD;QACjD,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,OAAO,IAAI,CAAA;QACf,CAAC;QACD,OAAO,KAAK,CAAA;IAChB,CAAC;IAED,wBAAwB;IACxB,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAA;IAExB,MAAM,OAAO,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAA;IAC5C,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;AACvD,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,aAAsB;IAEtB,IAAI,GAAG,IAAI,IAAI,EAAE,CAAA;IACjB,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,aAAa,CAAC;QAAE,OAAM;IAEhD,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,EAAE,EAAE,CAAC,CAAA;IAE5B,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;AAID,SAAS,WAAW,CAAE,SAAyB;IAC3C,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,8DAA8D;IAC9D,MAAM,aAAa,GAAG,SAAS,KAAK,IAAI,CAAA;IACxC,MAAM,eAAe,GAAG,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAA;IAEzE,MAAM,KAAK,GAAyB,UAAU,GAAG,IAAU;QACvD,OAAO,MAAM,CACT,eAAe,EACf,IAAI,EACJ,EAAE,QAAQ,EAAE,KAAK,EAAE,EACnB,aAAa,CAChB,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.9.
|
|
5
|
+
"version": "0.9.12",
|
|
6
6
|
"main": "./dist/node.js",
|
|
7
7
|
"files": [
|
|
8
8
|
"./dist/*"
|
|
@@ -18,27 +18,18 @@
|
|
|
18
18
|
},
|
|
19
19
|
"scripts": {
|
|
20
20
|
"lint": "eslint \"./**/*.{ts,js}\"",
|
|
21
|
-
"test
|
|
22
|
-
"
|
|
23
|
-
"test
|
|
24
|
-
"test": "npm run build && esbuild test/index.ts --target=es2020 --bundle --platform=node --format=esm | DEBUG=test NODE_ENV=development node --input-type=module",
|
|
25
|
-
"build-browser-tests": "esbuild test/index.ts --platform=node --target=es2020 --bundle --keep-names > test/test-bundle.js",
|
|
26
|
-
"test-tape-run": "npm run build-browser-tests && cat test/index.html | tape-run --input=html --static=test | tap-spec",
|
|
21
|
+
"test:node": "esbuild ./test/index.ts --format=esm --bundle --platform=node | node --input-type=module",
|
|
22
|
+
"test:browser": "esbuild ./test/test-browser.ts --bundle | npx tapout",
|
|
23
|
+
"test": "npm run test:browser && npm run test:node",
|
|
27
24
|
"build": "mkdir -p dist && rm -rf dist/* && tsc --project tsconfig.build.json",
|
|
25
|
+
"exmaple:node": "npx esbuild --platform=node --bundle ./example/node.ts | DEBUG=\"hello:*\" node",
|
|
28
26
|
"build-example": "vite build",
|
|
29
|
-
"build-example:dev": "vite build --mode=\"development\"",
|
|
30
27
|
"build-docs": "typedoc ./src/browser.ts ./src/node.ts",
|
|
31
28
|
"toc": "markdown-toc --maxdepth 3 -i README.md",
|
|
32
29
|
"start": "vite --mode=staging",
|
|
33
30
|
"start:ls": "vite --config vite-ls.config.js example-ls",
|
|
34
|
-
"start:star": "VITE_DEBUG=\"*\" vite",
|
|
35
|
-
"start:vite-production": "NODE_EN\"production\" vite",
|
|
36
|
-
"start:bar-production": "NODE_ENV=\"production\" VITE_DEBUG=\"barrr\" vite",
|
|
37
|
-
"start:bar-dev": "VITE_DEBUG=\"barrr\" vite",
|
|
38
|
-
"start:static": "npm run build:static && http-server -p 8888 example/static",
|
|
39
|
-
"build:static": "esbuild ./example/static/index.ts --bundle > ./example/static/bundle.js",
|
|
40
31
|
"preversion": "npm run lint",
|
|
41
|
-
"version": "npm run toc && git add README.md",
|
|
32
|
+
"version": "npm run toc && auto-changelog -p --template keepachangelog --breaking-pattern 'BREAKING CHANGE:' && git add CHANGELOG.md README.md",
|
|
42
33
|
"postversion": "git push --follow-tags && npm publish",
|
|
43
34
|
"prepublishOnly": "npm run build"
|
|
44
35
|
},
|
|
@@ -47,8 +38,8 @@
|
|
|
47
38
|
"supports-color": "^10.0.0"
|
|
48
39
|
},
|
|
49
40
|
"devDependencies": {
|
|
50
|
-
"@substrate-system/tapzero": "^0.10.15",
|
|
51
41
|
"@substrate-system/tapout": "^0.0.17",
|
|
42
|
+
"@substrate-system/tapzero": "^0.10.15",
|
|
52
43
|
"@types/node": "^24.3.0",
|
|
53
44
|
"@typescript-eslint/eslint-plugin": "^8.0.0",
|
|
54
45
|
"@typescript-eslint/parser": "^8.0.0",
|
|
@@ -59,7 +50,6 @@
|
|
|
59
50
|
"http-server": "^14.1.1",
|
|
60
51
|
"markdown-toc": "^1.2.0",
|
|
61
52
|
"tap-spec": "^5.0.0",
|
|
62
|
-
"tape-run": "^11.0.0",
|
|
63
53
|
"typedoc": "^0.28.1",
|
|
64
54
|
"typescript": "^5.4.5",
|
|
65
55
|
"vite": "^7.0.1"
|