@bscotch/gml-parser 1.14.2

package/dist/jsdoc.test.js

@@ -0,0 +1,185 @@
+import { undent } from '@bscotch/utility';
+import { expect } from 'chai';
+import { parseFeatherTypeString } from './jsdoc.feather.js';
+import { parseJsdoc } from './jsdoc.js';
+const functionJsdoc = `
+/// @desc This is a multiline
+///       description.
+/// @param {String} first - This is the first parameter
+/// @param {Real} second This is the second parameter,
+///        which spans multiple lines.
+/// @param {Struct} [third] This parameter is optional
+/// @param {Struct} [fourth = "bleh" ] This is optional and has a default value
+/// @param {Bool} [...] And so is this one, but there can be as many as you want!
+/// @returns {Struct} And here is a multiline
+///  description of the return type.
+/// @self Struct.AnotherConstructor
+/// @deprecated`;
+const functionJsdocJs = `
+* @desc This is a multiline
+*       description.
+@param {String} first This is the first parameter
+* @param {Real} second - This is the second parameter,
+*        which spans multiple lines.
+* @param {Struct} [third] This parameter is optional
+* @param {Struct} [fourth = "bleh" ] This is optional and has a default value
+* @param {Bool} [...] And so is this one, but there can be as many as you want!
+* @returns {Struct} And here is a multiline
+*  description of the return type.
+* @self Struct.AnotherConstructor
+* @deprecated`;
+describe('JSDocs', function () {
+    it('can parse Feather typestrings', function () {
+        const complexType = 'Array<string OR Array<Real>> or Struct.Hello or Id.Map<String,Real>';
+        const parsed = parseFeatherTypeString(complexType);
+        expect(parsed.kind).to.equal('union');
+        expect(parsed.types).to.have.lengthOf(3);
+        expect(parsed.types[0].kind).to.equal('type');
+        expect(parsed.types[0].name.content).to.equal('Array');
+        expect(parsed.types[0].of?.kind).to.equal('union');
+        expect(parsed.types[0].of?.types).to.have.lengthOf(2);
+        expect(parsed.types[0].of?.types[0].kind).to.equal('type');
+        expect(parsed.types[0].of?.types[0].name.content).to.equal('string');
+        expect(parsed.types[0].of?.types[1].kind).to.equal('type');
+        expect(parsed.types[0].of?.types[1].name.content).to.equal('Array');
+        expect(parsed.types[0].of?.types[1].of?.kind).to.equal('union');
+        expect(parsed.types[0].of?.types[1].of?.types).to.have.lengthOf(1);
+        expect(parsed.types[0].of?.types[1].of?.types[0].kind).to.equal('type');
+        expect(parsed.types[0].of?.types[1].of?.types[0].name.content).to.equal('Real');
+        expect(parsed.types[1].kind).to.equal('type');
+        expect(parsed.types[1].name.content).to.equal('Struct.Hello');
+        expect(parsed.types[2].kind).to.equal('type');
+        expect(parsed.types[2].name.content).to.equal('Id.Map');
+        expect(parsed.types[2].of?.kind).to.equal('union');
+        expect(parsed.types[2].of?.types).to.have.lengthOf(2);
+        expect(parsed.types[2].of?.types[0].kind).to.equal('type');
+        expect(parsed.types[2].of?.types[0].name.content).to.equal('String');
+        expect(parsed.types[2].of?.types[1].kind).to.equal('type');
+        expect(parsed.types[2].of?.types[1].name.content).to.equal('Real');
+    });
+    it('can parse GML-style Function JSDocs', function () {
+        const jsdoc = functionJsdoc;
+        const parsed = parseJsdoc(jsdoc);
+        expect(parsed.kind).to.equal('function');
+        expect(parsed.deprecated).to.equal(true);
+        expect(parsed.self?.content).to.equal('Struct.AnotherConstructor');
+        expect(parsed.description).to.equal('This is a multiline\ndescription.');
+        expect(parsed.params).to.have.lengthOf(5);
+        expect(parsed.params[0].name?.content).to.equal('first');
+        expect(parsed.params[0].type?.content).to.equal('String');
+        expect(parsed.params[0].description).to.equal('This is the first parameter');
+        expect(parsed.params[1].name?.content).to.equal('second');
+        expect(parsed.params[1].type?.content).to.equal('Real');
+        expect(parsed.params[1].description).to.equal('This is the second parameter,\nwhich spans multiple lines.');
+        expect(parsed.params[2].name?.content).to.equal('third');
+        expect(parsed.params[2].type?.content).to.equal('Struct');
+        expect(parsed.params[2].optional).to.equal(true);
+        expect(parsed.params[2].description).to.equal('This parameter is optional');
+        expect(parsed.params[3].name?.content).to.equal('fourth');
+        expect(parsed.params[3].type?.content).to.equal('Struct');
+        expect(parsed.params[3].optional).to.equal(true);
+        expect(parsed.params[3].description).to.equal('This is optional and has a default value');
+        expect(parsed.params[4].name?.content).to.equal('...');
+        expect(parsed.params[4].type?.content).to.equal('Bool');
+        expect(parsed.params[4].optional).to.equal(true);
+        expect(parsed.params[4].description).to.equal('And so is this one, but there can be as many as you want!');
+    });
+    it('can parse JS-style Function JSDocs', function () {
+        const jsdoc = functionJsdocJs;
+        const parsed = parseJsdoc(jsdoc);
+        expect(parsed.kind).to.equal('function');
+        expect(parsed.deprecated).to.equal(true);
+        expect(parsed.self?.content).to.equal('Struct.AnotherConstructor');
+        expect(parsed.description).to.equal('This is a multiline\ndescription.');
+        expect(parsed.params).to.have.lengthOf(5);
+        expect(parsed.params[0].name?.content).to.equal('first');
+        expect(parsed.params[0].type?.content).to.equal('String');
+        expect(parsed.params[0].description).to.equal('This is the first parameter');
+        expect(parsed.params[1].name?.content).to.equal('second');
+        expect(parsed.params[1].type?.content).to.equal('Real');
+        expect(parsed.params[1].description).to.equal('This is the second parameter,\nwhich spans multiple lines.');
+        expect(parsed.params[2].name?.content).to.equal('third');
+        expect(parsed.params[2].type?.content).to.equal('Struct');
+        expect(parsed.params[2].optional).to.equal(true);
+        expect(parsed.params[2].description).to.equal('This parameter is optional');
+        expect(parsed.params[3].name?.content).to.equal('fourth');
+        expect(parsed.params[3].type?.content).to.equal('Struct');
+        expect(parsed.params[3].optional).to.equal(true);
+        expect(parsed.params[3].description).to.equal('This is optional and has a default value');
+        expect(parsed.params[4].name?.content).to.equal('...');
+        expect(parsed.params[4].type?.content).to.equal('Bool');
+        expect(parsed.params[4].optional).to.equal(true);
+        expect(parsed.params[4].description).to.equal('And so is this one, but there can be as many as you want!');
+    });
+    it('can parse a GML type tag', function () {
+        const jsdoc = '/// @type {String} - This is a string';
+        const parsed = parseJsdoc(jsdoc);
+        expect(parsed.kind).to.equal('type');
+        expect(parsed.type?.content).to.equal('String');
+        expect(parsed.description).to.equal('This is a string');
+    });
+    it('can parse a JS type tag', function () {
+        const jsdoc = '@type {String} This is a string';
+        const parsed = parseJsdoc(jsdoc);
+        expect(parsed.kind).to.equal('type');
+        expect(parsed.type?.content).to.equal('String');
+        expect(parsed.description).to.equal('This is a string');
+    });
+    it('can parse a self tag', function () {
+        const jsdoc = '/// @self Struct.Hello';
+        const parsed = parseJsdoc(jsdoc);
+        expect(parsed.kind).to.equal('self');
+        expect(parsed.self?.content).to.equal('Struct.Hello');
+    });
+    it('can parse template tags', function () {
+        const jsdoc = undent `
+      /// @template T
+      /// @template {String} U
+      /// @param {T} first
+      /// @returns {U}
+    `;
+        const parsed = parseJsdoc(jsdoc);
+        expect(parsed.kind).to.equal('function');
+        expect(parsed.templates).to.have.lengthOf(2);
+        expect(parsed.templates[0].name?.content).to.equal('T');
+        expect(parsed.templates[0].type).to.be.undefined;
+        expect(parsed.templates[1].name?.content).to.equal('U');
+        expect(parsed.templates[1].type?.content).to.equal('String');
+        expect(parsed.params).to.have.lengthOf(1);
+        expect(parsed.params[0].name?.content).to.equal('first');
+        expect(parsed.params[0].type?.content).to.equal('T');
+        expect(parsed.returns?.type?.content).to.equal('U');
+    });
+    it('can parse utility types', function () {
+        const jsdoc = undent `
+      /// @template {Asset.GMObject} T
+      /// @param {T} first
+      /// @returns {InstanceType<T>}
+    `;
+        const parsed = parseJsdoc(jsdoc);
+        expect(parsed.kind).to.equal('function');
+        expect(parsed.templates).to.have.lengthOf(1);
+        expect(parsed.templates[0].name?.content).to.equal('T');
+        expect(parsed.templates[0].type?.content).to.equal('Asset.GMObject');
+        expect(parsed.params).to.have.lengthOf(1);
+        expect(parsed.params[0].name?.content).to.equal('first');
+        expect(parsed.params[0].type?.content).to.equal('T');
+        expect(parsed.returns?.type?.content).to.equal('InstanceType<T>');
+    });
+    it('can identify typstring ranges', function () {
+        const jsdoc = '/// @type {X|Array<Struct.GlobalConstructor>|String}';
+        const parsed = parseJsdoc(jsdoc);
+        const ranges = parsed.typeRanges;
+        expect(ranges.length).to.equal(4);
+        for (const range of ranges) {
+            const startOffset = jsdoc.indexOf(range.content);
+            expect(range.start.offset).to.equal(startOffset);
+            expect(range.end.offset).to.equal(startOffset + range.content.length - 1);
+            expect(range.start.column).to.equal(startOffset + 1);
+            expect(range.end.column).to.equal(startOffset + range.content.length);
+            expect(range.start.line).to.equal(1);
+            expect(range.end.line).to.equal(1);
+        }
+    });
+});
+//# sourceMappingURL=jsdoc.test.js.map

package/dist/jsdoc.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsdoc.test.js","sourceRoot":"","sources":["../src/jsdoc.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExC,MAAM,aAAa,GAAG;;;;;;;;;;;;gBAYN,CAAC;AAEjB,MAAM,eAAe,GAAG;;;;;;;;;;;;cAYV,CAAC;AAEf,QAAQ,CAAC,QAAQ,EAAE;IACjB,EAAE,CAAC,+BAA+B,EAAE;QAClC,MAAM,WAAW,GACf,qEAAqE,CAAC;QACxE,MAAM,MAAM,GAAG,sBAAsB,CAAC,WAAW,CAAC,CAAC;QACnD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC9C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACnD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACtD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACrE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACpE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAChE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACnE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACxE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CACrE,MAAM,CACP,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC9C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC9D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC9C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACxD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACnD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACtD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACrE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE;QACxC,MAAM,KAAK,GAAG,aAAa,CAAC;QAC5B,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QACnE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACzE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC1D,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAC5C,6BAA6B,CAC9B,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACzD,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAC5C,4DAA4D,CAC7D,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC1D,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAC5C,4BAA4B,CAC7B,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAC5C,0CAA0C,CAC3C,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACxD,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACzD,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAC5C,2DAA2D,CAC5D,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE;QACvC,MAAM,KAAK,GAAG,eAAe,CAAC;QAC9B,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QACnE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACzE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC1D,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAC5C,6BAA6B,CAC9B,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACzD,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAC5C,4DAA4D,CAC7D,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC1D,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAC5C,4BAA4B,CAC7B,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAC5C,0CAA0C,CAC3C,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACxD,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACzD,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAC5C,2DAA2D,CAC5D,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE;QAC7B,MAAM,KAAK,GAAG,uCAAuC,CAAC;QACtD,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yBAAyB,EAAE;QAC5B,MAAM,KAAK,GAAG,iCAAiC,CAAC;QAChD,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE;QACzB,MAAM,KAAK,GAAG,wBAAwB,CAAC;QACvC,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yBAAyB,EAAE;QAC5B,MAAM,KAAK,GAAG,MAAM,CAAA;;;;;KAKnB,CAAC;QACF,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC7C,MAAM,CAAC,MAAM,CAAC,SAAU,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACzD,MAAM,CAAC,MAAM,CAAC,SAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,SAAU,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACzD,MAAM,CAAC,MAAM,CAAC,SAAU,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9D,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC1D,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtD,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yBAAyB,EAAE;QAC5B,MAAM,KAAK,GAAG,MAAM,CAAA;;;;KAInB,CAAC;QACF,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC7C,MAAM,CAAC,MAAM,CAAC,SAAU,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACzD,MAAM,CAAC,MAAM,CAAC,SAAU,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACtE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC1D,MAAM,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtD,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE;QAClC,MAAM,KAAK,GAAG,sDAAsD,CAAC;QACrE,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC;QACjC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAElC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACjD,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACjD,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAC1E,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;YACrD,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACtE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACrC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACrC,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/lexer.d.ts

