From 164800b02349a8660bd624db796f8f246e39d8b5 Mon Sep 17 00:00:00 2001 From: Joe Freeman Date: Sat, 10 Feb 2024 18:12:07 -0500 Subject: [PATCH 1/3] Fix linter messages found in VSCode --- README.md | 4 +++- pkgs/shelf/README.md | 2 ++ pkgs/shelf_packages_handler/README.md | 2 ++ pkgs/shelf_proxy/README.md | 4 ++++ pkgs/shelf_router/README.md | 13 ++++++++----- pkgs/shelf_router_generator/README.md | 6 +++--- pkgs/shelf_static/README.md | 5 ++++- pkgs/shelf_test_handler/README.md | 4 ++++ pkgs/shelf_web_socket/README.md | 4 ++++ 9 files changed, 34 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 617e6e98..096a2b68 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# Shelf + [![Build Status](https://github.com/dart-lang/shelf/workflows/Dart%20CI/badge.svg)](https://github.com/dart-lang/shelf/actions?query=workflow%3A"Dart+CI"+branch%3Amaster) ## About Shelf @@ -30,4 +32,4 @@ See the [package:shelf readme](pkgs/shelf/) for more information. ## Publishing automation For information about our publishing automation and release process, see -https://github.com/dart-lang/ecosystem/wiki/Publishing-automation. +. diff --git a/pkgs/shelf/README.md b/pkgs/shelf/README.md index b27320c6..8cc14004 100644 --- a/pkgs/shelf/README.md +++ b/pkgs/shelf/README.md @@ -1,3 +1,5 @@ +# Shelf + [![pub package](https://img.shields.io/pub/v/shelf.svg)](https://pub.dev/packages/shelf) [![package publisher](https://img.shields.io/pub/publisher/shelf.svg)](https://pub.dev/packages/shelf/publisher) diff --git a/pkgs/shelf_packages_handler/README.md b/pkgs/shelf_packages_handler/README.md index 21f4765e..161328ab 100644 --- a/pkgs/shelf_packages_handler/README.md +++ b/pkgs/shelf_packages_handler/README.md @@ -1,3 +1,5 @@ +# Shelf Package Handler + [![pub package](https://img.shields.io/pub/v/shelf_packages_handler.svg)](https://pub.dev/packages/shelf_packages_handler) [![package publisher](https://img.shields.io/pub/publisher/shelf_packages_handler.svg)](https://pub.dev/packages/shelf_packages_handler/publisher) diff --git a/pkgs/shelf_proxy/README.md b/pkgs/shelf_proxy/README.md index 07b9017c..5852c263 100644 --- a/pkgs/shelf_proxy/README.md +++ b/pkgs/shelf_proxy/README.md @@ -1,3 +1,5 @@ +# Shelf Proxy + [![pub package](https://img.shields.io/pub/v/shelf_proxy.svg)](https://pub.dev/packages/shelf_proxy) [![package publisher](https://img.shields.io/pub/publisher/shelf_proxy.svg)](https://pub.dev/packages/shelf_proxy/publisher) @@ -9,6 +11,8 @@ mounted within a larger application to proxy only certain URLs. [Shelf]: https://pub.dev/packages/shelf +## Example + ```dart import 'package:shelf/shelf_io.dart' as shelf_io; import 'package:shelf_proxy/shelf_proxy.dart'; diff --git a/pkgs/shelf_router/README.md b/pkgs/shelf_router/README.md index 0fe6f398..4b8dd661 100644 --- a/pkgs/shelf_router/README.md +++ b/pkgs/shelf_router/README.md @@ -1,3 +1,5 @@ +# Shelf Router + [![pub package](https://img.shields.io/pub/v/shelf_router.svg)](https://pub.dev/packages/shelf_router) [![package publisher](https://img.shields.io/pub/publisher/shelf_router.svg)](https://pub.dev/packages/shelf_router/publisher) @@ -34,12 +36,13 @@ var server = await io.serve(app, 'localhost', 8080); See reference documentation of `Router` class for more information. ## See also - * Package [`shelf`][shelf] for which this package can create routers. - * Package [`shelf_router_generator`][shelf_router_generator] which can generate + +* Package [`shelf`][shelf] for which this package can create routers. +* Package [`shelf_router_generator`][shelf_router_generator] which can generate a router using source code annotations. - * Third-party tutorial by [creativebracket.com]: - * Video: [Build RESTful Web APIs with shelf_router][1] - * Sample: [repository for tutorial][2] +* Third-party tutorial by [creativebracket.com]: + * Video: [Build RESTful Web APIs with shelf_router][1] + * Sample: [repository for tutorial][2] [shelf]: https://pub.dev/packages/shelf [shelf_router_generator]: https://pub.dev/packages/shelf_router_generator diff --git a/pkgs/shelf_router_generator/README.md b/pkgs/shelf_router_generator/README.md index 07ad5a7d..1b2d38cb 100644 --- a/pkgs/shelf_router_generator/README.md +++ b/pkgs/shelf_router_generator/README.md @@ -1,7 +1,9 @@ +# Shelf Router Generator + [![pub package](https://img.shields.io/pub/v/shelf_router_generator.svg)](https://pub.dev/packages/shelf_router_generator) [![package publisher](https://img.shields.io/pub/publisher/shelf_router_generator.svg)](https://pub.dev/packages/shelf_router_generator/publisher) -## Shelf Router Generator +## Generator [Shelf](https://pub.dartlang.org/packages/shelf) makes it easy to build web applications in Dart by composing request handlers. The `shelf_router` package @@ -68,5 +70,3 @@ void main() async { var server = await io.serve(router.handler, 'localhost', 8080); } ``` - - diff --git a/pkgs/shelf_static/README.md b/pkgs/shelf_static/README.md index 7a54f44f..d9d9db5f 100644 --- a/pkgs/shelf_static/README.md +++ b/pkgs/shelf_static/README.md @@ -1,9 +1,12 @@ +# Shelf Static + [![pub package](https://img.shields.io/pub/v/shelf_static.svg)](https://pub.dev/packages/shelf_static) [![package publisher](https://img.shields.io/pub/publisher/shelf_static.svg)](https://pub.dev/packages/shelf_static/publisher) `shelf_static` is a `Handler` for the Dart `shelf` package. -### Example +## Example + ```dart import 'package:shelf/shelf_io.dart' as io; import 'package:shelf_static/shelf_static.dart'; diff --git a/pkgs/shelf_test_handler/README.md b/pkgs/shelf_test_handler/README.md index 6b9d24f7..ff1212d8 100644 --- a/pkgs/shelf_test_handler/README.md +++ b/pkgs/shelf_test_handler/README.md @@ -1,3 +1,5 @@ +# Shelf Test Handler + [![pub package](https://img.shields.io/pub/v/shelf_test_handler.svg)](https://pub.dev/packages/shelf_test_handler) [![package publisher](https://img.shields.io/pub/publisher/shelf_test_handler.svg)](https://pub.dev/packages/shelf_test_handler/publisher) @@ -13,6 +15,8 @@ HTTP server, whose URL can be passed to client code. [ShelfTestHandler]: https://www.dartdocs.org/documentation/shelf_test_handler/latest/shelf_test_handler/ShelfTestHandler-class.html [ShelfTestServer]: https://www.dartdocs.org/documentation/shelf_test_handler/latest/shelf_test_handler/ShelfTestServer-class.html +## Example + ```dart import 'package:shelf/shelf.dart' as shelf; import 'package:shelf_test_handler/shelf_test_handler.dart'; diff --git a/pkgs/shelf_web_socket/README.md b/pkgs/shelf_web_socket/README.md index 7105c114..77a367f5 100644 --- a/pkgs/shelf_web_socket/README.md +++ b/pkgs/shelf_web_socket/README.md @@ -1,3 +1,5 @@ +# Shelf Web Socket + [![pub package](https://img.shields.io/pub/v/shelf_web_socket.svg)](https://pub.dev/packages/shelf_web_socket) [![package publisher](https://img.shields.io/pub/publisher/shelf_web_socket.svg)](https://pub.dev/packages/shelf_web_socket/publisher) @@ -16,6 +18,8 @@ connection that's established. [WebSocketChannel]: https://pub.dev/documentation/web_socket_channel/latest/web_socket_channel/WebSocketChannel-class.html +## Example + ```dart import 'package:shelf/shelf_io.dart' as shelf_io; import 'package:shelf_web_socket/shelf_web_socket.dart'; From a5a2902abf8ad136fdd130edd69cd05dab35c316 Mon Sep 17 00:00:00 2001 From: Joe Freeman Date: Sat, 10 Feb 2024 21:51:24 -0500 Subject: [PATCH 2/3] Remove single top level headline line --- README.md | 3 +-- pkgs/shelf/README.md | 2 -- pkgs/shelf_packages_handler/README.md | 2 -- pkgs/shelf_proxy/README.md | 2 -- pkgs/shelf_router/README.md | 2 -- pkgs/shelf_router_generator/README.md | 2 -- pkgs/shelf_static/README.md | 2 -- pkgs/shelf_test_handler/README.md | 2 -- pkgs/shelf_web_socket/README.md | 2 -- 9 files changed, 1 insertion(+), 18 deletions(-) diff --git a/README.md b/README.md index 096a2b68..fb6a4c6b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -# Shelf - [![Build Status](https://github.com/dart-lang/shelf/workflows/Dart%20CI/badge.svg)](https://github.com/dart-lang/shelf/actions?query=workflow%3A"Dart+CI"+branch%3Amaster) ## About Shelf @@ -33,3 +31,4 @@ See the [package:shelf readme](pkgs/shelf/) for more information. For information about our publishing automation and release process, see . + diff --git a/pkgs/shelf/README.md b/pkgs/shelf/README.md index 8cc14004..b27320c6 100644 --- a/pkgs/shelf/README.md +++ b/pkgs/shelf/README.md @@ -1,5 +1,3 @@ -# Shelf - [![pub package](https://img.shields.io/pub/v/shelf.svg)](https://pub.dev/packages/shelf) [![package publisher](https://img.shields.io/pub/publisher/shelf.svg)](https://pub.dev/packages/shelf/publisher) diff --git a/pkgs/shelf_packages_handler/README.md b/pkgs/shelf_packages_handler/README.md index 161328ab..21f4765e 100644 --- a/pkgs/shelf_packages_handler/README.md +++ b/pkgs/shelf_packages_handler/README.md @@ -1,5 +1,3 @@ -# Shelf Package Handler - [![pub package](https://img.shields.io/pub/v/shelf_packages_handler.svg)](https://pub.dev/packages/shelf_packages_handler) [![package publisher](https://img.shields.io/pub/publisher/shelf_packages_handler.svg)](https://pub.dev/packages/shelf_packages_handler/publisher) diff --git a/pkgs/shelf_proxy/README.md b/pkgs/shelf_proxy/README.md index 5852c263..0ce3de1d 100644 --- a/pkgs/shelf_proxy/README.md +++ b/pkgs/shelf_proxy/README.md @@ -1,5 +1,3 @@ -# Shelf Proxy - [![pub package](https://img.shields.io/pub/v/shelf_proxy.svg)](https://pub.dev/packages/shelf_proxy) [![package publisher](https://img.shields.io/pub/publisher/shelf_proxy.svg)](https://pub.dev/packages/shelf_proxy/publisher) diff --git a/pkgs/shelf_router/README.md b/pkgs/shelf_router/README.md index 4b8dd661..296b5eae 100644 --- a/pkgs/shelf_router/README.md +++ b/pkgs/shelf_router/README.md @@ -1,5 +1,3 @@ -# Shelf Router - [![pub package](https://img.shields.io/pub/v/shelf_router.svg)](https://pub.dev/packages/shelf_router) [![package publisher](https://img.shields.io/pub/publisher/shelf_router.svg)](https://pub.dev/packages/shelf_router/publisher) diff --git a/pkgs/shelf_router_generator/README.md b/pkgs/shelf_router_generator/README.md index 1b2d38cb..845e19ce 100644 --- a/pkgs/shelf_router_generator/README.md +++ b/pkgs/shelf_router_generator/README.md @@ -1,5 +1,3 @@ -# Shelf Router Generator - [![pub package](https://img.shields.io/pub/v/shelf_router_generator.svg)](https://pub.dev/packages/shelf_router_generator) [![package publisher](https://img.shields.io/pub/publisher/shelf_router_generator.svg)](https://pub.dev/packages/shelf_router_generator/publisher) diff --git a/pkgs/shelf_static/README.md b/pkgs/shelf_static/README.md index d9d9db5f..fedf9815 100644 --- a/pkgs/shelf_static/README.md +++ b/pkgs/shelf_static/README.md @@ -1,5 +1,3 @@ -# Shelf Static - [![pub package](https://img.shields.io/pub/v/shelf_static.svg)](https://pub.dev/packages/shelf_static) [![package publisher](https://img.shields.io/pub/publisher/shelf_static.svg)](https://pub.dev/packages/shelf_static/publisher) diff --git a/pkgs/shelf_test_handler/README.md b/pkgs/shelf_test_handler/README.md index ff1212d8..3bf62d40 100644 --- a/pkgs/shelf_test_handler/README.md +++ b/pkgs/shelf_test_handler/README.md @@ -1,5 +1,3 @@ -# Shelf Test Handler - [![pub package](https://img.shields.io/pub/v/shelf_test_handler.svg)](https://pub.dev/packages/shelf_test_handler) [![package publisher](https://img.shields.io/pub/publisher/shelf_test_handler.svg)](https://pub.dev/packages/shelf_test_handler/publisher) diff --git a/pkgs/shelf_web_socket/README.md b/pkgs/shelf_web_socket/README.md index 77a367f5..051a2eb2 100644 --- a/pkgs/shelf_web_socket/README.md +++ b/pkgs/shelf_web_socket/README.md @@ -1,5 +1,3 @@ -# Shelf Web Socket - [![pub package](https://img.shields.io/pub/v/shelf_web_socket.svg)](https://pub.dev/packages/shelf_web_socket) [![package publisher](https://img.shields.io/pub/publisher/shelf_web_socket.svg)](https://pub.dev/packages/shelf_web_socket/publisher) From f84874b427d66ea4e722318def82c8c06e11e1f0 Mon Sep 17 00:00:00 2001 From: Joe Freeman Date: Sat, 10 Feb 2024 21:52:19 -0500 Subject: [PATCH 3/3] Restore --- pkgs/shelf_router_generator/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkgs/shelf_router_generator/README.md b/pkgs/shelf_router_generator/README.md index 845e19ce..e1bcd267 100644 --- a/pkgs/shelf_router_generator/README.md +++ b/pkgs/shelf_router_generator/README.md @@ -1,7 +1,7 @@ [![pub package](https://img.shields.io/pub/v/shelf_router_generator.svg)](https://pub.dev/packages/shelf_router_generator) [![package publisher](https://img.shields.io/pub/publisher/shelf_router_generator.svg)](https://pub.dev/packages/shelf_router_generator/publisher) -## Generator +## Shelf Router Generator [Shelf](https://pub.dartlang.org/packages/shelf) makes it easy to build web applications in Dart by composing request handlers. The `shelf_router` package