Сохранение метаданных с помощью Typescript, Babel 7, Decorators

Question

Я использую TypeORM с Babel 7 и Typescript, и кажется, что метаданные отсутствуют в скомпилированном коде. Можно ли что-то с этим сделать или это ограничение использования Бабеля?

Ошибка

ColumnTypeUndefinedError: Тип столбца для фотографии # isPublished is not определены и не могут быть угаданы. Убедитесь, что вы включили "emitDecoratorMetadata": истинная опция в tsconfig.json. Также убедитесь, что Вы импортировали «отражать-метаданные» поверх основного файла ввода в ваше приложение (до того, как какой-либо объект импортирован). Если вы используете JavaScript вместо TypeScript вы должны явно указать столбец тип. at new ColumnTypeUndefinedError

Photo.js

import { Column, Entity, PrimaryGeneratedColumn } from 'typeorm'

@Entity()
export class Photo {

    @PrimaryGeneratedColumn()
    id: number


    @Column()
    isPublished: boolean
}

код нормы

import 'reflect-metadata'
import {createConnection} from 'typeorm'
import {Photo} from './entities/Photo'

createConnection({
    type: 'postgres',
    host: 'localhost',
    port: 5432,
    username: 'postgres',
    password: 'root',
    database: 'test',
    entities: [
        Photo
    ],
    synchronize: true,
    logging: false
}).then(connection => {
    // here you can start to work with your entities
}).catch(error => console.log(error))

package.json

{
    "name": "typescript-babel-node",
    "version": "0.1.0",
    "description": "",
    "main": "index.js",
    "scripts": {
        "dev": "run-p -r dev:run type-check:watch",
        "dev:run": "nodemon --exec babel-node --extensions '.ts,.js' src/index.js",
        "build": "babel src -d build --extensions '.ts,.js' src/index.js",
        "start": "node build/index.js",
        "type-check:watch": "tsc --watch",
        "test": "jest --watch"
    },
    "author": "",
    "license": "ISC",
    "dependencies": {
        "@types/node": "^10.12.0",
        "express": "^4.16.4",
        "pg": "^7.6.0",
        "ramda": "^0.25.0",
        "reflect-metadata": "^0.1.12",
        "typeorm": "^0.2.8"
    },
    "devDependencies": {
        "@babel/cli": "^7.1.2",
        "@babel/core": "^7.1.2",
        "@babel/node": "^7.0.0",
        "@babel/plugin-proposal-class-properties": "^7.1.0",
        "@babel/plugin-proposal-decorators": "^7.1.2",
        "@babel/plugin-proposal-object-rest-spread": "^7.0.0",
        "@babel/plugin-syntax-import-meta": "^7.0.0",
        "@babel/preset-env": "^7.1.0",
        "@babel/preset-typescript": "^7.1.0",
        "@types/express": "^4.16.0",
        "@types/jest": "^23.3.7",
        "@types/ramda": "^0.25.39",
        "babel-core": "^7.0.0-bridge.0",
        "babel-jest": "^23.6.0",
        "babel-plugin-module-resolver": "^3.1.1",
        "dot-env": "0.0.1",
        "eslint": "^5.7.0",
        "eslint-config-standard": "^12.0.0",
        "eslint-plugin-import": "^2.14.0",
        "eslint-plugin-node": "^7.0.1",
        "eslint-plugin-promise": "^4.0.1",
        "eslint-plugin-standard": "^4.0.0",
        "jest": "^23.6.0",
        "nodemon": "^1.18.5",
        "npm-run-all": "^4.1.3",
        "regenerator-runtime": "^0.12.1",
        "source-map-loader": "^0.2.4",
        "ts-jest": "^23.10.4",
        "typescript": "^3.1.3",
        "webpack": "^4.23.0",
        "webpack-cli": "^3.1.2"
    }
}

Answer 1

Из коробки это не поддерживается, как отмечено в другом ответе. Однако мы можем написать плагин Babel, чтобы он заработал.

Написание кода не очень сложно, проблемы возникают из-за ограничений информации, которую мы имеем внутри babel. Бабель не выполняет проверку типов на машинописи. Это означает, что у нас нет семантической информации, у нас есть только аннотация типа и какую информацию мы можем извлечь из нее. Это означает, что наше решение по необходимости очень ограничено

Ограничения:

