Cómo crear plugins con fsmaker

fsmaker es nuestra herramienta en línea de comandos para crear rápidamente plugins para FacturaScripts, además de modelos, controladores, etc. Es una herramienta muy sencilla con la que ahorrará incontables horas de desarrollo.

Para instalar solamente necesita PHP y Composer.

Instalar Código fuente

Con fsmaker puede:

  • Crear modelos, con sus correspondientes tablas y controladores.
  • Crear extensiones para modelos y controladores.
  • Crear tareas programadas para el cron.
  • Crear tareas para la cola de trabajos.
  • Crear tests unitarios.
  • Ejecutar los tests unitarios.
  • Descargar las últimas traducciones de la web.
  • Empaquetar el plugin y crear el ZIP.
$ fsmaker
FacturaScripts Maker v1.4

crear:
$ fsmaker plugin
$ fsmaker api
$ fsmaker controller
$ fsmaker cron
$ fsmaker cronjob
$ fsmaker extension
$ fsmaker gitignore
$ fsmaker init
$ fsmaker model
$ fsmaker test
$ fsmaker upgrade
$ fsmaker upgrade-bs5
$ fsmaker worker

descargar:
$ fsmaker translations

ejecutar:
$ fsmaker run-tests

comprimir:
$ fsmaker zip

Ejemplo de uso de fsmaker

A continuación vamos a crear un plugin sencillo con fsmaker. Para ello abrimos un terminal en la carpeta Plugins de FacturaScripts y ejecutamos:

fsmaker plugin

fsmaker nos pedirá el nombre del plugin (MisNotas) y creará automáticamente la carpeta en el directorio Plugins. Dentro tenemos la estructura de directorios típica de un plugin de FacturaScripts, junto a los archivos facturascripts.ini, Init.php y Cron.php

Siguiendo con el ejemplo del plugin de notas, vamos a crear un modelo para las notas. Paran ello nos colocamos en el directorio del plugin y llamamos a fsmaker con la opción de model, para crear un nuevo modelo.

cd MisNotas
fsmaker model

fsmaker nos pedirá ahora el nombre del modelo. Para este ejemplo escribiremos MiNota. Después nos pedirá el nombre de la tabla de la base de datos, escribiremos mis_notas. Y por último nos pedirá los nombres y tipos de las columnas de la tabla. Para este ejemplo elegiremos estas columnas:

  • id, serial
  • creation_date, timestamp
  • last_mod, timestamp
  • nick, varchar(50)
  • body, text
  • done, bool

Por último fsmaker nos preguntará si queremos crear los controladores. Seleccionamos que si y elegimos el menú notas y el título notas. Una vez completado se crearán los correspondientes archivos:

  • Controller/EditMiNota.php
  • Controller/ListMiNota.php
  • Model/MiNota.php
  • Table/mis_notas.xml
  • XMLView/EditMiNota.xml
  • XMLView/ListMiNota.xml



Cómo instalar composer y fsmaker

Composer es un gestor de dependencias de PHP. Si no tiene instalado composer en su equipo, puede instalarlo fácilmente siguiendo estas guías que hemos preparado para Windows, Linux y Mac.

Instalar Composer en Linux

Para instalar composer en Linux, puede seguir la guía oficial de instalación en Linux/Unix/macOS. O si está usando Ubuntu o derivados, simplemente abra un terminal e instale el paquete composer con apt:

sudo apt update
sudo apt install composer

Instalar fsmaker en Linux

Una vez instalado composer ya puede instalar fsmaker con estos comandos:

composer global require facturascripts/fsmaker
sudo ln -s ~/.config/composer/vendor/bin/fsmaker /usr/local/bin/fsmaker

Ahora ya puede ejecutar fsmaker desde cualquier carpeta. Simplemente abra un terminal y ejecute:

fsmaker

Instalar Composer en Windows

Para instalar en windows puede seguir la guía oficial de instalación en windows, que normalmente implica descargar y ejecutar el Composer-Setup.exe.

Instalar fsmaker en Windows

Una vez instalado composer ya puede instalar fsmaker con este comando (use PowerShell o CMD):

composer global require facturascripts/fsmaker

Asegúrese de que la carpeta global de Composer (normalmente %APPDATA%\Composer\vendor\bin) está en el PATH del sistema.

Ahora ya puede ejecutar fsmaker desde cualquier carpeta. Simplemente abra un terminal y ejecute:

fsmaker

Nota: En algunas configuraciones de Windows puede ser necesario ejecutar composer global exec fsmaker en lugar de solo fsmaker.

Instalar Composer en macOS

Para instalar composer en macOS, puede seguir la misma guía oficial que para Linux. Normalmente implica ejecutar unos comandos en la Terminal.

Alternativamente, si usa Homebrew:

brew install composer

Instalar fsmaker en macOS

Una vez instalado composer ya puede instalar fsmaker con estos comandos (igual que en Linux):

composer global require facturascripts/fsmaker

Para poder ejecutar fsmaker directamente, cree un enlace simbólico (ajuste la ruta si su home de composer es diferente):

sudo ln -s ~/.composer/vendor/bin/fsmaker /usr/local/bin/fsmaker

Ahora ya puede ejecutar fsmaker desde cualquier carpeta. Simplemente abra Terminal y ejecute:

fsmaker

Cómo actualizar fsmaker

Al estar instalado fsmaker con composer, simplemente debemos llamar a composer para actualizar. Esto descargará siempre la última versión disponible:

composer global update

Consulte nuestra sección de noticias para estar informado o síganos en X, Facebook o YouTube.

Noticias


Cookies
Usamos cookies en nuestro sitio web para brindarte la experiencia más relevante recordando tus preferencias y visitas repetidas. Al hacer clic en "Aceptar", aceptas el uso de TODAS las cookies necesarias.
Copyright (c) 2013-2025 FacturaScripts
0.1047s

Soporte