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

chord-parser

v0.1.1

Published

Parse guitar chords contained within a string of tablature

Downloads

6

Readme

chord-parser

Utility for parsing guitar chords contained within a string of tablature. The most common use case is to wrap all chords found within a song in an anchor tag so that their finger chart can be presented in a tooltip.

Install

npm install chord-parser

or if using on the web, grab the dist/chord-parser.min.js file.

Usage

var input = '\
 Gsus4                Fsus4 F                     Csus4    C      Gsus4/B     \
e|------------3-------------------1-----|-------1---------------0-----------| \
B|---------3-----3-------------------1--|----------------1------1-------1---| \
G|------5-----------5-----3--2----------|----2--------------0--------------0| \
D|-5-------------------5--3--3----------|-3-----------3-----2---------0-----| \
A|--------------------------------------|----------3---------------2--------| \
E|--------------------------------------|-----------------------------------| ';

// Import chord-parser
var ChordParser = require('chord-parser');

// Create a new ChordParser object with the input string
var tabs = new ChordParser(input);

// Wrap chords found in the string (Gsus4, Fsus4, etc.) with an anchor tag
var wrappedTab = tabs.wrap(function(chord) {
  return '<a href="">' + chord + '</a>';
});

// Return an array of unique chords found in the string
var uniques = tabs.unique(); // => ['C', 'Csus4', 'F', 'Fsus4', 'Gsus4', 'Gsus4/B'];

API

constructor

Create a new chord parsing object passing in a string of guitar tabs/chords to parse:

var parser = new ChordParser(inputString);

wrap(replacerFn[, options]);

This method calls the function replacerFn for each chord it finds in the input string, passing in the chord in as its only argument. Your wrapper function should return a string to replace the chord with. A modified version of the input string with the transposed replacements is returned.

new ChordParser('Ab C#').wrap(function(chord) {
  return '<a>' + chord + '</a>';
});

// Return value: '<a>Ab</a> <a>C#</a>'

all([options])

Return a sorted array of all chords found in the input string.

new ChordParser('Ab C# B C#').all();

// Return value: ['Ab', 'B', 'C#', 'C#']

unique([options])

Return a sorted array of unique chords found in the input string.

new ChordParser('Ab C# B C#').unique();

// Return value: ['Ab', 'B', 'C#']

Options

All methods accept an options object as their last argument (or in unique and all's case, the only argument).

  • ignorecase (boolean) - Whether or not to ignore case sensitivity when searching the string for chords. Defaults to false.

Tests

Run npm test.

License

MIT.