如何在项目中直接使用npm模块?

时间:2016-10-18 21:15:48

标签: javascript node.js npm npm-install

我之前从未使用过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模块吗?

1 个答案:

答案 0 :(得分:1)

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

project
  criticaldemo.js

您应该导航到project并运行

npm init

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

如果您愿意,还可以根据requirements手动创建package.json

以下是它应该看起来的最低限度(必须至少有一个nameversion):

{
  "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