Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Build ESM migrations for JS #10802

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Build ESM migrations for JS #10802

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c0ffb24
fix: Build ESM migrations for JS
w3nl Mar 28, 2024
4bd1047
Merge branch 'typeorm:master' into master
w3nl Mar 28, 2024
fa659fc
fix: Fix the migration documentation
w3nl Mar 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
55 changes: 53 additions & 2 deletions docs/migrations.md
View file
Open in desktop
Expand Up @@ -258,15 +258,66 @@ export class PostRefactoringTIMESTAMP implements MigrationInterface {
Alternatively you can also output your migrations as Javascript files using the `o` (alias for `--outputJs`) flag. This is useful for Javascript only projects in which TypeScript additional packages are not installed. This command, will generate a new migration file `{TIMESTAMP}-PostRefactoring.js` with the following content:

```javascript
const { MigrationInterface, QueryRunner } = require("typeorm")

/**
* @typedef {import('typeorm').QueryRunner} QueryRunner
* @typedef {import('typeorm').MigrationInterface} MigrationInterface
*/

/**
* @class
* @implements {MigrationInterface}
*/
module.exports = class PostRefactoringTIMESTAMP {
/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async up(queryRunner) {
await queryRunner.query(
`ALTER TABLE "post" ALTER COLUMN "title" RENAME TO "name"`,
)
}

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async down(queryRunner) {
await queryRunner.query(
`ALTER TABLE "post" ALTER COLUMN "name" RENAME TO "title"`,
)
}
}

```
By default, it generates CommonJS JavaScript code with the `o` (alias for `--outputJs`) flag, but you can generate also ESM code with the `esm` flag. This is useful for Javascript projects that use ESM modules:

```javascript
/**
* @typedef {import('typeorm').QueryRunner} QueryRunner
* @typedef {import('typeorm').MigrationInterface} MigrationInterface
*/


/**
* @class
* @implements {MigrationInterface}
*/
export class PostRefactoringTIMESTAMP {
/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async up(queryRunner) {
await queryRunner.query(
`ALTER TABLE "post" ALTER COLUMN "title" RENAME TO "name"`,
)
}

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async down(queryRunner) {
await queryRunner.query(
`ALTER TABLE "post" ALTER COLUMN "name" RENAME TO "title"`,
Expand Down
28 changes: 26 additions & 2 deletions src/commands/MigrationCreateCommand.ts
View file
Open in desktop
Expand Up @@ -26,6 +26,12 @@ export class MigrationCreateCommand implements yargs.CommandModule {
describe:
"Generate a migration file on Javascript instead of Typescript",
})
.option("esm", {
type: "boolean",
default: false,
describe:
"Generate a migration file on ESM instead of CommonJS",
})
.option("t", {
alias: "timestamp",
type: "number",
Expand All @@ -48,6 +54,7 @@ export class MigrationCreateCommand implements yargs.CommandModule {
? MigrationCreateCommand.getJavascriptTemplate(
filename,
timestamp,
args.esm,
)
: MigrationCreateCommand.getTemplate(filename, timestamp)

Expand Down Expand Up @@ -97,14 +104,31 @@ export class ${camelCase(
protected static getJavascriptTemplate(
name: string,
timestamp: number,
esm: boolean,
): string {
return `const { MigrationInterface, QueryRunner } = require("typeorm");
const exportMethod = esm ? "export" : "module.exports ="
return `/**
* @typedef {import('typeorm').QueryRunner} QueryRunner
* @typedef {import('typeorm').MigrationInterface} MigrationInterface
*/

module.exports = class ${camelCase(name, true)}${timestamp} {
/**
* @class
* @implements {MigrationInterface}
*/
${exportMethod} class ${camelCase(name, true)}${timestamp} {

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async up(queryRunner) {
}

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async down(queryRunner) {
}

Expand Down
29 changes: 27 additions & 2 deletions src/commands/MigrationGenerateCommand.ts
View file
Open in desktop
Expand Up @@ -43,6 +43,12 @@ export class MigrationGenerateCommand implements yargs.CommandModule {
describe:
"Generate a migration file on Javascript instead of Typescript",
})
.option("esm", {
type: "boolean",
default: false,
describe:
"Generate a migration file on ESM instead of CommonJS",
})
.option("dr", {
alias: "dryrun",
type: "boolean",
Expand Down Expand Up @@ -162,6 +168,7 @@ export class MigrationGenerateCommand implements yargs.CommandModule {
timestamp,
upSqls,
downSqls.reverse(),
args.esm,
)
: MigrationGenerateCommand.getTemplate(
path.basename(fullPath),
Expand Down Expand Up @@ -264,19 +271,37 @@ ${downSqls.join(`
timestamp: number,
upSqls: string[],
downSqls: string[],
esm: boolean,
): string {
const migrationName = `${camelCase(name, true)}${timestamp}`

return `const { MigrationInterface, QueryRunner } = require("typeorm");
const exportMethod = esm ? "export" : "module.exports ="

return `/**
* @typedef {import('typeorm').QueryRunner} QueryRunner
* @typedef {import('typeorm').MigrationInterface} MigrationInterface
*/

module.exports = class ${migrationName} {
/**
* @class
* @implements {MigrationInterface}
*/
${exportMethod} class ${migrationName} {
name = '${migrationName}'

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async up(queryRunner) {
${upSqls.join(`
`)}
}

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async down(queryRunner) {
${downSqls.join(`
`)}
Expand Down
17 changes: 16 additions & 1 deletion test/functional/commands/templates/generate/cockroachdb.ts
View file
Open in desktop
Expand Up @@ -15,16 +15,31 @@ export class TestMigration1610975184784 implements MigrationInterface {
}

}`,
javascript: `const { MigrationInterface, QueryRunner } = require("typeorm");
javascript: `/**
* @typedef {import('typeorm').QueryRunner} QueryRunner
* @typedef {import('typeorm').MigrationInterface} MigrationInterface
*/

/**
* @class
* @implements {MigrationInterface}
*/
module.exports = class TestMigration1610975184784 {
name = 'TestMigration1610975184784'

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async up(queryRunner) {
await queryRunner.query(\`CREATE SEQUENCE "post_id_seq"\`);
await queryRunner.query(\`CREATE TABLE "post" ("id" INT DEFAULT nextval('"post_id_seq"') NOT NULL, "title" varchar NOT NULL, "createdAt" timestamptz NOT NULL DEFAULT now(), CONSTRAINT "PK_be5fda3aac270b134ff9c21cdee" PRIMARY KEY ("id"))\`);
}

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async down(queryRunner) {
await queryRunner.query(\`DROP TABLE "post"\`);
await queryRunner.query(\`DROP SEQUENCE "post_id_seq"\`);
Expand Down
19 changes: 17 additions & 2 deletions test/functional/commands/templates/generate/mssql.ts
View file
Open in desktop
Expand Up @@ -13,15 +13,30 @@ export class TestMigration1610975184784 implements MigrationInterface {
}

}`,
javascript: `const { MigrationInterface, QueryRunner } = require("typeorm");

javascript: `/**
* @typedef {import('typeorm').QueryRunner} QueryRunner
* @typedef {import('typeorm').MigrationInterface} MigrationInterface
*/

/**
* @class
* @implements {MigrationInterface}
*/
module.exports = class TestMigration1610975184784 {
name = 'TestMigration1610975184784'

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async up(queryRunner) {
await queryRunner.query(\`CREATE TABLE "post" ("id" int NOT NULL IDENTITY(1,1), "title" nvarchar(255) NOT NULL, "createdAt" datetime2 NOT NULL CONSTRAINT "DF_fb91bea2d37140a877b775e6b2a" DEFAULT getdate(), CONSTRAINT "PK_be5fda3aac270b134ff9c21cdee" PRIMARY KEY ("id"))\`);
}

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async down(queryRunner) {
await queryRunner.query(\`DROP TABLE "post"\`);
}
Expand Down
19 changes: 17 additions & 2 deletions test/functional/commands/templates/generate/mysql.ts
View file
Open in desktop
Expand Up @@ -13,15 +13,30 @@ export class TestMigration1610975184784 implements MigrationInterface {
}

}`,
javascript: `const { MigrationInterface, QueryRunner } = require("typeorm");

javascript: `/**
* @typedef {import('typeorm').QueryRunner} QueryRunner
* @typedef {import('typeorm').MigrationInterface} MigrationInterface
*/

/**
* @class
* @implements {MigrationInterface}
*/
module.exports = class TestMigration1610975184784 {
name = 'TestMigration1610975184784'

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async up(queryRunner) {
await queryRunner.query(\`CREATE TABLE \\\`post\\\` (\\\`id\\\` int NOT NULL AUTO_INCREMENT, \\\`title\\\` varchar(255) NOT NULL, \\\`createdAt\\\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6), PRIMARY KEY (\\\`id\\\`)) ENGINE=InnoDB\`);
}

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async down(queryRunner) {
await queryRunner.query(\`DROP TABLE \\\`post\\\`\`);
}
Expand Down
19 changes: 17 additions & 2 deletions test/functional/commands/templates/generate/oracle.ts
View file
Open in desktop
Expand Up @@ -13,15 +13,30 @@ export class TestMigration1610975184784 implements MigrationInterface {
}

}`,
javascript: `const { MigrationInterface, QueryRunner } = require("typeorm");

javascript: `/**
* @typedef {import('typeorm').QueryRunner} QueryRunner
* @typedef {import('typeorm').MigrationInterface} MigrationInterface
*/

/**
* @class
* @implements {MigrationInterface}
*/
module.exports = class TestMigration1610975184784 {
name = 'TestMigration1610975184784'

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async up(queryRunner) {
await queryRunner.query(\`CREATE TABLE "post" ("id" number GENERATED BY DEFAULT AS IDENTITY, "title" varchar2(255) NOT NULL, "createdAt" timestamp DEFAULT CURRENT_TIMESTAMP NOT NULL, CONSTRAINT "PK_be5fda3aac270b134ff9c21cdee" PRIMARY KEY ("id"))\`);
}

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async down(queryRunner) {
await queryRunner.query(\`DROP TABLE "post"\`);
}
Expand Down
19 changes: 17 additions & 2 deletions test/functional/commands/templates/generate/postgres.ts
View file
Open in desktop
Expand Up @@ -13,15 +13,30 @@ export class TestMigration1610975184784 implements MigrationInterface {
}

}`,
javascript: `const { MigrationInterface, QueryRunner } = require("typeorm");

javascript: `/**
* @typedef {import('typeorm').QueryRunner} QueryRunner
* @typedef {import('typeorm').MigrationInterface} MigrationInterface
*/

/**
* @class
* @implements {MigrationInterface}
*/
module.exports = class TestMigration1610975184784 {
name = 'TestMigration1610975184784'

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async up(queryRunner) {
await queryRunner.query(\`CREATE TABLE "post" ("id" SERIAL NOT NULL, "title" character varying NOT NULL, "createdAt" TIMESTAMP NOT NULL DEFAULT now(), CONSTRAINT "PK_be5fda3aac270b134ff9c21cdee" PRIMARY KEY ("id"))\`);
}

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async down(queryRunner) {
await queryRunner.query(\`DROP TABLE "post"\`);
}
Expand Down
19 changes: 17 additions & 2 deletions test/functional/commands/templates/generate/sqlite.ts
View file
Open in desktop
Expand Up @@ -13,15 +13,30 @@ export class TestMigration1610975184784 implements MigrationInterface {
}

}`,
javascript: `const { MigrationInterface, QueryRunner } = require("typeorm");

javascript: `/**
* @typedef {import('typeorm').QueryRunner} QueryRunner
* @typedef {import('typeorm').MigrationInterface} MigrationInterface
*/

/**
* @class
* @implements {MigrationInterface}
*/
module.exports = class TestMigration1610975184784 {
name = 'TestMigration1610975184784'

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async up(queryRunner) {
await queryRunner.query(\`CREATE TABLE "post" ("id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')))\`);
}

/**
* @param {QueryRunner} queryRunner
* @returns {Promise<void>}
*/
async down(queryRunner) {
await queryRunner.query(\`DROP TABLE "post"\`);
}
Expand Down