@gbbr, I just updated branch r3.0 to compile against the latest nodb branch of go-sourcegraph. When that is merged, can you merge r3.0 into master?

This is more of me not understanding how to use this package, but I'm not finding any css in here. Are we supposed to bring our own?

For example, compare the way github displays simple.go:

https://github.com/sourcegraph/syntaxhighlight/blob/master/testdata/simple.go

Versus the output html of this package for that simple.go file:

https://rawgithub.com/sourcegraph/syntaxhighlight/master/testdata/simple.go.html

Are we supposed to create the css ourselves from scratch, or are there any existing ones that can be used?

Also, all the newlines are missing. Is it because the css is missing or another reason?

Thanks!

Hi,

I'm trying to use the public interface/API of this package externally, but this API could be better:

const (
    WHITESPACE = iota
    STRING
    KEYWORD
    COMMENT
    TYPE
    LITERAL
    PUNCTUATION
    PLAINTEXT
    TAG
    HTMLTAG
    HTMLATTRNAME
    HTMLATTRVALUE
    DECIMAL
)

First, it's not idiomatic Go style to use ALLCAPS; these consts should be Whitespace, etc. See style guide section on Mixed Caps. As far as I can tell, it will not cause naming conflicts inside the package.

Second, these kind values are untyped constants.

I'd prefer if they were typed, for example syntaxhighlight.Kind, so that I can use that type in a struct in my package.

According to http://godoc.org/github.com/sourcegraph/syntaxhighlight?importers, the only public importers of this package are all my packages. Do you use the current WHITESPACE, etc. outside this package?

Do you agree it would be an improvement and would you take a PR that changes the above code to something like this?

// Kind represents a syntax highlighting class which will be assigned to elements. A style will assign visual properties to each kind.
type Kind uint8

const (
    Whitespace Kind = iota
    String
    Keyword
    Comment
    Type
    Literal
    Punctuation
    Plaintext
    Tag
    HTMLTag
    HTMLAttrName
    HTMLAttrValue
    Decimal
)

Also, Keywords probably does not need to be exported, does it? Unless users of this package are meant to be able to make changes to it (if it's meant to be exported, it should be documented, it's currently not).

I am writing a debugger for Go and came across this project via Dmitri Shuralyov and his use of this which uses go/scanner.

One improvement I'd like to see is more fined-grained control over what gets tagged. Rather than reinvent stuff when not necessary, I consulted Pygments to see what it has.

This is from pygments/formatters/terminal.py;

    Whitespace:         ('lightgray',   'darkgray'),
    Comment:            ('lightgray',   'darkgray'),
    Comment.Preproc:    ('teal',        'turquoise'),
    Keyword:            ('darkblue',    'blue'),
    Keyword.Type:       ('teal',        'turquoise'),
    Operator.Word:      ('purple',      'fuchsia'),
    Name.Builtin:       ('teal',        'turquoise'),
    Name.Function:      ('darkgreen',   'green'),
    Name.Namespace:     ('_teal_',      '_turquoise_'),
    Name.Class:         ('_darkgreen_', '_green_'),
    Name.Exception:     ('teal',        'turquoise'),
    Name.Decorator:     ('darkgray',    'lightgray'),
    Name.Variable:      ('darkred',     'red'),
    Name.Constant:      ('darkred',     'red'),
    Name.Attribute:     ('teal',        'turquoise'),
    Name.Tag:           ('blue',        'blue'),
    String:             ('brown',       'brown'),
    Number:             ('darkblue',    'blue'),

There are some things above that aren't relevant to Go (but you might want to add them for other languages), and there are some things that should be added above for go like Rune, possibly Case label and so on. So here is a list below:

• Whitespace
• Comment
• Keyword
• Type name
• Built in
• Function
• Variable
• Exported name
• Number
• Rune

Kind is a uint8 so there is plenty of space to add constants to this.

If you would like me to create a pull request for this, let me know.

Thanks.

This issue is largely documented downstream at shurcooL/go#19 (comment), but to quickly summarize:

After #11 was merged, syntaxhighlight package now indirectly imports an extremely large number of imports that are largely unrelated and unneeded to the core functionality of this package.

https://godoc.org/github.com/sourcegraph/syntaxhighlight?import-graph&hide=1

The vast majority of that is coming from the two imports sourcegraph.com/sourcegraph/go-sourcegraph/sourcegraph and sourcegraph.com/sourcegraph/vcsstore/vcsclient which are only needed to pull in the following types:

• vcsstore.FileWithRange
• sourcegraph.SourceCode
• sourcegraph.SourceCodeLine
• sourcegraph.SourceCodeToken

Despite those types being small, the packages that contain them are higher level and import many other dependencies.

We should fix this so that users of syntaxhighlight that only need the core functionality and do not use the NilAnnotator should not need to pull in that many dependencies.

Would you be interested in accepting iafan@0da6819 as a PR?

This commit introduces AsOrderedListHTML function which, in addition to highlighting the source, wraps each line in <li>..</li>, and then adds <ol>..</ol> global wrapper. The resulting highlighted source code now has line numbers.

Commit comes with full test coverage.

This issue contains a list of Renovate updates and their statuses.

This repository currently has no open or pending branches.

• Check this box to trigger a request for Renovate to run again on this repository