Xgist - Xcode extension to send code to GitHub's Gist

Fernando Bunn

Last update: Jul 2, 2022

Related tags

Xcode Extensions swift gist xcode xcode-plugin developer-tools github-gist xcode-extension

Overview

Xgist

Xgist is a Xcode extension to send code to GitHub's Gist. The extension will send your code selection to Gist and automatically copy the Gist URL into your Clipboard.

Be aware that it will replace your current clipboard with the Gist URL!

Authentication (Optional)

By default Xgist will post your gists as anonymous, but once you open the .app you'll see a login form where you can login to your GitHub account and post authenticated gists.

After you login you'll need to restart Xcode so it will give you the authenticated gist option

Note that Xcode might ask to use your keychain since that's how your GitHub access token is stored.

Youtube demo video

Installation

Easy way

Thanks to Rambo you can download a signed version of the app here:

After opening it, you might need to go to the system preferences app and enable Xgist plugin.

Manual way

Note that by choosing this way you'll need to create your own GitHub app and add your app ID and Secret into the GitHubCredential.swift file

Clone the repo and open Xgist.xcodeproj;
Enable target signing for both the Application and the Source Code Extension using your own developer ID;
Product > Archive;
Right click archive > Show in Finder;
Right click archive > Show Package Contents;
Open Products/Applications;
Drag Xgist.app to your Applications folder and double click on it;
Xgist macOS app will open and install the extension;
Close Xgist.app
Done.

Comments

Keychain access

The extension should only ask for keychain access when signing in or if the user has a token stored. Currently it will ask on the first run since GitHubAPI().isAuthenticated is executed to define what options the extension should display to the user on SourceEditorExtension.swift

opened by Bunn 2
Installation Section

I'd be cool to show on the README how to install the Extension since Xcode extensions can get tricky. Please take a look on how these guys did it.

Once this is fixed, I'll be able to approve your PR on AwesomeiOS

opened by lfarah 1
Sign in with GitHub

Would be good to have an option to sign in on GitHub so the user could choose to save the gists on his/her account instead of always being a anonymous gist.

This will probably require an macOS app for the settings and actual login

opened by Bunn 0

[Brainstorm] Create snippets from gist

Xcode save the snippets on this path ~/Library/Developer/Xcode/UserData/CodeSnippets

And this is a snippet file format:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>IDECodeSnippetCompletionScopes</key>
    <array>
        <string>CodeBlock</string>
    </array>
    <key>IDECodeSnippetContents</key>
    <string>       //CODE GOES HERE
</string>
    <key>IDECodeSnippetIdentifier</key>
    <string>5B59E4B8-2705-48CF-8104-F2EF4C6F7EE4</string>
    <key>IDECodeSnippetLanguage</key>
    <string>Xcode.SourceCodeLanguage.Objective-C</string>
    <key>IDECodeSnippetTitle</key>
    <string>SPIPPET_TITLE</string>
    <key>IDECodeSnippetUserSnippet</key>
    <true/>
    <key>IDECodeSnippetVersion</key>
    <integer>0</integer>
</dict>
</plist>

The app could have a way for the user to select gists from an UI or maybe having some special "tag" on the gists to list as snippets.

opened by Bunn 0

Automatic updates

This is kind of related to #5 : we should add automatic updates to the app. This is kind of problematic because the app is just a container for the Xcode extension, but I think it's doable.

I always use Sparkle on my apps (no need for a package manager, it works fine with just submodules haha). It only requires a XML file with feed of updates and the binary releases, both can be stored on the repo itself.

opened by insidegui 1
Improve language detection

Currently, the extension uses the content UTI to set the extension of the file on Gist, it would be better to detect the language based on the actual contents of the snippet.

opened by insidegui 1

Releases(1.3)

1.3(May 23, 2017)

GitHub authentication
Source code(tar.gz)
Source code(zip)
Xgist.zip(2.40 MB)
1.2(Feb 13, 2017)

Playground highlight support
Source code(tar.gz)
Source code(zip)
1.1(Jan 8, 2017)

Add Xgist URL on gist description
Source code(tar.gz)
Source code(zip)
1.0(Dec 12, 2016)

Source code(tar.gz)
Source code(zip)

Owner

Fernando Bunn

iOS @ DuckDuckGo

GitHub

SwiftInitializerGenerator - Xcode Source Code Extension to Generate Swift Initializers

Swift Initializer Generator This Xcode Source Code Extension will generate a Swift initializer based on the lines you've selected. Handy if you made a

718 Aug 21, 2022

XcodeEquatableGenerator - Xcode 8 Source Code Extension will generate conformance to Swift Equatable protocol based on type and fields selection.

Depricated! There is not need for it at the moment as Swift compiler can do that for us ?? Swift Equatable Generator Xcode 8 Source Code Extension wil