factorio-test 1.0.0

package/README.md

@@ -0,0 +1,22 @@
+## Factorio Test types
+
+Contains types for Factorio Test, for use with [TypescriptToLua](https://github.com/TypescriptToLua/TypescriptToLua)
+and [typed-factorio](https://github.com/GlassBricks/typed-factorio).
+
+To use, install the `factorio-test` npm package:
+
+```bash
+npm install --save-dev factorio-test
+```
+
+Add this to your `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    "types": [
+      "factorio-test"
+    ]
+  }
+}
+```

package/index.d.ts

@@ -0,0 +1,88 @@
+/** @noSelfInFile */
+/// <reference types="luassert-tstl" />
+
+declare var test: FactorioTest.TestCreator
+declare var it: FactorioTest.TestCreator
+declare var describe: FactorioTest.DescribeCreator
+declare var before_all: FactorioTest.LifecycleFn
+declare var after_all: FactorioTest.LifecycleFn
+declare var before_each: FactorioTest.LifecycleFn
+declare var after_each: FactorioTest.LifecycleFn
+declare var after_test: FactorioTest.LifecycleFn
+declare function async(timeout?: number): void
+declare function done(): void
+declare function on_tick(func: FactorioTest.OnTickFn): void
+declare function after_ticks(ticks: number, func: FactorioTest.TestFn): void
+declare function ticks_between_tests(ticks: number): void
+declare function tags(...tags: string[]): void
+
+/** @noSelf */
+declare namespace FactorioTest {
+  interface Config {
+    default_timeout: number
+    default_ticks_between_tests: number
+
+    game_speed: number
+
+    log_passed_tests: boolean
+    log_skipped_tests: boolean
+
+    test_pattern?: string
+    tag_whitelist?: string[]
+    tag_blacklist?: string[]
+
+    before_test_run?(): void
+    after_test_run?(): void
+
+    sound_effects: boolean
+  }
+
+  type TestFn = () => void
+  type HookFn = TestFn
+  type OnTickFn = (tick: number) => void | boolean
+
+  /** @noSelf */
+  interface TestCreatorBase {
+    (name: string, func: TestFn): TestBuilder
+
+    each<const V extends readonly any[]>(
+      values: readonly V[],
+    ): (name: string, func: (...values: V) => void) => TestBuilder<typeof func>
+    each<const T>(values: readonly T[]): (name: string, func: (value: T) => void) => TestBuilder<typeof func>
+  }
+
+  /** @noSelf */
+  interface TestCreator extends TestCreatorBase {
+    skip: TestCreatorBase
+    only: TestCreatorBase
+    todo(name: string): void
+  }
+
+  /** @noSelf */
+  export interface TestBuilder<F extends (...args: any) => void = TestFn> {
+    after_script_reload(func: F): TestBuilder<F>
+    after_mod_reload(func: F): TestBuilder<F>
+  }
+
+  /** @noSelf */
+  interface DescribeBlockCreatorBase {
+    (name: string, func: TestFn): void
+
+    each<const V extends readonly any[]>(values: readonly V[]): (name: string, func: (...values: V) => void) => void
+    each<const T>(values: readonly T[]): (name: string, func: (value: T) => void) => void
+  }
+
+  /** @noSelf */
+  interface DescribeCreator extends DescribeBlockCreatorBase {
+    skip: DescribeBlockCreatorBase
+    only: DescribeBlockCreatorBase
+  }
+
+  type LifecycleFn = (func: HookFn) => void
+}
+
+/** @noResolution */
+declare module "__factorio-test__/init" {
+  function init(this: void, files: string[], config?: Partial<FactorioTest.Config>): void
+  export = init
+}

package/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "factorio-test",
+  "version": "1.0.0",
+  "description": "Type definitions for using Factorio Test with TypescriptToLua",
+  "files": [
+    "index.d.ts"
+  ],
+  "peerDependencies": {
+    "luassert-tstl": ">=0.2.3",
+    "typed-factorio": "^1.14.0"
+  }
+}