feat: typescript types

Author: HitkoDev

.github/workflows/nodejs.yml

@@ -21,6 +21,7 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - run: yarn
+      - run: yarn build
       - run: yarn test
 
   build_windows:
@@ -37,4 +38,5 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - run: yarn
+      - run: yarn build
       - run: yarn test

eslint.config.mjs eslint.config.jseslint.config.mjs renamed to eslint.config.js

@@ -10,10 +10,10 @@ import { parser } from 'typescript-eslint'
 
 export default defineConfig(
     {
-        ignores: ['node_modules', 'coverage', 'docs', '.yarn', '.husky', 'tmp']
+        ignores: ['lib', 'node_modules', 'coverage', 'docs', '.yarn', '.husky', 'tmp']
     },
     {
-        files: ['**/*.ts', '**/*.mjs', '**/*.js'],
+        files: ['**/*.ts', '**/*.js', '**/*.mjs', '**/*.cjs'],
         plugins: {
             // @ts-ignore
             '@typescript-eslint': typescriptEslintPlugin,
@@ -25,7 +25,12 @@ export default defineConfig(
             '@stylistic': stylisticPlugin
         },
         languageOptions: {
-            parser
+            parser,
+            parserOptions: {
+                projectService: {
+                    allowDefaultProject: ['.*']
+                }
+            }
         },
         rules: {
             '@import/no-deprecated': 'warn',
@@ -125,9 +130,23 @@ export default defineConfig(
                 }
             ],
             '@typescript-eslint/naming-convention': 'off',
+            '@typescript-eslint/no-deprecated': ['error', {
+                allow: [
+                    {
+                        from: 'package',
+                        name: ['GlobalPreloadHook'],
+                        package: 'module'
+                    },
+                    {
+                        from: 'lib',
+                        name: ['RequireExtensions']
+                    }
+                ]
+            }],
             '@typescript-eslint/no-empty-function': 'off',
             '@typescript-eslint/no-empty-object-type': 'off',
             '@typescript-eslint/no-explicit-any': 'off',
+            '@typescript-eslint/no-floating-promises': 'error',
             '@typescript-eslint/no-inferrable-types': 'off',
             '@typescript-eslint/no-misused-new': 'error',
             '@typescript-eslint/no-namespace': 'off',
@@ -273,18 +292,20 @@ export default defineConfig(
         }
     },
     {
-        files: ['**/*.test.ts', '**/*.test.mjs', '**/*.config.mjs', '**/*.config.ts', '**/*.config.js', 'test/**/*.js', 'test/**/*.mjs', 'test/**/*.ts'],
+        files: ['**/*.config.js', '**/*.config.ts', '**/*.config.cjs', 'test/**/*.mjs', 'test/**/*.cjs', 'test/**/*.js'],
         rules: {
             '@import/no-extraneous-dependencies': [
                 'error',
                 {
-                    devDependencies: true
+                    devDependencies: true,
+                    packageDir: import.meta.dirname
                 }
-            ]
+            ],
+            '@typescript-eslint/no-floating-promises': 'off'
         }
     },
     {
-        files: ['**/*.js'],
+        files: ['test/**/*.js'],
         rules: {
             '@typescript-eslint/no-require-imports': 'off'
         }

package.json

@@ -10,12 +10,12 @@
     },
     "bin": "lib/entrypoint.js",
     "files": [
-        "lib"
+        "lib",
+        "icons"
     ],
     "dependencies": {
         "dateformat": "^5.0.3",
-        "dynamic-dedupe": "^0.3.0",
-        "filewatcher": "^3.0.1",
+        "debounce": "^3.0.0",
         "get-package-type": "^0.1.0",
         "minimist": "^1.2.8",
         "node-notifier": "^10.0.1",
@@ -26,7 +26,12 @@
         "@commitlint/cli": "^20.4.1",
         "@commitlint/config-conventional": "^20.4.1",
         "@stylistic/eslint-plugin": "^5.8.0",
+        "@types/dateformat": "^5.0.3",
+        "@types/get-package-type": "^0.1.0",
         "@types/node": "^20.0.0",
+        "@types/node-notifier": "^8.0.5",
+        "@types/resolve": "^1.20.6",
+        "@types/semver": "^7.7.1",
         "@typescript-eslint/eslint-plugin": "^8.55.0",
         "clean-package": "^2.2.0",
         "commit-and-tag-version": "^12.6.1",
@@ -39,16 +44,16 @@
         "npm-check-updates": "^19.3.2",
         "rimraf": "^6.1.2",
         "tap": "^21.5.1",
-        "tap-xunit": "^2.4.1",
         "touch": "^3.1.1",
         "ts-node-maintained": "^10.9.6",
         "typescript": "^5.9.3",
         "typescript-eslint": "^8.55.0"
     },
     "scripts": {
         "build": "rimraf lib && tsc -p tsconfig.lib.json",
-        "test": "node test",
+        "test": "node test/index.mjs",
         "lint": "eslint . --fix",
+        "prepublishOnly": "npm run build",
         "prepare": "husky",
         "release": "git diff --exit-code && commit-and-tag-version && git push --follow-tags origin",
         "prepack": "clean-package",

src/cfg.ts src/cfg.ctssrc/cfg.ts renamed to src/cfg.cts

@@ -1,9 +1,9 @@
-const { existsSync, readFileSync } = require('fs')
-const { dirname, resolve } = require('path')
+import { existsSync, readFileSync } from 'fs'
+import { dirname, resolve } from 'path'
+import { type Options } from './cli.js'
+import { resolveMain } from './resolve-main.cjs'
 
-const resolveMain = require('./resolve-main')
-
-const defaultConfig = {
+const defaultConfig: Options = {
     clear: false,
     debounce: 10,
     dedupe: false,
@@ -24,24 +24,24 @@ const defaultConfig = {
     vm: true
 }
 
-function read(dir) {
+function read(dir: string) {
     const f = resolve(dir, '.node-dev.json')
-    return existsSync(f) ? JSON.parse(readFileSync(f)) : {}
+    return existsSync(f) ? JSON.parse(readFileSync(f, 'utf-8')) : {}
 }
 
-function getConfig(script) {
+function getConfig(script: string) {
     const main = resolveMain(script)
     const dir = main ? dirname(main) : '.'
 
     return Object.assign(
         defaultConfig,
-        read(process.env.HOME || process.env.USERPROFILE),
+        read((process.env.HOME || process.env.USERPROFILE)!),
         read(process.cwd()),
         read(dir)
     )
 }
 
-module.exports = {
+export {
     defaultConfig,
     getConfig
 }

src/clear.cts

@@ -0,0 +1,4 @@
+const control = '\u001bc'
+const clearFactory = (clear?: boolean) => (clear ? () => process.stdout.write(control) : () => { })
+
+export { clearFactory, control }

src/clear.ts

@@ -1,13 +1,12 @@
-const assert = require('assert')
-const { resolve } = require('path')
-const minimist = require('minimist')
+import assert from 'node:assert'
+import { resolve } from 'node:path'
+import minimist, { ParsedArgs } from 'minimist'
+import { getConfig } from './cfg.cjs'
 
-const { getConfig } = require('./cfg')
+const arrayify = <T>(v: T | T[]) => (Array.isArray(v) ? [...v] : [v])
+const argify = (key: string) => ({ arg: `--${key}`, key })
 
-const arrayify = v => (Array.isArray(v) ? [...v] : [v])
-const argify = key => ({ arg: `--${key}`, key })
-
-const resolvePath = p => resolve(process.cwd(), p)
+const resolvePath = (p: string) => resolve(process.cwd(), p)
 
 const nodeAlias = { require: 'r' }
 const nodeBoolean = ['expose_gc', 'preserve-symlinks']
@@ -23,8 +22,8 @@ const boolean = [...nodeBoolean, ...nodeDevBoolean]
 const string = [...nodeString, ...nodeDevString]
 
 const nodeArgsReducer =
-    opts =>
-        (out, { arg, key }) => {
+    (opts: ParsedArgs) =>
+        (out: string[], { arg, key }: { arg: string, key: string }) => {
             const value = opts[key]
 
             if (typeof value === 'boolean') {
@@ -44,22 +43,40 @@ const nodeArgsReducer =
             return out
         }
 
-const nodeCustomFactory = args => arg => {
+const nodeCustomFactory = (args: any[]) => (arg: string) => {
     const isNodeCustom = nodeCustom.includes(arg.substring(2))
     if (isNodeCustom) args.push(arg)
     return !isNodeCustom
 }
 
-const unknownFactory = args => arg => {
+const unknownFactory = (args: Array<{ arg: string, key: string }>) => (arg: string) => {
     const [, key] = Object.keys(minimist([arg]))
     key && !nodeDevNumber.includes(key) && args.push({ arg, key })
+    return true
+}
+
+export interface Options {
+    clear: boolean
+    dedupe: boolean
+    fork: boolean
+    notify: boolean
+    poll: boolean
+    respawn: boolean
+    vm: boolean
+    debounce: number
+    deps: number
+    extensions: Record<string, string>
+    graceful_ipc: string
+    ignore: string[]
+    interval: number
+    timestamp: string
 }
 
-module.exports = argv => {
-    const nodeCustomArgs = []
+export const cli = (argv: string[]) => {
+    const nodeCustomArgs = new Array<string>()
     const args = argv.slice(2).filter(nodeCustomFactory(nodeCustomArgs))
 
-    const unknownArgs = []
+    const unknownArgs = new Array<{ arg: string, key: string }>()
     const unknown = unknownFactory(unknownArgs)
 
     const {
@@ -70,10 +87,10 @@ module.exports = argv => {
 
     const opts = minimist(args, { alias, boolean, default: getConfig(script) })
     const nodeArgs = [...nodeBoolean.map(argify), ...nodeString.map(argify), ...unknownArgs]
-        .sort((a, b) => a.key - b.key)
+        .sort((a, b) => parseFloat(a.key) - parseFloat(b.key))
         .reduce(nodeArgsReducer(opts), [...nodeCustomArgs])
 
     opts.ignore = arrayify(opts.ignore).map(resolvePath)
 
-    return { nodeArgs, opts, script, scriptArgs }
+    return { nodeArgs, opts: opts as any as Options, script, scriptArgs }
 }

src/cli.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
-const cli = require('./cli')
-const dev = require('.')
+import { cli } from './cli.js'
+import { dev } from './index.js'
 
 const {
     script,

src/dedupe.ts

@@ -0,0 +1,53 @@
+import vm from 'vm'
+import NodeModule from 'node:module'
+
+export const hook = (patchVM: boolean, callback: (file: string) => void) => {
+    // Hook into Node's `require(...)`
+    updateHooks()
+
+    // Patch the vm module Script class to watch files executed as vm scripts:
+    if (patchVM) {
+        vm.Script = class Script extends vm.Script {
+            constructor(...args: any[]) {
+                const opts = args[1]
+                let file: string | undefined
+                if (opts) {
+                    file = typeof opts === 'string' ? opts : opts.filename
+                }
+                if (file) callback(file)
+                // @ts-ignore
+                super(...args)
+            }
+        }
+    }
+
+    /**
+     * (Re-)install hooks for all registered file extensions.
+     */
+    function updateHooks() {
+        // @ts-ignore
+        const extensions: NodeJS.RequireExtensions = NodeModule._extensions
+        Object.keys(extensions).forEach(ext => {
+            const fn = extensions[ext]
+            if (typeof fn === 'function' && fn.name !== 'nodeDevHook') {
+                extensions[ext] = createHook(fn)
+            }
+        })
+    }
+
+    /**
+     * Returns a function that can be put into `NodeModule._extensions` in order to
+     * invoke the callback when a module is required for the first time.
+     */
+    function createHook(handler: (module: NodeJS.Module, filename: string) => any) {
+        return function nodeDevHook(module: NodeJS.Module, filename: string) {
+            if (!module.loaded) callback(module.filename)
+
+            // Invoke the original handler
+            handler(module, filename)
+
+            // Make sure the module did not hijack the handler
+            updateHooks()
+        }
+    }
+}