Skip to content

Add examples, package tags, icons, and deployment prep - #36

Merged
Chris-Wolfgang merged 11 commits into
mainfrom
feature/examples
Mar 24, 2026
Merged

Chris-Wolfgang merged 11 commits into
mainfrom
feature/examples

Conversation

@Chris-Wolfgang

Copy link
Copy Markdown
Owner

Summary

  • Add 9 example console apps demonstrating library features (extraction, loading, round-trip, headers, delimiters, error handling, progress reporting, skip/max, custom parsers)
  • Update BasicExtraction and BasicLoading examples to show full ETL pipelines using TestKit components (TestExtractor, TestTransformer, TestLoader)
  • Add NuGet package tags for discoverability (synonyms, ecosystem, architecture keywords)
  • Update package icons and add SVG source
  • Update Wolfgang.Etl.Abstractions to 0.11.0
  • Update Meziantou.Analyzer to 3.0.26
  • Tier Microsoft.NET.Test.Sdk by TFM compatibility (17.8.0/17.13.0/18.3.0)
  • Add coverlet.collector for CI coverage collection
  • Add README and DocFX documentation with real content

Test plan

  • Verify all example projects build and run
  • Verify tests pass across TFMs (net10.0, net8.0, net481)
  • Verify NuGet package tags appear correctly in packed .nupkg
  • Verify CI pipeline passes

🤖 Generated with Claude Code

Chris-Wolfgang and others added 11 commits March 20, 2026 21:42
- BasicExtraction: read fixed-width data into POCOs
- BasicLoading: write POCOs to fixed-width output
- RoundTrip: extract → transform → load pipeline
- CustomParsersConverters: Y/N booleans, date formats
- ProgressReporting: timer-based progress with IProgress<T>
- ErrorHandling: MalformedLineHandling modes
- FieldDelimiter: pipe-delimited fixed-width with headers
- SkipAndMax: pagination with SkipItemCount/MaximumItemCount
- HeadersAndSeparators: headers, separators, LineFilter

Each example is self-contained with inline data and heavy
documentation comments explaining the concepts.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Replace all template placeholders in README.md with:
- Quick start extraction and loading examples
- Features table covering all 17 library capabilities
- Links to all 9 example projects
- Acknowledgments for dependencies

Update DocFX documentation:
- introduction.md: overview and key features list
- getting-started.md: prerequisites, quick start examples
- examples.md: new page listing all 9 example projects
- toc.yml: add Examples entry

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Suppress MA0048 (file name must match type name), S3903 (type must
be in namespace), and CA2007 (ConfigureAwait) for example projects.
These rules conflict with top-level statement examples that define
record types in Program.cs.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Replace standalone extractor/loader usage with full ETL pipelines using
TestKit components. BasicExtraction now pipes through TestTransformer
and TestLoader; BasicLoading now sources from TestExtractor and
TestTransformer. This better demonstrates how the library is designed
to be composed with other ETL components.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add search terms covering synonyms (Fixed-Length, Positional),
architecture (IAsyncEnumerable, Streaming, Data-Pipeline), and
ecosystem (Wolfgang-ETL, Wolfgang.Etl.Abstractions).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Wolfgang.Etl.Abstractions 0.10.2 → 0.11.0
- Meziantou.Analyzer 3.0.25 → 3.0.26
- Microsoft.NET.Test.Sdk tiered by TFM compatibility:
  17.8.0 for netcoreapp3.1/net5.0, 17.13.0 for net6.0/net7.0/.NET Framework,
  18.3.0 for net8.0+
- Add SuppressTfmSupportBuildWarnings for older test TFMs

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@Chris-Wolfgang
Chris-Wolfgang merged commit 94c8fff into main Mar 24, 2026
7 checks passed
@Chris-Wolfgang
Chris-Wolfgang deleted the feature/examples branch March 24, 2026 12:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant