1.2.0

- Add getVersions function to CLI & Node
- Fix data pack version returning undefined

Author: Nixinova

.gitignore

@@ -1,4 +1,2 @@
 node_modules/
-
-index.js
-cli.js
+*.js

changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.2.0
+*2021-03-06*
+- Added function `getVersions(pack_format: number, type?: string): object` to retrieve a list of versions that have the specified pack_format.
+- Added CLI implementation of `getVersions`, `pack-format --list [--data|--version] <pack_format>`.
+- Fixed data pack format always returning `undefined`.
+
 ## 1.1.3
 *2021-03-04*
 - Changed output to return `undefined` for future snapshots.

cli.ts

@@ -1,9 +1,17 @@
 #!/usr/bin/env node
-const VERSION: string = '1.1.3'
 
-import getPackFormat from './index'
+const VERSION: string = '1.2.0'
+
+import { getPackFormat, getVersions } from './index'
 
 const arg = (n: number): string => process.argv[n + 1]
+const indent = (n: number): string => ' '.repeat(n * 4)
+const log = function (arg: string, desc: string[], example: string): void {
+    console.log(`\n${indent(2)}pack-format ${arg}`)
+    for (let i in desc)
+        console.log(indent(3) + desc[i])
+    console.log(`${indent(3)}Example: ${example}`)
+}
 
 if (arg(1) && !arg(1).includes('h'))
     if (/^-*v/.test(arg(1)))
@@ -12,17 +20,31 @@ if (arg(1) && !arg(1).includes('h'))
         console.log(`Data pack format of ${arg(2)} is ${getPackFormat(arg(2), 'data')}`)
     else if (/^-*r/.test(arg(1)))
         console.log(`Resource pack format of ${arg(2)} is ${getPackFormat(arg(2), 'resource')}`)
+    else if (/^-*l/.test(arg(1)))
+        if (arg(3)) console.log(getVersions(+arg(3), /^-*d/.test(arg(2)) ? 'data' : 'resource'))
+        else console.log(getVersions(+arg(2)))
     else
         console.log(`Pack format of ${arg(1)} is ${getPackFormat(arg(1))}`)
 else {
-    const indent = (n: number): string => ' '.repeat(n * 4)
-    const log = function (arg: string, ...desc: string[]): void {
-        console.log(`\n${indent(2)}pack-format ${arg}`)
-        for (let i in desc)
-            console.log(indent(+i + 3) + desc[i])
-    }
     console.log(`\n${indent(1)}pack-format arguments:`)
-    log('<version>', 'Retrieve the pack format of any Minecraft version.', 'Defaults to resource pack format when applicable.')
-    log('(--data|-d) <version>', 'Retrieve the data pack format in particular when applicable.')
-    log('(--resource|-r) <version>', 'Retrieve the resource pack format in particular when applicable.')
+    log(
+        '<version>',
+        ['Retrieve the pack format of any Minecraft version.', 'Defaults to resource pack format when applicable.'],
+        'pack-format 1.16',
+    )
+    log(
+        '(--data|-d) <version>',
+        ['Retrieve the data pack format in particular when applicable.'],
+        'pack-format --data 20w45a',
+    )
+    log(
+        '(--resource|-r) <version>', 
+        ['Retrieve the resource pack format in particular when applicable.'],
+        'pack-format -r 20w45a',
+    )
+    log(
+        '(--list|-l) [(--data|-d)|(--resource|-r)] <pack_format>', 
+        ['Retrieve a list of versions attached to a specific pack format.'],
+        'pack-format --list -d 6',
+    )
 }

index.ts

@@ -1,41 +1,49 @@
-#!/usr/bin/env node
+import { packType, formatResult, versionsResult } from './types'
 
 class Snapshot {
     version: string
     constructor(version: string) { this.version = version }
-    get year() { return parseInt(this.version.replace(/^(\d\d).+$/, '$1')) }
-    get week() { return parseInt(this.version.replace(/^\d\dw(\d\d)\w$/, '$1')) }
-    get id() { return (this.year - 10) * 52 + this.week }
+    get year(): number { return parseInt(this.version.replace(/^(\d\d).+$/, '$1')) }
+    get week(): number { return parseInt(this.version.replace(/^\d\dw(\d\d)\w$/, '$1')) }
+    get id(): number { return (this.year - 10) * 52 + this.week }
 }
 
