@xylabs/ts-scripts-yarn3

TypeScript project scripts

Install

Using npm:

npm install -D {{name}}

Using yarn:

yarn add -D {{name}}

Using pnpm:

pnpm add -D {{name}}

Using bun:

bun add -D {{name}}

Usage

Run commands via the xy CLI:

yarn xy <command> [options]

Build

yarn xy build          # Full build (compile + lint + deplint)
yarn xy compile        # Compile all packages
yarn xy rebuild        # Clean + full build
yarn xy copy-assets    # Copy non-TS assets to dist

Lint

yarn xy lint           # Lint all packages
yarn xy fix            # Auto-fix lint issues
yarn xy deplint        # Check dependency declarations
yarn xy publint        # Validate package.json for publishing

Test

yarn xy test           # Run tests with vitest

Deploy

yarn xy deploy         # Deploy patch version
yarn xy deploy-minor   # Deploy minor version
yarn xy deploy-major   # Deploy major version

README Generation

yarn xy readme         # Generate README.md for all packages
yarn xy readme init    # Scaffold README template files in .xy/

Other

yarn xy clean          # Clean build artifacts
yarn xy license        # Check dependency licenses
yarn xy gen-docs       # Generate API documentation via TypeDoc
yarn xy claude init    # Initialize Claude Code config files

Configuration

Create an xy.config.ts in your project root:

import type { XyConfig } from '@xylabs/ts-scripts-yarn3'

const config: XyConfig = {
  compile: {
    entryMode: 'auto',
  },
  deplint: {
    exclude: ['some-implicit-dependency'],
  },
  readme: {
    logoUrl: 'https://example.com/logo.svg',
    logoLinkUrl: 'https://example.com',
  },
}

export default config

License

See the LICENSE file for license rights and limitations (LGPL-3.0-only).