harmonics - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "harmonics",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Tools and utilities for a generic representation of scales, chords, progressions etc. for use in music software, music related web & mobile apps, VST/VCV plugins and Max for Live devices.",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest"
   },
@@ -19,3 +19,6 @@ "repository": {
     "scribbletune",
-    "music theory"
+    "music theory",
+    "tonal",
+    "max for live",
+    "vcv rack"
   ],
@@ -29,7 +32,9 @@ "author": "",
   "devDependencies": {
-    "tonal": "^2.2.2"
+    "@tonaljs/tonal": "^4.6.0",
+    "jest": "^26.6.3"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
-  }
+  },
+  "dependencies": {}
 }

README.md

@@ -1,3 +0,54 @@
-# harmonics
+# Harmonics
 
-Tools and utilities for a generic representation of scales, chords, progressions etc. for use in music software, music related web & mobile apps, VST/VCV plugins and Max for Live devices. Uses [tonal](https://github.com/tonaljs/tonal) for western classical and custom generators for other forms of music.
+Tools and utilities for a generic representation of scales, chords, progressions etc. for use in music software, music related web & mobile apps, [scribbletune](https://scribbletune.com), [VCV Rack](https://vcvrack.com/) plugins and [Max for Live](https://www.ableton.com/en/live/max-for-live/) devices. Uses [tonal](https://github.com/tonaljs/tonal) for western classical and custom generators for other forms of music.
+
+## Install
+
+```
+npm install harmonics
+```
+
+## Interface
+
+Use `harmonics` in your project
+
+```javascript
+const harmonics = require('harmonics'); // ['ionian', 'dorian', 'lydian', '...']
+```
+
+Get an `array` of commonly used scales exported from Tonal
+
+```javascript
+harmonics.scales();
+```
+
+Get the notes of a scale as an `array`
+
+```javascript
+harmonics.scale('C4 major'); // ['C4', 'D4', 'E4', 'F4', 'G4', 'A4', 'B4']
+```
+
+Get an `array` of all the available chords (with numeric chords such as `4`, `5`, `7` etc exposed as `4th`, `5th`, `7th`)
+
+```javascript
+harmonics.chords(); // ['M', 'm', 'maj7', '4th']
+```
+
+Get the notes of a chord as an `array` (defaults to the 4th octave)
+
+```javascript
+harmonics.chord('C4 M'); // ['C4', 'E4', 'G4']
+```
+
+Get the notes of a chord as an `array` for a specific octave
+
+```javascript
+harmonics.chord('C5 M'); // ['C5', 'E5', 'G5']
+```
+
+Get the notes of an "inline" chord such as CM or Cmaj7 or Dbsus4_6 (here 6 is the octave). This is used in Scribbletune where you can define a bunch of notes and use chords in between, e.g 'C4 E4 Csus2 G4' (here Csus2 is "inlined" with C4, E4 and G4)
+
+```javascript
+harmonics.inlineChord('CM'); // ['C4', 'E4', 'G4']
+harmonics.inlineChord('CM_5'); // ['C5', 'E5', 'G5']
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14837

increased by491.12%

Number of package files

9

increased by125%

Lines of code

366

increased byInfinity%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

55

increased by1275%

Worsened metrics

Dev dependency count

2

increased by100%

Number of low supply chain risk alerts

1

increased byInfinity%

No dependency changes