Skip to content

Commit 4c60f94

Browse files
authored
Merge pull request #2 from yelmuratoff/v0.1.7
v0.2.0
2 parents 1ce2d8a + 17045c3 commit 4c60f94

11 files changed

Lines changed: 23 additions & 23 deletions

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
## Review Checklist
1414

15-
- [ ] I walked through [`docs/CODE_REVIEW.md`](../docs/CODE_REVIEW.md) and verified every section that applies to this PR.
15+
- [ ] I walked through [`doc/CODE_REVIEW.md`](../doc/CODE_REVIEW.md) and verified every section that applies to this PR.
1616
- [ ] I regenerated code/docs/exports after YAML changes and inspected the diffs.
1717
- [ ] I confirmed provider/runtime changes include error handling + capability docs.
1818
- [ ] README/CHANGELOG (or relevant docs) describe the user-facing impact.

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
- **DI**: `final analytics = Analytics(...)`, then `analytics.logEvent(...)`.
6666
5. **Review diffs** for generated Dart, docs, and exports during PRs—treat them as production code.
6767

68-
Need a detailed walkthrough? Head to [`docs/ONBOARDING.md`](docs/ONBOARDING.md).
68+
Need a detailed walkthrough? Head to [`doc/ONBOARDING.md`](doc/ONBOARDING.md).
6969

7070
## Key Features
7171

@@ -156,12 +156,12 @@ Contexts allow you to define global properties (like user attributes, device inf
156156

157157
## Documentation Hub
158158

159-
- [Onboarding Guide](docs/ONBOARDING.md) – setup checklist, command reference, troubleshooting.
160-
- [Validation & Naming](docs/VALIDATION.md) – schema, strict naming rules, and error explanations.
161-
- [Capabilities](docs/CAPABILITIES.md) – why capability keys exist and how to expose provider-specific APIs.
162-
- [Migration Guides](docs/MIGRATION_GUIDES.md) – playbooks for moving Firebase manual strings, Amplitude events, and Mixpanel plans into YAML while keeping downstream dashboards stable.
163-
- [Code Review checklist](docs/CODE_REVIEW.md) – what to inspect in YAML, generated code, docs, and provider adapters during PRs.
164-
- [Scalability & Performance](docs/SCALABILITY.md) – benchmarks and limits for large enterprise plans (100+ domains / 1000+ events).
159+
- [Onboarding Guide](doc/ONBOARDING.md) – setup checklist, command reference, troubleshooting.
160+
- [Validation & Naming](doc/VALIDATION.md) – schema, strict naming rules, and error explanations.
161+
- [Capabilities](doc/CAPABILITIES.md) – why capability keys exist and how to expose provider-specific APIs.
162+
- [Migration Guides](doc/MIGRATION_GUIDES.md) – playbooks for moving Firebase manual strings, Amplitude events, and Mixpanel plans into YAML while keeping downstream dashboards stable.
163+
- [Code Review checklist](doc/CODE_REVIEW.md) – what to inspect in YAML, generated code, docs, and provider adapters during PRs.
164+
- [Scalability & Performance](doc/SCALABILITY.md) – benchmarks and limits for large enterprise plans (100+ domains / 1000+ events).
165165

166166
## CLI Commands
167167

@@ -185,7 +185,7 @@ Pair these with the configuration you committed to `analytics_gen.yaml`. Add `--
185185
- Naming strategy (`analytics_gen.naming`) enforces consistent identifiers—override per-field when legacy plans demand it.
186186
- **Strict Event Naming**: Set `strict_event_names: true` in `analytics_gen.yaml` to forbid string interpolation in event names (e.g. `View ${page}`). This prevents high-cardinality events from polluting your analytics data.
187187
- Docs/JSON/SQL outputs embed a fingerprint derived from the plan; unexpected diffs mean someone skipped regeneration.
188-
- Full details live in [`docs/VALIDATION.md`](docs/VALIDATION.md).
188+
- Full details live in [`doc/VALIDATION.md`](doc/VALIDATION.md).
189189

190190
## Analytics Providers & Capabilities
191191

@@ -196,7 +196,7 @@ The generated mixins call `logger.logEvent(...)`. You are in control of the unde
196196

197197
- Implement `IAnalytics` for a single SDK.
198198
- Use `MultiProviderAnalytics` to fan out events while isolating provider failures.
199-
- Need provider-specific hooks (user properties, timed events, etc.)? Register typed capabilities via `CapabilityKey<T>` (the new `CapabilityProviderMixin` wires a registry automatically). Consumers request them when needed, keeping the base interface small. See [`docs/CAPABILITIES.md`](docs/CAPABILITIES.md) for a junior-friendly walkthrough.
199+
- Need provider-specific hooks (user properties, timed events, etc.)? Register typed capabilities via `CapabilityKey<T>` (the new `CapabilityProviderMixin` wires a registry automatically). Consumers request them when needed, keeping the base interface small. See [`doc/CAPABILITIES.md`](doc/CAPABILITIES.md) for a junior-friendly walkthrough.
200200

201201
Mock + async adapters (`MockAnalyticsService`, `AsyncAnalyticsAdapter`) are included for tests and await-heavy flows.
202202

@@ -307,9 +307,9 @@ Contributions welcome! Please:
307307
1. Fork the repo and open a PR with focused changes.
308308
2. Add unit tests for new features/validations.
309309
3. Run `dart analyze`, `dart test`, and the generator before submitting.
310-
4. Document user-facing changes in the README or the relevant doc under `docs/`.
310+
4. Document user-facing changes in the README or the relevant doc under `doc/`.
311311

312-
Every PR description flows through `.github/pull_request_template.md`, which links directly to [`docs/CODE_REVIEW.md`](docs/CODE_REVIEW.md). Walk through that checklist (YAML, generated Dart, docs/exports, providers, and security) before requesting a review so reviewers only need to validate, not rediscover, regressions.
312+
Every PR description flows through `.github/pull_request_template.md`, which links directly to [`doc/CODE_REVIEW.md`](doc/CODE_REVIEW.md). Walk through that checklist (YAML, generated Dart, doc/exports, providers, and security) before requesting a review so reviewers only need to validate, not rediscover, regressions.
313313

314314
## FAQ
315315

@@ -323,7 +323,7 @@ Every PR description flows through `.github/pull_request_template.md`, which lin
323323
No. Implement or combine multiple providers. Capabilities expose provider-specific features without bloating the global interface.
324324

325325
- **Is it safe to commit generated files?**
326-
Committing generated files is supported. Outputs are deterministic and intended to be reviewed in PRs (see [`docs/CODE_REVIEW.md`](docs/CODE_REVIEW.md)).
326+
Committing generated files is supported. Outputs are deterministic and intended to be reviewed in PRs (see [`doc/CODE_REVIEW.md`](doc/CODE_REVIEW.md)).
327327

328328
## License
329329

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

pubspec.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ environment:
1515
sdk: ">=3.0.0 <4.0.0"
1616

1717
dependencies:
18-
yaml: 3.1.3
19-
path: 1.9.1
20-
args: 2.7.0
21-
collection: 1.19.1
18+
yaml: ^3.1.3
19+
path: ^1.9.1
20+
args: ^2.7.0
21+
collection: ^1.19.1
2222

2323
dev_dependencies:
24-
lints: 6.0.0
25-
test: 1.27.0
24+
lints: ^6.0.0
25+
test: ^1.27.0

test/docs/async_logging_guidance_test.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ void main() {
3535
});
3636

3737
test('Onboarding guide mentions AsyncAnalyticsAdapter usage', () {
38-
final onboarding = File('docs/ONBOARDING.md').readAsStringSync();
38+
final onboarding = File('doc/ONBOARDING.md').readAsStringSync();
3939

4040
expect(
4141
onboarding,

0 commit comments

Comments
 (0)