如何在我的项目中直接使用 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 的文件并将所有这些代码放在那里，但通过命令行运行它什么也没做。要通过命令行运行它，我使用了以下命令：

$ criticalfile.js

谁能帮我理解如何使用 npm 模块？

Answer 1

假设您的项目目录结构如下：

project
  criticaldemo.js

您应该导航到project 并运行

npm init

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

如果您愿意，也可以根据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 运行程序：

node criticaldemo.js