@eclipse-scout/migrate/src/memberAccessModifierPlugin.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 {defaultRecastOptions} from './common.js';

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

/**
 * @type import('ts-migrate-server').Plugin<unknown>
 */
const memberAccessModifierPlugin = {
  name: 'member-access-modifier-plugin',

  async run({text}) {
    const root = j(text);
    // Declaration is base type for ClassMethod and ClassProperty according to https://github.com/benjamn/ast-types/tree/master/def
    return root.find(j.Declaration)
      .filter(path => path.node.type === j.ClassMethod.name || path.node.type === j.ClassProperty.name)
      .forEach(expression => {
        if (expression.node.accessibility) {
          return;
        }
        let name = expression.node.key.name;
        if (name && name.startsWith('_') && !containsInternalInJsDoc(expression.node)) {
          expression.node.accessibility = 'protected';
        }
      }).toSource(defaultRecastOptions);
  }
};

function containsInternalInJsDoc(node) {
  let comments = node.comments;
  if (!comments) {
    return false;
  }
  return comments.some(comment => {
    if (comment.type !== 'CommentBlock') {
      return false;
    }
    return comment.value.includes('@internal');
  });
}

export default memberAccessModifierPlugin;