- readme.md:首先阅读
- dist /:distribution,它通常包含编译后的软件
- package.json:描述包
- lib /:包含软件包的依赖关系
- src /:包含包的源
- test /:包含项目的测试
- bin /:这些是在安装此软件包时添加到您的路径的文件
- npm是什么?
- npm 是 JavaScript 世界的包管理工具,并且是 Node.js 平台的默认包管理工具。通过 npm 可以安装、共享、分发代码,管理项目依赖关系。
- 使用场景:
- 在自己开发的工程中引入第三方模块(可以在npm官网搜索)
- 封装属于自己内部的私有模块,供自己使用或者供公司的团队使用
- package.json是什么?
- 管理本地安装的包的一个文件。定义了这个项目所需要的各种模块,以及项目的配置信息(比如名称、版本、许可证等元数据)。npm install 命令根据这个配置文件,自动下载所需的模块,也就是配置项目所需的运行和开发环境。
- 如何生成:npm安装package.json时 直接转到当前项目目录下用命令npm install 或npm install --save-dev安装即可,自动将package.json中的模块安装到node-modules文件夹下。(不能添加中文注释,否则报错)
- 参数详解:
- name,version 是npm init 时,用户需回答一些问题,然后在当前目录生成一个基本的package.json文件。所有问题之中,只有项目名称(name)和项目版本(version)是必填的,其他都是选填的。
- scripts:指定了运行脚本命令的npm命令行缩写,比如start指定了运行npm run start时,所要执行的命令。
- dependencies和devDependencies两项,分别指定了项目运行所依赖的模块、项目开发所需要的模块。它们都指向一个对象,该对象的各个成员,分别由模块名和对应的版本要去组成,表示依赖的模块及其版本范围
- --save参数表示将该模块写入dependencies属性:这些模块是你开发的模块的依赖项比如:react react-dom bootstrap,没有这些模块你的代码就会报错
- --save-dev表示将该模块写入devDependencies属性:这些模块只在开发环境下使用,比如
jshint、grunt
等开发过程中的辅助工具以及webpack 等依赖,各种loader
References: