Merge pull request #1349 from nextcloud/chore/dynamite/prepare-0.1.0-…

…release chore(dynamite_runtime): fix last pana complaints for the 0.1.0 release
nextcloud · Dec 26, 2023 · b0cfadb · b0cfadb
2 parents 98bafd4 + 5a63947
commit b0cfadb
Show file tree

Hide file tree

Showing 25 changed files with 51 additions and 14 deletions.
diff --git a/.cspell/misc.txt b/.cspell/misc.txt
@@ -1,5 +1,6 @@
 browsable
 cleartext
+codegen
 deeplinking
 flathub
 foss

diff --git a/commitlint.yaml b/commitlint.yaml
@@ -13,7 +13,6 @@ rules:
       - docs
       - dynamite
       - dynamite_end_to_end_test
-      - dynamite_petstore_example
       - dynamite_runtime
       - file_icons
       - neon_dashboard

diff --git a/cspell.json b/cspell.json
@@ -13,7 +13,7 @@
     "**/l10n/!(en.arb)",
     "**.openapi.dart",
     "external",
-    "packages/dynamite/dynamite_petstore_example/lib",
+    "packages/dynamite/dynamite/example/lib",
     "packages/file_icons/lib/src/data.dart",
     "packages/neon_lints/lib",
     "packages/nextcloud/test/fixtures",

diff --git a/melos.yaml b/melos.yaml
@@ -13,6 +13,7 @@ packages:
   - packages/*
   - packages/dynamite/*
   - packages/neon/*
+  - packages/**/example
 
 ide:
   intellij:

diff --git a/packages/app/pubspec.lock b/packages/app/pubspec.lock
@@ -231,7 +231,7 @@ packages:
       path: "../dynamite/dynamite_runtime"
       relative: true
     source: path
-    version: "1.0.0"
+    version: "0.1.0-dev.0"
   fake_async:
     dependency: transitive
     description:

diff --git a/packages/dynamite/dynamite/README.md b/packages/dynamite/dynamite/README.md
@@ -26,7 +26,7 @@ To generate code you need to invoke the `build_runner` with the following comman
 dart run build_runner build
 ``` 
 The builder will look for any files ending with either `.openapi.json` or `.openapi.yaml` and place the generated code next to the specifications in a file ending with `.openapi.dart`.
-For a full example checkout the [example package](https://github.com/nextcloud/neon/tree/main/packages/dynamite/dynamite_petstore_example) using the OpenAPI petstore specification.
+For a full example checkout the [example package](https://github.com/nextcloud/neon/tree/main/packages/dynamite/dynamite/example) using the OpenAPI petstore specification.
 
 
 # Build configuration

diff --git a/packages/dynamite/dynamite/example/LICENSE b/packages/dynamite/dynamite/example/LICENSE
@@ -0,0 +1 @@
+../../../../assets/AGPL-3.0.txt
diff --git a/...amite/dynamite_petstore_example/README.md → packages/dynamite/dynamite/example/README.md b/...amite/dynamite_petstore_example/README.md → packages/dynamite/dynamite/example/README.md
diff --git a/...te_petstore_example/analysis_options.yaml → ...te/dynamite/example/analysis_options.yaml b/...te_petstore_example/analysis_options.yaml → ...te/dynamite/example/analysis_options.yaml
diff --git a/...mite/dynamite_petstore_example/build.yaml → ...ages/dynamite/dynamite/example/build.yaml b/...mite/dynamite_petstore_example/build.yaml → ...ages/dynamite/dynamite/example/build.yaml
diff --git a/...etstore_example/lib/petstore.openapi.dart → ...ynamite/example/lib/petstore.openapi.dart b/...etstore_example/lib/petstore.openapi.dart → ...ynamite/example/lib/petstore.openapi.dart
diff --git a/...store_example/lib/petstore.openapi.g.dart → ...amite/example/lib/petstore.openapi.g.dart b/...store_example/lib/petstore.openapi.g.dart → ...amite/example/lib/petstore.openapi.g.dart
diff --git a/...etstore_example/lib/petstore.openapi.json → ...ynamite/example/lib/petstore.openapi.json b/...etstore_example/lib/petstore.openapi.json → ...ynamite/example/lib/petstore.openapi.json
diff --git a/...te/dynamite_petstore_example/pubspec.yaml → ...es/dynamite/dynamite/example/pubspec.yaml b/...te/dynamite_petstore_example/pubspec.yaml → ...es/dynamite/dynamite/example/pubspec.yaml
diff --git a/...e_petstore_example/pubspec_overrides.yaml → ...e/dynamite/example/pubspec_overrides.yaml b/...e_petstore_example/pubspec_overrides.yaml → ...e/dynamite/example/pubspec_overrides.yaml
@@ -1,8 +1,8 @@
 # melos_managed_dependency_overrides: dynamite,dynamite_runtime,neon_lints
 dependency_overrides:
   dynamite:
-    path: ../dynamite
+    path: ..
   dynamite_runtime:
-    path: ../dynamite_runtime
+    path: ../../dynamite_runtime
   neon_lints:
-    path: ../../neon_lints
+    path: ../../../neon_lints
diff --git a/packages/dynamite/dynamite/lib/src/helpers/version_checker.dart b/packages/dynamite/dynamite/lib/src/helpers/version_checker.dart
@@ -6,7 +6,7 @@ final dependencies = {
   'built_collection': Version.parse('5.0.0'),
   'built_value': Version.parse('8.0.0'),
   'collection': Version.parse('1.0.0'),
-  'dynamite_runtime': Version.parse('0.0.1'),
+  'dynamite_runtime': Version.parse('0.1.0'),
   'meta': Version.parse('1.0.0'),
   'universal_io': Version.parse('2.0.0'),
   'uri': Version.parse('1.0.0'),

diff --git a/packages/dynamite/dynamite/pubspec.yaml b/packages/dynamite/dynamite/pubspec.yaml
@@ -1,5 +1,12 @@
 name: dynamite
-version: 1.0.0
+version: 0.1.0-dev.0
+description: The helper package used at runtime by code generated with the OpenAPI generator dynamite.
+homepage: https://github.com/nextcloud/neon
+repository: https://github.com/nextcloud/neon/tree/main/packages/dynamite/dynamite
+topics:
+  - OpenAPI
+  - codegen
+  - build-runner
 
 environment:
   sdk: '>=3.1.0 <4.0.0'

diff --git a/packages/dynamite/dynamite_petstore_example/LICENSE b/packages/dynamite/dynamite_petstore_example/LICENSE
diff --git a/packages/dynamite/dynamite_runtime/example/README.md b/packages/dynamite/dynamite_runtime/example/README.md
@@ -0,0 +1,3 @@
+This package only provides the runtime functions needed in code generated by the [dynamite](https://github.com/nextcloud/neon/tree/main/packages/dynamite/dynamite) generator.
+
+For a full example checkout the dynamite [example package](https://github.com/nextcloud/neon/tree/main/packages/dynamite/dynamite/example) using the OpenAPI petstore specification.
diff --git a/packages/dynamite/dynamite_runtime/lib/built_value.dart b/packages/dynamite/dynamite_runtime/lib/built_value.dart
@@ -1,3 +1,6 @@
+/// Provides custom serializers to use with the `built_value` package.
+library built_value;
+
 export 'src/built_value/content_string_serializer.dart';
 export 'src/built_value/double_serializer.dart';
 export 'src/built_value/header_serializer.dart';
diff --git a/packages/dynamite/dynamite_runtime/lib/http_client.dart b/packages/dynamite/dynamite_runtime/lib/http_client.dart
@@ -1,3 +1,6 @@
+/// The dynamite client to handle http connections.
+library http_client;
+
 export 'package:cookie_jar/cookie_jar.dart';
 export 'src/dynamite_client.dart';
 export 'src/http_extensions.dart';
diff --git a/packages/dynamite/dynamite_runtime/lib/models.dart b/packages/dynamite/dynamite_runtime/lib/models.dart
@@ -1,2 +1,5 @@
+/// Common data models used in the generated code.
+library models;
+
 export 'src/models/content_string.dart';
 export 'src/models/header.dart';
diff --git a/packages/dynamite/dynamite_runtime/lib/utils.dart b/packages/dynamite/dynamite_runtime/lib/utils.dart
@@ -1,3 +1,6 @@
+/// Utility functions used by the generated code.
+library utils;
+
 export 'src/utils/codecs.dart';
 export 'src/utils/some_of_validators.dart';
 export 'src/utils/string_checker.dart';

diff --git a/packages/dynamite/dynamite_runtime/pubspec.yaml b/packages/dynamite/dynamite_runtime/pubspec.yaml
@@ -1,6 +1,12 @@
 name: dynamite_runtime
-description: Helper package for use with dynamite.
-version: 1.0.0
+description: The helper package used at runtime by code generated with the OpenAPI generator dynamite.
+version: 0.1.0-dev.0
+homepage: https://github.com/nextcloud/neon
+repository: https://github.com/nextcloud/neon/tree/main/packages/dynamite/dynamite_runtime
+topics:
+  - OpenAPI
+  - codegen
+  - build-runner
 
 environment:
   sdk: '>=3.1.0 <4.0.0'
@@ -22,3 +28,11 @@ dev_dependencies:
       url: https://github.com/nextcloud/neon
       path: packages/neon_lints
   test: ^1.24.9
+
+platforms:
+  windows:
+  linux:
+  macos:
+  android:
+  ios:
+  web:
diff --git a/tool/generate-dynamite-petstore-example.sh b/tool/generate-dynamite-petstore-example.sh
@@ -2,10 +2,10 @@
 set -euxo pipefail
 cd "$(dirname "$0")/.."
 
-cp external/openapi-specification/examples/v3.0/petstore-expanded.json packages/dynamite/dynamite_petstore_example/lib/petstore.openapi.json
+cp external/openapi-specification/examples/v3.0/petstore-expanded.json packages/dynamite/dynamite/example/lib/petstore.openapi.json
 
 (
-  cd packages/dynamite/dynamite_petstore_example
+  cd packages/dynamite/dynamite/example
   rm -rf .dart_tool/build/generated/dynamite
   fvm dart pub run build_runner build --delete-conflicting-outputs
   fvm dart fix --apply lib/
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		This package only provides the runtime functions needed in code generated by the [dynamite](https://github.com/nextcloud/neon/tree/main/packages/dynamite/dynamite) generator.

		For a full example checkout the dynamite [example package](https://github.com/nextcloud/neon/tree/main/packages/dynamite/dynamite/example) using the OpenAPI petstore specification.