kiubi-sync

Aide à la publication de thème graphique personnalisé sur Kiubi

Usage no npm install needed!

<script type="module">
  import kiubiSync from 'https://cdn.skypack.dev/kiubi-sync';
</script>

README

kiubi-sync

Aide à la publication de thème graphique personnalisé sur Kiubi.

Installation

Installation avec npm:

$ npm install --save-dev kiubi-sync

Utilisation avec Gulp

const { watch } = require('gulp');
const ftpWrapper = require('kiubi-sync');

const ftp = new ftpWrapper({
    user: 'MY-USER',
    password: 'MY-PASSWORD',
});

function watchTask() {
    ftp.watch(watch('theme/**', { events: 'all' }));
}

function pullTask() {
    return ftp.pullAll('theme');
}

function deployTask() {
    return ftp.pushAll('theme');
}

exports.watch = watchTask;

exports.deploy = deployTask;

exports.pull = pullTask;

API

watch

Surveille et publie les modifications locales des fichiers du thème graphique.

Params

  • watcher {chokidar}: Instance de chokidar

Example

ftp.watch(gulp.watch('theme/**', { events: 'all' }));

pullAll

Rapatrie en local tous les fichiers du thème graphique.

Params

  • path {String}: Chemin

Return

  • {Promise}

Example

ftp.pullAll('theme');

pushAll

Publie tous les fichiers du thème graphique.

Params

  • path {String}: Chemin

Return

  • {Promise}

Example

ftp.pushAll('theme');

À propos

Contribution

Pull requests et stars sont les bienvenues. Pour les bugs et les requêtes de fonctionnalités, merci d'ouvrir un rapport de bug.

License

Copyright © 2020, Kiubi. Released under the MIT License.