-type packType = 'resource' | 'data'
-type result = number | undefined
+const RELEASES: Record<number, string[]> = {
+    1: ['1.6.x', '1.7.x', '1.8.x'],
+    2: ['1.9.x', '1.10.x'],
+    3: ['1.11.x', '1.12.x'],
+    4: ['1.13.x', '1.14.x'],
+    5: ['1.15.x', '1.16.0', '1.16.1'],
+    6: ['1.16.x'],
+    7: ['1.17.x'],
+}
+
+const d: Date = new Date()
+const fauxCurrentSnapshot: string = (d.getFullYear() - 2000) + 'w' + ((d.getMonth() + 1) * 5) + 'a'
+const START_SNAPSHOTS: Record<string, Record<packType, formatResult>> = {
+    '13w24a': { resource: 1, data: undefined },
+    '15w31a': { resource: 2, data: undefined },
+    '16w32a': { resource: 3, data: undefined },
+    '17w48a': { resource: 4, data: 4 },
+    '20w06a': { resource: 5, data: 5 },
+    '20w45a': { resource: 7, data: 6 },
+    '20w46a': { resource: 7, data: 7 },
+    [fauxCurrentSnapshot]: { resource: undefined, data: undefined }
+}
 
-function getPackFormat(version: string, type?: packType): result {
+function getPackFormat(version: string, type: packType = 'resource'): formatResult {
     if (!version) return undefined
     version = version.toString().toLowerCase().trim()
 
     // Snapshot //
 
     if (/^\d\dw\d\d\w$/.test(version)) {
-        const d: Date = new Date()
-        const fauxCurrentSnapshot: string = (d.getFullYear() - 2000) + 'w' + ((d.getMonth() + 1) * 5) + 'a'
-        const startSnapshots: Record<string, Record<packType, result>> = {
-            '13w24a': { resource: 1, data: undefined },
-            '15w31a': { resource: 2, data: undefined },
-            '16w32a': { resource: 3, data: undefined },
-            '17w48a': { resource: 4, data: 4 },
-            '20w06a': { resource: 5, data: 5 },
-            '20w45a': { resource: 7, data: 6 },
-            '20w46a': { resource: 7, data: 7 },
-            [fauxCurrentSnapshot]: { resource: undefined, data: undefined }
-        }
         const snapshot = new Snapshot(version)
 
-        let ver: result
-        for (let testSnap in startSnapshots) {
+        let ver: formatResult
+        for (let testSnap in START_SNAPSHOTS) {
             if (snapshot.id >= (new Snapshot(testSnap)).id) {
-                ver = startSnapshots[testSnap][type || 'resource']
+                ver = START_SNAPSHOTS[testSnap][type]
             }
         }
         return ver
@@ -49,22 +57,11 @@ function getPackFormat(version: string, type?: packType): result {
         if (version.includes('1.16.2-pre')) return 5
         else version = version.replace(/-.+$/, '')
     }
-
     if (version.match(/^\d+\.\d+$/)) version += '.0'
 
-    const PACK_FORMATS: Record<number, Array<string>> = {
-        1: ['1.6.x', '1.7.x', '1.8.x'],
-        2: ['1.9.x', '1.10.x'],
-        3: ['1.11.x', '1.12.x'],
-        4: ['1.13.x', '1.14.x'],
-        5: ['1.15.x', '1.16.0', '1.16.1'],
-        6: ['1.16.x'],
-        7: ['1.17.x'],
-    }
-    for (let i in PACK_FORMATS) {
-        if (+i < 4 && type === 'data')
-            return undefined
-        for (let testVer of PACK_FORMATS[i]) {
+    for (let i in RELEASES) {
+        if (+i < 4 && type === 'data') continue
+        for (let testVer of RELEASES[i]) {
             const matchExact = testVer === version
             const matchMinor = testVer.includes('x') && version.includes(testVer.replace('.x', ''))
             if (matchExact || matchMinor) return +i
@@ -73,4 +70,39 @@ function getPackFormat(version: string, type?: packType): result {
     return undefined
 }
 
+function getVersions(format: number, type: packType = 'resource'): versionsResult {
+    let output = {
+        'releases': { 'min': '', 'max': '' },
+        'snapshots': { 'min': '', 'max': '' },
+    }
+    if (!format || (type === 'data' && format < 4)) return output
+
+    output.releases.min = RELEASES[format][0]
+    output.releases.max = RELEASES[format].slice(-1)[0]
+
+    const startSnaps = Object.keys(START_SNAPSHOTS)
+    for (let snap in START_SNAPSHOTS) {
+        if (START_SNAPSHOTS[snap][type] === format) {
+            let maxSnap: string = snap
+            let i = 1
+            do {
+                let nextSnap = startSnaps[startSnaps.indexOf(snap) + i++]
+                if (nextSnap) maxSnap = nextSnap
+                else break
+            }
+            while (getPackFormat(maxSnap, type) === getPackFormat(snap, type))
+
+            const prevSnap: string = maxSnap?.replace(/(\d)(?=\w$)/, (_, n) => String(+n - 1))
+            output.snapshots.min = snap
+            output.snapshots.max = prevSnap
+            break
+        }
+    }
+
+    return output
+}
+
+getPackFormat.getPackFormat = getPackFormat
+getPackFormat.getVersions = getVersions
+
 export = getPackFormat

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "pack-format",
-    "version": "1.1.3",
+    "version": "1.2.0",
     "description": "Returns the pack_format of any Minecraft version, including snapshots",
     "scripts": {
         "prepublish": "tsc",
@@ -18,7 +18,8 @@
     },
     "files": [
         "index.js",
-        "cli.js"
+        "cli.js",
+        "test.js"
     ],
     "repository": {
         "type": "git",

package.json

@@ -14,24 +14,42 @@ It was added in Minecraft version 1.6, and as such using this tool on any versio
 ## Install
 
 pack-format is available on [npm](https://www.npmjs.com/package/pack-format).
+You must have Node.js installed to be able to use this.
 
 To install pack-format, open the command line and type `npm install pack-format` to use for a Node.js project, or `npm install -g pack-format` to use from the command line.
 
 ## Usage
 
 ### Node
 
+Retrieve the `pack_format` of a given Minecraft version, optionally specifying whether the resource (default) or data pack version should be returned.
 ```js
 const packFormat = require('pack-format')
 packFormat('1.14.4') // 4
 packFormat('1.16.2-pre1', 'resource') // 5
 packFormat('20w45a', 'data') // 6
 ```
 
+Retrieve a list of versions corresponding to a specific `pack_format`, again optionally specifying resource/data pack version.
+```js
+const {getVersions} = require('pack-format')
+getVersions(3) // { releases: { min: '1.11.x', max: '1.12.x' }, snapshots: { min: '16w32a', max: '17w47a' } }
+getVersions(6, 'data') // { releases: { min: '1.15.x', max: '1.16.1' }, snapshots: { min: '20w06a', max: '20w44a' } }
+```
+
 ### Command line
 
-`pack-format [--data|--resource] <version>`
+Retrieve the `pack_format` of a given Minecraft version:
+```sh
+pack-format [--data|--resource] <version>
+```
 
+Retrieve a list of corresponding Minecraft versions:
+```sh
+pack-format --list [--data|--resource] <pack_format>
+```
+
+Examples:
 ```sh
 > pack-format 1.14.4
 Pack format of 1.14.4 is 4
@@ -41,4 +59,7 @@ Resource pack format of 1.16.2-pre1 is 5
 
 > pack-format --data 20w45a
 Data pack format of 20w45a is 6
+
+> pack-format --list --resource 3
+{ releases: { min: '1.11.x', max: '1.12.x' }, snapshots: { min: '16w32a', max: '17w47a' } }
 ```