exeteres/opc-types

OpenComputers and TypeScript

OpenComputers and TypeScript

Language

Introduction

This repository contains type declarations for OpenOS and GUI (and also some of it dependencies).

It is assumed that you will use TypeScriptToLua as a transpiler.

Some examples can be found in the examples folder. Also look at VSCode extension, which integrates TypeScript with OpenComputers.

Installation

# Typings for OpenOS
yarn add @opct/openos # or npm install @opct/openos -S

# Typings for MineOS
yarn add @opct/mineos

# Typings for GUI
yarn add @opct/gui

# TSTL
yarn add typescript-to-lua

// tsconfig.json
{
    "compilerOptions": {
        "target": "esnext",
        "outDir": "dist",
        "module": "commonjs",
        "lib": ["esnext"],
        "strict": true,
        "moduleResolution": "node",
        "rootDir": "src",
        "types": [
            "lua-types/jit",
            "@opct/openos",
            "@opct/gui",
            "@opct/mineos"
        ]
    },
    "tstl": {
        "luaTarget": "JIT"
    }
}

Setting up a comfortable working environment

• You can use Visual Studio Code or any other editor with TypeScript support.

• Instead of a real mod, you can use an emulator. Otherwise, it is necessary to set filesystem.bufferChanges to false in order to have external access to the disk.

• Create a link to the disk to keep the source code separate from it:

  # linux / macos
  ln -s /path/to/disk/home/app dist

  # windows (cmd)
  mklink /j dist C:\path\to\disk\home

• Use tstl --watch

opc-types's Issues

Issue building

When trying to build I get this error.

yarn run v1.22.10
$ tstl
node_modules/@opct/openos/component.d.ts:128:15 - error TS2694: Namespace 'OpenOS' has no exported member 'InventoryController'.

128     ): OpenOS.InventoryController | null;
                  ~~~~~~~~~~~~~~~~~~~

node_modules/@opct/openos/component.d.ts:161:72 - error TS2694: Namespace 'OpenOS' has no exported member 'InventoryController'.

161     function getPrimary(componentType: "inventory_controller"): OpenOS.InventoryController;
                                                                           ~~~~~~~~~~~~~~~~~~~

node_modules/@opct/openos/component.d.ts:269:40 - error TS2694: Namespace 'OpenOS' has no exported member 'InventoryController'.

269     const inventory_controller: OpenOS.InventoryController;
                                           ~~~~~~~~~~~~~~~~~~~

error Command failed with exit code 2.