git-touch/highlight.dart

Syntax highlighting for Dart and Flutter

GitTouch

An open-source app for GitHub, GitLab, Bitbucket, Gitea and Gitee(码云), built with Flutter

Installation

Click badges above to install it from Apple App Store or Google Play.

Android users can also download APK file from release page and install it manually.

Screenshots

Supported platforms

#29

✅: Done
🚧: Working in progress
💬: In review

Platform	Public service	API documentation	Status	Custom domain
GitHub	https://github.com	v3(RESTful), v4(GraphQL)	✅	💬
GitLab	https://gitlab.com	GitLab API v4	✅	✅
BitBucket	https://bitbucket.org	BitBucket API	✅	✅
Gogs	https://try.gogs.io/	Gogs API	🚧	✅
Gitea	https://gitea.com/	Gitea API	✅	✅
Gitee	https://gitee.com/	Gitee API	✅	💬

Contributing

See CONTRIBUTING.md.

Contributors

License

Apache-2.0 License

highlight.dart's Issues

Migrate example to AndroidX

PS C:\Users\tusha\code\flutter\highlight\flutter_highlight\example> flutter run
Launching lib\main.dart on ONEPLUS A5000 in debug mode...
[!] Your app isn't using AndroidX.
    To avoid potential build failures, you can quickly migrate your app by following the steps on https://goo.gl/CP92wY

Syntax highlight not works with unenclosed strings.

Hi, I am trying to implement javascript syntax highlight for TextField with a custom TextEditingController here.

I noticed that the library does not work if there are any unenclosed strings except the last line.

For example, It does not work in:

and works in:

It leads to an unpleasant result when typing:

Could you help me look into this? Thank you!

File Missing

example_map.dart is missing from flutter_highlight_gallery/lib/generated

There should be an option to specify a background color that overrides both theme and the default color.

Muitple language support

Can I be able to load multiple language like dart,PHP, vue

