Update generate-readme script (#3037)

* Rework generate-readmes

* Remove docs script from all packages (just applied monorepolint)

* Revert @monorepolint/cli to pick up an older yargs

* Add missed glob dependencies

* one more missed glob dependency

* Another missed dependency, not sure why these are only showing up on CI

* Remove glob from packages, keep it at the root instead

Author: mfedderly

.monorepolint.config.mjs

@@ -1,14 +1,15 @@
 // @ts-check
 import * as path from "node:path";
-import { glob } from "glob";
-import * as fs from "node:fs";
+import { existsSync } from "node:fs";
+import * as fs from "node:fs/promises";
 import {
   alphabeticalDependencies,
   alphabeticalScripts,
   packageOrder,
   packageEntry,
   packageScript,
   requireDependency,
+  REMOVE,
 } from "@monorepolint/rules";
 
 const TS_PACKAGES = []; // projects that use typescript to build
@@ -21,30 +22,34 @@ const TSTYCHE_PACKAGES = []; // projects that use tstyche for type tests.
 const BENCH_PACKAGES = []; // projects that have benchmarks
 
 // iterate all the packages and figure out what buckets everything falls into
-const __dirname = new URL(".", import.meta.url).pathname;
-glob.sync(path.join(__dirname, "packages", "turf-*")).forEach((pk) => {
+const packagesPath = path.join(process.cwd(), "packages");
+for (const pk of await fs.readdir(packagesPath)) {
+  if (pk === "turf") {
+    continue;
+  }
+
   const name = JSON.parse(
-    fs.readFileSync(path.join(pk, "package.json"), "utf8")
+    await fs.readFile(path.join(packagesPath, pk, "package.json"), "utf8")
   ).name;
 
-  if (fs.existsSync(path.join(pk, "index.ts"))) {
+  if (existsSync(path.join(packagesPath, pk, "index.ts"))) {
     TS_PACKAGES.push(name);
   } else {
     JS_PACKAGES.push(name);
   }
 
-  if (fs.existsSync(path.join(pk, "test.js"))) {
+  if (existsSync(path.join(pk, "test.js"))) {
     TAPE_PACKAGES.push(name);
   }
 
-  if (fs.existsSync(path.join(pk, "types.ts"))) {
+  if (existsSync(path.join(packagesPath, pk, "types.ts"))) {
     TYPES_PACKAGES.push(name);
   }
 
-  if (fs.existsSync(path.join(pk, "test/types.tst.ts"))) {
+  if (existsSync(path.join(packagesPath, pk, "test/types.tst.ts"))) {
     TSTYCHE_PACKAGES.push(name);
   }
-});
+}
 
 const TS_TAPE_PACKAGES = TAPE_PACKAGES.filter(
   (pkg) => -1 !== TS_PACKAGES.indexOf(pkg)
@@ -175,7 +180,7 @@ export default {
     packageScript({
       options: {
         scripts: {
-          docs: "tsx ../../scripts/generate-readmes.ts",
+          docs: REMOVE,
           test: "pnpm run /test:.*/",
         },
       },
@@ -234,6 +239,7 @@ export default {
       options: {
         devDependencies: {
           benchmark: "^2.1.4",
+          glob: REMOVE,
           tape: "^5.9.0",
           tsup: "^8.4.0",
           tsx: "^4.19.4",

docs/CONTRIBUTING.md

@@ -140,25 +140,13 @@ Should you want to generate new README files manually, use `pnpm run docs`:
 
 ### Documentation - Examples
 
-**Build docs for only `@turf/center`**
-
-```bash
-$ cd ./turf/packages/turf-center
-$ pnpm run docs
-
-> @turf/center@5.0.4 docs /Users/mac/Github/turf/packages/turf-center
-> node ../../scripts/generate-readmes
-
-Building Docs: @turf/center
-```
-
 **Builds docs for all packages**
 
 ```bash
 $ cd ./turf
 $ pnpm run docs
 > @ docs /Users/mac/Github/turf
-> tsx ./scripts/generate-readmes
+> node ./scripts/generate-readmes.mts
 
 Building Docs: @turf/along
 Building Docs: @turf/area
@@ -171,6 +159,8 @@ Building Docs: @turf/boolean-clockwise
 ....
 ```
 
+Note: This should be automatically executed with a pre-commit hook when necessary
+
 ### Public website
 
 The [turfjs.org](https://turfjs.org/) website is managed in a [separate repo](https://github.com/Turfjs/turf-www) with its own [contributing guide](https://github.com/Turfjs/turf-www/blob/master/CONTRIBUTING.md).

package.json

@@ -2,7 +2,7 @@
   "private": true,
   "funding": "https://opencollective.com/turf",
   "scripts": {
-    "docs": "tsx ./scripts/generate-readmes.ts",
+    "docs": "node ./scripts/generate-readmes.mts",
     "lint": "pnpm run /lint:.*/",
     "lint:docs": "documentation lint packages/turf-*/index.js",
     "lint:escheck-cjs": "es-check es8 packages/*/dist/cjs/index.cjs packages/turf/turf.min.js",
@@ -23,7 +23,7 @@
       "eslint --fix"
     ],
     "packages/*/index.{js,ts}": [
-      "pnpm tsx ./scripts/generate-readmes",
+      "node ./scripts/generate-readmes.mts",
       "git add ./packages/*/README.md"
     ],
     "*": "prettier --write --ignore-unknown"
@@ -32,10 +32,10 @@
   "devDependencies": {
     "@eslint/eslintrc": "^3.3.1",
     "@eslint/js": "^9.31.0",
-    "@monorepolint/cli": "0.5.0",
-    "@monorepolint/config": "0.5.0",
-    "@monorepolint/core": "0.5.0",
-    "@monorepolint/rules": "0.5.0",
+    "@monorepolint/cli": "0.6.0-alpha.5",
+    "@monorepolint/config": "0.6.0-alpha.6",
+    "@monorepolint/core": "0.6.0-alpha.6",
+    "@monorepolint/rules": "0.6.0-alpha.6",
     "@types/node": "22.15.3",
     "acorn": "^8.14.1",
     "camelcase": "^8.0.0",
@@ -48,7 +48,6 @@
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-prettier": "^5.5.3",
     "esm": "^3.2.25",
-    "fs-extra": "^11.3.0",
     "glob": "^11.1.0",
     "globals": "^16.0.0",
     "husky": "^9.1.7",
@@ -59,9 +58,8 @@
     "prettier": "^3.5.3",
     "progress": "^2.0.3",
     "tsup": "^8.4.0",
-    "tsx": "^4.19.4",
     "typescript": "^5.8.3",
     "typescript-eslint": "^8.38.0",
-    "yamljs": "^0.3.0"
+    "yaml": "^2.8.2"
   }
 }

packages/turf-along/package.json

@@ -47,7 +47,6 @@
   "scripts": {
     "bench": "tsx bench.ts",
     "build": "tsup --config ../../tsup.config.ts",
-    "docs": "tsx ../../scripts/generate-readmes.ts",
     "test": "pnpm run /test:.*/",
     "test:tape": "tsx test.ts"
   },

packages/turf-angle/package.json

@@ -47,7 +47,6 @@
   "scripts": {
     "bench": "tsx bench.ts",
     "build": "tsup --config ../../tsup.config.ts",
-    "docs": "tsx ../../scripts/generate-readmes.ts",
     "test": "pnpm run /test:.*/",
     "test:tape": "tsx test.ts"
   },
@@ -58,7 +57,6 @@
     "@types/benchmark": "^2.1.5",
     "@types/tape": "^5.8.1",
     "benchmark": "^2.1.4",
-    "glob": "^11.1.0",
     "load-json-file": "^7.0.1",
     "tape": "^5.9.0",
     "tsup": "^8.4.0",

packages/turf-area/package.json

@@ -46,7 +46,6 @@
   "scripts": {
     "bench": "tsx bench.ts",
     "build": "tsup --config ../../tsup.config.ts",
-    "docs": "tsx ../../scripts/generate-readmes.ts",
     "test": "pnpm run /test:.*/",
     "test:tape": "tsx test.ts"
   },

packages/turf-bbox-clip/package.json

@@ -52,7 +52,6 @@
   "scripts": {
     "bench": "tsx bench.ts",
     "build": "tsup --config ../../tsup.config.ts",
-    "docs": "tsx ../../scripts/generate-readmes.ts",
     "test": "pnpm run /test:.*/",
     "test:tape": "tsx test.ts"
   },

packages/turf-bbox-polygon/package.json

@@ -47,7 +47,6 @@
   "scripts": {
     "bench": "tsx bench.ts",
     "build": "tsup --config ../../tsup.config.ts",
-    "docs": "tsx ../../scripts/generate-readmes.ts",
     "test": "pnpm run /test:.*/",
     "test:tape": "tsx test.ts"
   },

packages/turf-bbox/package.json

@@ -48,7 +48,6 @@
   "scripts": {
     "bench": "tsx bench.ts",
     "build": "tsup --config ../../tsup.config.ts",
-    "docs": "tsx ../../scripts/generate-readmes.ts",
     "test": "pnpm run /test:.*/",
     "test:tape": "tsx test.ts"
   },

packages/turf-bearing/package.json

@@ -44,7 +44,6 @@
   "scripts": {
     "bench": "tsx bench.ts",
     "build": "tsup --config ../../tsup.config.ts",
-    "docs": "tsx ../../scripts/generate-readmes.ts",
     "test": "pnpm run /test:.*/",
     "test:tape": "tsx test.ts"
   },