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

gulp-clang-format

v1.0.27

Published

Checks that code is properly formatted

Downloads

56,510

Readme

gulp-clang-format

Gulp plugin to check that code is properly formatted, according to clang-format.

If the code differs from how clang-format would format it, this prints a warning to the build output, as well as a command to run that formats the file in-place.

Usage

Sample gulpfile.js:

var format = require('gulp-clang-format');

var srcsToFmt = ['path/**/*.js'];

gulp.task('check-format', function() {
  return gulp.src(srcsToFmt)
     .pipe(format.checkFormat());
});

gulp.task('format', function() {
  // The base option ensures the glob doesn't strip prefixes
  return gulp.src(srcsToFmt, {base: '.'})
      .pipe(format.format())
      .pipe(gulp.dest('.'));
});

Promoting warnings to errors

If you want to enforce the formatting, so that other team members don't introduce code that gives you a warning, you can turn them into build errors by acting on the 'warning' event. For example, this task exits the build immediately:

var format = require('gulp-clang-format');

gulp.task('check-format', function() {
  return gulp.src('*.js')
      .pipe(format.checkFormat('file'))
      .on('warning', function(e) {
        process.stdout.write(e.message);
        process.exit(1);
      });
});

Options

The format() and checkFormat() both accept two options: opt_clangStyle and opt_clangFormat. checkFormat() also accepts a third option, opt_gulpOptions.

opt_clangStyle

An optional parameter indicating the clang-format style to use. By default, it applies the "Google" style.

The parameter is passed to the -style argument of clang-format. See the docs here: http://clang.llvm.org/docs/ClangFormatStyleOptions.html

The recommended value is the string 'file', this means that clang-format will look for a .clang-format file in your repository. This allows you to keep the formatting consistent with other developers.

opt_clangFormat

The resolved clang-format module to use. Useful to pass a specific clang-format version to the task.

var format = require('gulp-clang-format');
var clangFormat = require('clang-format');

gulp.task('check-format', function() {
  return gulp.src('*.js')
      .pipe(format.checkFormat('file', clangFormat));
});

opt_gulpOptions

Options for the gulp operation. Supported options are

  • verbose, which causes a diff of all changed files to be printed.
  • fail, which causes the task to emit an error instead of a warning.
var format = require('gulp-clang-format');

gulp.task('check-format', function() {
  return gulp.src('*.js')
      .pipe(format.checkFormat(undefined, undefined, {verbose: true, fail: true}));
});