Машинопись: Как заполнить свойства объекта их полным именем - PullRequest
0 голосов
/ 18 января 2019

У меня есть переменная, определенная следующим образом:

interface MyObjects {
  Troll : {
    strength : string;
    dexterity : string;
    wisdom : string;
  },
  Child : {
    health : string;
    wellness : string;
  },
  Kitten : {
    sneakFactor : string;
    color : string;
  }
}

let myObjects : MyObjects;

Есть ли способ использовать TypeScript для заполнения myObjects , чтобы каждая строка содержала полное имя, например:

myObjects.Troll.strength = 'Troll_strength';
myObjects.Troll.dexterity= 'Troll_dexterity';
myObjects.Troll.wisdom = 'Troll_wisdom';
myObjects.Child.health = 'Child_health';
//etc

Обновление 1: Я надеялся использовать что-то вроде Object.keys (myObjects), чтобы получить все ключи для последующей итерации, но я не могу получить ключинеинициализированной переменной.


Обновление 2: Я получил немного больше, используя:

declare function keys<T extends object>() : Array<keyof T>;
const k = keys<MyObjects>();

Теперь у меня есть все имена ключей в корнесохранено в массиве kЯ могу получить доступ к каждому из подчиненных объектов следующим образом:

myObjects[k]

... но теперь я не уверен, как получить массив всех подчиненных свойств myObjects [k] поскольку у меня нет определенного типа для каждого из них.

1 Ответ

0 голосов
/ 19 января 2019

Это невозможно со стандартным компилятором TS.Типы TypeScript полностью удаляются во время выполнения, поэтому эта информация больше недоступна.

Однако, если вы компилируете исходный код с помощью пользовательского сценария, а не просто с помощью tsc, это станет возможным.

Чтобы упростить код, я использовал ts-simple-ast здесь.

Это хорошая идея?Нет ... но это было весело.

import { Project, VariableDeclaration, Type, WriterFunction } from 'ts-simple-ast' // ^21.0.0

const project = new Project()
project.addExistingSourceFiles('src/**/*.ts')

// Custom functionality
// Look for variables that have a doc comment with `@autoInit`
// Get their type, and assign values to https://stackoverflow.com/q/54260406/7186598
for (const sourceFile of project.getSourceFiles()) {
    // TODO: Class properties, object literal properties, etc.?
    const declarations = sourceFile.getVariableDeclarations()

    for (const declaration of declarations.filter(hasAutoInitTag)) {
        if (declaration.hasInitializer()) {
            console.warn(`'${declaration.getName()}' has an initializer and @autoInit tag. Skipping.`)
            continue
        }

        const type = declaration.getType()
        const writer = createWriterForType(declaration.getName(), type);

        const parentStatement = declaration.getParent().getParent()
        const index = sourceFile.getStatements().findIndex(statement => statement === parentStatement)

        // Insert after the variable declaration
        sourceFile.insertStatements(index + 1, writer);
    }

    console.log(sourceFile.getFullText())
    // Uncomment once you have verified it does what you want.
    // sourceFile.saveSync()
}

// There's almost certainly a better way to do this.
function hasAutoInitTag(declaration: VariableDeclaration) {
    // Comments are attached to a VariableDeclarationList which contains VariableDeclarations, so
    // get the parent.
    const comments = declaration.getParent().getLeadingCommentRanges().map(range => range.getText())
    return comments.some(comment => comment.includes('@autoInit'))
}

function createWriterForType(name: string, type: Type): WriterFunction {
    return writer => {
        function writeTypeInitializer(nameStack: string[], type: Type) {
            if (type.isString()) {
                // Some logic for non-standard names is probably a good idea here.
                // this won't handle names like '()\'"'
                writer.writeLine(`${nameStack.join('.')} = '${nameStack.slice(1).join('_')}'`)
            } else if (type.isObject()) {
                writer.writeLine(`${nameStack.join('.')} = {}`)
                for (const prop of type.getProperties()) {
                    const node = prop.getValueDeclarationOrThrow()
                    writeTypeInitializer(nameStack.concat(prop.getName()), prop.getTypeAtLocation(node))
                }
            } else {
                console.warn('Unknown type', nameStack, type.getText())
            }
        }

        writeTypeInitializer([name], type)
    }
}

Теперь, менее захватывающее решение.

Вместо описания вашего объекта с помощью интерфейса, вы можете сгенерировать интерфейс из объекта.Ключи будут доступны для доступа с помощью функции autoInit, которая может генерировать нужные вам строки. Демонстрация игровой площадки

// Exactly the same as the original interface
type MyObjects = typeof myObjects

let myObjects = {
    Troll: { 
        strength: '',
        dexterity: '',
        wisdom: ''
    },
    Child: {
        health: '',
        wellness: ''
    },
    Kitten: {
        sneakFactor: '',
        color: ''
    }
};

autoInit(myObjects)
console.log(myObjects)

type AutoInitable = { [k: string]: AutoInitable } | string
function autoInit(obj: { [k: string]: AutoInitable }, nameStack: string[] = []) {
    for (const key of Object.keys(obj)) {
        const val = obj[key]
        if (typeof val === 'string') {
            obj[key] = [...nameStack, key].join('_')
        } else {
            autoInit(val, nameStack.concat(key))
        }
    }
}

Связанный вопрос adiga является еще одним вариантом, который, вероятно, лучше, поскольку он более общий.Вы можете получить доступ к подтипам с помощью MyObjects['Troll'], но я уверен, что вы не сможете сделать это автоматически на любой глубине, как вы можете с помощью двух вышеупомянутых опций.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...