How seek-oss/skuba works
Project type and purpose
• This is an open-source toolkit and CLI (“skuba”) for bootstrapping, configuring, building, testing, linting, and deploying TypeScript backend applications and packages.
• It provides:
• A CLI front-end
• A library of development and runtime APIs (under src/api and src/wrapper)
• A set of reusable templates (under template/)
• Configuration presets (in packages/)
• Support scripts (in scripts/)
• Documentation site (in site/)
• CI/CD workflows (in .github/workflows/)
File structure
• Monorepo managed via pnpm-workspace.yaml
• Top-level components:
• config/ — ESLint, Jest, Prettier, TS configs
• docs/ — user guides, CLI docs, deep-dives
• integration/ & jest/ — integration and unit test fixtures
• packages/ — two published npm packages (eslint-config-skuba, skuba-dive)
• scripts/ — build, deploy, test-template shell and TypeScript scripts
• site/ — static site configuration for documentation
• src/ — core implementation of CLI, APIs, wrappers, and utilities
• template/ — project starter templates for Express, Koa, Lambda, OSS packages, etc.
• .github/ — CI workflows driving test, validate, release pipelines
README for additional insights
• Confirms TypeScript, ESLint, Prettier, Jest, Gantry, Serverless, AWS CDK as key technologies
• Emphasizes CLI commands, Templates, Development and Runtime APIs