Fizzmod Front Packages

Monorepo que contiene npm packages para el desarrollo de proyectos de frontend.

[TOC]

Lista de packages

• @fizzmod/eslint-config Configuración de linter para todos los proyectos y paquetes.

Para ver la instalación y uso de alguno, ingresar al link del package.

Desarrollo de packages

Para facilitar la tarea de gestionar multiples packages en un solo repo utilizamos Lerna, una herramienta muy util que optimiza el flujo de trabajo en la administración de repositorios mupli-package con git y npm.

Publicar un package requiere que cumpla con los siguientes items:

• README.md con instrucciones para instalación, descripción, todas las configuraciones posibles y ejemplos de uso.

• Unit tests, se debe incluir el script test de npm para que corra jest.

• Test coverage de al menos 80%.

• Código sin errores de linter.

• Changelog actualizado.

Creación

Para crear un package simplemente se debe crear una carpeta con el nombre del package dentro de packages/ e inicializar npm dentro.

Estructura de carpetas

front-packages/
  package.json
  packages/
    package-1/
      package.json
      src/
        index.js
        index.test.js
    package-2/
      package.json
        src/
          index.js
          index.test.js

Tests

Para testear los packages utilizamos jest y enzyme(react). Cada package debe tener un script de npm test.

Ejemplo jest:

// sum.js
export const sum = (a, b) => a + b;

// sum.test.js
import { sum } from './sum';

test('adds 1 + 2 to equal 3', () => {
  expect(sum(1, 2)).toBe(3);
});

Ejemplo jest + enzyme:

import React from 'react';
import { shallow } from 'enzyme';

import MyComponent from './MyComponent';
import Foo from './Foo';

describe('<MyComponent />', () => {
  it('renders three <Foo /> components', () => {
    const wrapper = shallow(<MyComponent />);
    expect(wrapper.find(Foo)).toHaveLength(3);
  });

  it('renders an `.icon-star`', () => {
    const wrapper = shallow(<MyComponent />);
    expect(wrapper.find('.icon-star')).toHaveLength(1);
  });
});

describe('<MyComponent /> snapshot', () => {
  it('renders MyComponent', () => {
    const wrapper = shallow(<MyComponent />);
    expect(wrapper).toMatchSnapshot();
  });

  it('renders MyComponent with color blue', () => {
    const wrapper = shallow(<MyComponent color="blue" />);
    expect(wrapper).toMatchSnapshot(1);
  });
});

NPM Scripts

{
  "scripts": {
    "check-uncommited-changes": "git diff --exit-code && git diff --cached --exit-code",
    "clean": "lerna clean",
    "test": "lerna run test",
    "bootstrap": "lerna bootstrap --hoist",
    "publish": "npm run check-uncommited-changes && lerna publish"
  }
}

bootstrap

$ npm run bootstrap

Intala todas las dependencias de los packages y linkea las dependencias cruzadas.

clean

$ npm run clean

Remueve la carpeta node_modules de todos los packages.

publish

$ npm run publish

Publica los packages a npm. Cuando se ejecuta, este comando hace lo siguiente:

Revisa que el working directory y staging area esten limpios.
Crea una nueva release de los packages que han sido actualizados.
Solicita la nueva versión.
Crea un nuevo git commit/tag en el proceso de publicación a npm.

test

$ npm test

Corre los test de todos los packages

¿Por qué están todos los packages en un solo repo?

Mantener muchos packages dispersados en distintos repositorios resulta dificultoso, más aún si se utilizan las mismas herramientas para testeo, linter o desarrollo.
Esta forma de organizar el código es llamada monorepo. Proyectos como Babel, React, Angular, Ember, Meteor, Jest, desarrollan sus packages en un único monorepo.