Registry / testing / generator-tsoa-bootstrap

generator-tsoa-bootstrap

JSON →
library1.0.3jsnpmunverified

Yeoman generator for scaffolding Node.js projects with TSOA (TypeScript OpenAPI), Sequelize ORM, and Jasmine testing framework. Version 1.0.3 is the current stable release. It provides sub-generators for models, controllers, associations, CRUD operations, migrations, and SQLite scaffold, reducing boilerplate for API development. Unlike generic generators, it integrates TSOA's OpenAPI generation and Sequelize's migrations with Jasmine testing, offering automated DAO and test generation. The project is in maintenance mode with no recent updates; last commit was several years ago.

npm install generator-tsoa-bootstrap
INSTALL
IMPORT
SIG · GENERATOR-TSOA-BOO
G
generator-tsoa-bootstrap
testingjavascriptv1.0.3
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

yo tsoa-bootstrap:model
yo tsoa-bootstrap:model <modelName>
yo tsoa-bootstrap:model --name <modelName>
Uses positional argument, not flag.
yo tsoa-bootstrap:controller
yo tsoa-bootstrap:controller <name>
yo tsoa-bootstrap:controller --name <name>
Uses positional argument.
yo tsoa-bootstrap:association
yo tsoa-bootstrap:association <from> <type> <to> [through]
yo tsoa-bootstrap:association <from> <to> <type>
Order matters: from, type, to, through.
yo tsoa-bootstrap:crud
yo tsoa-bootstrap:crud <controller> [<model>]
yo tsoa-bootstrap:crud <controller> <model> --model
Model is optional second positional argument.
yo tsoa-bootstrap:migration
yo tsoa-bootstrap:migration
yo tsoa-bootstrap:migration <name>
No arguments; prompts for name.

Installs Yeoman and runs the generator to scaffold a new project with TSOA, Sequelize, and Jasmine.

npm install -g yo yo tsoa-bootstrap
Debug
Known issues
deprecatedTSOA version compatibility: This generator uses TSOA v2; newer TSOA v3 has breaking changes in route generation and decorators.
fix
Check TSOA version in generated package.json and migrate manually to TSOA v3 if needed.
affects: >=1.0.0
gotchaGenerator expects a database connection; test environment uses SQLite in-memory but config must be set.
fix
Edit /app/sequelize/config/config.ts with your database settings before running migrations.
affects: >=1.0.0
gotchaModel name auto-singularized: generating a model with plural name will be singularized, which can cause confusion.
fix
Pass singular model name to avoid unexpected changes.
affects: >=1.0.0
deprecatedSequelize migration command typo: `npm run :sequelize:migrate:undo` has a leading colon, which is likely a mistake.
fix
Use `npm run sequelize:migrate:undo` instead.
affects: 1.0.3
gotchaCRUD generator infers model from controller name if not provided; may not match existing model.
fix
Explicitly provide model name if it differs from the singularized controller name.
affects: >=1.0.0
Errors
Common errors & fixes
Error: Cannot find module 'generator-tsoa-bootstrap'
Generator not installed globally.
fix
Run `npm install -g generator-tsoa-bootstrap`.
You don't seem to have a generator with the name "tsoa-bootstrap" installed.
Generator not registered correctly or not installed globally.
fix
Ensure `yo` and `generator-tsoa-bootstrap` are globally installed. Use `npm list -g --depth=0` to verify.
Sequelize CLI [Node: Migration] 20200101000000-create-user.js: ERROR: Column name 'id' is duplicated.
Migration generator may create duplicate column definitions if run multiple times.
fix
Edit the migration file to remove duplicate column definitions before running `sequelize:migrate`.
TypeError: Cannot read property 'DAO' of undefined
Model not properly exported; DAO not attached because models/index not regenerated.
fix
Run `yo tsoa-bootstrap:model <modelName>` again to regenerate the index, or manually add the model to /sequelize/models/index.
Upgrade
Version history
1.0.3latest on npm
Audit
Dependencies
yorequiredYeoman is required to run any generator.
Agent activity
4 hits · last 30 days
node
4
Resources
generator-tsoa-bootstrap — npm install generator-tsoa-bootstrap · libregistry