snippets 0.4.3
snippets: ^0.4.3 copied to clipboard

Published 10 months ago •

flutter.devDart 3 compatible

discontinued

SDKDart Flutter

PlatformAndroid iOS Linux macOS Windows

→

Metadata

A package for parsing and manipulating code samples in Flutter repo dartdoc comments.

More...

likes

130/ 160

pub points

123

downloads

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

Follow Dart file conventions

20 / 30

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

Repository URL doesn't exist.

At the time of the analysis https://github.com/flutter/assets-for-api-docs/tree/main/packages/snippets was unreachable. Make sure that the website is reachable via HEAD requests.

Issue tracker URL doesn't exist.

At the time of the analysis https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+snippets%22 was unreachable. Make sure that the website is reachable via HEAD requests.

Failed to verify repository URL.

Please provide a valid repository URL in pubspec.yaml, such that:

repository can be cloned,
a clone of the repository contains a pubspec.yaml, which:,
- contains name: snippets,
- contains a version property, and,
- does not contain a publish_to property.

Repository has no matching pubspec.yaml with name: snippets.

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: BSD-3-Clause.

Provide documentation

20 / 20

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

71 out of 147 API elements (48.3 %) have documentation comments.

Some symbols that are missing documentation: snippets, snippets.ApplicationSample.ApplicationSample.fromFile, snippets.ApplicationSample.type, snippets.CodeSample.CodeSample.fromFile, snippets.CodeSample.args.

10/10 points: Package has an example

Platform support

20 / 20

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

✓ Android
✓ iOS
✓ Windows
✓ Linux
✓ macOS

These platforms are not supported:

Package not compatible with platform Web

Because:

package:snippets/snippets.dart that imports:
package:snippets/src/util.dart that imports:
package:snippets/src/data_types.dart that imports:
package:file/file.dart that imports:
package:file/src/interface.dart that imports:
package:file/src/io.dart that imports:
dart:io

0/0 points: WASM compatibility

Package not compatible with runtime wasm

Because:

package:snippets/snippets.dart that imports:
package:snippets/src/util.dart that imports:
package:snippets/src/data_types.dart that imports:
package:file/file.dart that imports:
package:file/src/interface.dart that imports:
package:file/src/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 6 issues. Showing the first 2:

INFO: Use 'TypeName _' instead of a type literal.

lib/src/snippet_generator.dart:352:12

    ╷
352 │       case DartpadSample:
    │            ^^^^^^^^^^^^^
    ╵

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

INFO: Use 'TypeName _' instead of a type literal.

lib/src/snippet_generator.dart:353:12

    ╷
353 │       case ApplicationSample:
    │            ^^^^^^^^^^^^^^^^^
    ╵

To reproduce make sure you are using the lints_core and run dart analyze lib/src/snippet_generator.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
`analyzer`	`^6.4.1`	6.11.0	7.1.0
`args`	`^2.4.2`	2.6.0	2.6.0
`dart_style`	`^2.3.4`	2.3.7	3.0.1
`file`	`^7.0.0`	7.0.1	7.0.1
`interval_tree`	`^0.4.1`	0.4.1	0.4.1
`meta`	`^1.12.0`	1.16.0	1.16.0
`path`	`^1.9.0`	1.9.1	1.9.1
`platform`	`^3.1.4`	3.1.6	3.1.6
`process`	`^5.0.2`	5.0.3	5.0.3
`pub_semver`	`^2.1.4`	2.1.5	2.1.5
`quiver`	`^3.2.1`	3.2.2	3.2.2
`recase`	`^4.1.0`	4.1.0	4.1.0

Transitive dependencies

Package	Constraint	Compatible	Latest
`_fe_analyzer_shared`	-	76.0.0	78.0.0
`_macros`	-	0.3.3	0.3.3
`async`	-	2.12.0	2.12.0
`boolean_selector`	-	2.1.2	2.1.2
`collection`	-	1.19.1	1.19.1
`convert`	-	3.1.2	3.1.2
`crypto`	-	3.0.6	3.0.6
`glob`	-	2.1.2	2.1.2
`lints`	-	3.0.0	5.1.1
`macros`	-	0.1.3-main.0	0.1.3-main.0
`matcher`	-	0.12.17	0.12.17
`package_config`	-	2.1.1	2.1.1
`source_span`	-	1.10.1	1.10.1
`stack_trace`	-	1.12.1	1.12.1
`stream_channel`	-	2.1.3	2.1.3
`string_scanner`	-	1.4.1	1.4.1
`term_glyph`	-	1.2.2	1.2.2
`test_api`	-	0.7.4	0.7.4
`typed_data`	-	1.4.0	1.4.0
`watcher`	-	1.1.1	1.1.1
`yaml`	-	3.1.3	3.1.3