markdown_syntax_highlighter 1.1.0
markdown_syntax_highlighter: ^1.1.0 copied to clipboard

Published 3 years ago •

gsmlg.devDart 3 compatible

SDKFlutter

PlatformAndroid iOS Linux macOS web Windows

→

Metadata

syntax highlighter for flutter markdown.

More...

likes

120/ 160

pub points

downloads

We analyzed this package 5 days ago, and awarded it 120 pub points (of a possible 160):

Follow Dart file conventions

20 / 30

0/10 points: Provide a valid `pubspec.yaml`

The package description is too short.

Add more detail to the description field of pubspec.yaml. Use 50 to 180 characters to describe the package, what it does, and its target use case.

5/5 points: Provide a valid `README.md`

5/5 points: Provide a valid `CHANGELOG.md`

10/10 points: Use an OSI-approved license

Detected license: Apache-2.0.

Provide documentation

10 / 20

0/10 points: 20% or more of the public API has dartdoc comments

1 out of 16 API elements (6.3 %) have documentation comments.

Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API. Document at least 20% of the public API elements.

To highlight public API members missing documentation consider enabling the public_member_api_docs lint.

Some symbols that are missing documentation: markdown_syntax_highlighter, markdown_syntax_highlighter.DartSyntaxHighlighter, markdown_syntax_highlighter.DartSyntaxHighlighter.DartSyntaxHighlighter.new, markdown_syntax_highlighter.SyntaxHighlighterStyle, markdown_syntax_highlighter.SyntaxHighlighterStyle.SyntaxHighlighterStyle.new.

10/10 points: Package has an example

Platform support

20 / 20

20/20 points: Supports 6 of 6 possible platforms (iOS, Android, Web, Windows, macOS, Linux)

✓ Android
✓ iOS
✓ Windows
✓ Linux
✓ macOS
✓ Web

0/0 points: WASM compatibility

Package not compatible with runtime wasm

Because:

package:markdown_syntax_highlighter/markdown_syntax_highlighter.dart that imports:
package:markdown_syntax_highlighter/src/syntax_highlighter.dart that imports:
package:flutter_markdown/flutter_markdown.dart that imports:
package:flutter_markdown/src/widget.dart that imports:
package:flutter_markdown/src/_functions_io.dart that imports:
dart:io

This package is not compatible with runtime wasm, and will not be rewarded full points in a future version of the scoring model.

See https://dart.dev/web/wasm for details.

Pass static analysis

40 / 50

40/50 points: code has no errors, warnings, lints, or formatting issues

Found 14 issues. Showing the first 2:

INFO: Statements in an if should be enclosed in a block.

lib/src/syntax_highlighter.dart:145:11

    ╷
145 │ ┌           formattedText
146 │ └               .add(TextSpan(text: _src.substring(currentPosition, span.start)));
    ╵

To reproduce make sure you are using the lints_core and run flutter analyze lib/src/syntax_highlighter.dart

INFO: Statements in an if should be enclosed in a block.

lib/src/syntax_highlighter.dart:155:9

    ╷
155 │ ┌         formattedText
156 │ └             .add(TextSpan(text: _src.substring(currentPosition, _src.length)));
    ╵

To reproduce make sure you are using the lints_core and run flutter analyze lib/src/syntax_highlighter.dart

Support up-to-date dependencies

30 / 40

0/10 points: All of the package dependencies are supported in the latest version

Package	Constraint	Compatible	Latest	Notes
`flutter_markdown`	`^0.6.9+1`	0.6.23	0.7.7+1	Discontinued
`string_scanner`	`^1.0.4`	1.4.1	1.4.1

Transitive dependencies

Package	Constraint	Compatible	Latest
`args`	-	2.7.0	2.7.0
`characters`	-	1.4.0	1.4.1
`collection`	-	1.19.1	1.19.1
`markdown`	-	7.3.0	7.3.0
`material_color_utilities`	-	0.11.1	0.13.0
`meta`	-	1.16.0	1.17.0
`path`	-	1.9.1	1.9.1
`source_span`	-	1.10.1	1.10.1
`term_glyph`	-	1.2.2	1.2.2
`vector_math`	-	2.1.4	2.2.0