Hello,

I've tried using this plugin without success on Windows 7x64 with Sublime 3. I've found a working solution but first, here's the traceback:

Traceback (most recent call last):
  File "C:\Program Files\Sublime Text 3\sublime_plugin.py", line 543, in run_
    return self.run(edit, **args)
  File "C:\Users\Gabriel\AppData\Roaming\Sublime Text 3\Packages\API Blueprint\APIBlueprint.py", line 85, in run
    result = run_command ("snowcrash", args=args, source=source)
  File "C:\Users\Gabriel\AppData\Roaming\Sublime Text 3\Packages\API Blueprint\APIBlueprint.py", line 39, in run_command
    stat = proc.communicate(input=source)
  File "X/subprocess.py", line 906, in communicate
  File "X/subprocess.py", line 1180, in _communicate
TypeError: 'str' does not support the buffer interface

This error is very common and related to Python string encoding.

My solution was to completely remove win32 code in APIBlueprint.py in def run_command() and then it worked:

def run_command(cmd, args = [], source="", cwd = None, env = None):
  settings = sublime.load_settings('APIBlueprint.sublime-settings')

  if not type(args) is list:
    args = [args]

  #if sys.platform == "win32":
    #proc = Popen([cmd]+args, env=env, cwd=cwd, stdout=PIPE, stdin=PIPE, stderr=PIPE, shell=True)
    #stat = proc.communicate(input=source)

  #else:
  if env is None:
    env = {"PATH": settings.get('binDir', '/usr/local/bin')}

    command = [cmd] + args

    proc = Popen(command, env=env, cwd=cwd, stdin=PIPE, stdout=PIPE, stderr=PIPE)
    stat = proc.communicate(input=source.encode('utf-8'))

  okay = proc.returncode == 0

  #remove leading empty line
  lines = stat[1].decode('UTF-8').split('\n')
  if not lines[0]:
    lines.pop(0)
  sanitized_errout = '\n'.join(lines)

  return {"okay": okay, "out": stat[0].decode('UTF-8'), "err": sanitized_errout}

Installing apiblueprint from package control and accessing an .apib gives:

SublimeLinter: ERROR:

apiblueprint: Defining 'cls.selectors' has no effect anymore. Use http://www.sublimelinter.com/en/stable/linter_settings.html#selector instead.

SublimeLinter: ERROR:

apiblueprint disabled. 'selector' is mandatory in 'cls.defaults'.
See http://www.sublimelinter.com/en/stable/linter_settings.html#selector

I have markdown extended installed, snowcrash installed, monokai extended install, but still the only thing this plugin highlits is "HOST".

Here's the screenshot

Hello -

I really like apiaryio & sublime, so I would love to combine both :)

Unfortunately, the syntax highlighting does not work for me:

• sublime text2
• fresh install of snowcrash, generation of AST works fine
• only highlights are the resource names (the User bit from [User][] is shown in yellow

Any ideas on how to get more highlighting and/or description of what I could expect?

Thanks in advance!

I can maybe look into this as it'll be rather Python thing and I'm annoyed by the fact I can't install it instantly from the editor (or find it! previously I did not know it exists, because it wasn't showing up in search...).

I've created a build system for sublime text that creates HTML via agilo via ctrl+B shortcut.
link: https://github.com/sajadabasi/api-blueprint-sublime-build-system

The docs for API Blueprint suggest comments should be HTML style:

<!-- This is a comment -->

but the linter highlights it as an unrecognised block.

i've just installed the plugin and it's not clear to me as to how to use the ast file resulting from the parse command. specifically, i see the following warnings:

warning: (3)  unable to parse additional parameter traits, expected '([required | optional], [<type>], [`<example value>`])', e.g. '(optional, string, `Hello World`)' :21574:234
warning: (6)  empty response message-body :25880:13

while the error text is simple enough to understand, it's not clear where i'm looking for each one. it would be helpful then to provide some explanation of the warnings/errors and provide an example error/explanation in the read me.

It seems like current code folding markers are just the one inherited from Markdown. We could improve this one a lot on Resource Groups, Groups and so on.

I've followed all installation steps and installed all plugins successfully. However, autocomplete and highlighting doesn't seem to work. I can still parse the file and open result AST though.

I'm not a Sublime user. Am I missing any settings or configuration assumed in the installation instructions?

EDIT:
I've got some coloring selecting:
Preferences > Color Scheme > Monokai Extended > Monokai Extended

However, no autocompletion yet...

Part of the MSON spec but not yet supported by this plugin.
https://apiblueprint.org/documentation/mson/specification.html#353-type-attribute

after execute Ctrl + Shft + b
it opens a new tab: anf this is shown:

OK.

_version: 1.0
metadata:
HOST:
value: "http://..../"
name: "..."
description: "..."
resourceGroups:

.....

But I don't understand this output, I don't see any, no prview :(

As seen in the screenshot, both date strings should be completely rendered in the same color.

The MSON being used:

- sys
    - type: Space
    - id: cfexampleapi
    - version: 3 (number)
    - createdBy
        - sys
            - type: Link
            - linkType: User
            - id: 7BslKh9TdKGOK41VmLDjFZ
    - createdAt: `2013-06-23T19:02:00Z`
    - updatedBy
        - sys
            - type: Link
            - linkType: User
            - id: 7BslKh9TdKGOK41VmLDjFZ
    - updatedAt: `2014-07-09T07:18:20Z`
- name: Contentful Example API

See apiaryio/api-blueprint#202. Sample at line 126.

Code-blocks within list items (i-e, blocks that are indented by 4 spaces inside a list item) are not marked as code blocks, so underscores and other markdown syntax still work and cause the code not to be rendered correctly.

Example

+ Model (application/json)

        {
            "_id": "963bc95f1c1a56f69f3392b4aa03302f",
            "foo": "_bar"
        }

Moved from apiaryio/api-blueprint#241

application/json; charset=utf-8 is what Express is returning for res.json()

It should be grey.

It's weird, because this regex https://github.com/apiaryio/api-blueprint-sublime-plugin/blob/master/APIBlueprint.tmLanguage#L183

([-+*]) ([Rr]equest|[Rr]esponse) (\d+)? ?\(?(\(.*)\)?

matches it correctly

This plugin does not highlight the schema body. If you replace Schema with Body, the highlighting comes back.

I had a look at the source and can't seem to figure out why (my sublime plugin skills are not great though).

I'm using Mac.

1. Installed the plugin using Package Control.
2. Opened arbitrary apiary.apib file.
3. Selected "API Blueprint" highlighting.
4. Text is still not highlighted. Here and there, one or two words get some color, but the coloring does not make much sense or seem to be very helpful. Nothing from Markdown gets highlighted.