https://github.com/digital-alchemy-ts/type-writer

Tools for converting Home Assistant to Typescript types
https://github.com/digital-alchemy-ts/type-writer

code-generation digital-alchemy home-assistant home-automation nodejs typescipt

Last synced: about 1 month ago
JSON representation

Tools for converting Home Assistant to Typescript types

• Host: GitHub
• URL: https://github.com/digital-alchemy-ts/type-writer
• Owner: Digital-Alchemy-TS
• License: mit
• Created: 2024-03-10T04:19:45.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-10-30T02:01:56.000Z (3 months ago)
• Last Synced: 2024-10-30T04:02:36.833Z (3 months ago)
• Topics: code-generation, digital-alchemy, home-assistant, home-automation, nodejs, typescipt
• Language: TypeScript
• Homepage: https://docs.digital-alchemy.app
• Size: 1.27 MB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Welcome to `@digital-alchemy/type-writer`!

This application acts a support application for [@digital-alchemy/hass](https://github.com/Digital-Alchemy-TS/hass), providing type definitions to assist during development

- [Project docs](https://docs.digital-alchemy.app)

- [Discord](https://discord.gg/JkZ35Gv97Y)

![editor](./docs/editor.png)

## 🚀 Usage

```bash

# install to devDependencies

npm i --save-dev @digital-alchemy/type-writer

# run

npx type-writer

```

![command](./docs/command.png)

If you are running your code within a Home Assistant addon environment, `type-writer` will automatically connect to your install. No configuration needed!

## ⚙️ Configuration

For setups outside an addon environment, a configuration file is needed. Create one of the following:

- `.type_writer`: add to project root

- `~/.config/type_writer`: add to user configs

**Contents:**

```ini

[hass]

  BASE_URL=http://localhost:8123

  TOKEN=... # YOUR LONG LIVED ACCESS TOKEN

```