@@ -0,0 +1,3 @@
+import { Lexer } from 'chevrotain';
+export declare const GmlLexer: Lexer;
+//# sourceMappingURL=lexer.d.ts.map

package/dist/lexer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lexer.d.ts","sourceRoot":"","sources":["../src/lexer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAUnC,eAAO,MAAM,QAAQ,OASnB,CAAC"}

package/dist/lexer.js

@@ -0,0 +1,14 @@
+import { Lexer } from 'chevrotain';
+import { codeTokens } from './tokens.code.js';
+import { multilineDoubleStringTokens, multilineSingleStringTokens, stringTokens, templateTokens, } from './tokens.strings.js';
+export const GmlLexer = new Lexer({
+    defaultMode: 'code',
+    modes: {
+        code: codeTokens,
+        string: stringTokens,
+        multilineDoubleString: multilineDoubleStringTokens,
+        multilineSingleString: multilineSingleStringTokens,
+        template: templateTokens,
+    },
+});
+//# sourceMappingURL=lexer.js.map

package/dist/lexer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lexer.js","sourceRoot":"","sources":["../src/lexer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,OAAO,EACL,2BAA2B,EAC3B,2BAA2B,EAC3B,YAAY,EACZ,cAAc,GACf,MAAM,qBAAqB,CAAC;AAE7B,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,KAAK,CAAC;IAChC,WAAW,EAAE,MAAM;IACnB,KAAK,EAAE;QACL,IAAI,EAAE,UAAU;QAChB,MAAM,EAAE,YAAY;QACpB,qBAAqB,EAAE,2BAA2B;QAClD,qBAAqB,EAAE,2BAA2B;QAClD,QAAQ,EAAE,cAAc;KACyB;CACpD,CAAC,CAAC"}

