chore: merge dota-lua-types and panorama-types repositories

Author: ark120202

.editorconfig

@@ -8,5 +8,5 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[{types,normalized}/**/*]
+[packages/*/{types,normalized}/**/*]
 indent_size = 4

.eslintignore

@@ -1,3 +1,3 @@
-/transformer.*
-!/transformer.ts
-/types/*.generated.d.ts
+/packages/*/types/*.generated.d.ts
+/packages/*/transformer/*
+!/packages/*/transformer/index.ts

.eslintrc.json

@@ -1,16 +1,11 @@
 {
   "extends": "@ark120202/eslint-config/node",
   "parserOptions": {
-    "project": [
-      "tsconfig.json",
-      "build/tsconfig.json",
-      "types/tsconfig.json",
-      "normalized/tsconfig.json"
-    ]
+    "project": ["build/tsconfig.json", "packages/*/{,types,normalized}/tsconfig.json"]
   },
   "overrides": [
     {
-      "files": "{types,normalized}/**/*",
+      "files": "packages/*/{types,normalized}/**/*",
       "rules": {
         "no-plusplus": "off",
         "no-var": "off",

.gitignore

@@ -1,5 +1,6 @@
 node_modules
-/types/*.generated.d.ts
-/enum-mappings.json
-/transformer.*
-!/transformer.ts
+*.tsbuildinfo
+/packages/*/enum-mappings.json
+/packages/*/types/*.generated.d.ts
+/packages/*/transformer/*
+!/packages/*/transformer/index.ts

.prettierignore

@@ -1,4 +1,4 @@
-/enum-mappings.json
-/transformer.*
-!/transformer.ts
-/types/*.generated.d.ts
+/packages/*/enum-mappings.json
+/packages/*/types/*.generated.d.ts
+/packages/*/transformer/*
+!/packages/*/transformer/index.ts

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) ark120202
+Copyright (c) ModDota
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,78 +1 @@
-# Dota Lua Types
-
-TypeScript definitions for Dota 2 Lua API, designed to be used with
-[TypeScriptToLua](https://github.com/TypeScriptToLua/TypeScriptToLua).
-
-## Installation
-
-1. Get package from npm
-
-```shell
-yarn add -D dota-lua-types
-# or
-npm install -D dota-lua-types
-```
-
-2. Modify your `tsconfig.json`
-
-```json
-{
-  "compilerOptions": {
-    "types": ["dota-lua-types"],
-    "plugins": [{ "transform": "dota-lua-types/transformer" }]
-  }
-}
-```
-
-## Enums
-
-This package includes 2 versions of enum types - raw and normalized. Raw types are included with
-`"types": ["dota-lua-types"]`. They are defined using original engine names and have no structural
-changes. This makes the code using some enums compatible with Panorama, however it leads to
-repetition and requires you to use inconsistent standard names.
-
-Normalized enum types can be included with `"types": ["dota-lua-types/normalized"]`. With these
-types, enums have consistent names and have no repeated parts. For example, instead of
-`EDOTA_ModifyGold_Reason.DOTA_ModifyGold_Unspecified` you have to write
-`ModifyGoldReason.UNSPECIFIED`.
-
-Both type versions define aliases for alternative names, so libraries created with one version would
-be compatible with a different one.
-
-## Notes
-
-- You can explore the same data in readable form on
-  [dota-data](https://dota-data.netlify.com/vscripts/) page.
-
-- To extend standard classes you can use declaration merging:
-
-  ```ts
-  interface CDOTA_BaseNPC {
-    log(message: string): void;
-  }
-
-  CDOTA_BaseNPC.log = function(message) {
-    print(`${this.GetUnitName()} says: ${message}`);
-  };
-
-  HeroList.GetHero(0)!.log('Hello world');
-  ```
-
-- All Dota classes there are declared as interfaces. To extend them you can use
-  [utilities](https://gist.github.com/ark120202/f9ccd1076887664e8e8cb7e7d78fd7d1)
-
-  ```ts
-  import { BaseAbility, BaseModifier, registerAbility, registerModifier } from './utils';
-
-  @registerAbility('ability_test')
-  export class Test extends BaseAbility {
-    GetIntrinsicModifierName = () => TestModifier.name;
-  }
-
-  @registerModifier('ability_test_modifier')
-  export class TestModifier extends BaseModifier {
-    OnCreated() {
-      print('Test modifier created');
-    }
-  }
-  ```
+# Dota 2 TypeScript declarations

build/index.ts

@@ -1,13 +1,24 @@
 import fs from 'fs-extra';
 import path from 'path';
-import { generated } from './generate';
-import { generatedEnumMappings } from './generate/enums/mappings';
+import { generatedLua } from './lua';
+import { generatedEnumMappings } from './lua/enums/mappings';
+import { generatedPanorama } from './panorama';
 
-fs.outputFileSync(
-  path.resolve(__dirname, '../enum-mappings.json'),
-  JSON.stringify(generatedEnumMappings, null, 2),
-);
+const write = (packageName: string, type: string, content: string) =>
+  fs.outputFile(
+    path.resolve(__dirname, `../packages/${packageName}/types/${type}.generated.d.ts`),
+    content,
+  );
 
-for (const [type, content] of Object.entries(generated)) {
-  fs.outputFileSync(path.resolve(__dirname, `../types/${type}.generated.d.ts`), content);
-}
+Promise.all([
+  ...Object.entries(generatedLua).map(([t, c]) => write('dota-lua-types', t, c)),
+  ...Object.entries(generatedPanorama).map(([t, c]) => write('panorama-types', t, c)),
+  fs.outputJson(
+    path.resolve(__dirname, '../packages/dota-lua-types/enum-mappings.json'),
+    generatedEnumMappings,
+    { spaces: 4 },
+  ),
+]).catch(error => {
+  console.error(error);
+  process.exit(1);
+});

build/generate/api.ts renamed to build/lua/api.ts

@@ -3,7 +3,7 @@ import { generatedEnums, generatedEnumsNormalized } from './enums';
 import { generatedEvents } from './events';
 import { generatedModifierProperties } from './modifier-properties';
 
-export const generated = {
+export const generatedLua = {
   enums: generatedEnums,
   'enums-normalized': generatedEnumsNormalized,
   events: generatedEvents,

build/generate/enums/index.ts renamed to build/lua/enums/index.ts

@@ -217,9 +217,10 @@ export function getFunction<T extends CallableDeclaration>(
 
 const prettierConfig: prettier.Options = {
   parser: 'typescript',
-  ...prettier.resolveConfig.sync(path.resolve(__dirname, '../../types/_.generated.d.ts'), {
-    editorconfig: true,
-  }),
+  ...prettier.resolveConfig.sync(
+    path.resolve(__dirname, '../../packages/dota-lua-types/types/_.generated.d.ts'),
+    { editorconfig: true },
+  ),
 };
 
 export const emit = (

build/generate/enums/mappings.ts renamed to build/lua/enums/mappings.ts

@@ -0,0 +1,14 @@
+import enums from 'dota-data/files/panorama/enums';
+import { emit, withDescription } from './utils';
+
+export const generatedEnums = emit(
+  enums
+    .map(({ name: enumName, members }) => {
+      const memberTypes = members
+        .map(({ name, description, value }) => withDescription(`${name} = ${value}`, description))
+        .join(',\n');
+
+      return `declare enum ${enumName} {${memberTypes}}`;
+    })
+    .join('\n\n'),
+);

build/generate/enums/normalize.ts renamed to build/lua/enums/normalize.ts

@@ -0,0 +1,54 @@
+import events from 'dota-data/files/events';
+import _ from 'lodash';
+import { emit, withDescription } from './utils';
+
+const eventTypeMap: Record<string, string> = {
+  bool: '0 | 1',
+  byte: 'number',
+  short: 'number',
+  int: 'number',
+  long: 'number',
+  float: 'number',
+  uint64: 'number',
+  local: 'any',
+};
+
+// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+export const getEventType = (type: string) => eventTypeMap[type] ?? type;
+
+const gameEventDeclarations = (() => {
+  const members = _.uniqBy(
+    Object.values(events).flatMap(group => Object.entries(group)),
+    // `player_connect` and `hltv_chat` are duplicated
+    ([name]) => name,
+  ).map(([eventName, event]) =>
+    withDescription(
+      `${eventName}: ${
+        event.fields.length === 0 ? 'object' : `${_.upperFirst(_.camelCase(eventName))}Event`
+      }`,
+      event.description,
+    ),
+  );
+  return `interface GameEventDeclarations {${members}}`;
+})();
+
+const eventTypes = Object.values(events)
+  .flatMap(group => Object.entries(group))
+  .map(([eventName, event]) => {
+    const interfaceName = `${_.upperFirst(_.camelCase(eventName))}Event`;
+
+    if (event.fields.length === 0) {
+      return '';
+    }
+
+    const members = event.fields
+      .map(field =>
+        withDescription(`${field.name}: ${getEventType(field.type)}`, field.description),
+      )
+      .join('\n');
+
+    return withDescription(`interface ${interfaceName} {${members}}`, event.description);
+  })
+  .join('\n\n');
+
+export const generatedEvents = emit(gameEventDeclarations + eventTypes);

build/generate/events.ts renamed to build/lua/events.ts

@@ -0,0 +1,7 @@
+import { generatedEnums } from './enums';
+import { generatedEvents } from './events';
+
+export const generatedPanorama = {
+  enums: generatedEnums,
+  events: generatedEvents,
+};

build/generate/index.ts renamed to build/lua/index.ts

@@ -0,0 +1,26 @@
+import path from 'path';
+import prettier from 'prettier';
+import wordwrap from 'wordwrap';
+
+export const withDescription = (declaration: string, description = '') => {
+  if (!description) return declaration;
+  description = wrapDescription(description);
+  description = description.replace(/^/gm, ' * ');
+  description = `/**\n${description}\n*/\n`;
+  return description + declaration;
+};
+
+export const wrapDescription = (description: string, start = 0) =>
+  wordwrap({ stop: 80, start })(description.replace(/\n/g, '\n\n'));
+
+const prettierConfig: prettier.Options = {
+  parser: 'typescript',
+  ...prettier.resolveConfig.sync(
+    path.resolve(__dirname, '../../packages/panorama-types/types/_.generated.d.ts'),
+    { editorconfig: true },
+  ),
+};
+
+// There is some instability in comment formatting
+export const emit = (content: string) =>
+  prettier.format(prettier.format(content, prettierConfig), prettierConfig);

build/generate/modifier-properties.ts renamed to build/lua/modifier-properties.ts

@@ -0,0 +1,10 @@
+{
+  "version": "independent",
+  "npmClient": "yarn",
+  "useWorkspaces": true,
+  "command": {
+    "version": {
+      "message": "chore(release): publish"
+    }
+  }
+}