CommonJS Modules. Importación y Exportación

  • NODE.JS module patterns using simple examples. Trasparencias. Muestra ejemplos/patrones de exportación-importación (Reveal Slides)
  • Authoring CommonJS modules (CommonJS modules were conceived during the early days of server-side JavaScript environments such as node.js and Narwhal. As a result, CommonJS modules are optimized for these environments, not browser environments)

El comando npm

Ejercicio: Darse de alta en NPM

Para comenzar, crearemos una cuenta de usuario en el repositorio de NPM mediante la cual publicar nuestros propios paquetes:

  1. Abrir el navegador.
  2. Ir a https://npmjs.org
  3. Hacer clic en el enlace sign up
  4. Rellenar el formulario de alta:
    • Formulario para crear la cuenta en npmjs.org
  5. Aceptar los términos de licencia.
  6. Hacer clic en el botón Create an Account para crear la cuenta.
  7. Una vez creada la cuenta, hay que abrir sesión con el servidor NPM para poder publicar paquetes en él. Abrir una consola.
  8. Conectar al repositorio:
    1. $ npm login
    2. Rellene los datos que le solicita.
    3. Consultar la cuenta con la que tenemos abierta la sesión:
      $ npm whoami

Otra forma de darse de alta desde línea de comandos:

  • Ejecuta en la terminal estos comandos:

              npm set init.author.name "Casiano Rodriguez-Leon"
          npm set init.author.email "whatever@gmail.com"
          npm set init.author.url "https://github.com/crguezl"

  • El siguiente comando nos perdirá un email y una password, creando o verificando un usuario en el npm registry, y guardará el token en el fichero ~/.npmrc:

              npm adduser

Creación de Paquetes y Módulos en NodeJS

Documentación

Para escribir documentación para una API

Man pages

Instalación desde GitHub

You can install packages directly from Github, and even specify a tag, sha, or branch if you want.

                npm install https://github.com/ULL-ESIT-DSI-1617/scapegoat.git
                npm install https://github.com/ULL-ESIT-DSI-1617/scapegoat.git#branch

must be https or git+ssh.

See How to install an npm package from GitHub directly? in StackOverflow

Publicación con ámbito en una organización:

      [/tmp/scapegoat(master)]$ npm publish --access public
      + @ull-esit-dsi-1617/scapegoat@1.0.2

Ejemplo de package.json

    [~/javascript/evalua-module/scapegoat(master)]$ pwd -P
    /Users/casiano/local/src/javascript/evalua-module/scapegoat
    [~/javascript/evalua-module/scapegoat(master)]$ tree -I 'node_modules|docs'
    .
    ├── LICENSE-MIT
    ├── README.md
    ├── index.js
    ├── package.json
    └── test
            └── index.js

    1 directory, 5 files
    [~/javascript/evalua-module/scapegoat(master)]$ cat package.json 
    {
        "name": "@ull-esit-dsi-1617/scapegoat",
        "version": "1.0.4",
        "description": "A small library providing utility methods to escape and unescape HTML entities",
        "main": "index.js",
        "scripts": {
            "test": "./node_modules/.bin/mocha --reporter spec",
            "doc": "documentation build index.js -f html -o docs"
        },
        "repository": {
            "type": "git",
            "url": "git@github.com:ULL-ESIT-DSI-1617/scapegoat.git"
        },
        "keywords": [
            "escape",
            "unescape",
            "html"
        ],
        "author": "Casiano Rodriguez <casiano.rodriguez.leon@gmail.com>",
        "licenses": [
            {
                "type": "MIT",
                "url": "https://github.com/ULL-ESIT-DSI-1617/scapegoat/blob/master/LICENSE-MIT"
            }
        ],
        "bugs": {
            "url": "https://github.com/ULL-ESIT-DSI-1617/scapegoat/issues"
        },
        "devDependencies": {
            "mocha": "*",
            "chai": "*"
        }
    }

Semantic versioning and npm

NPM: Otros tutoriales

NPM: Video Tutoriales

Package.json

Scoped Packages

There are only two hard things in Computer Science: cache invalidation and naming things.

—Phil Karlton

Naming things is hard. It’s even harder when there are tens of thousands of other people who want to use the same names that you do. With hundred of thousands of modules on npm, it has been getting hard to find a name that isn’t taken.

Naming things just got a little bit easier for npm users with the introduction of scopes.

What are scopes?: Scopes are like namespaces for npm packages. Each npm user has their own scope.

@username/project-name

This means that you don’t have to worry about someone else taking your package name. Only you can add packages in your scope.

Scoped modules also make it possible to put your private code on npm when you sign up for private modules. With private modules, you have control over who can see and collaborate on any of the modules in your scope.

Public scoped packages are free. To create a scoped package, all you need to do is add your scope to the front of the name property in package.json and run npm with the access option:

npm publish --access=public

NPM Documentation: Getting Started

  1. What is npm?
  2. Installing Node.js and updating npm
  3. Fixing npm permissions
  4. Installing npm packages locally
  5. Using a `package.json`
  6. Updating local packages
  7. Uninstalling local packages
  8. Installing npm packages globally
  9. Updating global packages Uninstalling global packages11. Creating Node.js modules
  10. Publishing npm packages
  11. Semantic versioning and npm
  12. Working with scoped packages
  13. Using tags

NPM: Herramientas de ayuda

Release a new patch (increments from e.g. 1.0.4 to 1.0.5):

release-it

Release a patch, minor, major, or specific version:

release-it minor
release-it 0.8.3

You can also do a "dry run", which won't write/touch anything, but does output the commands it would execute, and show the interactivity:

release-it --dry-run

npm Organizations /npm Organizaciones

Members of an Organization are immediately added to a Developers team that automatically has Read/Write access to all packages published under an Organization scope

  • Publishing an Org Scoped Package

    • To create a new scoped package for your Organization scope, create a directory with the name of the package you would like to create. Navigate into that directory and use this command:

                  npm init --scope=<org_scope>

    • By default all scoped packages are published privately. To publish a scoped package publicly, pass the access flag with the value public:

                  npm publish --access public

  • The developers team

    • The Developers Team is a special Team that is automatically created when you create an Organization.
    • Members are automatically added to the Developers team:
      • The user who created the Organization is added to this team automatically.
      • Any member added to the Organization is also added to this team automatically.
      • If an Owner adds a new Member to an Organization and does not want that Member to be on the Developers team, an Owner can remove them. (Learn more about managing teams).
  • npm-team: Manage organization teams and team memberships
  • npm-access: Set access level on published packages

Documentación

Creación de Paquetes en el Cliente