npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@amaplex-software/gulp-slack

v0.1.2

Published

Post messages to Slack

Downloads

3

Readme

#gulp-slack

Simple gulp plugin to post information to Slack.

##Usage

###Basic use


var sftp = require('gulp-sftp');
var slack = require('gulp-slack')({
    url: '*Your Webhook URL*',
    channel: '#foo', // Optional
    user: 'bar', // Optional
    icon_url: 'http://foo.com/bar.jpg', // Optional
    icon_emoji: ':bowtie:' // Optional
});

gulp.task('deploy', function () {
    return gulp.src('src/*')
        .pipe(sftp({
            host: 'website.com',
            user: 'johndoe',
            pass: '1234'
        }))
        .pipe(slack('Deployed latest build'));
});

###Attachments

To display a richly-formatted message attachment in Slack, you need to pass an attachments array to gulp-slack. Each element of this array should contain the following parameters:


{
    'fallback': 'Required text summary of the attachment that is shown by clients that understand attachments but choose not to show them.',
    'text': 'Optional text that should appear within the attachment',
    'pretext': 'Optional text that should appear above the formatted data',
    'color': '#36a64f', // Can either be one of 'good', 'warning', 'danger', or any hex color code
    // Fields are displayed in a table on the message
    'fields': [
    {
        'title': 'Required Field Title', // The title may not contain markup and will be escaped for you
        'value': 'Text value of the field. May contain standard message markup and must be escaped as normal. May be multi-line.',
        'short': false // Optional flag indicating whether the `value` is short enough to be displayed side-by-side with other values
    }
}

Example:


var sftp = require('gulp-sftp');
var slack = require('gulp-slack')({
    url: '*Your Webhook URL*',
    channel: '#foo', // Optional
    user: 'bar', // Optional
    icon_url: 'http://foo.com/bar.jpg', // Optional
    icon_emoji: ':bowtie:' // Optional
});

gulp.task('deploy', function () {
    return gulp.src('src/*')
        .pipe(sftp({
            host: 'website.com',
            user: 'johndoe',
            pass: '1234'
        }))
        .pipe(slack([
            {
                'fallback': 'Latest build available <https://website.com/|here>',
                'pretext': 'Latest build available <https://website.com/|here>',
                'color': '#daa520',
                'fields': [
                    {
                        'title': 'Notes',
                        'value': 'Gulp is awesome!'
                    }
                ]
            }
        ]));
});