Se basa en un comando bash que crea, a partir de unos templates que he definido, los ficheros asociados a un component, reducer, action o saga.
Para usarlo, simplemente deberemos abrir una terminal y escribir create-react
seguido de dos parámetros:
- Elemento a crear
- Nombre del elemento a crear
Así, por ejemplo:
create-react component Prueba
Creará un componente y todos los ficheros asociados a él llamado Prueba.
Como hemos dicho antes, el comando admite dos parámetros. El primero de ellos es el tipo de elemento que queremos crear (component, reducer,action o saga), y el segundo, el nombre del elemento.
Crea un componente dentro del directorio src/components. Los archivos asociados que crea son:
-
Component.js: componente react con extensión js que contiene la plantilla básica que usamos en todos los componentes.
-
Component.css: fichero css asociado al componente por si queremos darle formato al html.
-
__tests__/Component.test.js: fichero test del componente con extensión js dentro del directorio __tests__ con la plantilla de los tests que usaremos para los componentes.
Para ejecutarlo, simplemente escribimos:
create-react component Prueba
Crea un reducer dentro del directorio src/reducers. Los archivos que se generan son:
-
nombre.reducer.js: reducer del componente que contiene la plantilla de un reducer react básico.
-
__tests__/reducer.test.js: fichero test del reducer con extensión js creado dentro del directorio __tests__ que contiene la plantilla básica para testear los reducers.
-
index.js: fichero con extensión js mediante el cual exportaremos la función principal del reducer. Si ya existe el fichero, añade el import y el export del reducer.
Para crear el reducer, simplemente escribimos:
create-react reducer Prueba
De igual forma que los dos anteriores, crea un action dentro del directorio src/actions con los siguientes archivos:
-
nombre.action.js: acción del componente que contiene la plantilla de un action de react básico, aunque probablemente no tengamos ni que tocarlo.
-
__tests__/actiontest.js: fichero test del action con extensión js creado dentro del directorio __tests__ que contiene la plantilla básica para testear los actions.
-
index.js: fichero con extensión js mediante el cual exportaremos nuestro action. Si ya existe el fichero, añade el export del action.
Para ejecutarlo, simplemente escribimos:
create-react action Prueba
- Descargar el proyecto del repositorio: https://github.com/SergioFdezRc/create-react
- Dar permisos de ejecución al fichero create-react con el comando
chmod +x create-react
- (Opcional) Cambiar el nombre del directorio por .create-react.
- Crear un enlace simbólico del fichero create-react en el directorio
usr/bin
con el comandosudo ln -s /directory/to/file/create-react /usr/bin/create-react
Haciendo esto, ya podremos ejecutar el comando libremente desde cualquier path.
- Vídeo de ejemplo: create-react-example