zoukankan      html  css  js  c++  java
  • 看懂 package.json 文件

    package.json存储的是一个严格的json对象。那么今天分析一下package.json中的字段意义。

    1.name

    在package.json中最重要的两个字段是name和version,如果没有这两个字段,npm无法安装你的包。name和version就像是你的项目身份证,且必须是唯一的。如果你的包做了改动,那么version也应该改动。
    一些规则:

    • name少于214字符
    • name不可以以._开头
    • name应是URL安全的字符,因为name会出现在URL中(git clone XXX

    2.version

    version应满足[major, minor, patch]的格式,version必须能够被node-semver解析的. semver给出了version的规则限定。

    3.description

    项目的描述信息

    4.keywords

    项目的一些关键字。有助于用户通过关键字搜索到你的项目

    5.homepage

    一个指向你项目主页的url

    6.bugs

    当用户发现了你的bugs时,可以在这里找到你并反馈给你

    {
       "url" : "https://github.com/owner/project/issues",
       "email" : "project@hostname.com"
    }

    7.license

    指明你的项目许可证,让用户知道以何种权限使用你的项目

    8.people fields: author, contributors

    宣誓你主权的地方啦

    "author":{
        "name": "xinhong",
        "email": "xinhong@anjuke.com"
    }

    9.files

    表明项目下的哪些文件是重要的。效果类似于.gitignore文件,区别是前者包含性,后者排除性。

    10.main

    指向你项目入口文件。比如项目名为foo,那么用户需要使用你的项目时,需要书写代码require('foo'),并且你的入口文件需要抛出这个对象

    11.repository

    指明你的项目仓库地点。这有助于其他人能够帮助你一起维护项目,最常见的就是GitHub仓库啦:

    "repository" :
     {
        "type" : "git",
        "url" : "https://github.com/npm/npm.git"
     }

    12.scripts

    scripts包含了在项目开发过程会使用的脚本命令,比如下面我们可以运行npm run start来执行 "node server.js"

    "scripts":{
       "start": "node server.js"
    }

    13.dependencies

    指定了项目运行所依赖的模块,--save参数表示将该模块写入dependencies属性,

    For production: 指明你项目生产环境时的依赖,即别人使用你的项目代码时必须依赖某些插件方可使用。在这里需要特别说明一下关于依赖项目version的范围规则:

    • version :必须满足规定的版本
    • >version :大于某个版本
    • >=version :大于等于某个版本
    • <version :小于某个版本
    • <=version :小于等于某个版本
    • ~version :大约等于某个版本。若指明minor,不允许超越minor;若未指明minor,则minor可变
    • ^version :兼容性版本。从左非零版本数值限定,之后版本数值可变
    • 1.2.x :指定某个版本数值可变
    • http://... :指定链接
    • * :任意版本
    • ...
    // ~
    ~1.2.3 := >=1.2.3 <1.(2+1).0 := >=1.2.3 <1.3.0
    ~1.2 := >=1.2.0 <1.(2+1).0 := >=1.2.0 <1.3.0 (Same as 1.2.x)
    ~1 := >=1.0.0 <(1+1).0.0 := >=1.0.0 <2.0.0 (Same as 1.x)
    ~0.2.3 := >=0.2.3 <0.(2+1).0 := >=0.2.3 <0.3.0
    ~0.2 := >=0.2.0 <0.(2+1).0 := >=0.2.0 <0.3.0 (Same as 0.2.x)
    ~0 := >=0.0.0 <(0+1).0.0 := >=0.0.0 <1.0.0 (Same as 0.x)
    
    // ^
    ^1.2.3 := >=1.2.3 <2.0.0
    ^0.2.3 := >=0.2.3 <0.3.0
    ^0.0.3 := >=0.0.3 <0.0.4

    14.devDependencies

    项目开发所需要的模块,--save-dev表示将该模块写入devDependencies属性。

    For development: 当其他开发者需要继续开发你的项目时,需要安装的依赖。

    15.bundleDependencies

    npm pack 记录打包的时候需要被打包的依赖

    16.optionalDependencies

    可选的依赖,如果找不到,不会影响npm下载。

    17.peerDependencies

    会提示你安装缺少的模块,默认要求带版本

    18.engines

    用于指明你的项目运行依赖的node版本或npm版本

    {
        "engines":{
           "node": ">=0.10.3",
           "npm": "~1.0.20"
        }
    }

    19.bin

    许多包有一个或多个可执行文件希望被安装到系统路径。在npm下要这么做非常容易(事实上,npm就是这么运行的)。

    这需要在你的package.json中提供一个bin字段,它是一个命令名和本地文件名的映射。在安装时,如果是全局安装,npm将会使用符号链接把这些文件链接到prefix/bin,如果是本地安装,会链接到./node_modules/.bin/。

    比如,要使用myapp作为命令时可以这么做:

    { "bin" : { "myapp" : "./cli.js" } }

    这么一来,当你安装myapp,npm会从cli.js文件创建一个到/usr/local/bin/myapp的符号链接(这使你可以直接在命令行执行myapp)。

     


    部分内容来自:

    作者:居客侠
    链接:https://www.jianshu.com/p/ea6ba4a3e213
    来源:简书

  • 相关阅读:
    C++ 重载操作符- 01 简单的入门
    C++ 析构函数
    Auto Control 001 自动控制的一般概念
    C++ 友元
    安装 SQL Server 2014 Express
    关闭是否只查看安全传送的网页内容提示框 和 是否允许运行软件,如ActiveX控件和插件提示框
    Python 网络爬虫 010 (高级功能) 解析 robots.txt 文件
    2019-06-12 Java学习日记之JDBC
    2019-06-11 Java学习日记之Bootstrap
    2019-06-10 Java学习日记之JQuery
  • 原文地址:https://www.cnblogs.com/MrZhujl/p/13540877.html
Copyright © 2011-2022 走看看