@sequencemedia/lsof 0.0.5 → 0.0.7

package/README.md

@@ -1,6 +1,6 @@
 # `@sequencemedia/lsof`
 
-Get a list of open files in a convenient JS structure
+Get a list of open files in a convenient structure
 
 ```bash
 npm i -P @sequencemedia/lsof

package/package.json

@@ -1,6 +1,10 @@
 {
   "name": "@sequencemedia/lsof",
-  "version": "0.0.5",
+  "version": "0.0.7",
+  "keywords": [
+    "lsof",
+    "list open files"
+  ],
   "main": "./index.mjs",
   "type": "module",
   "author": {
@@ -11,7 +15,7 @@
   "license": "ISC",
   "repository": {
     "type": "git",
-    "url": "git://github.com/sequencemedia/lsof.git"
+    "url": "git+https://github.com/sequencemedia/lsof.git"
   },
   "scripts": {
     "lint": "eslint .",
@@ -22,8 +26,8 @@
     "husky": "^9.1.7"
   },
   "devDependencies": {
-    "@sequencemedia/eslint-config-standard": "^0.2.53",
-    "@sequencemedia/eslint-config-typescript": "^0.1.83",
+    "@sequencemedia/eslint-config-standard": "^0.2.54",
+    "@sequencemedia/eslint-config-typescript": "^0.1.85",
     "@types/node": "^22.15.12",
     "eslint": "^9.26.0",
     "globals": "^16.0.0"

package/src/1/common.mjs

@@ -2,6 +2,18 @@ import {
   execFile
 } from 'node:child_process'
 
+export const PID = 'pid'
+export const COMMAND = 'command'
+export const USER = 'user'
+export const FD = 'fd'
+export const TYPE = 'type'
+export const DEVICE = 'device'
+export const SIZEOFF = 'sizeOff'
+export const NODE = 'node'
+export const NAME = 'name'
+
+const LF = '\n'
+
 /*
 export function toCamelCase (value) {
   return value.toLowerCase().replace(/[^a-zA-Z0-9]+(.)/g, (m, v) => v.toUpperCase())
@@ -9,7 +21,7 @@ export function toCamelCase (value) {
 
 export function fromTsv (string) {
   return (
-    string.replace(/\r/g, '\n').split('\n')
+    string.replace(/\r/g, LF).split(LF)
       .map((l) => l.split('\t'))
       .reduce((a, c, i, [head]) => (i) ? a.concat(Object.fromEntries(c.map((val, col) => [head[col], val]))) : a, [])
   )
@@ -49,12 +61,12 @@ function getCol (s) {
   switch (key) {
     case 'c': // will prefix the COMMAND or (Process Name) column
       return {
-        command: value
+        [COMMAND]: value
       }
 
     case 'u': // will prefix the User column that the process is running under
       return {
-        user: value
+        [USER]: value
       }
 
     case 'f': // will prefix the File Descriptor column
@@ -62,18 +74,18 @@ function getCol (s) {
       const fd = Number(value)
 
       return {
-        fd: isNaN(fd) ? value : fd
+        [FD]: isNaN(fd) ? value : fd
       }
     }
 
     case 't': // will prefix the type column
       return {
-        type: value
+        [TYPE]: value
       }
 
     case 'D': // will prefix the Device column
       return {
-        device: value
+        [DEVICE]: value
       }
 
     case 's': // will prefix the SizeOff column
@@ -81,7 +93,7 @@ function getCol (s) {
       const sizeOff = Number(value)
 
       return {
-        sizeOff: isNaN(sizeOff) ? value : sizeOff
+        [SIZEOFF]: isNaN(sizeOff) ? value : sizeOff
       }
     }
 
@@ -90,13 +102,13 @@ function getCol (s) {
       const node = Number(value)
 
       return {
-        node: isNaN(node) ? value : node
+        [NODE]: isNaN(node) ? value : node
       }
     }
 
     case 'n': // will prefix the Name or (File Path)
       return {
-        name: value
+        [NAME]: value
       }
 
     default:
@@ -115,7 +127,7 @@ function getCol (s) {
  *  @returns {Set<Set<Record<string, string | number>>>}
  */
 export function getSet (value = '') {
-  const array = value.split('\n')
+  const array = value.split(LF)
 
   /**
    *  @type {Set<Set<Record<string, string | number>>>}
@@ -143,7 +155,7 @@ export function getSet (value = '') {
  *  @returns {Array<Array<Record<string, string | number>>>}
  */
 export function getArray (value = '') {
-  const array = value.split('\n')
+  const array = value.split(LF)
 
   /**
    *  @type {Array<Array<Record<string, string | number>>>}

package/src/1/to-array.mjs

@@ -1,4 +1,7 @@
 import {
+  PID,
+  COMMAND,
+  USER,
   getArray
 } from './common.mjs'
 
@@ -10,21 +13,31 @@ import {
 function toEntries ({ pid, command, user }, ...args) {
   return [
     [
-      'pid',
+      PID,
       pid
     ],
     [
-      'command',
+      COMMAND,
       command
     ],
     [
-      'user',
+      USER,
       user
     ],
     ...args
   ]
 }
 
+/**
+ *  @param {Record<string, string | number>[]} inner
+ *  @returns {Array<Record<string, string | number>>}
+ */
+function map (inner) {
+  return (
+    inner.reduce(reduce, [{}])
+  )
+}
+
 /**
  *  @param {Array<Record<string, string | number>>} accumulator
  *  @param {Record<string, string | number>} current
@@ -57,6 +70,6 @@ export default function toArray (value) {
   const outer = getArray(value)
 
   return (
-    outer.map((inner) => inner.reduce(reduce, [{}]))
+    outer.map(map)
   )
 }

package/src/1/to-set.mjs

@@ -1,65 +1,79 @@
 import {
+  PID,
+  COMMAND,
+  USER,
   getSet
 } from './common.mjs'
 
 /**
- *  @param {string} value
- *  @returns {Set<Set<Map<string, string | number>>>}
+ *  @param {Map<string, string | number>} map
+ *  @param  {...Array<string | number>} args
+ *  @returns {Array<Array<string | number>>}
  */
-export default function toSet (value) {
-  const outer = getSet(value)
+function toEntries (map, ...args) {
+  const pid = map.get(PID)
+  const command = map.get(COMMAND)
+  const user = map.get(USER)
+
+  return [
+    [
+      PID,
+      pid
+    ],
+    [
+      COMMAND,
+      command
+    ],
+    [
+      USER,
+      user
+    ],
+    ...args
+  ]
+}
 
+/**
+ *  @param {Set<Map<string, string | number>>} inner
+ *  @returns {Set<Set<Map<string, string | number>>>}
+ */
+function map (inner) {
   return (
-    new Set(
-      Array
-        .from(outer)
-        .map((inner) => (
-          new Set(
-            Array
-              .from(inner)
-              .reduce((accumulator, current) => {
-                const map = accumulator[accumulator.length - 1] // ?? {}
+    new Set(Array.from(inner).reduce(reduce, [new Map()]))
+  )
+}
 
-                const [
-                  [
-                    key,
-                    value
-                  ]
-                ] = Object.entries(current)
+/**
+ *  @param {Array<Map<string, string | number>>} accumulator
+ *  @param {Map<string, string | number>} current
+ *  @returns {Array<Map<string, string | number>>}
+ */
+function reduce (accumulator, current) {
+  const previous = accumulator[accumulator.length - 1] // ?? {}
+
+  const [
+    [
+      key,
+      value
+    ]
+  ] = Object.entries(current)
 
-                if (map.has(key)) {
-                  const pid = map.get('pid')
-                  const command = map.get('command')
-                  const user = map.get('user')
+  if (previous.has(key)) {
+    accumulator.push(new Map(toEntries(previous, [key, value])))
+  } else {
+    previous.set(key, value)
+  }
 
-                  accumulator.push(
-                    new Map([
-                      [
-                        'pid',
-                        pid
-                      ],
-                      [
-                        'command',
-                        command
-                      ],
-                      [
-                        'user',
-                        user
-                      ],
-                      [
-                        key,
-                        value
-                      ]
-                    ])
-                  )
-                } else {
-                  map.set(key, value)
-                }
+  return accumulator
+}
 
-                return accumulator
-              }, [new Map()])
-          )
-        ))
-    )
+/**
+ *  @param {string} value
+ *  @returns {Set<Set<Map<string, string | number>>>}
+ */
+export default function toSet (value) {
+  const outer = getSet(value)
+
+  return (
+    new Set(Array.from(outer).map(map))
   )
 }

package/src/2/common.mjs

@@ -2,19 +2,29 @@ import {
   execFile
 } from 'node:child_process'
 
+export const PID = 'pid'
+export const COMMAND = 'command'
+export const USER = 'user'
+export const FD = 'fd'
+export const TYPE = 'type'
+export const DEVICE = 'device'
+export const SIZEOFF = 'sizeOff'
+export const NODE = 'node'
+export const NAME = 'name'
+
 /**
  *  @typedef {{
-*    command: string,
-*    pid: number,
-*    user: string,
-*    fd: string | number,
-*    type: string,
-*    device: string,
-*    sizeOff: string | number,
-*    node: string | number,
-*    name: string
-*  }} LineType
-*/
+ *    command: string,
+ *    pid: number,
+ *    user: string,
+ *    fd: string | number,
+ *    type: string,
+ *    device: string,
+ *    sizeOff: string | number,
+ *    node: string | number,
+ *    name: string
+ *  }} LineType
+ */
 
 const PATTERN = /^\s*(?<command>[!-~]+)\s+(?<pid>\d+)\s+(?<user>\w+)\s+(?<fd>\s+|\w+)\s+(?<type>\s+|\w+)\s+(?<device>\s+|\d+,\d+|0x[\w\d]*)\s+(?<sizeOff>\s+|\w+|\d+)\s+(?<node>\s+|\d+)\s+(?<name>.*)/
 
@@ -28,6 +38,20 @@ export function getArray (v) {
   return v.trim().split(LF).slice(1)
 }
 
+/**
+ * @param {string} string
+ * @returns {number | string}
+ */
+function transform (string) {
+  const number = Number(string)
+
+  return (
+    isNaN(number)
+      ? string.trim()
+      : number
+  )
+}
+
 /**
  *  @param {string} v
  *  @returns {Record<string, string | number>}
@@ -49,30 +73,26 @@ export function toObject (v) {
 
   const {
     groups: {
-      command,
-      user,
-      fd: FD,
-      type,
-      device,
-      sizeOff: SIZEOFF,
-      node: NODE,
-      name
+      [COMMAND]: command,
+      [USER]: user,
+      [FD]: fd,
+      [TYPE]: type,
+      [DEVICE]: device,
+      [SIZEOFF]: sizeOff,
+      [NODE]: node,
+      [NAME]: name
     } = {}
   } = match
 
-  const fd = Number(FD)
-  const sizeOff = Number(SIZEOFF)
-  const node = Number(NODE)
-
   return {
     pid,
     command,
     user,
-    fd: isNaN(fd) ? FD.trim() : fd,
+    fd: transform(fd),
     type,
     device,
-    sizeOff: isNaN(sizeOff) ? SIZEOFF.trim() : sizeOff,
-    node: isNaN(node) ? NODE.trim() : node,
+    sizeOff: transform(sizeOff),
+    node: transform(node),
     name
   }
 }

package/src/2/to-array.mjs

@@ -3,16 +3,6 @@ import {
   toObject
 } from './common.mjs'
 
-/**
- *  @param {string} value
- *  @returns {Record<string, string | number>}
- */
-function mapObject (value) {
-  return (
-    toObject(value)
-  )
-}
-
 /**
  *  @param {string} value
  *  @returns {Array<Record<string, string | number>>}
@@ -21,6 +11,6 @@ export default function toArray (value) {
   const array = getArray(value)
 
   return (
-    array.map(mapObject)
+    array.map(toObject)
   )
 }

package/src/2/to-set.mjs

@@ -7,9 +7,11 @@ import {
  *  @param {string} value
  *  @returns {Map<string, string | number>}
  */
-function mapMap (value) {
+function toMap (value) {
+  const object = toObject(value)
+
   return (
-    new Map(Object.entries(toObject(value)))
+    new Map(Object.entries(object))
   )
 }
 
@@ -21,6 +23,6 @@ export default function toSet (value) {
   const array = getArray(value)
 
   return (
-    new Set(array.map(mapMap))
+    new Set(array.map(toMap))
   )
 }