rewrite to esm, externalize the data, module is cli only now

Author: silverwind

.eslintrc.yaml

@@ -1,7 +1,12 @@
 root: true
 extends: silverwind
 
-rules:
-  import/no-commonjs: [0]
-  no-restricted-globals: [0]
-  import/no-unused-modules: [0]
+# espree can't into import assertions
+parser: "@babel/eslint-parser"
+parserOptions:
+  requireConfigFile: false
+  babelOptions:
+    plugins: ["@babel/plugin-syntax-import-assertions"]
+
+ignorePatterns:
+ - /bin/

.gitattributes

@@ -1 +1,2 @@
 * text=auto eol=lf
+snapshots/*.snap linguist-language=JavaScript linguist-generated

.github/workflows/ci.yaml

@@ -5,10 +5,10 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
       - run: make deps
       - run: make test
 

.github/workflows/update.yaml

@@ -1,4 +1,5 @@
-/.vscode/
+/.vscode
+/bin
 /node_modules
 /npm-debug.log*
 /yarn-error.log

.gitignore

@@ -1,3 +1,6 @@
+SRC := oui.js
+DST := bin/oui.js
+
 node_modules: package-lock.json
 	npm install --no-save
 	@touch node_modules
@@ -7,38 +10,51 @@ deps: node_modules
 
 .PHONY: lint
 lint: node_modules
-	npx eslint --color *.js
+	npx eslint --color .
+
+.PHONY: lint-fix
+lint-fix: node_modules
+	npx eslint --color . --fix
 
 .PHONY: test
-test: node_modules lint
+test: node_modules build
 	npx vitest
 
+.PHONY: test-update
+test-update: node_modules build
+	npx vitest -u
+
+.PHONY: build
+build: $(DST)
+
+$(DST): $(SRC) node_modules Makefile
+# workaround for https://github.com/evanw/esbuild/issues/1921
+	npx esbuild --log-level=warning --platform=node --target=node18 --format=esm --bundle --minify --legal-comments=none --banner:js="import {createRequire} from 'module';const require = createRequire(import.meta.url);" --define:import.meta.VERSION=\"$(shell jq .version package.json)\" --outfile=$(DST) $(SRC) --external:oui-data
+	chmod +x $(DST)
+
 .PHONY: publish
 publish: node_modules
 	git push -u --tags origin master
 	npm publish
 
+.PHONY: update
 update: node_modules
 	npx updates -cu
 	rm -rf node_modules package-lock.json
 	npm install
 	@touch node_modules
 
-.PHONY: data
-data: node_modules
-	node oui.js update -w
-
 .PHONY: patch
-patch: node_modules test
-	npx versions patch package.json package-lock.json
+patch: node_modules lint test
+	npx versions -c 'make --no-print-directory build' patch package.json package-lock.json
 	@$(MAKE) --no-print-directory publish
 
 .PHONY: minor
-minor: node_modules test
-	npx versions minor package.json package-lock.json
+minor: node_modules lint test
+	npx versions -c 'make --no-print-directory build' minor package.json package-lock.json
 	@$(MAKE) --no-print-directory publish
 
 .PHONY: major
-major: node_modules test
-	npx versions major package.json package-lock.json
+major: node_modules lint test
+	npx versions -c 'make --no-print-directory build' major package.json package-lock.json
 	@$(MAKE) --no-print-directory publish

Makefile

@@ -1,92 +1,17 @@
 # oui
-[![](https://img.shields.io/npm/v/oui.svg?style=flat)](https://www.npmjs.org/package/oui) [![](https://img.shields.io/npm/dm/oui.svg)](https://www.npmjs.org/package/oui)
-> Look up MAC addresses for their vendor in the IEEE OUI database
+[![](https://img.shields.io/npm/v/oui.svg?style=flat)](https://www.npmjs.org/package/oui) [![](https://img.shields.io/npm/dm/oui.svg)](https://www.npmjs.org/package/oui) [![](https://packagephobia.com/badge?p=oui)](https://packagephobia.com/result?p=oui)
+> CLI to look up MAC addresses for their vendor in the IEEE OUI database
 
-The data used in this module comes from the [IEEE OUI Data](https://standards-oui.ieee.org/oui/oui.txt) which is updated once a week on Sunday. The module is also able self-update on demand.
+*Note: This module is CLI only since v13. The data has moved to module [oui-data](https://github.com/silverwind/oui-data).*
 
-## Installation
-```console
-$ npm i oui
-```
-## Example
-```js
-var oui = require('oui');
-
-console.log(oui('20:37:06:12:34:56'));
-//=> Cisco Systems, Inc
-//=> 80 West Tasman Drive
-//=> San Jose CA 94568
-//=> United States
-
-console.log(oui.search('*Juniper Systems*'))
-//=> [
-//=>   {
-//=>     oui: '0C0535',
-//=>     organization: 'Juniper Systems\n1132 W. 1700 N.\nLogan UT 84321\nUnited States'
-//=>   }
-//=> ]
-```
-
-## Installation (CLI)
-```console
-$ npm install -g oui
-```
-## Examples (CLI)
+## Usage
 ```console
+$ npm i -g oui
 $ oui 20:37:06:12:34:56
 Cisco Systems, Inc
 80 West Tasman Drive
 San Jose CA 94568
 United States
 ```
-```console
-$ oui --search cisco theory
-OUI       ORGANZATION          ADDRESS             COUNTRY
-000C41    Cisco-Linksys LLC    121 Theory Dr.      Irvine CA 92612
-000F66    Cisco-Linksys LLC    121 Theory Dr.      Irvine CA 92612
-001217    Cisco-Linksys LLC    121 Theory Dr.      Irvine CA 92612
-001310    Cisco-Linksys LLC    121 Theory Dr.      Irvine CA 92612
-```
-To update the local OUI database:
-```console
-$ oui --update
-```
-Or from the original IEEE source (slow):
-```console
-$ oui --update http://standards.ieee.org/develop/regauth/oui/oui.txt
-```
-
-## API
-### oui(input, [options])
-- `input` *string*: The input string. Non-hexadecimal characters and characters after 6 hex characters are found are ignored unless `options.strict` is set.
-- `options` *Object*: A optional options object.
-  - `strict` *boolean*: When `true`, only [strict input formats will be accepted](#strictformats). Will throw an error when an invalid format is supplied.
-  - `file` *string*: A absolute file path to `oui.json`, which contains the parsed oui data. Defaults to the `oui.json` in the module directory.
-
-Returns: Either a string, or `null` if no matches are found. Throws if input is not a string.
-
-### oui.update([options])
-- `options` *Object*: A optional options object.
-  - `url` *string*: The URL from where to retrieve `oui.txt`. Default `"https://standards-oui.ieee.org/oui/oui.txt"`.
-  - `file` *string*: A absolute file path for `oui.json`, which is used to store the parsed oui data. Defaults to the `oui.json` in the module directory.
-
-Returns: A Promise that indicates when the internal database has been updated. Rejects on error.
-
-### oui.search(patterns [, options])
-- `patterns` *string/Array*: One or more wildcard patterns to search the vendor data, as supported by [minimatch](https://github.com/isaacs/minimatch).
-- `options` *Object*: A optional options object.
-  - `file` *String*: A absolute file path for `oui.json`, which is used to store the parsed oui data. Defaults to the `oui.json` in the module directory.
-  - All [minimatch options](https://github.com/isaacs/minimatch#options) are supported as well.
-
-Returns a array of objects in the format {oui, organization}.
-<a name="strictformats" />
-#### strict formats
-- `000000`
-- `00:00:00`
-- `00-00-00`
-- `000000000000`
-- `0000.0000.0000`
-- `00:00:00:00:00:00`
-- `00-00-00-00-00-00`
 
 © [silverwind](https://github.com/silverwind), distributed under BSD licence