gitbook_search 0.0.1 copy "gitbook_search: ^0.0.1" to clipboard
gitbook_search: ^0.0.1 copied to clipboard

A wrapper API for GitBook to search across pages and spaces. Useful for Saas or products with a search bar for docs and knowledge base.

4
likes
130/ 160
pub points
31
downloads

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

Passed report section
Follow Dart file conventions
30 / 30trigger folding of the section

Passed check 10/10 points: Provide a valid pubspec.yaml

Passed check 5/5 points: Provide a valid README.md

Passed check 5/5 points: Provide a valid CHANGELOG.md

Passed check 10/10 points: Use an OSI-approved license

Detected license: Apache-2.0.

Failed report section
Provide documentation
10 / 20trigger folding of the section

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

45 out of 85 API elements (52.9 %) have documentation comments.

Some symbols that are missing documentation: gitbook_search.AIAnswer, gitbook_search.AIAnswer.AIAnswer.new, gitbook_search.AIAnswer.followupQuestions, gitbook_search.AIAnswer.fromJson, gitbook_search.AIAnswer.pages.

Failed check 0/10 points: Package has an example

No example found.

See package layout guidelines on how to add an example.

Passed report section
Platform support
20 / 20trigger folding of the section

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

  • ✓ Android

  • ✓ iOS

  • ✓ Windows

  • ✓ Linux

  • ✓ macOS

  • ✓ Web

Passed check 0/0 points: WASM compatibility

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

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

Partially passed report section
Pass static analysis
40 / 50trigger folding of the section

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

INFO: Dangling library doc comment.

lib/src/constants.dart:1:1

  ╷
1 │ /// This file contains all the constants used in the app
  │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  ╵

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

Failed report section
Support up-to-date dependencies
30 / 40trigger folding of the section

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

Package Constraint Compatible Latest Notes
clear_response ^0.0.2 0.0.2 0.0.2
equatable ^2.0.5 2.0.7 2.0.7
http ^0.13.5 0.13.6 1.4.0
light_logger ^0.0.1 0.0.1 0.0.3
Transitive dependencies
Package Constraint Compatible Latest Notes
async - 2.13.0 2.13.0
collection - 1.19.1 1.19.1
http_parser - 4.1.2 4.1.2
meta - 1.17.0 1.17.0
path - 1.9.1 1.9.1
source_span - 1.10.1 1.10.1
string_scanner - 1.4.1 1.4.1
term_glyph - 1.2.2 1.2.2
typed_data - 1.4.0 1.4.0

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

The constraint `^0.13.5` on http does not support the stable version `1.0.0`.

Try running dart pub upgrade --major-versions http to update the constraint.

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

Passed check 20/20 points: Compatible with dependency constraint lower bounds

pub downgrade does not expose any static analysis error.

Analyzed with Pana 0.22.21, Dart 3.8.0.

Check the analysis log for details.

Weekly downloads

Display as:
By versions:
4
likes
130
points
31
downloads

Publisher

unverified uploader

Weekly Downloads

A wrapper API for GitBook to search across pages and spaces. Useful for Saas or products with a search bar for docs and knowledge base.

Repository (GitHub)

Documentation

API reference

License

Apache-2.0 (license)

Dependencies

clear_response, equatable, http, light_logger

More

Packages that depend on gitbook_search