如何在我的项目中直接使用 npm 模块？

Question

我以前从未使用过 npm，所以我可能不会问应该如何提问的问题，但我在任何地方都找不到此信息。假设我有兴趣使用 this module。作者要求我通过在命令行中键入以下内容来安装模块。

npm install --save critical

在那之后我迷路了。作者写了一大堆，不知道放在哪里

var critical = require('critical');

和

critical.generate({
  inline: true,
  base: 'test/',
  src: 'index.html',
  dest: 'index-critical.html',
  width: 1300,
  height: 900
});

我应该把这段代码放在哪里以及如何运行它。我尝试创建一个名为 criticaldemo.js 的文件并将所有这些代码放在那里，但是运行通过命令行设置它什么也没做。 TO 运行通过命令行我使用了以下命令：

$ criticalfile.js

任何人都可以帮助我了解如何使用 npm 模块吗？

Answer 1

让我们假设您的项目目录结构如下所示：

project
  criticaldemo.js

您应该导航到 project 和运行

npm init

这将在您的项目中创建 package.json。您只需为每个问题按回车键即可使用默认值。

如果愿意，您还可以根据 requirements.

手动创建 package.json

这是最低限度的外观（必须至少有 name 和 version）：

{
  "name": "my-cool-project",
  "version": "1.0.0"
}

无论如何，此时您的目录应该如下所示：

project
  criticaldemo.js
  package.json

接下来，你运行:

npm install --save critical

这将创建一个目录 node_modules，其中包含您的包：

目录结构：

project
  criticaldemo.js
  package.json
  node_modules

现在在你的 criticaldemo.js 里面，你把代码作为包作者说的：

var critical = require('critical'); // this loads the package from node_modules/critical

critical.generate({
  inline: true,
  base: 'test/',
  src: 'index.html',
  dest: 'index-critical.html',
  width: 1300,
  height: 900
});

最后你运行使用节点的程序：

node criticaldemo.js

如何在我的项目中直接使用 npm 模块？

How can I use a npm modules directly in my projects?

javascript

node.js

npm

npm-install