open-telemetry / opentelemetry.io

Gulp - open-telemetry/opentelemetry.io

Gulp is a task runner used for automating development workflows. It uses streams to enable real-time, non-blocking processing of files and data. Gulp is used in the OpenTelemetry.io project for tasks such as linting, formatting, and code analysis.

Design Philosophy:

  • Use Node.js streams for efficient, non-blocking processing
  • Write tasks as code, not configuration
  • Use simple, chainable APIs

Programming Languages:

  • JavaScript
  • TypeScript

Key Technologies and Dependencies:

  • Hugo: used for static site generation
  • Netlify CLI: used for deploying and managing the site
  • Prettier: used for code formatting
  • Textlint: used for linting text
  • Markdown-link-check: used for checking for broken links in markdown files
  • Gulp: used for automating tasks
  • PostCSS-CLI: used for post-processing CSS
  • Autoprefixer: used for adding vendor prefixes to CSS
  • Markdownlint: used for linting markdown files
  • Cspell: used for spell checking

Options and Examples:

  • gulp.task(): defines a new task
  • gulp.src(): specifies the source files for a task
  • gulp.dest(): specifies the destination for the output of a task
  • gulp.watch(): watches for changes to files and runs a task when a change is detected

Examples:

  • Linting and formatting with Prettier and Textlint:
const gulp = require('gulp');
const prettier = require('gulp-prettier');
const textlint = require('gulp-textlint');

gulp.task('lint-and-format', () => {
return gulp.src('src/**/*.md')
.pipe(textlint())
.pipe(prettier())
.pipe(gulp.dest('dist'));
});
  • Checking for broken links in markdown files:
const gulp = require('gulp');
const markdownLinkCheck = require('gulp-markdown-link-check');

gulp.task('check-links', () => {
return gulp.src('src/**/*.md')
.pipe(markdownLinkCheck())
.pipe(gulp.dest('dist'));
});

Sources: