From 0047aed55328485e0198b958fb3f0a4e9bce924d Mon Sep 17 00:00:00 2001 From: Anthony Veaudry Date: Thu, 24 Oct 2024 14:18:09 +0300 Subject: [PATCH 1/3] Adds script to fix links $ cd uppy $ ./bin/check-broken-links.sh The broken links will be written to uppy/link_check_log.txt This script has been tested on Mac OS only. --- .gitignore | 1 + bin/check-broken-links.sh | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100755 bin/check-broken-links.sh diff --git a/.gitignore b/.gitignore index a158168623..71ae30fe4b 100644 --- a/.gitignore +++ b/.gitignore @@ -16,6 +16,7 @@ yarn-error.log .env tsconfig.tsbuildinfo tsconfig.build.tsbuildinfo +link_check_log.txt dist/ lib/ diff --git a/bin/check-broken-links.sh b/bin/check-broken-links.sh new file mode 100755 index 0000000000..068a8be688 --- /dev/null +++ b/bin/check-broken-links.sh @@ -0,0 +1,36 @@ +#!/bin/bash + +# Log file to store the results +LOGFILE="link_check_log.txt" + +# Clear the log file if it exists +> $LOGFILE + +# Base directory where you want to scan (the parent of bin) +BASE_DIR="$(cd "$(dirname "$0")/.." && pwd)" + +# Find all .md files in the project directory and subdirectories, excluding node_modules +find "$BASE_DIR" -path "$BASE_DIR/node_modules" -prune -o -print | while read -r file; do + echo "Scanning $file for broken links..." + + # Make the file path relative to BASE_DIR to remove the './bin/../' part + real_file="${file#$BASE_DIR/}" + + # Use sed to extract URLs from Markdown format ([text](url)) + # This matches URLs within parentheses after a closing square bracket + sed -n 's/.*](\([^)]*\)).*/\1/p' "$file" | while IFS=: read -r url; do + # Get the line number by searching for the URL + line=$(grep -n "$url" "$file" | cut -d: -f1) + + # Check if URL is valid by getting the HTTP status code + status_code=$(curl -o /dev/null --silent --head --write-out "%{http_code}" "$url") + + # Print and log only if status is 404 (error) + if [ "$status_code" -eq 404 ]; then + output="Broken link found: File: $real_file | Line: $line | URL: $url | Status: ERROR (404)" + echo "$output" | tee -a $LOGFILE + fi + done +done + +echo "Link check completed. Results saved in $LOGFILE." | tee -a $LOGFILE From f6d089bef1f1073dfec1c7e8a73d19709ab6ff67 Mon Sep 17 00:00:00 2001 From: Anthony Veaudry Date: Thu, 24 Oct 2024 14:18:49 +0300 Subject: [PATCH 2/3] Fixes broken links --- .github/CONTRIBUTING.md | 2 +- README.md | 4 ++-- packages/@uppy/aws-s3/README.md | 2 +- packages/@uppy/box/README.md | 2 +- packages/@uppy/companion-client/README.md | 7 +++---- packages/@uppy/core/README.md | 2 +- packages/@uppy/dashboard/README.md | 2 +- packages/@uppy/drag-drop/README.md | 2 +- packages/@uppy/dropbox/README.md | 2 +- packages/@uppy/facebook/README.md | 2 +- packages/@uppy/file-input/README.md | 6 +++--- packages/@uppy/form/README.md | 2 +- packages/@uppy/golden-retriever/README.md | 2 +- packages/@uppy/google-drive/README.md | 2 +- packages/@uppy/google-photos/README.md | 2 +- packages/@uppy/image-editor/README.md | 2 +- packages/@uppy/informer/README.md | 2 +- packages/@uppy/instagram/README.md | 2 +- packages/@uppy/locales/README.md | 2 +- packages/@uppy/onedrive/README.md | 2 +- packages/@uppy/progress-bar/README.md | 4 ++-- packages/@uppy/provider-views/README.md | 2 +- packages/@uppy/react-native/README.md | 7 ++++--- packages/@uppy/react/README.md | 2 +- packages/@uppy/redux-dev-tools/README.md | 7 ++++--- packages/@uppy/screen-capture/README.md | 2 +- packages/@uppy/status-bar/README.md | 2 +- packages/@uppy/store-default/README.md | 4 ++-- packages/@uppy/store-redux/README.md | 4 ++-- packages/@uppy/svelte/README.md | 2 +- packages/@uppy/thumbnail-generator/README.md | 7 +++---- packages/@uppy/transloadit/README.md | 2 +- packages/@uppy/tus/README.md | 2 +- packages/@uppy/unsplash/README.md | 2 +- packages/@uppy/url/README.md | 2 +- packages/@uppy/utils/README.md | 2 +- packages/@uppy/vue/README.md | 2 +- packages/@uppy/webcam/README.md | 2 +- packages/@uppy/xhr-upload/README.md | 2 +- packages/@uppy/zoom/README.md | 2 +- 40 files changed, 56 insertions(+), 56 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b20655dea5..362edbf88b 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -477,7 +477,7 @@ You can likely use whatever code generation tool for your framework (ex. of `@uppy/core` to this as your peer dependency required, or you may run into strange issues. Try to include all the components are some of their functionality. -[The React example](https://github.com/transloadit/uppy/blob/main/examples/react-example/App.js) +[The React example](https://github.com/transloadit/uppy/blob/main/examples/react-example/App.tsx) is a great... well example of how to do this well. ### Integrating the build system diff --git a/README.md b/README.md index 097967df65..ce897deed5 100644 --- a/README.md +++ b/README.md @@ -194,8 +194,8 @@ server-side component, is needed for a plugin to work. image previews (included by default with `Dashboard`) - [`Form`](https://uppy.io/docs/form/) — collects metadata from `
` right before an Uppy upload, then optionally appends results back to the form -- [`Redux`](https://uppy.io/docs/redux/) — for your emerging - [time traveling](https://github.com/gaearon/redux-devtools) needs +- [`Redux`](https://uppy.io/docs/guides/custom-stores#reduxstore) — for your + emerging [time traveling](https://github.com/gaearon/redux-devtools) needs ## React diff --git a/packages/@uppy/aws-s3/README.md b/packages/@uppy/aws-s3/README.md index 9274a56519..0d925ca941 100644 --- a/packages/@uppy/aws-s3/README.md +++ b/packages/@uppy/aws-s3/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/aws-s3.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/aws-s3) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/box/README.md b/packages/@uppy/box/README.md index 0b8df87f97..939d7d4616 100644 --- a/packages/@uppy/box/README.md +++ b/packages/@uppy/box/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/box.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/box) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/companion-client/README.md b/packages/@uppy/companion-client/README.md index f66f294661..5aeaa14655 100644 --- a/packages/@uppy/companion-client/README.md +++ b/packages/@uppy/companion-client/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/companion-client.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/companion-client) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) @@ -45,11 +45,10 @@ socket.on('progress', () => {}) $ npm install @uppy/companion-client ``` - +Documentation for this plugin can be found on the +[Uppy website](https://uppy.io/docs/companion). ## License diff --git a/packages/@uppy/core/README.md b/packages/@uppy/core/README.md index 580110f347..b91c2c7a22 100644 --- a/packages/@uppy/core/README.md +++ b/packages/@uppy/core/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/core.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/core) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/dashboard/README.md b/packages/@uppy/dashboard/README.md index 9eb66b92da..0ee113f7b9 100644 --- a/packages/@uppy/dashboard/README.md +++ b/packages/@uppy/dashboard/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/dashboard.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/dashboard) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/drag-drop/README.md b/packages/@uppy/drag-drop/README.md index c1abf835d1..0a274152e8 100644 --- a/packages/@uppy/drag-drop/README.md +++ b/packages/@uppy/drag-drop/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/drag-drop.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/drag-drop) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/dropbox/README.md b/packages/@uppy/dropbox/README.md index 022a3f69cd..29ec493e6a 100644 --- a/packages/@uppy/dropbox/README.md +++ b/packages/@uppy/dropbox/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/dropbox.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/dropbox) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/facebook/README.md b/packages/@uppy/facebook/README.md index b031bfa2a5..44cf4f3c45 100644 --- a/packages/@uppy/facebook/README.md +++ b/packages/@uppy/facebook/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/facebook.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/facebook) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/file-input/README.md b/packages/@uppy/file-input/README.md index db42c0c2a3..0f945daf80 100644 --- a/packages/@uppy/file-input/README.md +++ b/packages/@uppy/file-input/README.md @@ -3,14 +3,14 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/file-input.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/file-input) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) FileInput is the most barebones UI for selecting files—it shows a single button that, when clicked, opens up the browser’s file selector. -**[Read the docs](https://uppy.io/docs/fileinput)** | +**[Read the docs](https://uppy.io/docs/file-input)** | **[Try it](https://uppy.io/examples/xhrupload/)** Uppy is being developed by the folks at [Transloadit](https://transloadit.com), @@ -42,7 +42,7 @@ global `window.Uppy` object. See the ## Documentation Documentation for this plugin can be found on the -[Uppy website](https://uppy.io/docs/fileinput). +[Uppy website](https://uppy.io/docs/file-input). ## License diff --git a/packages/@uppy/form/README.md b/packages/@uppy/form/README.md index 1f006c87b6..b2a8b7f564 100644 --- a/packages/@uppy/form/README.md +++ b/packages/@uppy/form/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/form.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/form) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/golden-retriever/README.md b/packages/@uppy/golden-retriever/README.md index 96eb8494c5..c860bb3fa7 100644 --- a/packages/@uppy/golden-retriever/README.md +++ b/packages/@uppy/golden-retriever/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/golden-retriever.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/golden-retriever) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/google-drive/README.md b/packages/@uppy/google-drive/README.md index 3a9621ca46..49b44eff77 100644 --- a/packages/@uppy/google-drive/README.md +++ b/packages/@uppy/google-drive/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/google-drive.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/google-drive) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/google-photos/README.md b/packages/@uppy/google-photos/README.md index 1d6b73e071..0607bdc34d 100644 --- a/packages/@uppy/google-photos/README.md +++ b/packages/@uppy/google-photos/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/google-photos.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/google-photos) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/image-editor/README.md b/packages/@uppy/image-editor/README.md index ca5281cb74..0cbebbba07 100644 --- a/packages/@uppy/image-editor/README.md +++ b/packages/@uppy/image-editor/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/image-editor.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/image-editor) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/informer/README.md b/packages/@uppy/informer/README.md index 6ce4c13844..e502806699 100644 --- a/packages/@uppy/informer/README.md +++ b/packages/@uppy/informer/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/informer.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/informer) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/instagram/README.md b/packages/@uppy/instagram/README.md index 8cdf192855..acb3c588b9 100644 --- a/packages/@uppy/instagram/README.md +++ b/packages/@uppy/instagram/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/instagram.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/instagram) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/locales/README.md b/packages/@uppy/locales/README.md index cc3431d17f..313ad885b8 100644 --- a/packages/@uppy/locales/README.md +++ b/packages/@uppy/locales/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/locales.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/locales) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/onedrive/README.md b/packages/@uppy/onedrive/README.md index 8a643ee21d..cd5d8e9b59 100644 --- a/packages/@uppy/onedrive/README.md +++ b/packages/@uppy/onedrive/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/facebook.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/facebook) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/progress-bar/README.md b/packages/@uppy/progress-bar/README.md index e711d5c1ea..fdd45bf575 100644 --- a/packages/@uppy/progress-bar/README.md +++ b/packages/@uppy/progress-bar/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/progress-bar.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/progress-bar) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) @@ -40,7 +40,7 @@ global `window.Uppy` object. See the ## Documentation Documentation for this plugin can be found on the -[Uppy website](https://uppy.io/docs/progressbar). +[Uppy website](https://uppy.io/docs/progress-bar). ## License diff --git a/packages/@uppy/provider-views/README.md b/packages/@uppy/provider-views/README.md index 05abb7a42a..f1a9a5ae52 100644 --- a/packages/@uppy/provider-views/README.md +++ b/packages/@uppy/provider-views/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/provider-views.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/provider-views) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/react-native/README.md b/packages/@uppy/react-native/README.md index d5dc65f70f..b54bbd0769 100644 --- a/packages/@uppy/react-native/README.md +++ b/packages/@uppy/react-native/README.md @@ -5,7 +5,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/react-native.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/react-native) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) @@ -21,10 +21,11 @@ help of our server-side component, $ npm install @uppy/react-native ``` + ## License diff --git a/packages/@uppy/react/README.md b/packages/@uppy/react/README.md index b10339f8ff..0ff0b0f867 100644 --- a/packages/@uppy/react/README.md +++ b/packages/@uppy/react/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/react.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/react) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/redux-dev-tools/README.md b/packages/@uppy/redux-dev-tools/README.md index d774af6b19..8763517bae 100644 --- a/packages/@uppy/redux-dev-tools/README.md +++ b/packages/@uppy/redux-dev-tools/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/redux-dev-tools.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/redux-dev-tools) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) @@ -34,10 +34,11 @@ Transloadit’s CDN: Smart CDN. In that case `Uppy` will attach itself to the global `window.Uppy` object. See the [main Uppy documentation](https://uppy.io/docs/#Installation) for instructions. + ## License diff --git a/packages/@uppy/screen-capture/README.md b/packages/@uppy/screen-capture/README.md index 1cb9ae6808..a575e03448 100644 --- a/packages/@uppy/screen-capture/README.md +++ b/packages/@uppy/screen-capture/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/screen-capture.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/screen-capture) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/status-bar/README.md b/packages/@uppy/status-bar/README.md index c0e529a819..2fff3d5a86 100644 --- a/packages/@uppy/status-bar/README.md +++ b/packages/@uppy/status-bar/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/status-bar.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/status-bar) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/store-default/README.md b/packages/@uppy/store-default/README.md index c36cf72f1e..e47ca538b1 100644 --- a/packages/@uppy/store-default/README.md +++ b/packages/@uppy/store-default/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/store-default.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/store-default) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) @@ -38,7 +38,7 @@ global `window.Uppy` object. See the ## Documentation Documentation for this plugin can be found on the -[Uppy website](https://uppy.io/docs/stores#DefaultStore). +[Uppy website](https://uppy.io/docs/guides/custom-stores#defaultstore). ## License diff --git a/packages/@uppy/store-redux/README.md b/packages/@uppy/store-redux/README.md index 0e1fd70113..309818bab0 100644 --- a/packages/@uppy/store-redux/README.md +++ b/packages/@uppy/store-redux/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/store-redux.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/store-redux) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) @@ -48,7 +48,7 @@ global `window.Uppy` object. See the ## Documentation Documentation for this plugin can be found on the -[Uppy website](https://uppy.io/docs/stores#ReduxStore). +[Uppy website](https://uppy.io/docs/guides/custom-stores#reduxstore). ## License diff --git a/packages/@uppy/svelte/README.md b/packages/@uppy/svelte/README.md index d834030fa6..66c75af30f 100644 --- a/packages/@uppy/svelte/README.md +++ b/packages/@uppy/svelte/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/svelte.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/svelte) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/thumbnail-generator/README.md b/packages/@uppy/thumbnail-generator/README.md index 4540ed1e14..be716093dc 100644 --- a/packages/@uppy/thumbnail-generator/README.md +++ b/packages/@uppy/thumbnail-generator/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/thumbnail-generator.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/thumbnail-generator) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) @@ -35,11 +35,10 @@ Transloadit’s CDN: Smart CDN. In that case `Uppy` will attach itself to the global `window.Uppy` object. See the [main Uppy documentation](https://uppy.io/docs/#Installation) for instructions. - +Documentation for this plugin can be found on the +[Uppy website](https://uppy.io/docs/thumbnail-generator). ## License diff --git a/packages/@uppy/transloadit/README.md b/packages/@uppy/transloadit/README.md index 20d21573d9..4900fd2704 100644 --- a/packages/@uppy/transloadit/README.md +++ b/packages/@uppy/transloadit/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/transloadit.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/transloadit) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/tus/README.md b/packages/@uppy/tus/README.md index 79d589e2fc..20b72741e4 100644 --- a/packages/@uppy/tus/README.md +++ b/packages/@uppy/tus/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/tus.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/tus) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/unsplash/README.md b/packages/@uppy/unsplash/README.md index ddd47b0416..37d1384c4b 100644 --- a/packages/@uppy/unsplash/README.md +++ b/packages/@uppy/unsplash/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/unsplash.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/unsplash) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/url/README.md b/packages/@uppy/url/README.md index cec9ad734e..42e5427dc9 100644 --- a/packages/@uppy/url/README.md +++ b/packages/@uppy/url/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/url.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/url) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/utils/README.md b/packages/@uppy/utils/README.md index 506dad0c66..11096c1688 100644 --- a/packages/@uppy/utils/README.md +++ b/packages/@uppy/utils/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/utils.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/utils) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/vue/README.md b/packages/@uppy/vue/README.md index 5f33cb5923..843132c83a 100644 --- a/packages/@uppy/vue/README.md +++ b/packages/@uppy/vue/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/vue.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/vue) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/webcam/README.md b/packages/@uppy/webcam/README.md index 3c60813377..2267475786 100644 --- a/packages/@uppy/webcam/README.md +++ b/packages/@uppy/webcam/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/webcam.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/webcam) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/xhr-upload/README.md b/packages/@uppy/xhr-upload/README.md index 6a101f8c12..de21c973b4 100644 --- a/packages/@uppy/xhr-upload/README.md +++ b/packages/@uppy/xhr-upload/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/xhr-upload.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/xhr-upload) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) diff --git a/packages/@uppy/zoom/README.md b/packages/@uppy/zoom/README.md index a1c5e2be87..43d7578572 100644 --- a/packages/@uppy/zoom/README.md +++ b/packages/@uppy/zoom/README.md @@ -3,7 +3,7 @@ Uppy logo: a smiling puppy above a pink upwards arrow [![npm version](https://img.shields.io/npm/v/@uppy/zoom.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/zoom) -![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg) +![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg) ![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg) ![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg) From 40a31c3255d5e5625ed551a19eec400baf17e9d6 Mon Sep 17 00:00:00 2001 From: Anthony Veaudry Date: Tue, 29 Oct 2024 13:16:40 +0200 Subject: [PATCH 3/3] Revert "Adds script to fix links" This reverts commit 0047aed55328485e0198b958fb3f0a4e9bce924d. --- .gitignore | 1 - bin/check-broken-links.sh | 36 ------------------------------------ 2 files changed, 37 deletions(-) delete mode 100755 bin/check-broken-links.sh diff --git a/.gitignore b/.gitignore index 71ae30fe4b..a158168623 100644 --- a/.gitignore +++ b/.gitignore @@ -16,7 +16,6 @@ yarn-error.log .env tsconfig.tsbuildinfo tsconfig.build.tsbuildinfo -link_check_log.txt dist/ lib/ diff --git a/bin/check-broken-links.sh b/bin/check-broken-links.sh deleted file mode 100755 index 068a8be688..0000000000 --- a/bin/check-broken-links.sh +++ /dev/null @@ -1,36 +0,0 @@ -#!/bin/bash - -# Log file to store the results -LOGFILE="link_check_log.txt" - -# Clear the log file if it exists -> $LOGFILE - -# Base directory where you want to scan (the parent of bin) -BASE_DIR="$(cd "$(dirname "$0")/.." && pwd)" - -# Find all .md files in the project directory and subdirectories, excluding node_modules -find "$BASE_DIR" -path "$BASE_DIR/node_modules" -prune -o -print | while read -r file; do - echo "Scanning $file for broken links..." - - # Make the file path relative to BASE_DIR to remove the './bin/../' part - real_file="${file#$BASE_DIR/}" - - # Use sed to extract URLs from Markdown format ([text](url)) - # This matches URLs within parentheses after a closing square bracket - sed -n 's/.*](\([^)]*\)).*/\1/p' "$file" | while IFS=: read -r url; do - # Get the line number by searching for the URL - line=$(grep -n "$url" "$file" | cut -d: -f1) - - # Check if URL is valid by getting the HTTP status code - status_code=$(curl -o /dev/null --silent --head --write-out "%{http_code}" "$url") - - # Print and log only if status is 404 (error) - if [ "$status_code" -eq 404 ]; then - output="Broken link found: File: $real_file | Line: $line | URL: $url | Status: ERROR (404)" - echo "$output" | tee -a $LOGFILE - fi - done -done - -echo "Link check completed. Results saved in $LOGFILE." | tee -a $LOGFILE