From a571c94c5d0cc6eb555b97faf2b7f3564bd77924 Mon Sep 17 00:00:00 2001 From: Jonathan Fraimorice Date: Tue, 14 Mar 2023 01:32:52 +0200 Subject: [PATCH] Replace broken image in README file (#695) chore: fix broken readme and npm@9 build process * Fix broken image for RunMD * Update runmd package (fixes logo link) * Fix build script (npm bin -> npx) Co-authored-by: Robert Kieffer --- README.md | 12 ++++---- README_js.md | 6 ++-- package-lock.json | 70 +++++++++++++++++++++++++++++++++++------------ package.json | 4 +-- scripts/build.sh | 9 +++--- 5 files changed, 66 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index c8aa13ef..f6a5ae94 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ -- This file is auto-generated from README_js.md. Changes should be made there. --> + # uuid [![CI](https://github.com/uuidjs/uuid/workflows/CI/badge.svg)](https://github.com/uuidjs/uuid/actions?query=workflow%3ACI) [![Browser](https://github.com/uuidjs/uuid/workflows/Browser/badge.svg)](https://github.com/uuidjs/uuid/actions?query=workflow%3ABrowser) For the creation of [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) UUIDs @@ -17,11 +18,9 @@ For the creation of [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) UUIDs - **Small** - Zero-dependency, small footprint, plays nice with "tree shaking" packagers - **CLI** - Includes the [`uuid` command line](#command-line) utility -> **Note** -> Upgrading from `uuid@3`? Your code is probably okay, but check out [Upgrading From `uuid@3`](#upgrading-from-uuid3) for details. +> **Note** Upgrading from `uuid@3`? Your code is probably okay, but check out [Upgrading From `uuid@3`](#upgrading-from-uuid3) for details. -> **Note** -> Only interested in creating a version 4 UUID? You might be able to use [`cypto.randomUUID()`](https://developer.mozilla.org/en-US/docs/Web/API/Crypto/randomUUID), eliminating the need to install this library. +> **Note** Only interested in creating a version 4 UUID? You might be able to use [`cypto.randomUUID()`](https://developer.mozilla.org/en-US/docs/Web/API/Crypto/randomUUID), eliminating the need to install this library. ## Quickstart @@ -462,5 +461,6 @@ const uuid = require('uuid'); // <== REMOVED! This usage pattern was already discouraged in `uuid@3` and has been removed in `uuid@7`. ----- -Markdown generated from [README_js.md](README_js.md) by [![RunMD Logo](https://i.imgur.com/h0FVyzU.png)](https://github.com/broofa/runmd) \ No newline at end of file +--- + +Markdown generated from [README_js.md](README_js.md) by diff --git a/README_js.md b/README_js.md index 8d3a18e5..4572c575 100644 --- a/README_js.md +++ b/README_js.md @@ -32,11 +32,9 @@ For the creation of [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) UUIDs - **Small** - Zero-dependency, small footprint, plays nice with "tree shaking" packagers - **CLI** - Includes the [`uuid` command line](#command-line) utility -> **Note** -> Upgrading from `uuid@3`? Your code is probably okay, but check out [Upgrading From `uuid@3`](#upgrading-from-uuid3) for details. +> **Note** Upgrading from `uuid@3`? Your code is probably okay, but check out [Upgrading From `uuid@3`](#upgrading-from-uuid3) for details. -> **Note** -> Only interested in creating a version 4 UUID? You might be able to use [`cypto.randomUUID()`](https://developer.mozilla.org/en-US/docs/Web/API/Crypto/randomUUID), eliminating the need to install this library. +> **Note** Only interested in creating a version 4 UUID? You might be able to use [`cypto.randomUUID()`](https://developer.mozilla.org/en-US/docs/Web/API/Crypto/randomUUID), eliminating the need to install this library. ## Quickstart diff --git a/package-lock.json b/package-lock.json index b91dcc40..8b6ea66e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -7,6 +7,10 @@ "": { "name": "uuid", "version": "9.0.0", + "funding": [ + "https://github.com/sponsors/broofa", + "https://github.com/sponsors/ctavan" + ], "license": "MIT", "bin": { "uuid": "dist/bin/uuid" @@ -33,7 +37,7 @@ "optional-dev-dependency": "2.0.1", "prettier": "2.7.1", "random-seed": "0.3.0", - "runmd": "1.3.6", + "runmd": "1.3.9", "standard-version": "9.5.0" } }, @@ -10391,10 +10395,13 @@ } }, "node_modules/minimist": { - "version": "1.2.6", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz", - "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==", - "dev": true + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", + "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, "node_modules/minimist-options": { "version": "4.1.0", @@ -11755,18 +11762,35 @@ } }, "node_modules/runmd": { - "version": "1.3.6", - "resolved": "https://registry.npmjs.org/runmd/-/runmd-1.3.6.tgz", - "integrity": "sha512-mcHjOURHsbdubPCKRWNhLb4VkyYI19CVymMNhgX5AM0ykRmirhIK1680cnEcTJS0Goebov1lBi2Qa+krxmRpWA==", + "version": "1.3.9", + "resolved": "https://registry.npmjs.org/runmd/-/runmd-1.3.9.tgz", + "integrity": "sha512-2WWY2zUykm0NrOrI7yaYNyO6MH5XToraJ4gb+RzRCFcyLmdYuOJLHWt4ELxDe+PwBOCgHn62XGlRAih50ap14g==", "dev": true, "dependencies": { - "minimist": "1.2.6", - "require-like": "0.1.2" + "minimist": "1.2.8", + "prettier": "2.8.4", + "require-like": "0.1.2", + "standard-version": "9.5.0" }, "bin": { "runmd": "cli.js" } }, + "node_modules/runmd/node_modules/prettier": { + "version": "2.8.4", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.4.tgz", + "integrity": "sha512-vIS4Rlc2FNh0BySk3Wkd6xmwxB0FpOndW5fisM5H8hsZSxU2VWVB5CWIkIjWvrHjIhxk2g3bfMKM87zNTrZddw==", + "dev": true, + "bin": { + "prettier": "bin-prettier.js" + }, + "engines": { + "node": ">=10.13.0" + }, + "funding": { + "url": "https://github.com/prettier/prettier?sponsor=1" + } + }, "node_modules/rxjs": { "version": "7.5.6", "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-7.5.6.tgz", @@ -20660,9 +20684,9 @@ } }, "minimist": { - "version": "1.2.6", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz", - "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==", + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", + "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", "dev": true }, "minimist-options": { @@ -21676,13 +21700,23 @@ } }, "runmd": { - "version": "1.3.6", - "resolved": "https://registry.npmjs.org/runmd/-/runmd-1.3.6.tgz", - "integrity": "sha512-mcHjOURHsbdubPCKRWNhLb4VkyYI19CVymMNhgX5AM0ykRmirhIK1680cnEcTJS0Goebov1lBi2Qa+krxmRpWA==", + "version": "1.3.9", + "resolved": "https://registry.npmjs.org/runmd/-/runmd-1.3.9.tgz", + "integrity": "sha512-2WWY2zUykm0NrOrI7yaYNyO6MH5XToraJ4gb+RzRCFcyLmdYuOJLHWt4ELxDe+PwBOCgHn62XGlRAih50ap14g==", "dev": true, "requires": { - "minimist": "1.2.6", - "require-like": "0.1.2" + "minimist": "1.2.8", + "prettier": "2.8.4", + "require-like": "0.1.2", + "standard-version": "9.5.0" + }, + "dependencies": { + "prettier": { + "version": "2.8.4", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.4.tgz", + "integrity": "sha512-vIS4Rlc2FNh0BySk3Wkd6xmwxB0FpOndW5fisM5H8hsZSxU2VWVB5CWIkIjWvrHjIhxk2g3bfMKM87zNTrZddw==", + "dev": true + } } }, "rxjs": { diff --git a/package.json b/package.json index 809d4618..e2fd9ccb 100644 --- a/package.json +++ b/package.json @@ -75,7 +75,7 @@ "optional-dev-dependency": "2.0.1", "prettier": "2.7.1", "random-seed": "0.3.0", - "runmd": "1.3.6", + "runmd": "1.3.9", "standard-version": "9.5.0" }, "optionalDevDependencies": { @@ -109,7 +109,7 @@ "prettier:fix": "prettier --write '**/*.{js,jsx,json,md}'", "bundlewatch": "npm run pretest:browser && bundlewatch --config bundlewatch.config.json", "md": "runmd --watch --output=README.md README_js.md", - "docs": "( node --version | grep -q 'v16' ) && ( npm run build && runmd --output=README.md README_js.md )", + "docs": "( node --version | grep -q 'v16' ) && ( npm run build && npx runmd --output=README.md README_js.md )", "docs:diff": "npm run docs && git diff --quiet README.md", "build": "./scripts/build.sh", "prepack": "npm run build", diff --git a/scripts/build.sh b/scripts/build.sh index 1836a687..6eda9b75 100755 --- a/scripts/build.sh +++ b/scripts/build.sh @@ -4,7 +4,6 @@ ROOT="$(pwd)/$(dirname "$0")/.." cd "$ROOT" || exit 1 -PATH="$(npm bin):$PATH" DIR="$ROOT/dist" # Clean up output dir @@ -26,17 +25,17 @@ mkdir -p "$DIR" # └── bin (<-- Node.js CLI) # Transpile CommonJS versions of files for node -babel --env-name commonjsNode src --source-root src --out-dir "$DIR" --copy-files --quiet +npx babel --env-name commonjsNode src --source-root src --out-dir "$DIR" --copy-files --quiet # Transpile CommonJS versions of files for the browser -babel --env-name commonjsBrowser src --source-root src --out-dir "$DIR/commonjs-browser" \ +npx babel --env-name commonjsBrowser src --source-root src --out-dir "$DIR/commonjs-browser" \ --copy-files --quiet # Transpile ESM versions of files for the browser -babel --env-name esmBrowser src --source-root src --out-dir "$DIR/esm-browser" --copy-files --quiet +npx babel --env-name esmBrowser src --source-root src --out-dir "$DIR/esm-browser" --copy-files --quiet # Transpile ESM versions of files for node -babel --env-name esmNode src --source-root src --out-dir "$DIR/esm-node" --copy-files --quiet +npx babel --env-name esmNode src --source-root src --out-dir "$DIR/esm-node" --copy-files --quiet # No need to have the CLI files in the esm build rm -rf "$DIR/commonjs-browser/bin"