allow polytone output to specific files

Author: PssbleTrngle

src/emit/polytoneTabs.ts

@@ -6,16 +6,26 @@ import RegistryLookup from '../loader/registry/index.js'
 import CustomEmitter from './custom.js'
 import { ClearableEmitter } from './index.js'
 
-type AddOptions =
-   | {
-        after: IdInput<ItemId>
-     }
-   | {
-        before: IdInput<ItemId>
-     }
+interface TabOptions {
+   file?: IdInput
+}
+
+interface TabOptionsWithAfter extends TabOptions {
+   after: IdInput<ItemId>
+}
+
+interface TabOptionsWithBefore extends TabOptions {
+   before: IdInput<ItemId>
+}
+
+type AddOptions = TabOptionsWithAfter | TabOptionsWithBefore | TabOptions
 
 export interface PolytoneTabs {
-   remove(tab: IdInput<CreativeModeTabId> | IdInput<CreativeModeTabId>[], items: IdInput<ItemId>[]): void
+   remove(
+      tab: IdInput<CreativeModeTabId> | IdInput<CreativeModeTabId>[],
+      items: IdInput<ItemId>[],
+      options?: TabOptions
+   ): void
    add(
       tab: IdInput<CreativeModeTabId> | IdInput<CreativeModeTabId>[],
       items: IdInput<ItemId>[],
@@ -54,16 +64,25 @@ function mergeModifiers(a: PolytoneTabModifier, b: PolytoneTabModifier): Polyton
    }
 }
 
-function translateOptions(options?: AddOptions): Partial<AdditionEntry> {
-   if (!options) return {}
-   const before = 'before' in options
-   const item = before ? options.before : options.after
-   return {
-      before,
-      predicate: {
-         items: [encodeId(item)],
-         type: 'items_match',
-      },
+function translateOptions(options: AddOptions = {}): Partial<AdditionEntry> {
+   if ('before' in options) {
+      return {
+         before: true,
+         predicate: {
+            items: [encodeId(options.before)],
+            type: 'items_match',
+         },
+      }
+   } else if ('after' in options) {
+      return {
+         before: false,
+         predicate: {
+            items: [encodeId(options.after)],
+            type: 'items_match',
+         },
+      }
+   } else {
+      return {}
    }
 }
 
@@ -88,16 +107,32 @@ export default class PolytoneTabsEmitter implements PolytoneTabs, ClearableEmitt
       await Promise.all([this.entries.emit(acceptor), this.tabs.emit(acceptor)])
    }
 
-   remove(tab: IdInput<CreativeModeTabId> | IdInput<CreativeModeTabId>[], items: IdInput<ItemId>[]) {
-      this.forEach(tab, {
-         removals: [{ type: 'items_match', items: items.map(encodeId) }],
-      })
+   remove(
+      tab: IdInput<CreativeModeTabId> | IdInput<CreativeModeTabId>[],
+      items: IdInput<ItemId>[],
+      options: TabOptions = {}
+   ) {
+      this.forEach(
+         tab,
+         {
+            removals: [{ type: 'items_match', items: items.map(encodeId) }],
+         },
+         options
+      )
    }
 
-   add(tab: IdInput<CreativeModeTabId> | IdInput<CreativeModeTabId>[], items: IdInput<ItemId>[], options?: AddOptions) {
-      this.forEach(tab, {
-         additions: [{ items: items.map(encodeId), ...translateOptions(options) }],
-      })
+   add(
+      tab: IdInput<CreativeModeTabId> | IdInput<CreativeModeTabId>[],
+      items: IdInput<ItemId>[],
+      options: AddOptions = {}
+   ) {
+      this.forEach(
+         tab,
+         {
+            additions: [{ items: items.map(encodeId), ...translateOptions(options) }],
+         },
+         options
+      )
    }
 
    create(id: IdInput) {
@@ -109,14 +144,16 @@ export default class PolytoneTabsEmitter implements PolytoneTabs, ClearableEmitt
 
    private forEach(
       tab: IdInput<CreativeModeTabId> | IdInput<CreativeModeTabId>[],
-      modifier: Omit<PolytoneTabModifier, 'targets'>
+      modifier: Omit<PolytoneTabModifier, 'targets'>,
+      options: TabOptions
    ) {
       arrayOrSelf(tab).forEach(target => {
+         const file = options.file ?? target
          const entry: PolytoneTabModifier = {
             targets: [encodeId(target)],
             ...modifier,
          }
-         this.entries.merge(target, entry, mergeModifiers)
+         this.entries.merge(file, entry, mergeModifiers)
       })
    }
 }

test/__snapshots__/polytoneTabs.test.ts.snap

@@ -24,6 +24,14 @@ exports[`create removal entries > resolves filter correctly > removal modifier 2
 "
 `;
 
+exports[`create removal entries > uses custom file name > removal modifier with custom file name 1`] = `
+"{
+  "targets": ["something:test_tab"],
+  "removals": [{ "type": "items_match", "items": ["minecraft:diamond"] }]
+}
+"
+`;
+
 exports[`creates addition entries > adds after predicate > addition modifier with after predicate 1`] = `
 "{
   "targets": ["example:tab"],
@@ -67,3 +75,11 @@ exports[`creates addition entries > emits per tab key > addition modifier 2 1`]
 }
 "
 `;
+
+exports[`creates addition entries > uses custom file name > removal modifier with custom file name 1`] = `
+"{
+  "targets": ["something:test_tab"],
+  "additions": [{ "items": ["minecraft:diamond"] }]
+}
+"
+`;

test/polytoneTabs.test.ts

@@ -47,6 +47,27 @@ describe('creates addition entries', () => {
          'addition modifier with after predicate'
       )
    })
+
+   it('uses custom file name', async () => {
+      const acceptor = createTestAcceptor()
+
+      loader.tabs.add('something:test_tab', ['minecraft:diamond'], { file: 'other:id' })
+
+      await loader.emit(acceptor)
+
+      expect(acceptor.at('assets/something/polytone/creative_tab_modifiers/test_tab.json')).toBeNull()
+      expect(acceptor.at('assets/other/polytone/creative_tab_modifiers/id.json')).toMatchSnapshot(
+         'removal modifier with custom file name'
+      )
+   })
+
+   it('fails trying to merge modifiers with different targets', () => {
+      loader.tabs.add('something:test_tab', ['minecraft:diamond'], { file: 'other:id' })
+
+      expect(() =>
+         loader.tabs.add('something:another_tab', ['minecraft:diamond_chestplate'], { file: 'other:id' })
+      ).toThrow('trying to merge modifiers with different targets')
+   })
 })
 
 describe('create removal entries', () => {
@@ -67,6 +88,19 @@ describe('create removal entries', () => {
          'removal modifier 1'
       )
    })
+
+   it('uses custom file name', async () => {
+      const acceptor = createTestAcceptor()
+
+      loader.tabs.remove('something:test_tab', ['minecraft:diamond'], { file: 'other:id' })
+
+      await loader.emit(acceptor)
+
+      expect(acceptor.at('assets/something/polytone/creative_tab_modifiers/test_tab.json')).toBeNull()
+      expect(acceptor.at('assets/other/polytone/creative_tab_modifiers/id.json')).toMatchSnapshot(
+         'removal modifier with custom file name'
+      )
+   })
 })
 
 describe('create new tabs', () => {