Un Fichero package.json

Creamos un fichero en la raíz de nuestro proyecto con nombre package.json. Este fichero describe nuestro proyecto. Es esencial si vamos a publicar nuestro proyecto con npm.

Podemos especificar en este fichero:

  1. Name, version, description, and keywords to describe your program.
  2. A homepage where users can learn more about it.
  3. Other packages that yours depends on.

Si hemos instalado npm podemos usar el comando npm init para empezar. Véase npm help json para obtener información sobre este fichero:

La cosa mas importante a especificar cuando estamos escribiendo un programa para su uso por otros, es el módulo main. Este consituirá el punto de entrada a nuestro programa.

Es esencial documentar las dependencias.

El siguiente es un ejemplo de fichero package.json tomado del proyecto ebnf-parser:

[~/javascript/PLgrado/ebnf-parser(master)]$ cat -n package.json 
   1  {
   2    "name": "ebnf-parser",
   3    "version": "0.1.1",
   4    "description": "A parser for BNF and EBNF grammars used by jison",
   5    "main": "ebnf-parser.js",
   6    "scripts": {
   7      "test": "make test"
   8    },
   9    "repository": "",
  10    "keywords": [
  11      "bnf",
  12      "ebnf",
  13      "grammar",
  14      "parser",
  15      "jison"
  16    ],
  17    "author": "Zach Carter",
  18    "license": "MIT",
  19    "devDependencies": {
  20      "jison": "0.4.x",
  21      "lex-parser": "0.1.0",
  22      "test": "*"
  23    }
  24  }

Casiano Rodriguez León 2015-06-18