Ссылки на проекты в объявлениях tsconfig и ambient - PullRequest
0 голосов
/ 29 ноября 2018

Я пытаюсь настроить свой проект Typescript, чтобы иметь следующую структуру каталогов:

src/
├── client/
│   └── tsconfig.json
│
├── server/
│   └── tsconfig.json
│
├── shared/
│   ├── utils/
│   │   └── type-utils.d.ts
│   │
│   └── tsconfig.json
│
└── tsconfig-base.json
  • client/tsconfig.json, server/tsconfig.json и shared/tsconfig.json каждый имеет "extends": "../tsconfig-base.json"

  • client/tsconfig.json и server/tsconfig.json оба имеют "references": [{ "path": "../shared" }]

  • shared/utils/type-utils.d.ts не является модулем, но вместо этого содержит объявления окружающего типакак Id и CouldBeNull, а также объединение объявлений для Array (определяя метод flatMap).

Идея состоит в том, что tsconfig-base.json может включать в себямного общих настроек, отдельные tsconfig.json могут определять настройки, относящиеся к этому подпроекту (например, React для client/tsconfig.json, Node для server/tsconfig.json), и shared/ будет совместно использоваться между client/ и server/.

Проблема в том, что объявления окружения и объявления mergin shared/utils/type-utils.ts не видны client/ или server/, а только shared/.Это приводит к ошибкам, например, tsc -b client --verbose создает

$ tsc -b client --verbose
15:31:41 - Projects in this build:
    * shared/tsconfig.json
    * client/tsconfig.json

15:31:41 - Project 'shared/tsconfig.json' is up to date because newest input 'shared/formatting/numbers.ts' is older than oldest output 'shared/formatting/numbers.js.map'

15:31:41 - Project 'client/tsconfig.json' is out of date because output file 'client/client/index.js' does not exist

15:31:41 - Building project 'C:/Users/KRyan/Web/5heet/client/tsconfig.json'...

client/index.tsx(32,29): error TS7006: Parameter 'skill' implicitly has an 'any' type.
client/index.tsx(80,37): error TS2339: Property 'flatMap' does not exist on type 'Ability[]'.
client/index.tsx(80,45): error TS7006: Parameter 'ability' implicitly has an 'any' type.
client/index.tsx(88,16): error TS7006: Parameter 'one' implicitly has an 'any' type.
client/index.tsx(88,21): error TS7006: Parameter 'another' implicitly has an 'any' type.
client/index.tsx(151,32): error TS7031: Binding element 'id' implicitly has an 'any' type.
client/parts/editing.tsx(31,60): error TS2339: Property 'oneOperand' does not exist on type 'never'.
client/parts/editing.tsx(31,81): error TS2339: Property 'operator' does not exist on type 'never'.
client/parts/editing.tsx(31,108): error TS2339: Property 'anotherOperand' does not exist on type 'never'.
client/parts/portal.tsx(55,61): error TS2304: Cannot find name 'Omit'.
shared/ability.d.ts(2,33): error TS2304: Cannot find name 'Id'.
shared/ability.d.ts(8,36): error TS2304: Cannot find name 'Id'.
shared/ability.d.ts(12,37): error TS2304: Cannot find name 'Id'.
shared/character.d.ts(3,35): error TS2304: Cannot find name 'Id'.
shared/expression.d.ts(7,35): error TS2304: Cannot find name 'Id'.
shared/expression.d.ts(30,38): error TS2304: Cannot find name 'ElementOf'.
shared/expression.d.ts(33,118): error TS2304: Cannot find name 'Id'.
shared/formatting/numbers.d.ts(1,41): error TS2304: Cannot find name 'Id'.
shared/skill.d.ts(3,31): error TS2304: Cannot find name 'Id'.
shared/utils/basic.d.ts(5,46): error TS2304: Cannot find name 'CouldBeNull'.

Неявные типы any вызваны непосредственно невозможностью найти различные имена, перечисленные во второй половине вывода.

И, ради полноты, полные файлы:

shared/utils/type-utils.d.ts:

type PropsOf<T> = T[keyof T];
type ElementOf<T> = T extends (infer E)[] ? E : T;
type Subtract<T, U> = Pick<T, Exclude<keyof T, keyof U>>;
type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
type CouldBeNull<T> = null extends T ? unknown : never;

