@eclipse-scout/migrate/src/typedObjectTypePlugin.js

TypeScript migration module

/*
 * Copyright (c) 2010, 2023 BSI Business Systems Integration AG
 *
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 */
import jscodeshift from 'jscodeshift';
import {defaultModuleMap, defaultRecastOptions, insertMissingImportsForTypes, isOneOf, mapType, removeEmptyLinesBetweenImports} from './common.js';

const j = jscodeshift.withParser('ts');
let referencedTypes;

/**
 * @type import('ts-migrate-server').Plugin<{moduleMap?: object}>
 */
const typedObjectTypePlugin = {
  name: 'typed-object-type-plugin',

  async run({text, options, sourceFile}) {
    let root = j(text);
    const moduleMap = {...defaultModuleMap, ...options.moduleMap};
    referencedTypes = new Set();

    root.find(j.ObjectProperty)
      .filter(path =>
        isOneOf(path.value.key.name, 'objectType', 'logicalGrid', 'lookupCall') &&
        path.value.value.type === j.StringLiteral.name)
      .forEach(path => {
        let objectType = path.value.value.value;
        path.node.value = getTypeForStringObjectType(objectType);
      });

    root.find(j.CallExpression)
      .filter(path =>
        path.value.callee.type === j.MemberExpression.name &&
        path.value.callee.object.name === 'scout' &&
        path.value.callee.property.name === 'create' &&
        path.value.arguments[0].type === j.StringLiteral.name)
      .forEach(path => {
        let objectType = path.value.arguments[0].value;
        path.node.arguments[0] = getTypeForStringObjectType(objectType);
      });

    insertMissingImportsForTypes(j, root, Array.from(referencedTypes), moduleMap, sourceFile.fileName);
    return removeEmptyLinesBetweenImports(root.toSource(defaultRecastOptions));
  }
};

function getTypeForStringObjectType(objectType) {
  // noinspection DuplicatedCode
  let module = 'scout';
  let name = objectType;
  if (objectType.indexOf('.') > -1) {
    [module, name] = objectType.split('.');
  }
  let type = mapType(j, module + '.' + name);
  referencedTypes.add(type);
  return j.identifier(name);
}

export default typedObjectTypePlugin;