@sequencemedia/music-library 1.0.0 → 1.0.4

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run pre-commit

package/README.md

@@ -1,19 +1,22 @@
-# @sequencemedia/itunes-library
+# @sequencemedia/music-library
 
-Parses an `iTunes Library.xml` file and transforms it to [`m3u`](https://en.wikipedia.org/wiki/M3U) files, JSON, or JavaScript.
+Parses an Apple Music `Library.xml` file and transforms it to [`m3u`](https://en.wikipedia.org/wiki/M3U) files, JSON, JavaScript, or EcmaScript.
 
-The command line app can watch for changes to an `iTunes Library.xml` file and write `m3u` files to a destination directory.
+The command line app can watch for changes to an Apple Music `Library.xml` file and write `m3u` files to a destination directory.
 
 Or, the component functions can be imported into your own application. 
 
-This packages implements [`@sequencemedia/itunes-library-parser`](https://github.com/sequencemedia/itunes-library-parser).
+This packages implements [`@sequencemedia/music-library-parser`](https://github.com/sequencemedia/music-library-parser).
 
 Requires [Java](https://www.oracle.com/java/technologies/javase-downloads.html) and [Saxon PE](https://www.saxonica.com/welcome/welcome.xml).
 
 ## Command line app
 
 ```
-npm run start -- --jar "/usr/local/bin/saxon/SaxonPE10-0J/saxon-pe-10.0.jar" --xml "~/Music/iTunes/iTunes Library.xml" --destination "~/Documents/iTunes Library"
+npm run start -- \
+  --jar "/usr/local/bin/saxon/SaxonPE10-6J/saxon-pe-10.6.jar" \
+  --xml "~/Music/Music/Library.xml" \
+  --destination "~/Documents/Music Library"
 ```
 
 Paths will differ on your device.
@@ -23,12 +26,12 @@ Paths will differ on your device.
 Transforms the entire library.
 
 ```javascript
-const { toM3U } = require('./lib/library')
-const {
+import { toM3U } from './src/library/index.mjs'
+import {
   toJSON,
   toJS,
   toES
- } = require('./lib/library/transform')
+ } from './src/library/transform/index.mjs'
 ```
 
 ### `toM3U`
@@ -36,7 +39,7 @@ const {
 Requires the arguments `jar`, `xml`, and `destination`.
 
 - `jar` - the path to the Saxon binary on your device
-- `xml` - the path to the `iTunes Library.xml` file
+- `xml` - the path to the Apple Music `Library.xml` file
 - `destination` - the path for the `m3u` files to be written
 
 Returns a `Promise` resolving when all `m3u` files are written.
@@ -46,7 +49,7 @@ Returns a `Promise` resolving when all `m3u` files are written.
 Requires the arguments `jar`, and `xml`.
 
 - `jar` - the path to the Saxon binary on your device
-- `xml` - the path to the `iTunes Library.xml` file
+- `xml` - the path to the Apple Music `Library.xml` file
 
 Returns a `Promise` resolving to a `JSON` string.
 
@@ -55,7 +58,7 @@ Returns a `Promise` resolving to a `JSON` string.
 Requires the arguments `jar`, and `xml`.
 
 - `jar` - the path to the Saxon binary on your device
-- `xml` - the path to the `iTunes Library.xml` file
+- `xml` - the path to the Apple Music `Library.xml` file
 
 Returns a `Promise` resolving to a JavaScript object.
 
@@ -64,7 +67,7 @@ Returns a `Promise` resolving to a JavaScript object.
 Requires the arguments `jar`, and `xml`.
 
 - `jar` - the path to the Saxon binary on your device
-- `xml` - the path to the `iTunes Library.xml` file
+- `xml` - the path to the Apple Music `Library.xml` file
 
 Returns a `Promise` resolving to a collection of JavaScript `Map` and `Set` instances.
 
@@ -73,12 +76,12 @@ Returns a `Promise` resolving to a collection of JavaScript `Map` and `Set` inst
 Transforms the playlists.
 
 ```javascript
-const { toM3U } = require('./lib/library/playlists')
-const {
+import { toM3U } from './src/library/playlists/index.mjs'
+import {
   toJSON,
   toJS,
   toES
- } = require('./lib/library/playlists/transform')
+ } from './src/library/playlists/transform/index.mjs'
 ```
 
 See **Library**.
@@ -88,12 +91,12 @@ See **Library**.
 Transforms the tracks.
 
 ```javascript
-const { toM3U } = require('./lib/library/tracks')
-const {
+import { toM3U } from './src/library/tracks/index.mjs'
+import {
   toJSON,
   toJS,
   toES
- } = require('./lib/library/tracks/transform')
+ } from './src/library/tracks/transform/index.mjs'
 ```
 
 See **Library**.

package/app.mjs

@@ -1,133 +1,149 @@
-#!/usr/bin/env node
-
-import 'dotenv/config'
-
-import debug from 'debug'
-
-import {
-  readFile
-} from 'fs/promises'
-
-import psList from 'ps-list'
-
-import commander from 'commander'
-
-import * as watch from '#music-library/watch'
-
-const {
-  library,
-  library: {
-    tracks,
-    playlists
-  }
-} = watch
-
-const NAME = 'ml.App'
-process.title = NAME
-
-async function app () {
-  const PACKAGE = JSON.parse(await readFile('./package.json'))
-
-  const {
-    name
-  } = PACKAGE
-
-  /**
-   *  Permit only one instance of the application
-   */
-  try {
-    const a = (await psList())
-      .filter(({ name }) => name === NAME)
-
-    if (a.length > 1) {
-      const {
-        pid: PID
-      } = process
-
-      const {
-        pid
-      } = a.find(({ pid }) => pid !== PID)
-
-      const log = debug('music-library:process:log')
-
-      log(`Killing application "${name}" in process ${pid}.`)
-
-      process.kill(pid)
-    }
-  } catch ({ message }) {
-    const error = debug('music-library:process:error')
-
-    error(message)
-    return
-  }
-
-  const log = debug('@sequencemedia/music-library')
-
-  const {
-    pid,
-    argv,
-    env: {
-      JAR,
-      XML,
-      DESTINATION
-    }
-  } = process
-
-  log(`Starting application "${name}" in process ${pid}.`)
-
-  const {
-    version
-  } = PACKAGE
-
-  commander
-    .version(version)
-    .option('-j, --jar [jar]', 'Path to Saxon PE/EE JAR')
-    .option('-x, --xml [xml]', 'Path to iTunes Library XML')
-    .option('-d, --destination [destination]', 'Destination path for M3Us')
-    .option('-t, --tracks', 'Parse all tracks')
-    .option('-p, --playlists', 'Parse all playlists')
-    .parse(argv)
-
-  const {
-    jar = JAR,
-    xml = XML,
-    destination = DESTINATION,
-    tracks: t = false,
-    playlists: p = false
-  } = commander.opts()
-
-  const l = (
-    (t && p) || (!t && !p)
-  )
-
-  if (l) {
-    log(`Application "${name}" in process ${pid} watching Library.`)
-
-    log({ jar, xml, destination })
-
-    return (
-      library
-        .toM3U(jar, xml, destination)
-    )
-  } else {
-    if (t) {
-      log(`Application "${name}" in process ${pid} watching Tracks.`)
-
-      return (
-        tracks
-          .toM3U(jar, xml, destination)
-      )
-    }
-
-    if (p) {
-      log(`Application "${name}" in process ${pid} watching Playlists.`)
-
-      return (
-        playlists
-          .toM3U(jar, xml, destination)
-      )
-    }
-  }
-}
-
-export default app()
+#!/usr/bin/env node
+
+import 'dotenv/config'
+
+import debug from 'debug'
+
+import {
+  readFile
+} from 'fs/promises'
+
+import psList from 'ps-list'
+
+import commander from 'commander'
+
+import * as watch from '#music-library/watch'
+
+const {
+  library,
+  library: {
+    tracks,
+    playlists
+  }
+} = watch
+
+const log = debug('@sequencemedia/music-library')
+
+log('`music-library` is awake')
+
+const NAME = 'ml.App'
+process.title = NAME
+
+async function app () {
+  const PACKAGE = JSON.parse(await readFile('./package.json'))
+
+  const {
+    name
+  } = PACKAGE
+
+  /**
+   *  Permit only one instance of the application
+   */
+  try {
+    const a = (await psList())
+      .filter(({ name }) => name === NAME)
+
+    if (a.length > 1) {
+      const {
+        pid: PID
+      } = process
+
+      const {
+        pid
+      } = a.find(({ pid }) => pid !== PID)
+
+      const log = debug('@sequencemedia/music-library:process:log')
+
+      log(`Killing application "${name}" in process ${pid}.`)
+
+      process.kill(pid)
+    }
+  } catch ({ message }) {
+    const error = debug('@sequencemedia/music-library:process:error')
+
+    error(message)
+    return
+  }
+
+  const {
+    pid,
+    argv,
+    env: {
+      TRACKS = false,
+      PLAYLISTS = false
+    }
+  } = process
+
+  log(`Starting application "${name}" in process ${pid}.`)
+
+  const {
+    version
+  } = PACKAGE
+
+  try {
+    commander
+      .version(version)
+      .exitOverride()
+      .requiredOption('-j, --jar [jar]', 'Path to Saxon PE/EE JAR')
+      .requiredOption('-x, --xml [xml]', 'Path to iTunes Library XML')
+      .requiredOption('-d, --destination [destination]', 'Destination path for M3Us')
+      .option('-t, --tracks', 'Parse all tracks')
+      .option('-p, --playlists', 'Parse all playlists')
+      .parse(argv)
+  } catch (e) {
+    const {
+      code
+    } = e
+
+    const error = debug('@sequencemedia/music-library:commander:error')
+
+    if (code !== 'commander.missingMandatoryOptionValue') error(e)
+
+    error(`Halting application "${name}" in process ${pid}.`)
+    return
+  }
+
+  const {
+    jar,
+    xml,
+    destination,
+    tracks: t = TRACKS,
+    playlists: p = PLAYLISTS
+  } = commander.opts()
+
+  log({
+    jar,
+    xml,
+    destination
+  })
+
+  try {
+    const l = (
+      (t && p) || (!t && !p)
+    )
+
+    if (l) {
+      log(`Application "${name}" in process ${pid} watching Library.`)
+
+      await library.toM3U(jar, xml, destination)
+    } else {
+      if (t) {
+        log(`Application "${name}" in process ${pid} watching Tracks.`)
+
+        await tracks.toM3U(jar, xml, destination)
+      } else {
+        if (p) {
+          log(`Application "${name}" in process ${pid} watching Playlists.`)
+
+          await playlists.toM3U(jar, xml, destination)
+        }
+      }
+    }
+  } catch ({ message }) {
+    const error = debug('@sequencemedia/music-library:error')
+
+    error(message)
+  }
+}
+
+export default app()

package/babel.config.cjs

@@ -1,24 +1,24 @@
-const presets = [
-  [
-    '@babel/env',
-    {
-      targets: {
-        node: 'current'
-      },
-      useBuiltIns: 'usage',
-      corejs: 3
-    }
-  ]
-]
-
-const plugins = [
-  '@babel/proposal-export-default-from',
-  '@babel/proposal-export-namespace-from'
-]
-
-module.exports = {
-  compact: true,
-  comments: false,
-  presets,
-  plugins
-}
+const presets = [
+  [
+    '@babel/env',
+    {
+      targets: {
+        node: 'current'
+      },
+      useBuiltIns: 'usage',
+      corejs: 3
+    }
+  ]
+]
+
+const plugins = [
+  '@babel/proposal-export-default-from',
+  '@babel/proposal-export-namespace-from'
+]
+
+module.exports = {
+  compact: true,
+  comments: false,
+  presets,
+  plugins
+}

package/build/gulp/pre-commit.mjs

@@ -0,0 +1,114 @@
+import debug from 'debug'
+
+import {
+  exec
+} from 'child_process'
+
+const log = debug('@sequencemedia/music-library:build:gulp:pre-commit')
+
+log('`@sequencemedia/music-library` is awake')
+
+const PACKAGE_VERSION_CHANGES = /\-+\s+"version":\s+"(\d+\.\d+\.\d+)",+\s+\++\s+"version":\s+"(\d+\.\d+\.\d+)",+\s+/ /* eslint-disable-line no-useless-escape */
+
+const HAS_STAGED_CHANGES = /Changes to be committed/s
+
+const NOT_STAGED_CHANGES = /Changes not staged for commit/s
+
+const OPTIONS = {
+  maxBuffer: 1024 * 500
+}
+
+export function hasPackageVersionChanges () {
+  log('hasPackageVersionChanges')
+
+  return (
+    new Promise((resolve, reject) => {
+      exec('git diff HEAD origin/main package.json', OPTIONS, (e, v) => (!e) ? resolve(PACKAGE_VERSION_CHANGES.test(v)) : reject(e))
+    })
+  )
+}
+
+export function notPackageVersionChanges () {
+  log('notPackageVersionChanges')
+
+  return (
+    new Promise((resolve, reject) => {
+      exec('git diff HEAD origin/main package.json', OPTIONS, (e, v) => (!e) ? resolve(PACKAGE_VERSION_CHANGES.test(v) !== true) : reject(e))
+    })
+  )
+}
+
+export function hasStagedChanges () {
+  log('hasStagedChanges')
+
+  return (
+    new Promise((resolve, reject) => {
+      exec('git status', OPTIONS, (e, v) => (!e) ? resolve(HAS_STAGED_CHANGES.test(v)) : reject(e))
+    })
+  )
+}
+
+export function notStagedChanges () {
+  log('notStagedChanges')
+
+  return (
+    new Promise((resolve, reject) => {
+      exec('git status', OPTIONS, (e, v) => (!e) ? resolve(NOT_STAGED_CHANGES.test(v)) : reject(e))
+    })
+  )
+}
+
+export function notPushedChanges () {
+  log('notPushedChanges')
+
+  return (
+    new Promise((resolve, reject) => {
+      exec('git log origin/main..HEAD', OPTIONS, (e, v) => (!e) ? resolve(!!v) : reject(e))
+    })
+  )
+}
+
+export function patchPackageVersion () {
+  log('patchPackageVersion')
+
+  return (
+    new Promise((resolve, reject) => {
+      exec('npm version patch -m %s -n --no-git-tag-version --no-verify', OPTIONS, (e) => (!e) ? resolve() : reject(e))
+    })
+  )
+}
+
+export function addPackageVersionChanges () {
+  log('addPackageVersionChanges')
+
+  return (
+    new Promise((resolve, reject) => {
+      exec('git add package.json package-lock.json', OPTIONS, (e) => (!e) ? resolve() : reject(e))
+    })
+  )
+}
+
+export default async function preCommit () {
+  log('pre-commit')
+
+  try {
+    /**
+     *  Not changes added, exit
+     */
+    if (await notStagedChanges()) return
+    /**
+     *  Has changes added, continue
+     */
+    if (await hasStagedChanges()) {
+      /**
+       *  Not package version changes, continue
+       */
+      if (await notPackageVersionChanges()) {
+        await patchPackageVersion()
+        await addPackageVersionChanges()
+      }
+    }
+  } catch ({ code = 'NONE', message = 'No error message defined' }) {
+    log({ code, message })
+  }
+}

package/gulpfile.mjs

@@ -0,0 +1,9 @@
+import gulp from 'gulp'
+
+import preCommit from '#build/gulp/pre-commit'
+
+gulp
+  .task('pre-commit', preCommit)
+
+gulp
+  .task('default', gulp.series('pre-commit'))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sequencemedia/music-library",
-  "version": "1.0.0",
+  "version": "1.0.4",
   "description": "Watch Apple Music Library XML and parse to JSON, JS, ES, or M3U",
   "keywords": [
     "music",
@@ -34,17 +34,20 @@
   "scripts": {
     "lint": "eslint . --ext .mjs --ext .cjs",
     "lint:fix": "npm run lint -- --fix",
-    "start": "cross-env DEBUG=@sequencemedia/music-library* NODE_ENV=production node .",
-    "start:dev": "cross-env DEBUG=@sequencemedia/music-library* NODE_ENV=development node ."
+    "start": "cross-env DEBUG=@sequencemedia/music-library,@sequencemedia/music-library:*,@sequencemedia/music-library-parser,@sequencemedia/music-library-parser:* NODE_ENV=production node .",
+    "dev": "cross-env DEBUG=@sequencemedia/music-library,@sequencemedia/music-library:*,@sequencemedia/music-library-parser,@sequencemedia/music-library-parser:* NODE_ENV=development node .",
+    "gulp": "gulp --color",
+    "pre-commit": "npm run lint && cross-env DEBUG=@sequencemedia/music-library,@sequencemedia/music-library:* npm run gulp -- pre-commit",
+    "prepare": "husky install"
   },
   "dependencies": {
-    "@sequencemedia/music-library-parser": "1.0.0",
+    "@sequencemedia/music-library-parser": "1.0.2",
     "chokidar": "^3.5.2",
     "commander": "^8.3.0",
     "cross-env": "^7.0.3",
     "debug": "^4.3.3",
     "dotenv": "^10.0.0",
-    "ps-list": "7.2.0",
+    "ps-list": "^8.0.0",
     "supports-color": "^9.2.1"
   },
   "devDependencies": {
@@ -57,21 +60,27 @@
     "core-js": "^3.20.1",
     "eslint": "7.32.0",
     "eslint-config-standard": "^16.0.3",
-    "eslint-import-resolver-babel-module": "^5.3.1",
     "eslint-plugin-import": "^2.25.3",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "5.2.0",
-    "rimraf": "^3.0.2"
+    "gulp": "^4.0.2",
+    "husky": "^7.0.4"
   },
   "imports": {
     "#music-library/common/normalise": "./src/common/normalise.mjs",
     "#music-library/library": "./src/library/index.mjs",
+    "#music-library/library/transform": "./src/library/transform/index.mjs",
+    "#music-library/library/playlists": "./src/library/playlists/index.mjs",
+    "#music-library/library/playlists/transform": "./src/library/playlists/transform/index.mjs",
+    "#music-library/library/tracks": "./src/library/tracks/index.mjs",
+    "#music-library/library/tracks/transform": "./src/library/tracks/transform/index.mjs",
     "#music-library/watch": "./src/watch/index.mjs",
     "#music-library/watch/library": "./src/watch/library/index.mjs",
     "#music-library/watch/library/transform": "./src/watch/library/transform/index.mjs",
     "#music-library/watch/library/playlists": "./src/watch/library/playlists/index.mjs",
     "#music-library/watch/library/playlists/transform": "./src/watch/library/playlists/transform/index.mjs",
     "#music-library/watch/library/tracks": "./src/watch/library/tracks/index.mjs",
-    "#music-library/watch/library/tracks/transform": "./src/watch/library/tracks/transform/index.mjs"
+    "#music-library/watch/library/tracks/transform": "./src/watch/library/tracks/transform/index.mjs",
+    "#build/gulp/*": "./build/gulp/*.mjs"
   }
 }

package/src/common/normalise.mjs

@@ -2,8 +2,10 @@ import {
   homedir
 } from 'os'
 
-import path from 'path'
+import {
+  resolve
+} from 'path'
 
-const normalise = (p) => path.resolve(p.trim().replace(/^~/, homedir()))
+const normalise = (p = '') => resolve(String(p).trim().replace(/^~/, homedir()))
 
 export default normalise

package/src/index.mjs

@@ -1 +1 @@
-export * as library from '#music-library/library'
+export * as library from '#music-library/library'