Asked to install Typescript when already installed when building Docker image
I am trying to build a docker image of a Next.js/React application which uses Typescript.
Typescript is installed, and I am able to run a build locally without docker.
However, as the docker image is building, I get to the following point:
Step 8/10 : RUN npm run build
---> Running in ee577c719739
> [email protected] build /app
> next build
Creating an optimized production build...
Attention: Next.js now collects completely anonymous telemetry regarding usage.
This information is used to shape Next.js' roadmap and prioritize features.
You can learn more, including how to opt-out if you'd not like to participate in this anonymous program, by visiting the following URL:
https://nextjs.org/telemetry
It looks like you're trying to use TypeScript but do not have the required package(s) installed.
Please install typescript by running:
npm install --save-dev typescript
If you are not trying to use TypeScript, please remove the tsconfig.json file from your package root (and any TypeScript files).
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] build: `next build`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] build script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
I have installed Typescript already. This is very confusing for me.
The Docker image I am using looks like this:
FROM gcr.io/companyX/companyX-node-base:12-alpine
# Copy in the project files
COPY . .
# Clean
USER root
RUN rm -fr node_modules
ENV NODE_ENV=production
COPY package*.json ./
RUN npm install && \
npm cache clean --force
RUN npm run build
EXPOSE 3000
# Running the app
CMD [ "npm", "start" ]
Answer
When you run (even outside Docker)
export NODE_ENV=production
npm install
it only installs the dependencies from your package.json and not the devDependencies. On the other hand, you probably need the devDependencies to get tools like typescript.
The good solution here is to use a multi-stage build. The first stage installs all of the dependencies; the second stage copies out only what’s needed to run the application.
FROM gcr.io/companyX/companyX-node-base:12-alpine AS build
# Copy in only the parts needed to install dependencies
# (This avoids rebuilds if the package.json hasn’t changed)
COPY package.json package.lock .
# Install dependencies (including dev dependencies)
RUN npm install
# Copy in the rest of the project
# (include node_modules in a .dockerignore file)
COPY . .
# Build the project
RUN npm run build
# Second stage: runtime
FROM gcr.io/companyX/companyX-node-base:12-alpine
ENV NODE_ENV=production
# Again get dependencies, but this time only install
# runtime dependencies
COPY package.json package.lock .
RUN npm install
# Get the built application from the first stage
COPY --from=build /app/dist dist
# Set runtime metadata
EXPOSE 3000
CMD [ "npm", "start" ]
# CMD ["node", "dist/index.js"]
Note that this approach isn’t compatible with setups that overwrite the application content with arbitrary content from the host, or that try to store libraries in Docker volumes. The final image is self-contained and doesn’t require any host content, and can be run as-is on other systems without separately copying the source code.