package/dist/lexer.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=lexer.test.d.ts.map

package/dist/lexer.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lexer.test.d.ts","sourceRoot":"","sources":["../src/lexer.test.ts"],"names":[],"mappings":""}

package/dist/lexer.test.js

@@ -0,0 +1,78 @@
+import { undent } from '@bscotch/utility';
+import fs from 'fs/promises';
+import { GmlLexer } from './lexer.js';
+import { logger } from './logger.js';
+describe('Lexer', function () {
+    it('can lex strings', function () {
+        const sample = undent `
+      "hello"
+      @"world"
+      @'singlez'
+      @"multi
+      line
+      one!"
+    `;
+        const result = GmlLexer.tokenize(sample);
+        if (result.errors.length) {
+            logger.dir(result, { depth: null });
+            throw new Error('Lexer failed to lex sample file: ' + sample);
+        }
+    });
+    it('can lex templates', function () {
+        const sample = '$"a template {woo+3}!"';
+        const result = GmlLexer.tokenize(sample);
+        if (result.errors.length) {
+            logger.dir(result, { depth: null });
+            throw new Error('Lexer failed to lex sample: ' + sample);
+        }
+    });
+    it('can lex GML style JSDocs', function () {
+        const sample = undent `
+      /// @description This is a description
+      /// @param {string} a
+      /// @param {number} b
+      /// @returns {string}
+      function myFunc(a, b) {}
+    `;
+        const result = GmlLexer.tokenize(sample);
+        if (result.errors.length) {
+            logger.dir(result, { depth: null });
+            throw new Error('Lexer failed to lex sample: ' + sample);
+        }
+    });
+    it('can lex JS style JSDocs', function () {
+        const sample = undent `
+      /**
+       * @description This is a description
+       * @param {string} a
+       * @param {number} b
+       * @returns {string}
+       */
+      function myFunc(a, b) {}
+    `;
+        const result = GmlLexer.tokenize(sample);
+        if (result.errors.length) {
+            logger.dir(result.errors, { depth: null });
+            throw new Error('Lexer failed to lex sample: ' + sample);
+        }
+    });
+    it('can lex sample files', async function () {
+        const samples = await fs.readdir('./samples');
+        for (const sample of samples) {
+            const filePath = `./samples/${sample}`;
+            if (await fs.stat(filePath).then((s) => s.isDirectory())) {
+                continue;
+            }
+            const code = await fs.readFile(filePath, 'utf-8');
+            const result = GmlLexer.tokenize(code);
+            if (result.errors.length) {
+                logger.dir(result, { depth: null });
+                throw new Error('Lexer failed to lex sample file: ' + filePath);
+            }
+        }
+    });
+});
+function logResult(result) {
+    logger.log(JSON.stringify(result.tokens, ['image', 'startOffset', 'tokenType', 'name', 'PUSH_MODE', 'POP_MODE'], 2));
+}
+//# sourceMappingURL=lexer.test.js.map