• Если нет аннотации типа, у нас нет типа для записи
• Если у нас есть ссылка на тип, мы можем использовать только имя типа, мы не можем проверить, относится ли ссылка к интерфейсу, как псевдоним типа, класс или перечисление. На практике это означает, что:
  • Если тип является интерфейсом или псевдонимом типа, имя типа будет undefined во время выполнения, чтобы избежать неопределенного, мы можем сделать type || Object по умолчанию для объекта, если типу не присвоено значение времени выполнения
  • Если тип является перечислением, Typescript записывает в метаданные Number или String, в зависимости от типа перечисления. Поскольку мы записываем имя типа в метаданные, это означает, что вы получите контейнерный объект enum внутри метаданных.

Сериализация типов может быть скопирована из самого компилятора машинописи с минимальными изменениями (и на самом деле это всего две функции serializeTypeNode и serializeTypeList всего около 150 строк кода).

Для этого примера класса мы получаем следующие результаты:

declare var decorator: any;

interface ISampleInterface {

}

enum Flags { One }
class OtherClass {}


type ArrayAlias = number[]

class Test {
    @decorator
    untypedProp; // no design:type
    @decorator
    nrProp: number // Number as expected
    @decorator
    strProp: string // String as expected
    @decorator
    boolProp: boolean // Boolean as expected

    @decorator
    nrPropUndefined: number | undefined // Number as expected
    @decorator
    strPropUndefined: string | undefined // String as expected
    @decorator
    boolPropUndefined: boolean | undefined // Boolean as expected

    @decorator
    arrayProp: number[]

    // Type references
    @decorator
    classRefProp: OtherClass; // OtherClass || Object  = Object since OtherClass is still a class at runtime

    @decorator
    interfaceRefProp: ISampleInterface;  // ISampleInterface || Object  = Object since ISampleInterface is undefined at runtime

    @decorator
    enumRefProp: Flags; // Flags || Object = Flags since Flags exists as a value at runtime, here TS would have written Number/String

    @decorator
    typeAliasProp: ArrayAlias; // ArrayAlias || Object = Object since ArrayAlias does not exist t runtime and in Babel swe have no idea ArrayAlias is actually an array

    @decorator
    selfClassRefProp: Test; // Test || Object  = Object since Babel puts decorators instantiation before class definition, this is a quirk, this may be fixable
}

Фактический код плагина не очень велик (за исключением методов, скопированных из версии TS):

export default declare((api: typeof import('@babel/core'), { jsxPragma = "React" }): PluginObj => {
  api.assertVersion(7);

  return {
    name: "transform-typescript-decorator-metadata",
    inherits: syntaxTypeScript,

    visitor: {
      ClassDeclaration(path) {
        var node = path.node;
        for (const field of node.body.body) {
          if (field.type !== "ClassProperty") continue;

          if (field.typeAnnotation && field.typeAnnotation.type === "TSTypeAnnotation" && field.decorators && field.decorators.length > 0) {
            const key = field.key as t.Identifier;
            const serializedType = serializeTypeNode(field.typeAnnotation.typeAnnotation);
            field.decorators.push(decorator(
              t.callExpression(
                t.memberExpression(t.identifier("Reflect"), t.identifier("metadata")), [
                  t.stringLiteral("design:type"),
                  t.logicalExpression("||", serializedType, createIdentifier("Object"))
                ])
            ))
          }
        }
      },
    }
  };
});

Вы можете найти полный код плагина и рабочий образец здесь

Так же как и в стороне, порядок плагинов имеет значение, если @babel/plugin-proposal-class-properties предшествует нашему плагину, он удалит все свойства, и у нашего плагина больше не будет информации о том, чтобы испустить декораторы. Это .babelrc, который я тестировал, и он работает, я не получил его ни с какой другой конфигурацией (но я не могу сказать, что я так старался)

  {
    "env": {},
    "ignore": [],
    "plugins": [
      "../plugin/plugin.js",
      ["@babel/plugin-proposal-decorators", { "legacy": true }],
      ["@babel/plugin-proposal-class-properties", { "loose": true }],
      "babel-plugin-transform-es2015-modules-commonjs"
    ],
    "presets": [
      "@babel/preset-typescript"
    ]
  }

Answer 2

К сожалению, я достаточно уверен, что это ограничение использования Babel с Typescript.Что делает Babel, так это просто отбирает типизацию Typescript, , а затем обрабатывает код как JavaScript .Это означает, что babel не заботится о ваших tsconfig.json вообще , и, следовательно, не emitDecoratorMetadata.

Так что, к сожалению, если вам нужны метаданные декоратора, вам придетсяпридерживаться tsc