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-set-cobblestone-site-schedule-file

v0.4.0

Published

Sets schedule data across the entire pipeline from a single file.

Downloads

7

Readme

gulp-set-cobblestone-site-schedule-file

A gulp plugin for setting metadata schedule information from a site-wide schedule YAML.

Setup and usage

Install gulp-set-cobblestone-site-schedule-file using npm:

npm i gulp-set-cobblestone-site-schedule-file

In your gulpfile.js:

var gulp = require('gulp');
var schedule = require('gulp-set-cobblestone-site-schedule-file');

gulp.task('default', function() {
  return gulp.src('./src/**.*')
    .pipe(schedule({ scheduleFile: "schedule.yaml" }))
    .pipe(gulp.dest('./dest'));
});

A common workflow using this tool is to parse the files, then create a propery called breadcrumbs which has an ordered list of parent items, excluding the current one. This can then be walked in a template to write out the crumbs.

Options

property

string

Default: data.schedule

The name of the property (which can be nested) to put the resulting ordered list of breadcrumbs. The resulting item will be an array of schedule data.

scheduleFile

string

The name of the file to load the schedule data (see below). This or scheduleYaml is required.

scheduleYaml

string

A block of YAML formatted data that contains the schedule data (see below). This or scheduleFile is required.

logLevel

number

Defaults: 0

Include increasingly more detailed levels of logging and tracing.

skipIf

{ (file: any) => boolean }

If provided, allows a file-by-file override for the schedule.

Schedule

The schedule file is a YAML file with RegExp keys for relative paths of a file (data.relativePath) with the value being information about that schedule. Any key/values or even nested structures are allowed here and will be push into the schedule block for the file except for three keys which are used for processing and will be removed.

scheduleData (Required)

string | Moment

The date to start the schedule. If the key matches a single file, this will be the schedule data. If multiples are matched, then advanceAmount and advanceUnit will be used to advance the schedule data for each duplicate. The multiple files will be sorted alphabetically to produce a consistent result.

advanceAmount

number

Default: 1

The numerical amount to advance the scheduleData for each additional file that matches the pattern.

advanceUnit

"day" | "week" | "month" | "year"

Defaults: "week"

The unit (as defined in Moment) to advance the time for each additional file that matches the pattern.