npm-init

创建一个 package.json 文件
目录
Table of contents

概要

npm init [--force|-f|--yes|-y|--scope]
npm init <@scope> (same as `npx <@scope>/create`)
npm init [<@scope>/]<name> (same as `npx [<@scope>/]create-<name>`)

示例

使用 create-react-app 创建一个新的基于 React 的项目：

$ npm init react-app ./my-react-app

使用 create-esm 创建一个新的 esm 兼容包：

$ mkdir my-esm-lib && cd my-esm-lib
$ npm init esm --yes

使用旧版 init 生成一个普通的旧 package.json：

$ mkdir my-npm-pkg && cd my-npm-pkg
$ git init
$ npm init

生成它而不让它问任何问题：

$ npm init -y

描述

npm init <initializer> 可用于设置新的或现有的 npm 包。

在这种情况下，initializer 是一个名为 create-<initializer> 的 npm 包，它将由 npx 安装，然后执行其主 bin —— 大概是创建或更新 package.json 并运行任何其他与初始化相关的操作。

init 命令转化为对应的 npx 操作如下：

  • npm init foo -> npx create-foo
  • npm init @usr/foo -> npx @usr/create-foo
  • npm init @usr -> npx @usr/create

任何附加选项都将直接传递给命令，因此 npm init foo --hello 将映射到 npx create-foo --hello。

如果初始化器被省略（通过调用 npm init），init 将回退到旧的 init 行为。 它会问你一堆问题，然后为你写一个 package.json。 它将尝试根据现有字段、依赖和选择的选项进行合理的猜测。 它是严格附加的，因此它将保留已设置的所有字段和值。 你也可以使用 -y/--yes 完全跳过问卷。 如果你通过 --scope，它将创建一个范围包。

也可以看看

npm 中文网 - 粤ICP备13048890号