Can use arbitrary varaible

Author: nichoth

README.md

@@ -39,32 +39,63 @@ Plus, [see the docs](https://substrate-system.github.io/debug/) generated by typ
 ## config
 
 ### namespace
-If you pass in a variable of the form `VITE_DEBUG=example`, then this will log
-any instances created with the `example` namespace:
+Works with `vite` or other systems. This will look at `import.meta.env`, or
+an arbitrary object you can pass in.
 
 ```js
 import Debug from '@substrate-system/debug'
+
+// look at `import.meta.env.VITE_DEBUG`
 const debug = Debug('example')
+
+// or call with your own env object
+const debug = Debug('example', { DEBUG: 'example' })
 ```
 
 If you create an instance without passing in a `namespace` string, then this
-will log iff the website is in `DEV` mode (if `import.meta.env.DEV` is true).
+will log iff anything other than `false` is passed as an argument.
+
+```js
+import Debug from '@substrate-system/debug'
+
+// log b/c we are not calling with `false`
+const debug = Debug()
+
+debug('hello')
+```
+
+You can use any variable as debug status:
+
+```js
+import Debug from '@substrate-system/debug'
+
+// in Vite
+const debug = Debug(!!(import.meta.env && import.meta.env.DEV))
+
+// in an arbitrary server
+const debug = Debug(window.EXAMPLE_DEBUG_MODE)
+```
 
 Use an env variable of `*` to log everything.
 
+
+### NODE_ENV + Vite
+
 Build the site with a `NODE_ENV` variable to set `import.meta.env.DEV`:
 
 ```sh
 NODE_ENV=development vite build
 ```
 
-This will work too. Any value of `NODE_ENV`, except `production`, wil equate to
+Any value of `NODE_ENV`, except `production`, wil equate to
 `import.meta.env.DEV` being true.
 
 ```sh
 NODE_ENV=staging vite build
 ```
 
+----------------------------------------------------------------------
+
 ## install
 
 ```sh
@@ -74,8 +105,10 @@ npm i -D @substrate-system/debug
 Use this with [vite](https://vitejs.dev/) in the [browser](#browser), or
 in [node](#node-JS).
 
+
 ------------------------------------------------------------------
 
+
 ## Node JS
 Run your script with an env variable, `DEBUG`.
 
@@ -116,6 +149,9 @@ Start a `vite` server and log some things. This uses [the example directory](./e
 npm start
 ```
 
+
+## test
+
 ### node
 Run tests:
 

example/index.ts

@@ -22,7 +22,7 @@ const debug4 = Debug('bazzz')
 debug4('bazzzzzzz')  // should not log
 
 const debug5 = Debug()
-debug5('debug 5 should be the same color as debug 2')
+debug5("debug 5 should be a different color, because it's a different instance.")
 
 // testing the * variable
 const debug7 = Debug('quxxx')

example/static/index.ts

@@ -10,6 +10,9 @@ const debugThree = Debug(true)
 
 debugThree('three')
 
+const debugFalse = Debug(false)
+debugFalse('should not see this')
+
 // @ts-expect-error dev
 window.debug = debug
 
@@ -20,3 +23,9 @@ setTimeout(() => {
 }, 1000)
 
 debugTwo('...aaa again')
+
+// need to use the boolean coersion, else it will pass in `undefined`
+const debugFive = Debug(!!(import.meta.env && import.meta.env.DEV))
+
+// will not see this
+debugFive('five!')

package.json

@@ -29,6 +29,10 @@
     "build-docs": "typedoc ./src/browser.ts ./src/node.ts",
     "toc": "markdown-toc --maxdepth 3 -i README.md",
     "start": "vite --mode=staging",
+    "start:star": "VITE_DEBUG=\"*\" vite",
+    "start:vite-production": "NODE_EN\"production\" vite",
+    "start:bar-production": "NODE_ENV=\"production\" VITE_DEBUG=\"barrr\" vite",
+    "start:bar-dev": "VITE_DEBUG=\"barrr\" vite",
     "start:static": "npm run build:static && http-server -p 8888 example/static",
     "build:static": "esbuild ./example/static/index.ts --bundle > ./example/static/bundle.js",
     "preversion": "npm run lint",

src/browser/index.ts

@@ -21,7 +21,7 @@ function isEnabled (
     namespace:string,
     env?:ImportMetaEnv|Record<string, string>
 ):boolean {
-    if (env && (env.VITE_DEBUG || env.DEBUG === '*')) return true
+    if (env && (env.VITE_DEBUG === '*' || env.DEBUG === '*')) return true
 
     // if we were not called with a namespace
     if (namespace === 'DEV') {