JSDoc banners

ttsc is the standalone TypeScript-Go compiler — see Setup if you haven’t installed it yet.

@ttsc/banner adds a fixed @packageDocumentation JSDoc banner to the top of every emitted file. Common case: a license / copyright line at the top of your published package.

Install


npm install -D @ttsc/banner

Configure (file form — recommended)

Create banner.config.ts next to tsconfig.json:


import type { TtscBannerConfig } from "@ttsc/banner";
 
export default {
  text: "License MIT (c) 2026 Acme",
} satisfies TtscBannerConfig;


{
  "compilerOptions": {
    "plugins": [{ "transform": "@ttsc/banner" }]
  }
}

Run ttsc. Every emitted .js and .d.ts gets:


/**
 * License MIT (c) 2026 Acme
 *
 * @packageDocumentation
 */

Configure (inline form)

If you don’t want a separate config file:


{
  "compilerOptions": {
    "plugins": [
      {
        "transform": "@ttsc/banner",
        "text": "License MIT (c) 2026 Acme"
      }
    ]
  }
}

Required configuration

If @ttsc/banner is installed but neither banner.config.ts nor an inline text can be found, the compile fails. This is deliberate — banners are not silently skipped.

Common use cases

License headers at the top of every file in a published library.
Generated-file warnings — "⚠️ Generated by codegen — do not edit by hand."
Build provenance — "Built from commit @{COMMIT_SHA}" (interpolation is up to your build script; the banner plugin itself takes a fixed string).