{"_id":"@buitar/to-guitar","name":"@buitar/to-guitar","dist-tags":{"latest":"0.0.14"},"versions":{"0.0.14":{"name":"@buitar/to-guitar","version":"0.0.14","description":"guitar chord js lib","main":"dist/index.esm.js","types":"dist/index.d.ts","scripts":{"test":"jest","patch":"yarn version --patch","dev":"rollup -c --watch","build":"rollup -c","publish:patch":"yarn build && yarn patch && npm publish"},"repository":{"type":"git","url":"git+https://github.com/Barba828/to-guitar.git"},"keywords":["guitar","chord","music","tone"],"author":{"name":"liningzhu2012@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/Barba828/to-guitar/issues"},"homepage":"https://github.com/Barba828/to-guitar#readme","devDependencies":{"@rollup/plugin-commonjs":"^21.0.2","@rollup/plugin-typescript":"^8.3.1","@types/jest":"^27.4.1","jest":"^27.5.1","rollup":"^2.70.0","rollup-plugin-dts":"^4.2.0","rollup-plugin-node-resolve":"^5.2.0","ts-jest":"^27.1.3"},"gitHead":"2d09652e1824c918a78326b27803eac470feedc4","_id":"@buitar/to-guitar@0.0.14","_nodeVersion":"16.17.0","_npmVersion":"8.15.0","dist":{"integrity":"sha512-IDFVBaqjyqakXn0aZYyqMl5wDftFdaTF7FUiIT3HSByJ3D1aq8jLpl2KhXgWEp1YSN6Lh0UlhYpZVmB/YNjqJw==","shasum":"ca0d6c9457330d50611ba16ca72027e9d594189b","tarball":"https://registry.npmjs.org/@buitar/to-guitar/-/to-guitar-0.0.14.tgz","fileCount":21,"unpackedSize":166321,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD88kY2otrs8drH5jtISuf1mPNQadIHy5d1ge/9aDVLEwIhAPaXbGycfRLrXE6bu2WS7XcyFFH6IVfmfpXuXt3AWajG"}]},"_npmUser":{"name":"barba828","email":"liningzhu828@163.com"},"directories":{},"maintainers":[{"name":"barba828","email":"liningzhu828@163.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/to-guitar_0.0.14_1708678755985_0.364995267567674"},"_hasShrinkwrap":false}},"time":{"created":"2024-02-23T08:59:15.907Z","0.0.14":"2024-02-23T08:59:16.169Z","modified":"2024-02-23T08:59:16.745Z"},"maintainers":[{"name":"barba828","email":"liningzhu828@163.com"}],"description":"guitar chord js lib","homepage":"https://github.com/Barba828/to-guitar#readme","keywords":["guitar","chord","music","tone"],"repository":{"type":"git","url":"git+https://github.com/Barba828/to-guitar.git"},"author":{"name":"liningzhu2012@gmail.com"},"bugs":{"url":"https://github.com/Barba828/to-guitar/issues"},"license":"MIT","readme":"# to-guitar\n\nto-guitar.js for Guitar fretboard and chords\n吉他指板/和弦转换 js 库\n\n## Board\n\n吉他指板对象\n可设置属性包括 调式、音阶、0 品调音、指板品数、调音高度\n可获取属性包括 调式、音阶、和弦类型、顺阶和弦、指板数组\n\n### 基础使用\n\n```js\nimport { Board } from '@buitar/to-guitar'\n\nconst emit = (board) => {\n\tconsole.log('The board changed', board)\n}\nconst options = {\n\tmode: 'major',\n\tscale: 'C',\n}\n\nconst board = new Board(emit, options)\n\nboard.setOptions({\n\tscale: 'D',\n})\n```\n\n## trans\n\n吉他数据转换方法\n\n```js\nimport { rootToChord, transChordTaps } from '@buitar/to-guitar'\n\n// c_minor_chord = \n// {\n// \t\"chord\": [ \"C\", \"D#\", \"G\" ],\n// \t\"chordType\": {\n// \t\t\"tag\": \"m\",\n// \t\t\"name\": \"minor triad\",\n// \t\t\"constitute\": [\n// \t\t\t\"1\",\n// \t\t\t\"3b\",\n// \t\t\t\"5\"\n// \t\t],\n// \t\t\"name_zh\": \"小三和弦\"\n// \t}\n// }\nconst c_minor_chord = rootToChord('C', 'm') // 获取和弦音\n\n// keyboard_taps = [\n// \t{ chordTaps: [...], chordType: {...} },\n// \t...\n// ]\nconst keyboard_taps = transChordTaps([ \"C\", \"D#\", \"G\" ]) // 获取和弦吉他指法\n```\n\n### trans功能\n\n```js\ntoDegreeTag, //和弦音 => 和弦名称[]\nintervalToSemitones, //度数 => 半音程\nrootToChord, //和弦根音 => 和弦\ntoneToChordType, //和弦 => 和弦名称 & 类型\ntransScale, //调式 & 调 => 顺阶音调\ntransScaleDegree, //调式 & 调 => 顺阶和弦\ngenerateFifthCircle, // 五度圈[]\n\ntransBoard, // 二维指板数组\ntransChordTaps, // 和弦指板位置\ngetModeFregTaps, // 获取调式音阶基础指法(上行 & 下行)\ngetModeRangeTaps, // 获取指板某范围内某调式音阶\ngetTapsOnBoard, // 根据指位获取Taps\n...\n```\n\n# TODO\n## 划分层级\n1. 必须要 keyboard\t\t「taps」\n2. 必须要 12 个音名\t\t 「degrees」\n3. 使用音名Note进行计算   「notes」\n4. 直接计算音高Tone\t\t 「tones」","readmeFilename":"README.md"}