Add package readmes

.editorconfig

@@ -1,9 +1,10 @@
 root = true
 
 [*]
+charset = utf-8
 end_of_line = lf
-insert_final_newline = true
-indent_style = space
 indent_size = 2
-charset = utf-8
+indent_style = space
+insert_final_newline = true
+max_line_length = 80
 trim_trailing_whitespace = true

.prettierignore

@@ -1,3 +1,4 @@
 .github/
 scripts/templates
+packages/**/*.original*
 package-lock.json

.prettierrc

@@ -3,5 +3,5 @@
   "semi": false,
   "singleQuote": true,
   "trailingComma": "none",
-  "printWidth": 80
+  "proseWrap": "always"
 }

SECURITY.md

@@ -1,11 +1,13 @@
 # Reporting Security Issues
 
 If you believe you've discovered a security vulnerability in a `@socketregistry`
-package, please report it directly to us at **[[email protected]](mailto:[email protected])**.
+package, please report it directly to us at
+**[[email protected]](mailto:[email protected])**.
 
 We take all reports seriously and will work to address any legitimate issues as
 quickly as possible.
 
-**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**
+**Please do not report security vulnerabilities through public GitHub issues,
+discussions, or pull requests.**
 
 Thanks for helping make `@socketregistry` more secure :heart:

eslint.config.js

@@ -11,10 +11,10 @@ const tsEslint = require('typescript-eslint')
 
 const {
   PACKAGE_JSON,
-  gitignoreFile,
+  gitIgnoreFile,
   npmPackageNames,
   npmPackagesPath,
-  prettierignoreFile,
+  prettierIgnoreFile,
   relNpmPackagesPath,
   rootTsConfigPath
 } = require('@socketregistry/scripts/constants')
@@ -218,8 +218,8 @@ function configs(sourceType) {
 }
 
 module.exports = [
-  gitignoreFile,
-  prettierignoreFile,
+  gitIgnoreFile,
+  prettierIgnoreFile,
   ...configs('script'),
   ...configs('module')
 ]

package.json

@@ -36,6 +36,7 @@
     "update:manifest": "node ./scripts/update-manifest.js",
     "update:package-json": "node ./scripts/update-package-json.js",
     "update:package-lock": "node ./scripts/update-package-lock.js",
+    "update:readmes": "node ./scripts/update-readmes.js",
     "update:npm:package-json": "node ./scripts/update-npm-package-json.js",
     "update:test:npm:package-json": "node ./scripts/update-test-npm-package-json.js"
   },
@@ -68,6 +69,7 @@
     "eslint-plugin-import-x": "^4.2.1",
     "eslint-plugin-n": "^17.10.2",
     "eslint-plugin-sort-destructure-keys": "^2.0.0",
+    "eta": "^3.5.0",
     "fast-sort": "^3.4.1",
     "fs-extra": "^11.2.0",
     "husky": "^9.1.6",

packages/npm/abab/README.md

