feat: use as a cli

.github/workflows/release.yml

@@ -24,7 +24,7 @@ jobs:
               run: npm i
 
             - name: Build
-              run: npm run build
+              run: npm run compile
 
             - name: Semantic release
               uses: codfish/semantic-release-action@v2

.gitignore

@@ -1,3 +1,4 @@
+.out
 # Logs
 logs
 *.log

.releaserc.json

@@ -14,7 +14,22 @@
                 "assets": ["CHANGELOG.md", "package.json", "package-lock.json"]
             }
         ],
-        "@semantic-release/github",
+        [
+            "@semantic-release/github",
+            {
+                "assets": [
+                    {
+                        "path": ".out/dats-cli-linux",
+                        "label": "Linux distribution"
+                    },
+                    {
+                        "path": ".out/dats-cli-macos",
+                        "label": "Macos distribution"
+                    },
+                    { "path": ".out/dats-cli-win", "label": "Win distribution" }
+                ]
+            }
+        ],
         [
             "@saithodev/semantic-release-backmerge",
             {

package.json

@@ -2,6 +2,7 @@
     "name": "@immobiliarelabs/dats",
     "version": "3.0.1",
     "description": "Minimalistic zero-dependencies UDP/TCP statsd client for Node.js",
+    "bin": "./dist/dats-cli.js",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "publishConfig": {
@@ -25,6 +26,8 @@
         "sampling"
     ],
     "scripts": {
+        "precompile": "npm run build",
+        "compile": "pkg dist/dats-cli.js --out-path .out",
         "build": "tsc -p tsconfig.json",
         "build:watch": "npm run build -- -w",
         "lint": "eslint --fix --ignore-path .gitignore .",
@@ -71,14 +74,15 @@
         "lint-staged": "^13.0.0",
         "markdown-toc": "^1.2.0",
         "nyc": "^15.0.1",
+        "pkg": "^5.8.0",
         "prettier": "^2.0.5",
         "sinon": "^15.0.0",
         "strip-ansi-cli": "^3.0.0",
         "ts-node-dev": "^2.0.0",
-        "typescript": "^4.2.3"
+        "typescript": "^4.9.4"
     },
     "volta": {
-        "node": "16.13.0",
+        "node": "18.13.0",
         "npm": "8.1.0"
     }
 }

src/dats-cli.ts

@@ -0,0 +1,90 @@
+import { parseArgs } from 'util';
+import Client, { Types } from './index';
+
+const TYPES = Object.keys(Types);
+
+type Options = {
+    [k: string]: {
+        type: string;
+        default?: string | boolean;
+        help?: string;
+        validate?: (v: any) => boolean;
+    };
+};
+
+const options: Options = {
+    host: {
+        type: 'string',
+        validate: (v) => Boolean(v),
+    },
+    port: {
+        type: 'string',
+        validate: (v) => Boolean(v) && isFinite(v),
+    },
+    // metric
+    type: {
+        type: 'string',
+        help: 'Metric type can be one of: ' + TYPES.join(', '),
+        validate: (v) => Boolean(v) && TYPES.includes(v),
+    },
+    namespace: {
+        type: 'string',
+        help: 'Metric full namespace, use dots `.` to separate metrics',
+        validate: (v) => Boolean(v),
+    },
+    value: {
+        type: 'string',
+        help: 'Metric value',
+        validate: (v) => Boolean(v),
+    },
+    help: {
+        type: 'boolean',
+    },
+};
+
+function validateRequiredValues(values, opts: Options) {
+    let valid = true;
+    for (const [k, opt] of Object.entries(opts)) {
+        if (
+            typeof opt?.validate === 'function' &&
+            !opt?.validate(values?.[k])
+        ) {
+            valid = false;
+            console.log('🚨 Wrong input flag: `%s`', k);
+        }
+    }
+    if (!valid) console.log('ℹ️  Run with `--help` for more info');
+    return valid;
+}
+
+function printHelp({ help, ...opts }: Options) {
+    console.log(
+        'ℹ️  The following are required input flags: \n\n%s\n\nIf unsure of output run the command prepended with `DRY_RUN=1`',
+        Object.entries(opts)
+            .map(([k, v]) => `\t--${k} {${v.type}} [${v?.help || ''}]`)
+            .join('\n')
+    );
+    return process.exit(0);
+}
+
+const { values } = parseArgs({ options } as any);
+
+if (values.help) {
+    printHelp(options);
+}
+
+if (!validateRequiredValues(values, options)) {
+    process.exit(1);
+}
+
+const { host, port, type, value, namespace } = values;
+
+const client = new Client({
+    host: new URL(`udp://${host}:${port}`),
+});
+
+if (!process.env.DRY_RUN) {
+    client[type as string](namespace, value);
+} else {
+    console.log(`[dry-run]: ${namespace}:${value}|${Types[type as string]}`);
+}

src/index.ts

@@ -11,7 +11,7 @@ interface DebugLogger extends DebugLoggerFunction {
  * Enum of metrics types
  * @see https://github.com/statsd/statsd/blob/master/docs/metric_types.md
  */
-enum Types {
+export enum Types {
     counter = 'c',
     timing = 'ms',
     gauge = 'g',