package/dist/lexer.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lexer.test.js","sourceRoot":"","sources":["../src/lexer.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EAAE,MAAM,aAAa,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,QAAQ,CAAC,OAAO,EAAE;IAChB,EAAE,CAAC,iBAAiB,EAAE;QACpB,MAAM,MAAM,GAAG,MAAM,CAAA;;;;;;;KAOpB,CAAC;QACF,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACzB,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,mCAAmC,GAAG,MAAM,CAAC,CAAC;QAChE,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mBAAmB,EAAE;QACtB,MAAM,MAAM,GAAG,wBAAwB,CAAC;QACxC,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACzB,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,8BAA8B,GAAG,MAAM,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE;QAC7B,MAAM,MAAM,GAAG,MAAM,CAAA;;;;;;KAMpB,CAAC;QACF,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACzB,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,8BAA8B,GAAG,MAAM,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yBAAyB,EAAE;QAC5B,MAAM,MAAM,GAAG,MAAM,CAAA;;;;;;;;KAQpB,CAAC;QACF,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACzB,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,8BAA8B,GAAG,MAAM,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE,KAAK;QAC9B,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC9C,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,QAAQ,GAAG,aAAa,MAAM,EAAE,CAAC;YACvC,IAAI,MAAM,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;gBACzD,SAAS;YACX,CAAC;YACD,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAClD,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvC,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;gBACzB,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;gBACpC,MAAM,IAAI,KAAK,CAAC,mCAAmC,GAAG,QAAQ,CAAC,CAAC;YAClE,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAS,SAAS,CAAC,MAAqB;IACtC,MAAM,CAAC,GAAG,CACR,IAAI,CAAC,SAAS,CACZ,MAAM,CAAC,MAAM,EACb,CAAC,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,CAAC,EACtE,CAAC,CACF,CACF,CAAC;AACJ,CAAC"}

package/dist/lib.objects.d.ts