type DeepPartial<T> = {
    [P in keyof T]?: T[P] extends Array<infer U>
    ? Array<DeepPartial<U>>
    : T[P] extends ReadonlyArray<infer U>
    ? ReadonlyArray<DeepPartial<U>>
    : DeepPartial<T[P]>
};

declare class Tagged<Tag> {
    private 'is tagged as': [Tag];
    private dummy(): Tag;
}
type Id<Tag> = string & Tagged<Tag>;

interface Array<T> {
    /**
     * Calls a defined callback function on each element of an array. Then, flattens the result into
     * a new array.
     * This is identical to a map followed by a flatten of depth 1.
     *
     * @param callback A function that accepts up to three arguments. The flatMap method calls the
     * callback function one time for each element in the array.
     * @param thisArg An object to which the this keyword can refer in the callback function. If
     * thisArg is omitted, undefined is used as the this value.
     */
    flatMap<U, This = undefined>(
        callback: (this: This, value: T, index: number, array: T[]) => U | U[],
        thisArg?: This,
    ): U[];
}

tsconfig-base.json:

{
    "compileOnSave": true,
    "compilerOptions": {
        "target": "es2018",
        "baseUrl": ".",
        "module": "amd",
        "moduleResolution": "classic",
        "paths": {
            "csstype": [
                "node_modules/csstype/index"
            ],
        },
        "composite": true,
        "declaration": true,
        "declarationMap": true,
        "noEmitOnError": true,
        "strictNullChecks": true,
        "allowJs": false,
        "allowUnusedLabels": false,
        "noImplicitAny": true,
        "noImplicitThis": true,
        "noImplicitReturns": true,
        "noUnusedParameters": true,
        "noFallthroughCasesInSwitch": true,
        "noStrictGenericChecks": true,
        "noUnusedLocals": true,
        "noErrorTruncation": true,
        "allowUnreachableCode": false,
        "forceConsistentCasingInFileNames": false,
        "preserveConstEnums": true,
        "sourceMap": true
    }
}

client/tsconfig.json:

{
    "extends": "../tsconfig-base.json",
    "include": [
        "**/*.ts"
    ],
    "outDir": "../../built/client",
    "compilerOptions": {
        "rootDir": "..",
        "jsx": "react",
        "types": [
            "react",
            "react-dom"
        ]
    },
    "references": [
        {
            "path": "../shared"
        }
    ],
    "watch": true
}

server/tsconfig.json:

{
    "extends": "../tsconfig-base.json",
    "include": [
        "**/*.ts"
    ],
    "outDir": "../../built/server",
    "compilerOptions": {
        "rootDir": "..",
        "module": "commonjs",
        "types": [
            "node",
            "mime-types"
        ]
    },
    "references": [
        {
            "path": "../shared"
        }
    ]
}

shared/tsconfig.json:

{
    "extends": "../../tsconfig-base.json",
    "include": [
        "**/*.ts"
    ],
    "outDir": "built/shared",
    "compilerOptions": {
        "module": "amd",
        "types": []
    }
}

1 Ответ

0 голосов
/ 30 ноября 2018

Выяснил решение , хотя я не без ума от этого:

client/tsconfig.json:

{
    "extends": "../tsconfig-base.json",
    "include": [
        "**/*.ts",
        "**/*.tsx",
        "../shared/utils/type-utils.d.ts"
    ],
    "outDir": "../built/client",
    "compilerOptions": {
        "baseUrl": "..",
        "rootDir": "..",
        "jsx": "react",
        "types": [
            "react",
            "react-dom"
        ]
    },
    "references": [
        {
            "path": "../shared"
        }
    ],
    "watch": true
}

Обратите внимание на ../shared/utils/type-utils.d.ts в include раздел.Это решает проблему.

Я не в восторге от этого решения, потому что оно подразумевает явное перечисление чего-либо в shared/, а не просто включение в результате ссылки на проект.Я не рад мысли о том, что мне придется вручную обновлять tsconfig.json s для каждого нового файла .d.ts, который я хочу добавить shared/.Но это ответ, в котором проект собирается, и я не слишком вероятен , чтобы добавить больше моих собственных .d.ts файлов в проект, так что мои опасения, возможно,философский / теоретический для этого проекта.

...