ts-mig

library1.0.2jsnpmunverified

Utility to scaffold Sequelize migration files for TypeScript projects, supporting NestJS and Express.js. Current stable version is 1.0.2 (last updated 2020). It wraps the Sequelize CLI to generate migration stubs in TypeScript, bypassing issues with sequelize-cli's native JS output. Differentiates via a `-f` filepath option and a `ct` (create table) template. However, it is minimally documented, has no active maintenance (no commits since 2020), and lacks TypeScript type declarations, making it risky for production use.

database devops

npm install ts-mig

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · TS-MIG

ts-mig

databasejavascriptv1.0.2

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.

ts-mig CLI

✓ npx ts-mig -n "migrationName" -f "path/to/migrations"

✗ require('ts-mig')

ts-mig is a CLI tool, not a module. It must be run from the terminal or npm scripts.

sequelize migration types

✓ import { QueryInterface, DataTypes } from 'sequelize';

✗ import QueryInterface from 'sequelize';

ts-mig generates migration stubs that use sequelize's TypeScript types; ensure sequelize types are installed.

.sequelizerc configuration

✓ module.exports = { 'config': path.resolve('.sequelize/config', 'config.json') };

✗ export default { config: './config.json' }

.sequelizerc is a CommonJS file; TypeScript ESM exports will fail.

Install ts-mig and dependencies, configure .sequelizerc for TypeScript output directory, initialize Sequelize, and run a migration scaffold.

npm install --save-dev ts-mig sequelize-cli sequelize # Create .sequelizerc: echo "const path = require('path'); module.exports = { 'config': path.resolve('.sequelize/config', 'config.json'), 'models-path': path.resolve('dist/db', 'models'), 'migrations-path': path.resolve('dist/db', 'migrations') };" > .sequelizerc # Initialize Sequelize config: npx sequelize-cli init:config # Add npm script: npm pkg set scripts.create-migration="ts-mig -f src/db/migrations" # Run: npm run create-migration -- -n create_users_table

Debug

Known issues

deprecatedPackage has no updates since 2020; may not work with Sequelize v6+

fix

Consider alternatives like umzug or writing migrations manually.

affects: >=1.0.2

gotchats-mig requires .sequelizerc to point to dist/ directories for TypeScript output

fix

Ensure .sequelizerc uses absolute paths with path.resolve() and points config to a config.json file.

affects: >=1.0.0

gotchaGlobal install may conflict with local project dependencies

fix

Use npx ts-mig or install as devDependency and run via npm scripts.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Cannot find module 'typescript-sequelize-migration'

Package was renamed from 'typescript-sequelize-migration' to 'ts-mig'; npm registry contains both, but require() fails if old name used.

fix

Uninstall old and install 'ts-mig': npm uninstall typescript-sequelize-migration && npm install --save-dev ts-mig

TypeError: sequelize.import is not a function

Sequelize v5+ removed sequelize.import; generated migrations may use it.

fix

Update migration stubs to use require() or import statements instead.

Upgrade

Version history

1.0.2latest on npm

Audit

Dependencies

sequelizeoptionalruntime peer dependency for generated migrations

sequelize-clioptionalrequired tool for running migrations

Agent activity

29 hits · last 30 days

node