Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore/doc improvements #164

Merged
merged 14 commits into from
Jan 24, 2024

Update test

535c991
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
Merged

Chore/doc improvements #164

Update test
535c991
Select commit
Loading
Failed to load commit list.
GitHub Actions / Analysis of mix succeeded Jan 24, 2024 in 2m 39s

Package analysis results for mix

Score

125/140 points
(89.28571428571429%)

Supported platforms

  • Flutter
    • android
    • ios
    • windows
    • linux
    • macos
    • web

Details

Follow Dart file conventions (25/30)

✔ 10/10 points: Provide a valid pubspec.yaml

❌ 0/5 points: Provide a valid README.md

Links in `README.md` should be secure. 1 link is insecure.

README.md:71:48

   ╷
71 │ <td align="center" valign="top" width="14.28%"><a href="http://eduardom.dev"><img src="https://avatars.githubusercontent.com/u/29983481?v=4?s=50" width="50px;" alt="Eduardo M."/><br /><sub><b>Eduardo M.</b></sub></a><br /><a href="https://github.com/conceptadev/mix/commits?author=aguilaair" title="Code">💻</a></td>
   │                                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   ╵

Use https URLs instead.

✔ 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

475 out of 1672 API elements (28.4 %) have documentation comments.

Some symbols that are missing documentation: mix, mix.$colors, mix.$md, mix.$radii, mix.$space.

✔ 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

Pass static analysis (40/50)

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

INFO: 'textScaleFactor' is deprecated and shouldn't be used. Use textScaler instead. Use of textScaleFactor was deprecated in preparation for the upcoming nonlinear text scaling support. This feature was deprecated after v3.12.0-2.0.pre.

lib/src/specs/text/text_widget.dart:113:7

    ╷
113 │       textScaleFactor: spec.textScaleFactor,
    │       ^^^^^^^^^^^^^^^
    ╵

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

Support up-to-date dependencies (20/20)

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

Package Constraint Compatible Latest
flutter flutter 0.0.0 0.0.0
Transitive dependencies
Package Constraint Compatible Latest
characters - 1.3.0 1.3.0
collection - 1.18.0 1.18.0
material_color_utilities - 0.5.0 0.8.0
meta - 1.10.0 1.11.0
sky_engine - 0.0.99 0.0.99
vector_math - 2.1.4 2.1.4
web - 0.3.0 0.4.2

To reproduce run dart pub outdated --no-dev-dependencies --up-to-date --no-dependency-overrides.

✔ 10/10 points: Package supports latest stable Dart and Flutter SDKs

Versions