@tombatossals/chords-db

The database stores chords as JavaScript objects where each chord contains a key, a suffix, and an array of positions. Each position represents a specific way to play the chord (a variation).

Key fields within a position include:

• frets: A string representing the fret number for each string (e.g., '0320xx').
• fingers: A string representing the finger used for each string (e.g., '031000').
• barres: An optional integer indicating if a barre is required.
• capo: An optional boolean to indicate if the barre should be represented as a capo.

export default {
  key: 'D',
  suffix: 'sus2',
  positions: [{
    frets: '0320xx',
    fingers: '031000'
  },
  {
    frets: '55775x',
    fingers: '114310',
    barres: 5,
    capo: true
  }]
}

This project uses yarn as the package manager. Use the following commands to manage the library lifecycle:

• yarn build: Generates a new version of the library (required when adding new chords).
• yarn test: Runs tests on the added chords to detect basic mistakes.

The chord data is provided as a JSON library. To use it, you can consume the JSON data and pass it to a utility capable of parsing this specific schema to render chord diagrams visually.

A reference implementation for visual rendering can be seen in the react-chords tool.

The src/db/guitar/chords/F/index.js file exports a default array containing all available guitar chord variations for the key of F. This includes major, minor, diminished, suspended, augmented, and various extended chord types (7ths, 9ths, 11ths, 13ths), as well as specific minor variations and other chord qualities.

To use this data, you can import the default export from this path to get a collection of chord objects representing the key of F.

import fChords from '@tombatossals/chords-db/src/db/guitar/chords/F/index.js';

// fChords is an array containing all chord variations for the key of F
console.log(fChords);

The src/db/guitar/chords/C/index.js module exports a default array containing various guitar chord objects specifically for the key of C. This array includes major, minor, diminished, suspended, and various extended chord types (7ths, 9ths, 11ths, 13ths), as well as relative minor and altered chords.

Each element in the exported array represents a specific chord configuration available in the key of C.

import cChords from '@tombatossals/chords-db/src/db/guitar/chords/C/index.js';

// cChords is an array of chord objects for the key of C
console.log(cChords);

The src/db/piano/chords/D/index.js module exports a default array containing various piano chord definitions specifically for the key of D. This array includes a wide range of chord types such as major, minor, diminished, augmented, suspended, and various seventh, ninth, eleventh, and thirteenth chords. Each element in the array represents a specific chord configuration for the key of D.

import dChords from '@tombatossals/chords-db/src/db/piano/chords/D/index.js';

// dChords is an array of chord objects for the key of D
console.log(dChords);

The src/db/guitar/chords/E/index.js module exports a default array containing various guitar chord variations specifically for the key of E. This array includes major, minor, diminished, suspended, augmented, and various extended chord types (7ths, 9ths, 11ths, 13ths), as well as specific minor variations and altered chords.

When importing this module, you receive a collection of chord objects that can be used to retrieve fingerings or chord properties for the key of E.

import eChords from '@tombatossals/chords-db/src/db/guitar/chords/E/index.js';

// eChords is an array containing all chord variations for the key of E
console.log(eChords);

The src/db/piano/chords/G/index.js module exports a default array containing various piano chord definitions specifically for the key of G. Each element in the array represents a different chord type (e.g., major, minor, diminished, etc.) available in that key. This array can be imported and iterated over to access the specific note structures for each chord type in G.

import gChords from './src/db/piano/chords/G/index.js';

// gChords is an array of chord objects for the key of G
console.log(gChords);

The src/db/guitar/chords/Bb/index.js module exports a default array containing all available guitar chord data specifically for the key of Bb. This array includes various chord qualities such as major, minor, diminished, suspended, augmented, and extended chords (7ths, 9ths, 11ths, 13ths), as well as relative minor and other variations.

When using this module, you receive an array of chord objects that can be iterated over to retrieve fingerings and structures for chords in the Bb key.

import BbChords from './src/db/guitar/chords/Bb/index.js';

// BbChords is an array of chord objects
BbChords.forEach(chord => {
  console.log(chord);
});

The src/db/piano/chords/Bb/index.js module exports a default array containing various piano chord definitions specifically for the key of Bb. This array includes a wide range of chord types such as major, minor, diminished, augmented, dominant 7th, suspended, and extended chords (9ths, 11ths, 13ths). Each element in the array represents a specific chord configuration available in the Bb key.

import BbChords from '@tombatossals/chords-db/src/db/piano/chords/Bb/index.js';

// BbChords is an array of chord objects for the key of Bb
console.log(BbChords);

The src/db/piano/chords/Eb/index.js module exports a default array containing various piano chord variations for the key of Eb. Each element in the array represents a specific chord type (e.g., major, minor, diminished, etc.) available for that key. This data is intended to be consumed by applications providing piano chord information.

import ebChords from '@tombatossals/chords-db/src/db/piano/chords/Eb/index.js';

// ebChords is an array of chord objects for the Eb key
console.log(ebChords);