@@ -0,0 +1,45 @@
+# @socketregistry/@socketregistry/abab
+
+> A zero dependency drop-in replacement of
+> [@socketregistry/abab](https://www.npmjs.com/package/@socketregistry/abab).
+
+## Install
+
+### `@socketsecurity/cli` :sparkles:
+
+Use [`@socketsecurity/cli`](https://www.npmjs.com/package/@socketsecurity/cli)
+to automagically populate the
+[overrides](https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides)
+and [resolutions](https://yarnpkg.com/configuration/manifest#resolutions) fields
+of your `package.json`.
+
+```sh
+npx @socketsecurity/cli optimize
+```
+
+### Handcrafted
+
+Manually add `@socketregistry/@socketregistry/abab` to your `package.json`.
+
+```json
+{
+  "overrides": {
+    "@socketregistry/abab": "npm:@socketregistry/@socketregistry/abab@^1"
+  },
+  "resolutions": {
+    "@socketregistry/abab": "npm:@socketregistry/@socketregistry/abab@^1"
+  }
+}
+```
+
+### Direct Dependency
+
+Install as a direct dependency.
+
+````sh
+npm install @socketregistry/@socketregistry/abab```
+
+## Requirements
+
+Node >=18.20.4
+````

packages/npm/aggregate-error/README.md

@@ -0,0 +1,46 @@
+# @socketregistry/@socketregistry/aggregate-error
+
+> A zero dependency drop-in replacement of
+> [@socketregistry/aggregate-error](https://www.npmjs.com/package/@socketregistry/aggregate-error).
+
+## Install
+
+### `@socketsecurity/cli` :sparkles:
+
+Use [`@socketsecurity/cli`](https://www.npmjs.com/package/@socketsecurity/cli)
+to automagically populate the
+[overrides](https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides)
+and [resolutions](https://yarnpkg.com/configuration/manifest#resolutions) fields
+of your `package.json`.
+
+```sh
+npx @socketsecurity/cli optimize
+```
+
+### Handcrafted
+
+Manually add `@socketregistry/@socketregistry/aggregate-error` to your
+`package.json`.
+
+```json
+{
+  "overrides": {
+    "@socketregistry/aggregate-error": "npm:@socketregistry/@socketregistry/aggregate-error@^1"
+  },
+  "resolutions": {
+    "@socketregistry/aggregate-error": "npm:@socketregistry/@socketregistry/aggregate-error@^1"
+  }
+}
+```
+
+### Direct Dependency
+
+Install as a direct dependency.
+
+````sh
+npm install @socketregistry/@socketregistry/aggregate-error```
+
+## Requirements
+
+Node >=18.20.4
+````

packages/npm/array-buffer-byte-length/README.md

@@ -0,0 +1,46 @@
+# @socketregistry/@socketregistry/array-buffer-byte-length
+
+> A zero dependency drop-in replacement of
+> [@socketregistry/array-buffer-byte-length](https://www.npmjs.com/package/@socketregistry/array-buffer-byte-length).
+
+## Install
+
+### `@socketsecurity/cli` :sparkles:
+
+Use [`@socketsecurity/cli`](https://www.npmjs.com/package/@socketsecurity/cli)
+to automagically populate the
+[overrides](https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides)
+and [resolutions](https://yarnpkg.com/configuration/manifest#resolutions) fields
+of your `package.json`.
+
+```sh
+npx @socketsecurity/cli optimize
+```
+
+### Handcrafted
+
+Manually add `@socketregistry/@socketregistry/array-buffer-byte-length` to your
+`package.json`.
+
+```json
+{
+  "overrides": {
+    "@socketregistry/array-buffer-byte-length": "npm:@socketregistry/@socketregistry/array-buffer-byte-length@^1"
+  },
+  "resolutions": {
+    "@socketregistry/array-buffer-byte-length": "npm:@socketregistry/@socketregistry/array-buffer-byte-length@^1"
+  }
+}
+```
+
+### Direct Dependency
+
+Install as a direct dependency.
+
+````sh
+npm install @socketregistry/@socketregistry/array-buffer-byte-length```
+
+## Requirements
+
+Node >=18.20.4
+````

packages/npm/array-flatten/README.md

@@ -0,0 +1,46 @@
+# @socketregistry/@socketregistry/array-flatten
+
+> A zero dependency drop-in replacement of
+> [@socketregistry/array-flatten](https://www.npmjs.com/package/@socketregistry/array-flatten).
+
+## Install
+
+### `@socketsecurity/cli` :sparkles:
+
+Use [`@socketsecurity/cli`](https://www.npmjs.com/package/@socketsecurity/cli)
+to automagically populate the
+[overrides](https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides)
+and [resolutions](https://yarnpkg.com/configuration/manifest#resolutions) fields
+of your `package.json`.
+
+```sh
+npx @socketsecurity/cli optimize
+```
+
+### Handcrafted
+
+Manually add `@socketregistry/@socketregistry/array-flatten` to your
+`package.json`.
+
+```json
+{
+  "overrides": {
+    "@socketregistry/array-flatten": "npm:@socketregistry/@socketregistry/array-flatten@^1"
+  },
+  "resolutions": {
+    "@socketregistry/array-flatten": "npm:@socketregistry/@socketregistry/array-flatten@^1"
+  }
+}
+```
+
+### Direct Dependency
+
+Install as a direct dependency.
+
+````sh
+npm install @socketregistry/@socketregistry/array-flatten```
+
+## Requirements
+
+Node >=18.20.4
+````

packages/npm/array-includes/README.md

@@ -0,0 +1,46 @@
+# @socketregistry/@socketregistry/array-includes
+
+> A zero dependency drop-in replacement of
+> [@socketregistry/array-includes](https://www.npmjs.com/package/@socketregistry/array-includes).
+
+## Install
+
+### `@socketsecurity/cli` :sparkles:
+
+Use [`@socketsecurity/cli`](https://www.npmjs.com/package/@socketsecurity/cli)
+to automagically populate the
+[overrides](https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides)
+and [resolutions](https://yarnpkg.com/configuration/manifest#resolutions) fields
+of your `package.json`.
+
+```sh
+npx @socketsecurity/cli optimize
+```
+
+### Handcrafted
+
+Manually add `@socketregistry/@socketregistry/array-includes` to your
+`package.json`.
+
+```json
+{
+  "overrides": {
+    "@socketregistry/array-includes": "npm:@socketregistry/@socketregistry/array-includes@^1"
+  },
+  "resolutions": {
+    "@socketregistry/array-includes": "npm:@socketregistry/@socketregistry/array-includes@^1"
+  }
+}
+```
+
+### Direct Dependency
+
+Install as a direct dependency.
+
+````sh
+npm install @socketregistry/@socketregistry/array-includes```
+
+## Requirements
+
+Node >=18.20.4
+````

packages/npm/array.from/README.md

@@ -0,0 +1,46 @@
+# @socketregistry/@socketregistry/array.from
+
+> A zero dependency drop-in replacement of
+> [@socketregistry/array.from](https://www.npmjs.com/package/@socketregistry/array.from).
+
+## Install
+
+### `@socketsecurity/cli` :sparkles:
+
+Use [`@socketsecurity/cli`](https://www.npmjs.com/package/@socketsecurity/cli)
+to automagically populate the
+[overrides](https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides)
+and [resolutions](https://yarnpkg.com/configuration/manifest#resolutions) fields
+of your `package.json`.
+
+```sh
+npx @socketsecurity/cli optimize
+```
+
+### Handcrafted
+
+Manually add `@socketregistry/@socketregistry/array.from` to your
+`package.json`.
+
+```json
+{
+  "overrides": {
+    "@socketregistry/array.from": "npm:@socketregistry/@socketregistry/array.from@^1"
+  },
+  "resolutions": {
+    "@socketregistry/array.from": "npm:@socketregistry/@socketregistry/array.from@^1"
+  }
+}
+```
+
+### Direct Dependency
+
+Install as a direct dependency.
+
+````sh
+npm install @socketregistry/@socketregistry/array.from```
+
+## Requirements
+
+Node >=18.20.4
+````