Typescript Nodejs Dockerfile：错误 TS5057：在指定目录中找不到 tsconfig.json 文件：“。”

Posted 2023-03-13

【中文标题】Typescript Nodejs Dockerfile：错误 TS5057：在指定目录中找不到 tsconfig.json 文件：“。”

【英文标题】：Typescript Nodejs Dockerfile: error TS5057: Cannot find a tsconfig.json file at the specified directory: '.'

【发布时间】：2020-10-07 22:13:51

【问题描述】：

我正在尝试使用 Dockerfile 为节点打字稿项目创建 生产 构建。

虽然，在将 TS 文件转换为 javascript 的步骤中，我收到以下错误：

error TS5057: Cannot find a tsconfig.json file at the specified directory: '.'.
error Command failed with exit code 1.

有人可以帮我解决这个问题吗？

以下是有关使用的主要文件的信息：

Dockerfile

FROM node:lts-stretch-slim

# Create app directory to hold the application code inside the image
WORKDIR /usr/src/app

# Install app dependencies
COPY package*.json yarn.lock ./

RUN yarn

RUN yarn build

COPY ./dist .

EXPOSE 3333

COPY entrypoint.sh /
ENTRYPOINT [ "/bin/bash", "/entrypoint.sh" ]

错误

[4/4] Building fresh packages...
Done in 13.99s.
Removing intermediate container 44a52bf048a4
 ---> 39b5fc8dc705
Step 5/9 : RUN yarn build
 ---> Running in 04bb0ea984e3
yarn run v1.22.4
$ tsc -p .
error TS5057: Cannot find a tsconfig.json file at the specified directory: '.'.
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
ERROR: Service 'node-app' failed to build: The command '/bin/sh -c yarn build' returned a non-zero code: 1

Package.json

"scripts": 
    "dev": "ts-node-dev --transpileOnly --ignore-watch node_modules src/server.ts",
    "start": "node dist/src/server.js",
    "build": "tsc -p ."
  ,

tsconfig.json

  "compilerOptions": 
    /* Visit https://aka.ms/tsconfig.json to read more about this file */

    /* Basic Options */
    // "incremental": true,                   /* Enable incremental compilation */
    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
    // "lib": [],                             /* Specify library files to be included in the compilation. */
    // "allowJs": true,                       /* Allow javascript files to be compiled. */
    // "checkJs": true,                       /* Report errors in .js files. */
    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
    // "outFile": "./",                       /* Concatenate and emit output to single file. */
    "outDir": "./dist",                        /* Redirect output structure to the directory. */
    "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
    // "composite": true,                     /* Enable project compilation */
    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
    // "removeComments": true,                /* Do not emit comments to output. */
    // "noEmit": true,                        /* Do not emit outputs. */
    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

    /* Strict Type-Checking Options */
    "strict": true,                           /* Enable all strict type-checking options. */
    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
    // "strictNullChecks": true,              /* Enable strict null checks. */
    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */

    /* Additional Checks */
    // "noUnusedLocals": true,                /* Report errors on unused locals. */
    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */

    /* Module Resolution Options */
    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
    // "paths": ,                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
    // "typeRoots": [],                       /* List of folders to include type definitions from. */
    // "types": [],                           /* Type declaration files to be included in compilation. */
    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */

    /* Source Map Options */
    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

    /* Experimental Options */
    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */

    /* Advanced Options */
    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
  

PS：Dockerfile 和tsconfig.json 都在项目的根目录下（我的意思是同一级别）。而且我可以在本地（Dockerfile 之外）成功运行yarn build 脚本，从而生成只有JS 代码的dist 文件夹。

PS2：我关注this tutorial 是为了为我构建一个类似的 Dockerfile。

【问题讨论】：

您必须将该文件复制到您的容器映像中或使用它安装一个卷。

是的，谢谢@DanielA.White 这确实解决了我遇到的错误。但是现在，我得到了另一个关于构建步骤的信息：error TS18003: No inputs were found in config file '/usr/src/app/tsconfig.json'. Specified 'include' paths were '["**/*"]' and 'exclude' paths were '["./dist"]'. error Command failed with exit code 2. 你知道这可能是什么原因吗？再次感谢您的回复。

嗯，我确实通过关注this answer 解决了我上次评论中的问题。

【参考方案1】：

您没有将所有文件复制到容器中。你只是在复制里面的东西 带有COPY ./dist .的 dist 文件夹

我的问题是，这是用于开发还是用于生产？ 如果它用于开发，您可以使用

复制项目的 while 根目录

COPY . .

现在，如果这是用于生产构建，您肯定需要一个中间构建步骤，因此您只需将编译后的 JS 代码复制到容器并运行它。

【讨论】：

嘿@German Gamboa，感谢您的回复。是的，这是用于生产构建的。我做了@Daniel A. White 在问题的评论部分中提到的上述内容，为 tsconfig 添加了一个 COPY 步骤，我遇到的错误就消失了。不过，正如他的评论回复中提到的那样，我现在面临另一个关于中间构建步骤 tsc -p . 的错误。您对导致此错误的原因有任何想法吗？再次感谢！

【参考方案2】：

感谢提供帮助的人，我能够在此处根据我的需要调整 Dockerfile。

我必须在我的 tsconfig.json 文件旁边创建一个空的 TS 文件，以消除我上面评论中提到的错误。我还必须删除脚本部分路径前面的dist，否则我会收到module not found 错误。

Dockerfile 最终变成了这样：

FROM node:lts-stretch-slim
# FROM node:10

# Create app directory to hold the application code inside the image
WORKDIR /usr/src/app

# Install app dependencies
COPY package*.json yarn.lock ./
COPY tsconfig.json ./
COPY .env ./

COPY emptyTs.ts ./

RUN yarn


RUN yarn build

COPY ./dist .
# COPY . .

EXPOSE 3333

COPY entrypoint.sh /
ENTRYPOINT [ "/bin/bash", "/entrypoint.sh" ]

package.json

  "scripts": 
    "dev": "ts-node-dev --transpileOnly --ignore-watch node_modules src/server.ts",
    "start": "node src/server.js",
    "build": "tsc -p ."
  ,

更新答案（2020 年 11 月 28 日）

我最终为此使用了多阶段构建。您可以在下面找到我编写的 Dockerfile 脚本：

FROM node:lts-stretch-slim AS build
WORKDIR /usr/src/app
COPY package*.json yarn.lock ./
COPY tsconfig.json ./
COPY .env ./
RUN yarn
COPY . .
RUN yarn build


FROM node:lts-stretch-slim
WORKDIR /usr/src/app
COPY package*.json yarn.lock ./
COPY .env ./
RUN yarn
COPY --from=build /usr/src/app/dist ./
EXPOSE 3333
COPY entrypoint.sh /
ENTRYPOINT [ "/bin/bash", "/entrypoint.sh" ]

【讨论】：

你为什么要从主机处理 dist 文件夹，理想情况下我们应该假设它没有被正确创建？ yarn build不是为你做的吗？

我不记得当时我为什么这样做，但我相信我遇到了打字稿错误，这不允许我在容器中编译代码。不过，后来我最终为此创建了一个多阶段构建。

我用我的最终解决方案更新了答案@Vallie 希望对您有所帮助！