@@ -0,0 +1,190 @@
+export interface ObjectEvent {
+    label: string;
+    name: string;
+    eventNum: number;
+    eventType: number;
+    group: string;
+}
+export type ObjectEventName = (typeof objectEvents)[number]['name'];
+export type ObjectEventLabel = (typeof objectEvents)[number]['label'];
+interface ObjectAlarmEvent<N extends number> extends ObjectEvent {
+    label: `Alarm ${N}`;
+    name: `Alarm_${N}`;
+    eventNum: N;
+    eventType: 2;
+    group: 'alarm';
+}
+/**
+ * Mapping of GameMaker filenames to their corresponding
+ * human-friendly event names.
+ */
+export declare const objectEvents: readonly [{
+    readonly label: "Create";
+    readonly name: "Create_0";
+    readonly eventNum: 0;
+    readonly eventType: 0;
+    readonly group: "main";
+}, {
+    readonly label: "Destroy";
+    readonly name: "Destroy_0";
+    readonly eventNum: 0;
+    readonly eventType: 1;
+    readonly group: "cleanup";
+}, {
+    readonly label: "CleanUp";
+    readonly name: "CleanUp_0";
+    readonly eventNum: 0;
+    readonly eventType: 12;
+    readonly group: "cleanup";
+}, {
+    readonly label: "Room Start";
+    readonly name: "Other_4";
+    readonly eventNum: 4;
+    readonly eventType: 7;
+    readonly group: "cleanup";
+}, {
+    readonly label: "Room End";
+    readonly name: "Other_5";
+    readonly eventNum: 5;
+    readonly eventType: 7;
+    readonly group: "cleanup";
+}, {
+    readonly label: "Game End";
+    readonly name: "Other_3";
+    readonly eventNum: 3;
+    readonly eventType: 7;
+    readonly group: "cleanup";
+}, {
+    readonly label: "Pre-Draw";
+    readonly name: "Draw_76";
+    readonly eventNum: 76;
+    readonly eventType: 8;
+    readonly group: "draw";
+}, {
+    readonly label: "Draw Begin";
+    readonly name: "Draw_72";
+    readonly eventNum: 72;
+    readonly eventType: 8;
+    readonly group: "draw";
+}, {
+    readonly label: "Draw";
+    readonly name: "Draw_0";
+    readonly eventNum: 0;
+    readonly eventType: 8;
+    readonly group: "draw";
+}, {
+    readonly label: "Draw End";
+    readonly name: "Draw_63";
+    readonly eventNum: 63;
+    readonly eventType: 8;
+    readonly group: "draw";
+}, {
+    readonly label: "Post-Draw";
+    readonly name: "Draw_77";
+    readonly eventNum: 77;
+    readonly eventType: 8;
+    readonly group: "draw";
+}, {
+    readonly label: "Draw GUI Begin";
+    readonly name: "Draw_74";
+    readonly eventNum: 74;
+    readonly eventType: 8;
+    readonly group: "draw-gui";
+}, {
+    readonly label: "Draw GUI";
+    readonly name: "Draw_64";
+    readonly eventNum: 64;
+    readonly eventType: 8;
+    readonly group: "draw-gui";
+}, {
+    readonly label: "Draw GUI End";
+    readonly name: "Draw_75";
+    readonly eventNum: 75;
+    readonly eventType: 8;
+    readonly group: "draw-gui";
+}, {
+    readonly label: "Begin Step";
+    readonly name: "Step_1";
+    readonly eventNum: 1;
+    readonly eventType: 3;
+    readonly group: "step";
+}, {
+    readonly label: "Step";
+    readonly name: "Step_0";
+    readonly eventNum: 0;
+    readonly eventType: 3;
+    readonly group: "step";
+}, {
+    readonly label: "End Step";
+    readonly name: "Step_2";
+    readonly eventNum: 2;
+    readonly eventType: 3;
+    readonly group: "step";
+}, ...({
+    label: string;
+    name: string;
+    eventNum: number;
+    eventType: number;
+    group: string;
+} | ObjectAlarmEvent<number> | {
+    readonly label: "Animation Update";
+    readonly name: "Other_58";
+    readonly eventNum: 58;
+    readonly eventType: 7;
+    readonly group: "animation";
+} | {
+    readonly label: "Animation Event";
+    readonly name: "Other_59";
+    readonly eventNum: 59;
+    readonly eventType: 7;
+    readonly group: "animation";
+} | {
+    readonly label: "Async - HTTP";
+    readonly name: "Other_62";
+    readonly eventNum: 62;
+    readonly eventType: 7;
+    readonly group: "async";
+} | {
+    readonly label: "Async - System";
+    readonly name: "Other_75";
+    readonly eventNum: 75;
+    readonly eventType: 7;
+    readonly group: "async";
+} | {
+    readonly label: "Async - Social";
+    readonly name: "Other_70";
+    readonly eventNum: 70;
+    readonly eventType: 7;
+    readonly group: "async";
+} | {
+    readonly label: "Async - Save/Load";
+    readonly name: "Other_72";
+    readonly eventNum: 72;
+    readonly eventType: 7;
+    readonly group: "async";
+} | {
+    readonly label: "Async - Steam";
+    readonly name: "Other_69";
+    readonly eventNum: 69;
+    readonly eventType: 7;
+    readonly group: "async";
+} | {
+    readonly label: "Async - Dialog";
+    readonly name: "Other_63";
+    readonly eventNum: 63;
+    readonly eventType: 7;
+    readonly group: "async";
+} | {
+    readonly label: "Broadcast Message";
+    readonly name: "Other_76";
+    readonly eventNum: 76;
+    readonly eventType: 7;
+    readonly group: "broadcast message";
+})[]];
+/**
+ * Given a GameMaker object event filename, get its human-friendly name. */
+export declare function getEventFromFilename(filename: string): ObjectEvent | undefined;
+export declare function getEventFromLabel(label: string): ObjectEvent | undefined;
+export declare function getEventFrom(eventNum: number, eventType: number): ObjectEvent | undefined;
+export {};
+//# sourceMappingURL=lib.objects.d.ts.map

package/dist/lib.objects.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lib.objects.d.ts","sourceRoot":"","sources":["../src/lib.objects.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AACpE,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC;AAEtE,UAAU,gBAAgB,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,WAAW;IAC9D,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC;IACpB,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC;IACnB,QAAQ,EAAE,CAAC,CAAC;IACZ,SAAS,EAAE,CAAC,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;CAChB;AAqBD;;;GAGG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAyLf,CAAC;AAGX;2EAC2E;AAC3E,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,MAAM,GACf,WAAW,GAAG,SAAS,CAkBzB;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAaxE;AAED,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,GAChB,WAAW,GAAG,SAAS,CAIzB"}