remove-gulp (#605)

Signed-off-by: yaacov <kobi.zamir@gmail.com>

Author: yaacov

README.md

@@ -40,6 +40,15 @@ This repo uses **npm** and a committed **`package-lock.json`**. After cloning:
 
 To refresh dependencies after editing `package.json`, run `npm install` and commit the updated lockfile.
 
+Optional maintainer tasks (generated output is gitignored):
+
+- `npm run clean` — remove `modbus-serial/` and `docs/gen/`
+- `npm run build` — copy `apis`, `ports`, `servers`, and `utils` into `modbus-serial/`
+- `npm run doc` — generate API HTML under `docs/gen/` (JSDoc 4 + clean-jsdoc-theme)
+- `npm run doc:examples` — copy `examples/` into `docs/gen/examples/`
+- `npm run docs` — run `doc` then `doc:examples`
+- `npm run publish:prepare` — runs `build` then `docs` (mirrored package tree plus generated HTML and copied examples)
+
 #### What can I do with this module ?
 
 This class makes it fun and easy to communicate with electronic

eslint.config.mjs

@@ -12,7 +12,9 @@ export default defineConfig([
         ignores: [
             "**/node_modules/**",
             "**/coverage/**",
-            "**/.nyc_output/**"
+            "**/.nyc_output/**",
+            "**/docs/**",
+            "**/modbus-serial/**"
         ]
     },
     js.configs.recommended,

gulpfile.js

@@ -0,0 +1,32 @@
+{
+  "tags": {
+    "allowUnknownTags": true
+  },
+  "source": {
+    "include": [
+      "README.md",
+      "apis",
+      "ports",
+      "servers",
+      "utils"
+    ]
+  },
+  "plugins": [
+    "plugins/markdown"
+  ],
+  "opts": {
+    "encoding": "utf8",
+    "destination": "./docs/gen",
+    "recurse": true,
+    "template": "./node_modules/clean-jsdoc-theme",
+    "theme_opts": {
+      "title": "modbus-serial",
+      "homepageTitle": "modbus-serial",
+      "default_theme": "light"
+    }
+  },
+  "markdown": {
+    "hardwrap": false,
+    "idInHeadings": true
+  }
+}