Skip to content

Resolving 'type' and 'enum', Allow choosing the channel of the documents #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zdevwu wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Resolving 'type' and 'enum', Allow choosing the channel of the documents #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b139d09
Resolving 'type' and 'enum' as well as ['struct','trait','fn']
zdevwu Jun 16, 2016
2239243
Allow choosing the channel from which the document will be searched
zdevwu Jun 16, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions lib/docs-resolver.coffee
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,18 @@ module.exports = DocsResolver =
@searchMathingDocs(path, callback)

searchMathingDocs: (path, callback) ->
for objectType in ['struct','trait','fn']
for objectType in ['type','enum','struct','trait','fn']
@assertPageAvailability(path, "#{objectType}.$1.html", callback)
@assertModulePageAvailability(path, callback)

assertModulePageAvailability: (path, callback) -> @assertPageAvailability(path, "$1/index.html", callback)

assertPageAvailability: (path, resourceEndFormat, callback) ->
channel = atom.config.get('rust-api-docs-helper.rustChannel')
p = path.replace(/(\w*?)$/, resourceEndFormat)
req = new XMLHttpRequest()
req.onloadend = @onLoadEnd(path, @cache, callback)
req.open("HEAD","http://doc.rust-lang.org/#{p}")
req.open("HEAD","http://doc.rust-lang.org/#{channel}/#{p}")
req.send()

onLoadEnd: (path, cache, callback) -> (e) ->
Expand Down
7 changes: 7 additions & 0 deletions lib/rust-api-docs-helper.coffee
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ Shell = require 'shell'

module.exports = RustApiDocsHelper =
config:
rustChannel:
type: 'string'
description: """
The distribution channel from which the document will be searched
"""
enum: ['stable','beta','nightly']
default: 'stable'
useInternalBrowser:
type:'boolean'
description: """If set, a URL open request will be sent, that will attempt to open the docs URL within atom,
Expand Down