Connector Scaffold

Below is a visualization of the connector registry scaffolds. Each section shows the folder layout generated by the scaffold and the intent of the key folders.

Python implementation scaffold

No Python scaffold found.

TypeScript implementation scaffold

    What the folders mean

    {connector}/{version}/{author}/{language}/{implementation}/_meta

    • Holds all connector metadata at the implementation level.
    • Files: `connector.json` (identifier, name, author, version, capabilities, etc.), `README.md`, `CHANGELOG.md`, `LICENSE`, and `assets/` for logos/images.
    • Each implementation has its own `_meta` folder, allowing different implementations to have different metadata, maintainers, and assets.

    Language implementations under {connector}/{version}/{author}/{language}/{implementation}

    • `typescript/{implementation}/` (and optionally `python/` if provided) contain the runnable implementation.
    • Follow these conventions:
      • `docs/` for human-facing guides (getting started, configuration, limits, schema docs)
      • `schemas/` at the top level of the language directory for machine-readable definitions and related Markdown
      • `src/` for code with subfolders like `auth/`, `extract/`, `transform/`, `load/`
      • `tests/` for unit tests
      • `examples/` for usage samples

    Notes

    • The `_meta` folder is now at the implementation level, containing all metadata for that specific implementation.
    • Documentation goes in the `docs/` folder within each implementation, not in the `_meta` folder.
    • Schemas should live at the top level of each language implementation in the `schemas/` folder (not under `src`).