Skip to content

Commit

Permalink
chore: improve docs + templates part 1
Browse files Browse the repository at this point in the history
  • Loading branch information
jtdLab committed Aug 25, 2023
1 parent 483a9f5 commit ac9647e
Show file tree
Hide file tree
Showing 101 changed files with 366 additions and 989 deletions.
5 changes: 0 additions & 5 deletions bricks/di_package/__brick__/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,6 @@ migrate_working_dir/
*.iws
.idea/

# The .vscode folder contains launch configuration and tasks you configure in
# VS Code which you may wish to be included in version control, so this line
# is commented out by default.
#.vscode/

# Files and directories created by pub.
.dart_tool/
.packages
Expand Down
2 changes: 1 addition & 1 deletion bricks/di_package/__brick__/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## 1.0.0
## 0.1.0

- Initial version.
40 changes: 6 additions & 34 deletions bricks/di_package/__brick__/README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,11 @@
<!--
This README describes the package. If you publish this package to pub.dev,
this README's contents appear on the landing page for your package.
## Dependency Injection Package

For information about how to write a good package README, see the guide for
[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
### Responsibilities

For general information about developing packages, see the Dart guide for
[creating packages](https://dart.dev/guides/libraries/create-library-packages)
and the Flutter guide for
[developing packages and plugins](https://flutter.dev/developing-packages).
-->
🎯 Provide a dependency injection container.

TODO: Put a short description of the package here that helps potential users
know whether this package might be useful for them.
🎯 Provide platform annotations for dependency injection.

## Features
For more information click [here][1].

TODO: List what your package can do. Maybe include images, gifs, or videos.

## Getting started

TODO: List prerequisites and provide or point to information on how to
start using the package.

## Usage

TODO: Include short and useful examples for package users. Add longer examples
to `/example` folder.

```dart
const like = 'sample';
```

## Additional information

TODO: Tell users more about the package: where to find more information, how to
contribute to the package, how to file issues, what response they can expect
from the package authors, and more.
[1]: https://docs.page/jtdLab/rapid/architecture/app-module#dependency-injection-package
5 changes: 0 additions & 5 deletions bricks/di_package/__brick__/analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
include: ../../../analysis_options.yaml
# Uncomment the following section to specify additional rules.

# linter:
# rules:
# - camel_case_types
2 changes: 1 addition & 1 deletion bricks/di_package/__brick__/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: {{ project_name }}_di
description: Dependency injection of {{project_name.titleCase()}}.
version: 0.0.1
version: 0.1.0
publish_to: none

environment:
Expand Down
5 changes: 0 additions & 5 deletions bricks/domain_package/__brick__/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,6 @@ migrate_working_dir/
*.iws
.idea/

# The .vscode folder contains launch configuration and tasks you configure in
# VS Code which you may wish to be included in version control, so this line
# is commented out by default.
#.vscode/

# Files and directories created by pub.
.dart_tool/
.packages
Expand Down
2 changes: 1 addition & 1 deletion bricks/domain_package/__brick__/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## 1.0.0
## 0.1.0

- Initial version.
44 changes: 14 additions & 30 deletions bricks/domain_package/__brick__/README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,23 @@
<!--
This README describes the package. If you publish this package to pub.dev,
this README's contents appear on the landing page for your package.
## Domain Package

For information about how to write a good package README, see the guide for
[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
### Responsibilities

For general information about developing packages, see the Dart guide for
[creating packages](https://dart.dev/guides/libraries/create-library-packages)
and the Flutter guide for
[developing packages and plugins](https://flutter.dev/developing-packages).
-->
🎯 Represent a domain.

TODO: Put a short description of the package here that helps potential users
know whether this package might be useful for them.
### Components

## Features
📦 [Entity][2]

TODO: List what your package can do. Maybe include images, gifs, or videos.
📦 [Value Object][3]

## Getting started
📦 [Service Interface][4]

TODO: List prerequisites and provide or point to information on how to
start using the package.
📦 [Failure][5]

## Usage
For more information click [here][1].

TODO: Include short and useful examples for package users. Add longer examples
to `/example` folder.

```dart
const like = 'sample';
```

## Additional information

TODO: Tell users more about the package: where to find more information, how to
contribute to the package, how to file issues, what response they can expect
from the package authors, and more.
[1]: https://docs.page/jtdLab/rapid/architecture/app-module#domain-package
[2]: https://docs.page/jtdLab/rapid/architecture/app-module#entity
[3]: https://docs.page/jtdLab/rapid/architecture/app-module#value-object
[4]: https://docs.page/jtdLab/rapid/architecture/app-module#service-interface
[5]: https://docs.page/jtdLab/rapid/architecture/app-module#failure
5 changes: 0 additions & 5 deletions bricks/domain_package/__brick__/analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
include: ../../../../analysis_options.yaml
# Uncomment the following section to specify additional rules.

# linter:
# rules:
# - camel_case_types
5 changes: 3 additions & 2 deletions bricks/domain_package/__brick__/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: {{project_name}}_domain{{#has_name}}_{{name}}{{/has_name}}
description: TODO
version: 0.0.1
version: 0.1.0
publish_to: none

environment:
Expand All @@ -13,5 +13,6 @@ dependencies:
dev_dependencies:
test: ^1.24.6
build_runner: ^2.4.6
freezed: ^2.4.1
build_verify: ^3.1.0
freezed: ^2.4.1

5 changes: 0 additions & 5 deletions bricks/infrastructure_package/__brick__/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,6 @@ migrate_working_dir/
*.iws
.idea/

# The .vscode folder contains launch configuration and tasks you configure in
# VS Code which you may wish to be included in version control, so this line
# is commented out by default.
#.vscode/

# Files and directories created by pub.
.dart_tool/
.packages
Expand Down
2 changes: 1 addition & 1 deletion bricks/infrastructure_package/__brick__/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## 1.0.0
## 0.1.0

- Initial version.
42 changes: 10 additions & 32 deletions bricks/infrastructure_package/__brick__/README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,17 @@
<!--
This README describes the package. If you publish this package to pub.dev,
this README's contents appear on the landing page for your package.
## Infrastructure Package

For information about how to write a good package README, see the guide for
[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
### Responsibilities

For general information about developing packages, see the Dart guide for
[creating packages](https://dart.dev/guides/libraries/create-library-packages)
and the Flutter guide for
[developing packages and plugins](https://flutter.dev/developing-packages).
-->
🎯 Implement a domain.

TODO: Put a short description of the package here that helps potential users
know whether this package might be useful for them.
### Components

## Features
📦 [Data Transfer Object][2]

TODO: List what your package can do. Maybe include images, gifs, or videos.
📦 [Service Implementation][3]

## Getting started
For more information click [here][1].

TODO: List prerequisites and provide or point to information on how to
start using the package.

## Usage

TODO: Include short and useful examples for package users. Add longer examples
to `/example` folder.

```dart
const like = 'sample';
```

## Additional information

TODO: Tell users more about the package: where to find more information, how to
contribute to the package, how to file issues, what response they can expect
from the package authors, and more.
[1]: https://docs.page/jtdLab/rapid/architecture/app-module#infrastructure-package
[2]: https://docs.page/jtdLab/rapid/architecture/app-module#data-transfer-object
[3]: https://docs.page/jtdLab/rapid/architecture/app-module#service-implementation
5 changes: 0 additions & 5 deletions bricks/infrastructure_package/__brick__/analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
include: ../../../../analysis_options.yaml
# Uncomment the following section to specify additional rules.

# linter:
# rules:
# - camel_case_types
10 changes: 5 additions & 5 deletions bricks/infrastructure_package/__brick__/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
name: {{project_name}}_infrastructure{{#has_name}}_{{name}}{{/has_name}}
description: TODO
version: 0.0.1
version: 0.1.0
publish_to: none

environment:
sdk: ">=3.1.0 <4.0.0"

dependencies:
freezed_annotation: ^2.4.1
json_annotation: ^4.8.1
injectable: ^2.3.0
json_annotation: ^4.8.1
{{project_name}}_logging:
{{project_name}}_domain{{#has_name}}_{{name}}{{/has_name}}:

dev_dependencies:
test: ^1.24.6
mocktail: ^1.0.0
build_runner: ^2.4.6
build_verify: ^3.1.0
freezed: ^2.4.1
injectable_generator: ^2.4.0
json_serializable: ^6.7.1
build_verify: ^3.1.0
mocktail: ^1.0.0
test: ^1.24.6
5 changes: 0 additions & 5 deletions bricks/logging_package/__brick__/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,6 @@ migrate_working_dir/
*.iws
.idea/

# The .vscode folder contains launch configuration and tasks you configure in
# VS Code which you may wish to be included in version control, so this line
# is commented out by default.
#.vscode/

# Files and directories created by pub.
.dart_tool/
.packages
Expand Down
2 changes: 1 addition & 1 deletion bricks/logging_package/__brick__/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## 1.0.0
## 0.1.0

- Initial version.
40 changes: 5 additions & 35 deletions bricks/logging_package/__brick__/README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,9 @@
<!--
This README describes the package. If you publish this package to pub.dev,
this README's contents appear on the landing page for your package.
## Logging Package

For information about how to write a good package README, see the guide for
[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
### Responsibilities

For general information about developing packages, see the Dart guide for
[creating packages](https://dart.dev/guides/libraries/create-library-packages)
and the Flutter guide for
[developing packages and plugins](https://flutter.dev/developing-packages).
-->
🎯 Provide a logger.

TODO: Put a short description of the package here that helps potential users
know whether this package might be useful for them.
For more information click [here][1].

## Features

TODO: List what your package can do. Maybe include images, gifs, or videos.

## Getting started

TODO: List prerequisites and provide or point to information on how to
start using the package.

## Usage

TODO: Include short and useful examples for package users. Add longer examples
to `/example` folder.

```dart
const like = 'sample';
```

## Additional information

TODO: Tell users more about the package: where to find more information, how to
contribute to the package, how to file issues, what response they can expect
from the package authors, and more.
[1]: https://docs.page/jtdLab/rapid/architecture/app-module#logging-package
5 changes: 0 additions & 5 deletions bricks/logging_package/__brick__/analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
include: ../../../analysis_options.yaml
# Uncomment the following section to specify additional rules.

# linter:
# rules:
# - camel_case_types
10 changes: 5 additions & 5 deletions bricks/logging_package/__brick__/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
name: {{project_name}}_logging
description: Logging of {{project_name.titleCase()}}.
version: 0.0.1
version: 0.1.0
publish_to: none

environment:
sdk: ">=3.1.0 <4.0.0"

dependencies:
meta: ^1.9.1
injectable: ^2.3.0
meta: ^1.9.1

dev_dependencies:
test: ^1.24.6
mocktail: ^1.0.0
build_runner: ^2.4.6
build_verify: ^3.1.0
injectable_generator: ^2.4.0
build_verify: ^3.1.0
mocktail: ^1.0.0
test: ^1.24.6
5 changes: 0 additions & 5 deletions bricks/platform_app_feature_package/__brick__/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,6 @@ migrate_working_dir/
*.iws
.idea/

# The .vscode folder contains launch configuration and tasks you configure in
# VS Code which you may wish to be included in version control, so this line
# is commented out by default.
#.vscode/

# Flutter/Dart/Pub related
**/doc/api/
**/ios/Flutter/.last_build_id
Expand Down
2 changes: 1 addition & 1 deletion bricks/platform_app_feature_package/__brick__/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## 0.0.1
## 0.1.0

* TODO: Describe initial release.
1 change: 0 additions & 1 deletion bricks/platform_app_feature_package/__brick__/LICENSE

This file was deleted.

Loading

0 comments on commit ac9647e

Please sign in to comment.