Registry / devops / mikro-orm-interactive-generator

mikro-orm-interactive-generator

library0.1.0jsnpmunverified

A CLI tool (v0.1.0, pre-release) for interactively generating MikroORM migration files without requiring a MikroORM configuration or being inside a project folder. Integrates with KnexJS for migration generation. Currently supports only migration files without relations; relation support is planned. Not yet stable for production use.

devops

npm install mikro-orm-interactive-generator

package ↗

INSTALL

IMPORT

SIG · MIKRO-ORM-INTERACT

mikro-orm-interactive-generator

devopsjavascriptv0.1.0

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.

default

✓ import moig from 'mikro-orm-interactive-generator'

✗ const moig = require('mikro-orm-interactive-generator')

ESM import only; CommonJS require is not supported.

generateMigration

✓ import { generateMigration } from 'mikro-orm-interactive-generator'

Named export for programmatic use; CLI usage is primary.

MigrationGenerator

✓ import { MigrationGenerator } from 'mikro-orm-interactive-generator'

✗ const MigrationGenerator = require('mikro-orm-interactive-generator').MigrationGenerator

ESM only; class for custom migration generation.

Shows programmatic use of generateMigration to create a migration for a 'users' table with common columns.

// Generate a migration interactively import moig from 'mikro-orm-interactive-generator'; async function run() { const migration = await moig.generateMigration({ // Options: table name, columns, etc. tableName: 'users', columns: [ { name: 'id', type: 'increments', primary: true }, { name: 'name', type: 'string', length: 255, nullable: false }, { name: 'email', type: 'string', length: 255, nullable: false, unique: true }, { name: 'created_at', type: 'datetime', default: 'now()' } ] }); console.log(migration); } run().catch(console.error);

Debug

Known issues

breakingThe package does not support relations in migration generation (e.g., foreign keys, joins). Attempting to use relations may produce broken or incomplete migration files.

fix

Wait for a future version that adds relation support or manually edit generated migrations to add relations.

affects: 0.1.0

breakingESM-only package: `require()` usage will throw a `ERR_REQUIRE_ESM` error if called from a CommonJS context.

fix

Use `import` syntax or dynamic import if inside a CommonJS file.

affects: >=0.1.0

gotchaThe CLI must be run globally (`npm i -g`) or via npx; local install will not make `moig` command available unless added to PATH.

fix

Install globally with `npm i -g mikro-orm-interactive-generator` or use `npx mikro-orm-interactive-generator`.

affects: >=0.1.0

deprecatedThe command `moig --create` may be deprecated in future versions in favor of `moig create` (subcommand pattern).

fix

Use `moig create` if available in your version, or check `moig --help` for current usage.

affects: 0.1.0

gotchaGenerated migration files may not include proper `down` method or rollback logic.

fix

Manually add down/rollback logic to generated migration files if needed.

affects: 0.1.0

Errors

Common errors & fixes

Error: Cannot find module 'mikro-orm-interactive-generator'

Package not installed globally or not in node_modules.

fix

Run `npm install -g mikro-orm-interactive-generator` or use `npx mikro-orm-interactive-generator`.

TypeError: moig.generateMigration is not a function

Incorrect import; the package may export a default object with methods.

fix

Use `import moig from 'mikro-orm-interactive-generator'` and call `moig.generateMigration()`.

Error [ERR_REQUIRE_ESM]: require() of ES Module not supported

Using CommonJS `require()` on an ESM-only package.

fix

Change to `import` syntax or use dynamic `import()`.

Upgrade

Version history

0.1.0latest on npm

Audit

Dependencies

mikro-ormoptionalpeer dependency for MikroORM entity definitions

knexoptionalpeer dependency for migration generation via KnexJS

Agent activity

2 hits · last 30 days

node

Resources

packagemikro-orm-interactive-generator ↗