run local prettier instead of global one

Bumps [prettier](https://github.com/prettier/prettier) from 3.0.0 to 3.0.1.
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md)
- [Commits](https://github.com/prettier/prettier/compare/3.0.0...3.0.1)

---
updated-dependencies:
- dependency-name: prettier
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+github: captn3m0
+ko_fi: captn3m0
+liberapay: captn3m0

.github/workflows/action.yml

@@ -4,13 +4,14 @@ jobs:
   tests:
     strategy:
       matrix:
-        node: ['16', '14', '12']
+        node: ["18", "20", "21"]
     name: Run NPM Stuff
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
-    - uses: actions/setup-node@v2
-      with:
-        node-version: ${{matrix.node}}
-    - run: npm install
-    - run: npm test
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v2
+        with:
+          node-version: ${{matrix.node}}
+      - run: npm install
+      - run: npm run lint
+      - run: npm run test

CHANGELOG.md

@@ -1,32 +1,63 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+
+## 1.0.9
+### Changed
+- Dependency Updates
+- Minimum NodeJS version is now v14
+
+## 1.0.8
 ### Added
+- Dependency Updates
+
+## 1.0.7
+### Added
+- `--version` is now supported
+- An update notification is shown if the package isn't latest.
+
+## 1.0.6 - 2021-07-29
+
+### Added
+
 - Tracklists using duration instead of timestamps are now supported.
 
 ## 1.0.5 - 2021-07-21
+
 ### Changed
+
 - Dependency Updates
 
 ## 1.0.4 - 2021-06-28
+
 ### Added
+
 - Support for timestamps in square brackets (#64)
 - Improved formatting for helptext
+
 ### Changed
+
 - output filename has a default value, and is now optional
 
 ## 1.0.3 - 2021-06-28
+
 ### Changed
+
 - Dependency Updates
 
 ## 1.0.2 - 2021-06-10
+
 ### Changed
+
 - Switches from `mocha` to `minimist` to parse arguments. Now down to 9 total (recursive) dependencies.
 
 ## 1.01 - 2021-06-10
+
 ### Changed
+
 - Dependency Updates

README.md

@@ -52,14 +52,12 @@ You need to pass 2 parameters, a Youtube URL and a output CUE filename. YouTube
     very specific edge cases, they should not be required for most files.
 
     Examples
-      $ youtube-cue --audio-file audio.m4a "https://www.youtube.com/watch?v=THzUassmQwE"
-        "T A Y L O R  S W I F T – Folklore [Full album].cue" saved
-      $ youtube-cue "https://youtu.be/THzUassmQwE" folklore.cue
-        folklore.cue saved
+      $ youtube-cue --audio-file audio.m4a "https://www.youtube.com/watch?v=WzpmVxvoBoc" "The Groovy Nobody - Solarium.cue"
+        "The Groovy Nobody - Solarium.cue" saved
 
 ## Personal Usage
 
-I have this in my `.bashrc` to download, split, tag, and import albums:
+I have this in my `.bashrc` to download, split, tag, and import albums using beet:
 
 ```shell
 function ytdl.album() {

index.js

@@ -1,16 +1,22 @@
 #!/usr/bin/env node
-import ytdl from 'ytdl-core';
-import getArtistTitle from 'get-artist-title'
-import {parse} from './src/parser.js'
-import {generate} from './src/cue.js'
-import minimist from 'minimist'
-import exit from 'process'
+import ytdl from "ytdl-core";
+import getArtistTitle from "get-artist-title";
+import { parse } from "./src/parser.js";
+import { generate } from "./src/cue.js";
+import minimist from "minimist";
+import exit from "process";
+import updateNotifier from "update-notifier";
+import pkg from "./src/package.js";
+
+updateNotifier({ pkg }).notify();
 
 let argv = minimist(process.argv.slice(2), {
-  string: 'audio-file'
+  string: "audio-file",
 });
 
-if (argv._.length <1 || argv.help ){
+if (argv.version) {
+  console.log(pkg.version);
+} else if (argv._.length < 1 || argv.help) {
   console.log(`Usage
     $ youtube-cue [--audio-file audio.m4a] <youtube_url> [output_file]
 
@@ -32,36 +38,45 @@ if (argv._.length <1 || argv.help ){
     The above 2 are only needed to force behaviour in very specific edge cases, they should
     not be required for most files.
 
+    --version Print version
+
   Examples
     $ youtube-cue --audio-file audio.m4a "https://www.youtube.com/watch?v=THzUassmQwE"
       "T A Y L O R  S W I F T – Folklore [Full album].cue" saved
     $ youtube-cue "https://youtu.be/THzUassmQwE" folklore.cue
-      folklore.cue saved`)
+      folklore.cue saved`);
 } else {
-  let url = argv._[0]
+  let url = argv._[0];
 
-  ytdl.getInfo(url).then(info=>{
-    let audioFile = argv['audio-file']? argv['audio-file'] : `${info.videoDetails.title}.m4a`
+  ytdl.getInfo(url).then((info) => {
+    let audioFile = argv["audio-file"]
+      ? argv["audio-file"]
+      : `${info.videoDetails.title}.m4a`;
 
-    let output_file = argv._[1]? argv._[1] : `${info.videoDetails.title}.cue`
+    let output_file = argv._[1] ? argv._[1] : `${info.videoDetails.title}.cue`;
 
-    let forceTimestamps = argv['timestamps']? argv['timestamps'] : false;
+    let forceTimestamps = argv["timestamps"] ? argv["timestamps"] : false;
 
-    let forceDurations = argv['durations']? argv['durations'] : false;
+    let forceDurations = argv["durations"] ? argv["durations"] : false;
 
     if (forceTimestamps && forceDurations) {
       console.error("You can't pass both --timestamps and durations");
-      exit(1)
+      exit(1);
     }
 
-    let res = getArtistTitle(info.videoDetails.title,{
+    let res = getArtistTitle(info.videoDetails.title, {
       defaultArtist: "Unknown Artist",
-      defaultTitle: info.videoDetails.title
+      defaultTitle: info.videoDetails.title,
     });
-    let [artist, album] = res
-    artist = (info.videoDetails.media ? info.videoDetails.media.artist : artist)
-    let tracks = parse(info.videoDetails.description, {artist, forceTimestamps, forceDurations})
-    generate({tracks, artist, audioFile, album}, output_file)
-    console.log(`"${output_file}" saved`)
-  })
+    let [artist, album] = res;
+    artist = info.videoDetails.media ? info.videoDetails.media.artist : artist;
+    let tracks = parse(info.videoDetails.description, {
+      artist,
+      forceTimestamps,
+      forceDurations,
+      length: Number(info.videoDetails.lengthSeconds),
+    });
+    generate({ tracks, artist, audioFile, album }, output_file);
+    console.log(`"${output_file}" saved`);
+  });
 }

package.json

@@ -1,22 +1,25 @@
 {
   "name": "youtube-cue",
-  "version": "1.0.6-beta.0",
+  "version": "1.0.10",
   "description": "Generates Cue sheet from Youtube URL",
   "main": "index.js",
   "scripts": {
-    "test": "mocha"
+    "test": "mocha",
+    "lint": "prettier --check *.js src/*.js test/*.js"
   },
   "bin": "index.js",
   "author": "Nemo <npm@captnemo.in>",
   "license": "MIT",
   "devDependencies": {
-    "mocha": "^9.0.0"
+    "mocha": "^10.0.0",
+    "prettier": "^3.1.0"
   },
   "dependencies": {
     "console-log-level": "^1.4.1",
     "get-artist-title": "^1.3.1",
-    "minimist": "^1.2.5",
-    "ytdl-core": "^4.8.2"
+    "minimist": "^1.2.8",
+    "update-notifier": "^7.0.0",
+    "ytdl-core": "^4.11.5"
   },
   "repository": {
     "type": "git",

src/cue.js

@@ -1,21 +1,27 @@
-import fs from 'fs';
+import fs from "fs";
+
+/** code to create a new CUE file, as per the standard
+ * with a REM PERFORMER, TITLE, FILE attribute
+ * and a list of tracks provided as input
+ */
 
 // https://en.wikipedia.org/wiki/Cue_sheet_(computing)
 export function generate(data, outputFile) {
   try {
-    fs.truncateSync(outputFile)
+    fs.truncateSync(outputFile);
   } catch {}
   fs.appendFileSync(outputFile, `REM Generated using youtube-cue\n`);
   fs.appendFileSync(outputFile, `PERFORMER "${data.artist}"\n`);
   fs.appendFileSync(outputFile, `TITLE "${data.album}"\n`);
   fs.appendFileSync(outputFile, `FILE "${data.audioFile}" M4A\n`);
-  for(var i in data.tracks) {
+  for (var i in data.tracks) {
     let song = data.tracks[i];
-    let minutes = (song.start.hh * 60) + (song.start.mm)
+    let minutes = String(song.start.hh * 60 + song.start.mm).padStart(2, "0");
+    let seconds = String(song.start.ss).padStart(2, "0");
     fs.appendFileSync(outputFile, `  TRACK ${song.track} AUDIO\n`);
     fs.appendFileSync(outputFile, `    TITLE "${song.title}"\n`);
     fs.appendFileSync(outputFile, `    PERFORMER "${song.artist}"\n`);
     // Cue File is always MINUTES:SECONDS:FRAME, where FRAME is 00
-    fs.appendFileSync(outputFile, `    INDEX 01 ${minutes}:${song.start.ss}:00\n`);
+    fs.appendFileSync(outputFile, `    INDEX 01 ${minutes}:${seconds}:00\n`);
   }
 }

src/package.js

@@ -0,0 +1,5 @@
+import { createRequire } from "module";
+const require = createRequire(import.meta.url);
+const data = require("../package.json");
+
+export default data;

src/parser.js

@@ -20,7 +20,8 @@
  *
  * It is suggested to check their lengths and pick one to parse as the Track Title
  */
-const TS_REGEX = /^((?<trackl>\d{1,3})\.)? *(?<text_1>.*?) *[\(\[]?(?<start_ts>((?<start_hh>\d{1,2}):)?(?<start_mm>\d{1,2}):(?<start_ss>\d{1,2})) *-? *[\)\]]?(?<end_ts>(?<end_hh>\d{1,2}:)?(?<end_mm>\d{1,2}):(?<end_ss>\d{1,2}))? *((?<trackr>\d{1,3})\.)? *(?<text_2>.*?)$/;
+const TS_REGEX =
+  /^((?<trackl>\d{1,3})\.)? *(?<text_1>.*?) *[\(\[]?(?<start_ts>((?<start_hh>\d{1,2}):)?(?<start_mm>\d{1,2}):(?<start_ss>\d{1,2})) *-? *[\)\]]?(?<end_ts>(?<end_hh>\d{1,2}:)?(?<end_mm>\d{1,2}):(?<end_ss>\d{1,2}))? *((?<trackr>\d{1,3})\.)? *(?<text_2>.*?)$/;
 import getArtistTitle from "get-artist-title";
 var _options = {};
 
@@ -30,18 +31,18 @@ function convertTime(h, m, s) {
 }
 
 // Only picks out lines which have a timestamp in them
-var filterTimestamp = function(line) {
+var filterTimestamp = function (line) {
   return TS_REGEX.test(line);
 };
 
 // Parse each line as per the regex
-var firstPass = function(line) {
+var firstPass = function (line) {
   let matches = line.match(TS_REGEX);
   let track = matches.groups["trackl"]
     ? +matches.groups["trackl"]
     : matches.groups["trackr"]
-    ? +matches.groups["trackr"]
-    : null;
+      ? +matches.groups["trackr"]
+      : null;
   return {
     track: track,
     start: {
@@ -71,7 +72,7 @@ var firstPass = function(line) {
 };
 
 // Add a calc attribute with total seconds
-var calcTimestamp = function(obj) {
+var calcTimestamp = function (obj) {
   if (obj.end) {
     obj.end.calc = convertTime(obj.end.hh, obj.end.mm, obj.end.ss);
   }
@@ -80,7 +81,7 @@ var calcTimestamp = function(obj) {
 };
 
 // Pick the longer "text" from left or right side.
-var parseTitle = function(obj) {
+var parseTitle = function (obj) {
   obj.title =
     obj._.left_text.length > obj._.right_text.length
       ? obj._.left_text
@@ -89,7 +90,7 @@ var parseTitle = function(obj) {
 };
 
 // Parse the text as the title/artist
-var parseArtist = function(obj) {
+var parseArtist = function (obj) {
   let [artist, title] = getArtistTitle(obj.title, {
     defaultArtist: _options.artist,
     defaultTitle: obj.title,
@@ -100,7 +101,7 @@ var parseArtist = function(obj) {
 };
 
 // If track numbers are not present, add them accordingly
-var addTrack = function(obj, index) {
+var addTrack = function (obj, index) {
   if (obj.track == null) {
     obj.track = index + 1;
   }
@@ -108,7 +109,7 @@ var addTrack = function(obj, index) {
 };
 
 // Add "end" timestamps as next start timestamps
-var addEnd = function(obj, index, arr) {
+var addEnd = function (obj, index, arr) {
   if (!obj.end) {
     if (arr.length != index + 1) {
       let next = arr[index + 1];
@@ -119,7 +120,7 @@ var addEnd = function(obj, index, arr) {
   return obj;
 };
 
-var timeToObject = function(obj) {
+var timeToObject = function (obj) {
   let d = new Date(obj.calc * 1000).toISOString();
   obj.hh = +d.substr(11, 2);
   obj.mm = +d.substr(14, 2);
@@ -131,7 +132,7 @@ var timeToObject = function(obj) {
 // Instead of timestamps, some tracklists use durations
 // If durations are provided, use them to re-calculate
 // the starting and ending timestamps
-var fixDurations = function(list) {
+var fixDurations = function (list) {
   for (let i in list) {
     if (i == 0) {
       // Set the first one to start of track.
@@ -152,9 +153,19 @@ var fixDurations = function(list) {
   }
 };
 
+var dropInvalid = function (e) {
+  // All tracks should start before the closing time
+  if (_options.length) return e.start.calc < _options.length;
+  return true;
+};
+
 export function parse(
   text,
-  options = { artist: "Unknown", forceTimestamps: false, forceDurations: false }
+  options = {
+    artist: "Unknown",
+    forceTimestamps: false,
+    forceDurations: false,
+  },
 ) {
   _options = options;
   let durations = false;
@@ -167,7 +178,7 @@ export function parse(
   if (!options.forceTimestamps) {
     // If our timestamps are not in increasing order
     // Assume that we've been given a duration list instead
-    if (result[0].start.calc!=0) {
+    if (result[0].start.calc != 0) {
       result.forEach((current, index, list) => {
         if (index > 0) {
           let previous = list[index - 1];
@@ -187,5 +198,6 @@ export function parse(
     .map(parseTitle)
     .map(parseArtist)
     .map(addTrack)
-    .map(addEnd);
+    .map(addEnd)
+    .filter(dropInvalid);
 }

test/cue_test.js

@@ -0,0 +1,48 @@
+/*jshint esversion: 6 */
+import { strict as assert } from "assert";
+import { generate } from "../src/cue.js";
+import fs from "fs";
+
+const DATA = {
+  artist: "Dumbledore",
+  album: "Curse of the Elder Wand",
+  audioFile: "audio.m4a",
+  tracks: [
+    {
+      artist: "Unknown",
+      title: "the 1",
+      track: 1,
+      start: { ts: "00:00:00", hh: 0, mm: 0, ss: 0, calc: 0 },
+      end: { ts: "00:3:9", hh: 0, mm: 3, ss: 9, calc: 189 },
+      _: { left_text: "", right_text: "the 1" },
+    },
+    {
+      artist: "Unknown",
+      title: "cardigan",
+      track: 2,
+      start: { ts: "00:3:09", hh: 0, mm: 3, ss: 9, calc: 189 },
+      end: { ts: "00:9:30", hh: 0, mm: 9, ss: 30, calc: 570 },
+      _: { left_text: "", right_text: "cardigan" },
+    },
+  ],
+};
+
+describe("CUE", function () {
+  it("should generate with leading zeroes", function () {
+    generate(DATA, "/tmp/test.cue");
+    const CUE_EXPECTED = `REM Generated using youtube-cue
+PERFORMER "Dumbledore"
+TITLE "Curse of the Elder Wand"
+FILE "audio.m4a" M4A
+  TRACK 1 AUDIO
+    TITLE "the 1"
+    PERFORMER "Unknown"
+    INDEX 01 00:00:00
+  TRACK 2 AUDIO
+    TITLE "cardigan"
+    PERFORMER "Unknown"
+    INDEX 01 03:09:00
+`;
+    assert.equal(CUE_EXPECTED, fs.readFileSync("/tmp/test.cue", "utf-8"));
+  });
+});

test/parser_test.js

@@ -24,21 +24,21 @@ Hello World 48:20
 
 const TEXT_WITH_ARTIST = "12:23 Rolling Stones - Hello World";
 
-describe("Parser", function() {
+describe("Parser", function () {
   var big_result;
-  before(function() {
+  before(function () {
     big_result = parse(TEXT);
   });
-  it("should find all timestamps", function() {
+  it("should find all timestamps", function () {
     assert.equal(big_result.length, 15);
   });
 
-  it("should find artist names", function() {
+  it("should find artist names", function () {
     let result = parse(TEXT_WITH_ARTIST);
     assert.equal(result[0].artist, "Rolling Stones");
   });
 
-  it("should find track numbers", function() {
+  it("should find track numbers", function () {
     assert.equal(big_result[3].track, 1);
     assert.equal(big_result[4].track, 2);
     assert.equal(big_result[5].track, 3);
@@ -51,7 +51,7 @@ describe("Parser", function() {
     assert.equal(big_result[12].track, 10);
   });
 
-  it("should ensure ending timestamps for all", function() {
+  it("should ensure ending timestamps for all", function () {
     assert.deepEqual(big_result[13].end, {
       calc: 3023,
       hh: 0,
@@ -63,8 +63,9 @@ describe("Parser", function() {
     assert.deepEqual(big_result[14].end, null);
   });
 
-  it("should parse timestamps with square brackets", function() {
-    let result = parse(`[00:00:00] 1. Steve Kroeger x Skye Holland - Through The Dark
+  it("should parse timestamps with square brackets", function () {
+    let result =
+      parse(`[00:00:00] 1. Steve Kroeger x Skye Holland - Through The Dark
       [00:02:53] 2. Gabri Ponte x Jerome - Lonely `);
     assert.deepEqual(result[0], {
       artist: "Steve Kroeger x Skye Holland",
@@ -79,7 +80,7 @@ describe("Parser", function() {
     });
   });
 
-  it("should parse durations when given", function() {
+  it("should parse durations when given", function () {
     let result = parse(`1. Artist - Title 6:19
 2. Another Artist - Another Title 6:59
 3. Yet Another Artist - Yet another title 5:12`);
@@ -113,7 +114,7 @@ describe("Parser", function() {
     });
   });
 
-  it("should parse as timestamps if first timestamp is 00:00", function() {
+  it("should parse as timestamps if first timestamp is 00:00", function () {
     let result = parse(`1. Artist - Title 00:00
 2. Another Artist - Another Title 01:00
 3. Yet Another Artist - Yet another title 02:00`);
@@ -140,15 +141,18 @@ describe("Parser", function() {
       track: 3,
       end: null,
       start: { ts: "00:02:00", hh: 0, mm: 2, ss: 0, calc: 120 },
-      _: { left_text: "Yet Another Artist - Yet another title", right_text: "" },
+      _: {
+        left_text: "Yet Another Artist - Yet another title",
+        right_text: "",
+      },
     });
   });
 
-  it("should parse durations as timestamps when forced", function() {
+  it("should parse durations as timestamps when forced", function () {
     let result = parse(
       `1. Artist - Title 5:00
 2. Another Artist - Another Title 4:20`,
-      { forceTimestamps: true }
+      { forceTimestamps: true },
     );
     assert.deepEqual(result[0].end, {
       ts: "00:4:20",
@@ -166,11 +170,11 @@ describe("Parser", function() {
     });
   });
 
-  it("should parse timestamps as durations when forced", function() {
+  it("should parse timestamps as durations when forced", function () {
     let result = parse(
       `1. Artist - Title 1:00
 2. Another Artist - Another Title 1:15`,
-      { forceDurations: true }
+      { forceDurations: true },
     );
     assert.deepEqual(result[0], {
       track: 1,
@@ -214,7 +218,7 @@ describe("Parser", function() {
     });
   });
 
-  it("should parse taylor swift", function() {
+  it("should parse taylor swift", function () {
     let result = parse(`0:00 the 1
     3:29 cardigan
     9:30 the last great american dynasty