Number sign (#) breaks java highlighting

For this input:

class MyClass {
}

we get the correct result:

Add a number sign:

class MyClass {
}#

and nothing is parsed:

Note that language is also null although java is explicitly passed.

Code

import 'package:highlight/highlight_core.dart';
import 'package:highlight/languages/java.dart';

void main() {
  highlight.registerLanguage('java', java);

  const text = '''
class MyClass {
}
''';
  final result = highlight.parse(text, language: 'java');
  print(result.nodes);

  const textNumber = '''
class MyClass {
}#
''';
  final resultNumber = highlight.parse(textNumber, language: 'java');
  print(resultNumber.nodes);
}

Output

[Instance of 'Node', Instance of 'Node', Instance of 'Node']
[Instance of 'Node']

List<String> will be trimed in <pre>

Hi,

I had a same Java code wrapped with <pre> tag, like this:

List<Integer> arr = new List<Integer>;

when I display it in flutter with highlight, it will be trimed to:

List arr = new List;

Is there a method to resovle it?
Thanks!

Extra padding at the bottom of the code block

There is an extra padding or new line in the code block at the bottom. Would it be possible to remove it? The code block is with a light grey background

not working for some langs

I'm playing with the web demo and some languages are not working.

Support Text copy

• flutter_highlight.dart

Change RichText to SelectableText.rich

@override
  Widget build(BuildContext context) {
   /// ....
    return Container(
      color: theme[_rootKey]?.backgroundColor ?? _defaultBackgroundColor,
      padding: padding,
      child: SelectableText.rich(
        TextSpan(
          style: _textStyle,
          children:
              _convert(highlight.parse(source, language: language).nodes!),
        ),
      ),
    );
  }

Automate porting from JavaScript

I understand that this is a port from https://highlightjs.org

I guess the port was automated to some extent, because language files contain the comment:

// GENERATED CODE - DO NOT MODIFY BY HAND

This package now has quite a number of bugs that are not reproducible with the original Highlight.js, like

• #36
• #37

Also I can see no progress on older issues.

Can you please share the process of this porting so anyone can fast-forward the changes in Highlight.js? These then can be contributed here or implemented in a fork. This would solve most of the problems.

Or share any hints if the port was manual.

@pd4d10 @shreyas1599

How to make a HighlightView widget's text selectable?

How to make a HighlightView widget's text selectable?

TextFields support?

Is there anyway I use the syntax highlighter for editable textfields?

Maintenance status?

What is the current maintenance status of this project? There are many PRs pending, some of them being easy-merges. Tagging author: @pd4d10. Maybe it is time to find new maintainers?

Process for adding/modifying languages?

It looks like the language.dart files are all generated somehow. What is the process for adding new langauges?

Code issue

I think you could replace this

final _languages = {}.cast<String, Mode>()

with this

final _languages = <String, Mode>{};

Multiline string literal breaks java highlighting

For this input:

class MyClass {
  private string str = "abc";
}

we get the correct result:

Make this string literal multiline:

class MyClass {
  private string str = """
  abc
  """;
}

and nothing is parsed:

Note that language is also null although java is explicitly passed.

This codepen shows that the original highlightjs can handle multiline string literals: https://codepen.io/alexey-inkin/pen/abYYVOj

Code

import 'package:highlight/highlight_core.dart';
import 'package:highlight/languages/java.dart';

void main() {
  highlight.registerLanguage('java', java);

  const text = '''
class MyClass {
  private string str = "abc";
}
''';
  final result = highlight.parse(text, language: 'java');
  print(result.nodes);

  const textMultiline = '''
class MyClass {
  private string str = """
  abc
  """;
}
''';
  final resultMultiline = highlight.parse(textMultiline, language: 'java');
  print(resultMultiline.nodes);
}

Output

[Instance of 'Node', Instance of 'Node', Instance of 'Node', Instance of 'Node', Instance of 'Node', Instance of 'Node', Instance of 'Node']
[Instance of 'Node']

http, ini, pgsql language broken

I found that the syntax I needed was not highlighted in any way. I decided to check the rest of the languages and found more recognition errors.

flutter_highlight autodetect not working

this needs autoDetection: true https://github.com/git-touch/highlight/blob/master/flutter_highlight/lib/flutter_highlight.dart#L96

line by line parsing (simple change)

Please add line by line parsing ... Below is currently my workaround (I saved the latest continuation and pass it back on the next line parse). The block comments work correctly. But I'm not sure if this is the right way to do this.

index fdab3dc..6cf7c6e 100644
--- a/highlight/lib/src/highlight.dart
+++ b/highlight/lib/src/highlight.dart
@@ -251,7 +251,9 @@ class Highlight {
   /// [autoDetect]: The default value is `false`. Pass `true` to enable language auto detection.
   /// Notice that **this may cause performance issue** because it will try to parse source with
   /// all registered languages and use the most relevant one.
-  Result parse(String source, {String? language, bool autoDetection = false}) {
+  
+  Mode? lastContinuation;
+  Result parse(String source, {String? language, bool autoDetection = false, Mode? continuation}) {
     if (language == null) {
       if (autoDetection) {
         return _parseAuto(source);
@@ -259,7 +261,7 @@ class Highlight {
         throw ArgumentError.notNull('language');
       }
     }
-    return _parse(source, language: language);
+    return _parse(source, language: language, continuation: continuation);
   }
 
   Result _parse(
@@ -369,6 +371,7 @@ class Highlight {
       if (explicit) {
         continuations[top!.subLanguage!.first] = result.top;
       }
+
       return _buildSpan(result.language, result.nodes, noPrefix: true);
     }
 
@@ -378,6 +381,7 @@ class Highlight {
               ? _processSubLanguage()!
               : _processKeywords(),
           currentChildren);
+      lastContinuation = top;
       mode_buffer = '';
     }
 
@@ -404,6 +408,7 @@ class Highlight {
           }
         }
         _startNewMode(new_mode);
+
         return new_mode.returnBegin == true ? 0 : lexeme.length;
       }
 

FormatException: when `language` is null and `autoDetection` is true

source code sample

import 'package:markdown_widget/config/highlight_themes.dart' as theme;

  Widget buildMarkdown() => MarkdownWidget(
        data: data,
        styleConfig: StyleConfig(
          preConfig: PreConfig(
            language: 'java',
            theme: theme.a11yLightTheme
          )
        ),
      );

usage

_convert(hi.highlight.parse(source, language: null, autoDetection: true)

error log

flutter: FormatException: Invalid number (at character 1)

^
flutter: FormatException: Invalid radix-10 number (at character 1)
=
^

flutter doctor

Doctor summary (to see all details, run flutter doctor -v):
[✓] Flutter (Channel stable, v1.17.1, on Mac OS X 10.15.3 19D76, locale zh-Hans-CN)
 
[✓] Android toolchain - develop for Android devices (Android SDK version 29.0.3)
[✓] Xcode - develop for iOS and macOS (Xcode 11.1)
[✓] Android Studio (version 3.6)
[✓] VS Code (version 1.43.1)
[✓] Connected device (1 available)

Line Number Support

Support for line numbers in files?

Add GDScript as language

I wanted to add Godots GDScript to the supported languages. For testing purposes I just copied the python implementation and replaced some keywords and it seems to work fine enough.

As the language files have stated // GENERATED CODE - DO NOT MODIFY BY HAND at the top I came to thinking that those language files are generated somehow. As I couldn't find documenation in how to generate another language I stopped work there.

Are those files somehow generated by converting the available languages from highlight.js? If so there is the 3rd party package highlightjs-gdscript which could be used.

If this is not the way to go then how to add languages to highlight.dart?

Is it possible to set highlight block to full width?

Hello,

I use these plugin in my app, it's great!
This is the preview image:

So I'd like to know if I can set the code block as full width?

Thanks!

Double quotes (") are not escaped

As far as I understand, double quotes (") should be escaped with " in the generated HTML.
<, > and & are correctly escaped.

import 'package:highlight/highlight.dart' show highlight;

main() {
  var source = '''main() {
  print("Hello <> World!");
}
''';

  var result = highlight.parse(source, language: 'dart');
  var html = result.toHtml();
  print(html); // HTML string
}

Actual output is:

<span class="hljs-built_in">print</span>(<span class="hljs-string">"Hello &lt;&gt; World!"</span>);

Expected output is:

<span class="hljs-built_in">print</span>(<span class="hljs-string">&quot;Hello &lt;&gt; World!&quot;</span>);

Html Highlights

There are no html Highlights

Add method to get the List of TextSpan

Not that everytime we need the whole container, can you add method just to get the List of TextSpans?

NNBD migration

Are there any plans to migrate these packages to non-nullable-by-default?

Using highlighting in Orgro

Hi,

Is it possible to use different code files in Orgro for better viewing?

Where can elaborate steps be seen?

Thanks
Nehal

Add method to get a `TextEditingController`

Only a widget can be accessed for now. Access to a TextEditingController based class that style it's text could be added. It would allow any TextField to highlight syntax.

We forked this package and have fixed many bugs

This project seems abandoned, so we forked it and did the following:

• Updated to the recent HighlightJS 11.8 (was 9.18). A lot of bugs were fixed by this.
• Improved the API by adding Language class in addition to Mode to better mimic the original HighlightJS classes.
• Improved the porting script so it is easier to understand.
• Described the process here: https://medium.com/akvelon/how-we-ported-highlightjs-to-dart-82b107415fbd

The new package is published as:

1. https://pub.dev/packages/highlighting
2. https://pub.dev/packages/flutter_highlighting

We intend to maintain our fork.
See the migration guide: https://github.com/akvelon/dart-highlighting/blob/main/doc/migrating.md

(Posting this here as there seems to be no other way to inform the users of the package who are in need of changes.)

Missing highlights

I'm not sure if it's missing highlights for the Dart language or in general. On the line var foo = Foo();, I would expect Foo to be highlighted.

As well as variable invocation