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

align-yaml

v0.1.8

Published

Format, prettify, align, whatever you want to call it. This does that to YAML. Great for making long config files more readable!

Downloads

290

Readme

align-yaml NPM version

Format, prettify, align, whatever you want to call it. This does that to YAML. Great for making long config files more readable!

Reformats this:

one: two
three: four
seventeen: five

to this:

one:       two
three:     four
seventeen: five

Install

Install globally with npm:

npm i -g align-yaml

Usage

CLI

From the command line, use:

align [source file] [destination] [padding]

flags

All arguments are optional

  • source: the source file. first argument or -s|--src
  • destination: the destination file path. second argument or -d|--dest
  • padding: the amount of padding to add next to each line. third argument or -p|--pad

Also:

  • If no source or dest is provided, align will search for any .yml or .yaml files in the current working directory and format them.
  • If a source is provided but no dest, the source file will be overwritten.

Glob patterns may also be used:

align **/*.yml

padding

By default, all values are formatted to be aligned to the longest key with one space of padding. e.g.

one:       two
three:     four
seventeen: five

To add extra padding, just do something like align foo.yml -p 10, to get:

one:                two
three:              four
seventeen:          five

API

There isn't much of an API, just do:

var align = require('align-yaml');

Then pass a string to align(str). This is important! Read in the YAML as a string, DON'T PARSE IT.

Just do this, and you'll be fine:

var fs = require('fs');
var str = fs.readFileSync('foo.yml', 'utf8');

align(str, padding);

See the tests for a basic example.

Author

Jon Schlinkert

License

Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license


This file was generated by verb-cli on April 13, 2014.