Skip to content

Latest commit

 

History

History
117 lines (91 loc) · 3.22 KB

EXAMPLE_FILE_ORGANIZATION.md

File metadata and controls

117 lines (91 loc) · 3.22 KB

✅ AppContainerBuilder - File Organization Complete

Summary

The AppContainerBuilder example file has been successfully moved outside the src folder and excluded from the TypeScript build.

Changes Made

1. Example File Moved

  • From: src/Builder/Samples/AppContainerBuilder.example.ts
  • To: examples/AppContainerBuilder.example.ts
  • Status: ✅ Completed

2. TypeScript Configuration Updated

  • File: tsconfig.json
  • Changes:
    • Added "examples" to the exclude array
    • Removed "src/Builder/Samples/AppContainerBuilder.example.ts" from the files array
  • Status: ✅ Completed

3. Source Directory Cleaned

  • Action: Removed src/Builder/Samples/ directory
  • Status: ✅ Completed

4. Build Output Cleaned

  • Action: Removed .out-bin/Builder/Samples/ directory
  • Status: ✅ Completed

5. Documentation Added

  • File: examples/README.md
  • Content: Instructions on how to use the examples
  • Status: ✅ Completed

Final Directory Structure

drunk-pulumi-azure/
├── examples/                           # ✨ NEW - Examples directory (excluded from build)
│   ├── README.md                       # Usage instructions
│   └── AppContainerBuilder.example.ts  # Example file
├── src/
│   └── Builder/
│       ├── AppContainerBuilder.ts      # Main builder (included in build)
│       └── types/
│           └── appContainerBuilder.ts  # Type definitions (included in build)
├── .out-bin/
│   └── Builder/
│       ├── AppContainerBuilder.js      # Compiled output
│       └── AppContainerBuilder.d.ts    # Type definitions
└── tsconfig.json                       # Updated to exclude examples/

Verification

✅ Example File Location

$ ls examples/
AppContainerBuilder.example.ts
README.md

✅ Source Directory Clean

$ ls src/Builder/Samples/
ls: src/Builder/Samples/: No such file or directory

✅ Build Output Clean

$ ls .out-bin/Builder/ | grep -i sample
# No results - Samples directory removed

✅ TypeScript Exclude Configuration

{
  "exclude": [
    "node_modules",
    ".out-bin",
    ".tools",
    "src/z_tests/**/*.ts",
    "pulumi-test",
    "examples"
  ]
}

Benefits

  1. Clean Build: Example files are not compiled into the published package
  2. Better Organization: Examples are separate from source code
  3. Easier Maintenance: Examples can be updated without affecting the build
  4. Clear Documentation: README explains how to use the examples
  5. Smaller Package Size: No unnecessary compiled example files in distribution

Usage

Users can reference the examples by:

  1. Viewing them on GitHub in the examples/ directory
  2. Copying them to their own Pulumi projects
  3. Adapting them for their specific use cases

The examples serve as documentation and reference implementations without being part of the compiled library.

Build Status

✅ Build: Successful
✅ TypeScript Compilation: Clean (no example files)
✅ Output Directory: Clean (no Samples/ directory)
✅ Package Ready: For distribution

Date: November 25, 2025
Status: ✅ Complete