npm init

1. Create a directory myproject
2. cd myproject
3. npm init

{
  "name": "myproject",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "Sequoia McDowell <sequoia.mcdowell@gmail.com> (http://sequoia.makes.software/)",
  "license": "ISC"
}

init.author.name=Sequoia McDowell
init.author.email=sequoia.mcdowell@gmail.com
init.author.url=http://sequoia.makes.software/

npm config

1. npm config set init.author.name [your name]
2. npm config set init.author.email [your email]
3. cat ~/.npmrc

In myproject/:

Part 1

1. Create index.js
2. Put console.log('hello world') in it
3. "node ." to run index.js
   
   

Part 2

1. Rename index.js app.js
2. Update package.json (? which property ?)
3. "node ." to run app.js

npm install

• npm install foo: installs package
• npm install --save foo: ... & saves dependency
• npm remove [--save] foo: remove package
• npm install: installs this package

In myproject/:

npm install chalk

Use our dependency:

//npm/start/myproject/app.js

console.log(chalk.green.underline('Hello World!'));
console.log(chalk.red.bold('Hello Again!'));

Run the file

Hints:

1. Something is missing...

Install "this" package

In myproject/:

1. rm -rf node_modules
2. npm install
3. node .

In myproject/:

npm install --save chalk

node_modules/chalk/package.json

...
"dependencies": {
  "ansi-styles": "^2.1.0",
  "escape-string-regexp": "^1.0.2",
  "has-ansi": "^2.0.0",
  "strip-ansi": "^3.0.0",
  "supports-color": "^2.0.0"
},
...

node_modules/chalk/package.json

...
"devDependencies": {
  "coveralls": "^2.11.2",
  "matcha": "^0.6.0",
  "mocha": "*",
  "nyc": "^3.0.0",
  "require-uncached": "^1.0.2",
  "resolve-from": "^1.0.0",
  "semver": "^4.3.3",
  "xo": "*"
}
...

Semver

"Semantic Versioning"

Semver Parts

3.10.23

• 3: Major Version
• 10: Minor Version
• 23: Patch Version

Semver Ranges

• >=2.3
• 2.*
• 1.2.7
• ~3.1 (3.1.*)
• ^3.1.9 (3.* + >=3.1)

http://semver.npmjs.com/

Finding packages

• https://www.npmjs.com/
• npm search
• google

Up Next: Global Installs

Global Install

Installs to privileged location (/usr/local/bin)

• Change permissions, or
• Tell NPM to install elsewhere
• Use "sudo"

Make NPM install globals in our home directory

npm set prefix /your/home/npm_packages

Don't do this if you used nvm to install node!!

1. npm install -g nodemon
2. nodemon /path/to/myproject
3. make a change to the myproject/app.js & save the file

package.bin

Like package.main but for command-line usage:

  "main": "index.js",
  "bin" : "bin/index.js"

  "bin" : {
    "ccc" : "dist/cli/do_this.js",
    "jsfoo":"dist/cli/foo.js"
  }

Up Next: npm scripts

...
"scripts": {
  "bbl-build": "babel src --out-dir dist",
  "build": "npm run bbl-build",
  "postinstall": "npm run build",
  "start": "node . --httpauth ../presentations.htpasswd",
  "debug": "PORT=3030 DEBUG=app:*,express:* npm run start",
  "pretest": "echo \"about to start tests...\"",
  "test": "echo \"Error: no test specified\" && exit 1"
},
...

In myproject/:

1. Install (and save!) cowsay local to project
2. Add script to package.json that runs cowsay Hello
3. Run script: npm run hello

Hints:

1. npm run hello runs a script named hello

Good Job! :)