• Stars
    star
    308
  • Rank 135,712 (Top 3 %)
  • Language
    Ruby
  • License
    MIT License
  • Created about 9 years ago
  • Updated about 8 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

:octocat: Correct README Redirects

Frankenstein

frankenstein checks for live URLs in a file, it can update links based on HTTP redirects in a README :octocat:

This project uses awesome_bot to validate links.

Build Status

Installation

git clone https://github.com/dkhamsing/frankenstein.git
cd frankenstein
rake install

Usage

$ frankenstein https://fastlane.tools # URL
$ frankenstein README.md # Path to file
$ frankenstein ccgus/fmdb # GitHub repo README, https://github.com/ccgus/fmdb works too

Found: master for ccgus/fmdb — A Cocoa / Objective-C wrapper around SQLite — 8935⭐️  — last updated today
🏃  Processing links for ccgus/fmdb ...
🔎  Checking 18 links
✅  https://www.zetetic.net/sqlcipher/
✅  http://sqlite.org/
✅  https://cocoapods.org/
✅  https://github.com/marcoarment/FCModel
✅  https://github.com/layerhq/FMDBMigrationManager
#...
🕐  Time elapsed: 4.07 seconds

🏃  No failures for ccgus/fmdb
✅ 200 ok
🔶 3xx redirect
🔴 4xx error
⚪ white list / other

Correct GitHub README Redirects

frankenstein can open a pull request to update README links based on HTTP redirects (this requires credentials set in .netrc).

$ frankenstein fastlane/sigh

Finding default branch for fastlane/sigh
Found: master for fastlane/sigh — Because you would rather spend your time building stuff than fighting provisioning — 864⭐️  — last updated 8 days ago
🏃  Processing links for https://raw.githubusercontent.com/fastlane/sigh/master/README.md ...
🔎  Checking 21 links
🔶  301 https://github.com/KrauseFx/fastlane
🔶  301 https://github.com/KrauseFx/deliver
#...
🔶  10 redirects
https://github.com/KrauseFx/fastlane redirects to
https://github.com/fastlane/fastlane
#...
Next? (pull request | white list w=<s1^s2..> | gist | tweet [-h] [message] | enter to end) p
Creating pull request on GitHub for fastlane/sigh ...
Pull request created: https://github.com/fastlane/sigh/pull/195

White List

  • URLs that are meant to be redirected (i.e. URL shortener, badge, authentication) are white listed and not corrected.

  • You can also white list links at the end of a run with option w.

$ frankenstein dkhamsing/forker

Finding default branch for dkhamsing/forker
Found: wip for dkhamsing/forker — Fork GitHub repos found on a page — 0⭐️  — last updated today
🏃  Processing links for dkhamsing/forker ...
🔎  Checking 10 links
✅  https://github.com/opensourceios
#...
🔶  1 redirect
http://gph.is/1768v38 redirects to
http://giphy.com/gifs/loop-factory-how-its-made-n1JN4fSrXovJe
#...
🕐  Time elapsed: 2.56 seconds

🏃  No failures for dkhamsing/forker

Next? (pull request | white list w=<s1^s2..> | gist | tweet [-h] [message] | enter to end) w=gph
#...

Contact

License

This project is available under the MIT license. See the LICENSE file for more info.

More Repositories

1

open-source-ios-apps

📱 Collaborative List of Open-Source iOS Apps
41,887
star
2

awesome_bot

✅ Validate links in awesome projects
Ruby
826
star
3

ios-asset-names

📐 Guide to name iOS assets
Swift
670
star
4

ScrollTab

Scrolling Tab for iOS
Objective-C
267
star
5

dkhamsing.github.io

:octocat: My GitHub Page
Ruby
221
star
6

news

📰 iOS news app in the style of Apple News, CNN, BBC, Facebook, NYT, Twitter, Reddit & more
Swift
217
star
7

TabDump

📰 TabDump app for iOS
Objective-C
98
star
8

osia

:octocat: iOS app to browse open-source-ios-apps
Swift
88
star
9

apns-guide

🔔 Guide to setup APNS
86
star
10

DKImageBrowser

iOS Image Browser with a Thumbnail Strip
Objective-C
56
star
11

stocks

📈 Basic iOS app to track stocks (data from Finnhub, Tiingo, or IEX Cloud)
Swift
42
star
12

covid19.swift

🌐 Small iOS app to show some COVID-19 health, data, news and tweets
Swift
27
star
13

listapp.ios

✨ Basic lists from iOS 2 to iOS 15
Swift
27
star
14

fastmdb

🔍 Fast iOS app to browse and search movies, tv, actors, credits
Swift
22
star
15

how-much

💰 iOS price list app using Firebase, Realm & more
Objective-C
21
star
16

xcode-readme

🔍 Correct the spelling of Xcode in a README
Ruby
10
star
17

GitHubOAuthController

:octocat: Simple GitHub OAuth Controller for iOS
Objective-C
10
star
18

cocoapods-readme

🔍 Correct the spelling of CocoaPods in a README
Ruby
9
star
19

pdf_xcassets

🚋 Generate Xcode xcassets for PDF assets
Ruby
8
star
20

upcomingtv

📆 iOS app to track when your favorite tv show airs next
Swift
8
star
21

github-readme

:octocat: Get the README from a GitHub repo
Ruby
6
star
22

update_profile_pic

👤 Update your Twitter profile pic in a snap
Ruby
6
star
23

delete_my_tweets

🐤 Delete my tweets
Ruby
5
star
24

markdown_html

📄 The simplest way to convert Markdown to HTML
Ruby
4
star
25

readme-correct

😁 Fix GitHub typos with ease
Ruby
4
star
26

tumblr_uploadr

🐼 Tumblr photo batch uploader
Ruby
3
star
27

forker

🍴 Fork GitHub repos found on a page
Ruby
2
star
28

covid19cli

⚡ Quick CLI for COVID-19 data
Ruby
2
star
29

twitter_oauth_token

✋ Twitter OAuth token Ruby library
Ruby
1
star