sync (#18)

.cspell.json

@@ -0,0 +1,9 @@
+{
+  "version": "0.2",
+  "ignorePaths": [],
+  "dictionaryDefinitions": [],
+  "dictionaries": [],
+  "words": ["hass", "bunx"],
+  "ignoreWords": [],
+  "import": []
+}

.eslintrc.json

@@ -0,0 +1,89 @@
+{
+  "env": {
+    "es6": true,
+    "node": true
+  },
+  "plugins": [
+    "import",
+    "jsonc",
+    "no-unsanitized",
+    "sonarjs",
+    "simple-import-sort",
+    "sort-keys-fix",
+    "unicorn",
+    "prettier"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "sourceType": "module",
+    "project": ["tsconfig.json"]
+  },
+  "overrides": [
+    {
+      "files": ["src/**/*.ts"],
+      "extends": [
+        "plugin:@typescript-eslint/recommended",
+        "plugin:jsonc/recommended-with-jsonc",
+        "plugin:sonarjs/recommended",
+        "plugin:unicorn/recommended",
+        "plugin:prettier/recommended",
+        "plugin:@cspell/recommended"
+      ],
+      "parser": "@typescript-eslint/parser",
+      "rules": {
+        "prettier/prettier": "error",
+        "unicorn/switch-case-braces": "off",
+        "unicorn/prefer-module": "off",
+        "@typescript-eslint/no-magic-numbers": "off",
+        "unicorn/no-object-as-default-parameter": "off",
+        "unicorn/no-null": "off",
+        "unicorn/no-empty-file": "off",
+        "sonarjs/prefer-single-boolean-return": "off",
+        "unicorn/no-array-callback-reference": "off",
+        "unicorn/no-await-expression-member": "off",
+        "unicorn/no-useless-undefined": "off",
+        "@typescript-eslint/unbound-method": "error",
+        "import/no-extraneous-dependencies": [
+          "error",
+          {
+            "packageDir": "./"
+          }
+        ],
+        "sonarjs/prefer-immediate-return": "off",
+        "no-case-declarations": "off",
+        "no-async-promise-executor": "off",
+        "sonarjs/no-duplicate-string": "off",
+        "unicorn/prefer-node-protocol": "off",
+        "unicorn/no-array-for-each": "off",
+        "unicorn/import-style": "off",
+        "sort-keys-fix/sort-keys-fix": "warn",
+        "unicorn/prefer-event-target": "off",
+        "simple-import-sort/imports": "warn",
+        "simple-import-sort/exports": "warn",
+        "no-console": ["error"],
+        "@typescript-eslint/no-unnecessary-type-constraint": "off",
+        "@typescript-eslint/no-unused-vars": "warn",
+        "@typescript-eslint/no-explicit-any": "error"
+      }
+    },
+    {
+      "files": ["*.spec.ts", "*.test.ts"],
+      "env": {
+        "jest": true
+      },
+      "rules": {
+        "@typescript-eslint/unbound-method": "off",
+        "@typescript-eslint/no-magic-numbers": "off",
+        "sonarjs/no-unused-collection": "warn",
+        "unicorn/consistent-function-scoping": "off"
+      }
+    },
+    {
+      "files": ["metrics.helper.ts", "*.module.ts"],
+      "parser": "@typescript-eslint/parser",
+      "rules": {
+        "@typescript-eslint/no-magic-numbers": "off"
+      }
+    }
+  ]
+}

.github/FUNDING.yml

@@ -1,7 +1,7 @@
 # These are supported funding model platforms
 
 # Note: This is an override for this repository specifically
-github: [webbertakken, zoe-codez]
+github: webbertakken
 patreon: # Replace with a single Patreon username
 open_collective: # replace with a single OpenCollective username
 ko_fi: # Replace with a single Ko-fi username

.github/workflows/main.yaml

@@ -20,7 +20,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version-file: package.json
-          cache: "yarn"
+          cache: 'yarn'
 
       - name: Install deps
         run: yarn install --frozen-lockfile --immutable

.github/workflows/pull-request.yaml

@@ -20,13 +20,13 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version-file: package.json
-          cache: "yarn"
+          cache: 'yarn'
 
       - name: Install deps
         run: yarn install --frozen-lockfile --immutable
 
       - name: Tests
-        run: yarn test:coverage
+        run: yarn coverage
 
       - name: Upload coverage reports to Codecov
         uses: codecov/[email protected]

.gitignore

@@ -4,10 +4,8 @@
 /node_modules
 /deploy
 /previous_deploy.tar.gz
-/synapse_storage.db
 /.yarn
 /.idea
 /.vscode
 /.env*
 !/.env*.dist
-!/.env*.template

.husky/pre-commit

@@ -4,5 +4,5 @@
 # If tty is available, apply fix from https://github.com/typicode/husky/issues/968#issuecomment-1176848345
 if sh -c ": >/dev/tty" >/dev/null 2>/dev/null; then exec >/dev/tty 2>&1; fi
 
-# Heavy checks should only be done on staged files
-yarn lint-staged
+# Heavy checks should only be done on staged files123
+bun run lint-staged

.prettierrc.json

@@ -1,7 +1,7 @@
 {
-  "singleQuote": false,
-  "trailingComma": "all",
-  "jsxSingleQuote": false,
+  "semi": false,
+  "singleQuote": true,
   "printWidth": 100,
-  "arrowParens": "avoid"
+  "trailingComma": "all",
+  "proseWrap": "always"
 }

Dockerfile

@@ -4,6 +4,9 @@
 ##                                                       ##
 ###########################################################
 
+# see all versions at https://hub.docker.com/r/oven/bun/tags
+ARG BUN_VERSION="1"
+
 # see all versions at https://hub.docker.com/r/bitnami/node/tags
 ARG NODE_VERSION="20"
 
@@ -35,7 +38,7 @@ ENV VOLTA_HOME "/root/.volta"
 ENV PATH "$VOLTA_HOME/bin:$PATH"
 
 # Copy only relevant files
-COPY package.json yarn.lock .yarnrc.yml tsconfig.json vitest.config.ts .prettier* .eslint* /app/
+COPY package.json yarn.lock .yarnrc.yml tsconfig.json vitest.config.ts .prettier* .eslint* .cspell.json /app/
 COPY src/ /app/src/
 
 # Build and pre-flight checks
@@ -87,9 +90,6 @@ WORKDIR /app
 # Copy the distributable files and production specific dependencies
 COPY --from=builder /app/dist /app/package.json ./
 
-# match port in app
-ENV PORT 3000
-
 # Run the app
-EXPOSE $PORT
+EXPOSE 3000
 CMD ["./server"]

README.md

@@ -1,84 +1,117 @@
-## Automation Standalone 🏡💻🐳
+# Automation Standalone 🏡💻🐳
 
 Welcome to the Digital Alchemy standalone automation repository!
 
-This repository is designed to work as a locally running development server, as well as providing options for long term deployments.
+## Purpose
 
-- 📚 [Documentation](https://docs.digital-alchemy.app)
+This repository is designed to work both locally and deployed as a docker container. The container
+will interact with the HomeAssistant websocket to fulfill its automation goals.
+
+## Community
+
+- 📚 [Documentation](https://docs.digital-alchemy.app/)
 - 🗣️ [Discord](https://discord.gg/JkZ35Gv97Y)
 
-## 🏗️ Setup
+## Setup
 
 ### Prerequisites
 
-Digital Alchemy targets `node20`, which is the only required system dependency. Recommended workspace tools:
+These tools need to be installed on your machine:
 
 - [Volta](https://volta.sh/) - Autonomously manages Node and Yarn versions
 - [Docker desktop](https://www.docker.com/products/docker-desktop/) - For packaging the application
 
 ### Clone
 
-Clone the repository to your local machine and change directory to thew new repo:
+Clone the repository to your local machine:
 
 ```bash
 git clone [email protected]/Digital-Alchemy-TS/automation-standalone.git
+```
+
+### Change directory
 
+Change directory to the repository root:
+
+```bash
 cd automation-standalone
 ```
 
-### Install Dependencies
+### Install
 
 Install dependencies using Yarn:
 
 ```bash
-# (optional) enable yarn for setups without Volta
-corepack enable
-
-# install node_modules
-yarn install
+yarn
 ```
 
 ### Configure
 
-Create a `.env` file from the `.env.template` example file. <sup>[docs](https://docs.digital-alchemy.app/docs/core/configuration)</sup>
+Create a `.env` file from the `.env.dist` example file.
 
 ```bash
-cp .env.template .env
+cp .env.dist .env
 ```
 
 Then, configure each variable in `.env` so that the application can connect to your HA instance.
 
-## 🪄 Workspace Usage
+## Usage
 
-### Management
+### Sync
 
-Upgrade the version of `@digital-alchemy` libraries to latest.
+Synchronize the latest DA packages and write types based on your HA instance
 
 ```bash
-yarn upgrade
+yarn sync
 ```
 
-Update the library type definitions based on current Home Assistant state. <sup>[docs](https://docs.digital-alchemy.app/docs/home-automation/type-writer/)</sup>
+### Run
+
+Run your automations locally
 
 ```bash
-yarn type-writer
+yarn dev
 ```
 
-### Run
+## Testing
 
-Run your automations locally
+#### Unit tests and integration tests
+
+Run all your tests
 
 ```bash
-# normal start
-yarn start
+yarn test
+```
+
+#### End-to-end tests
+
+See [./playground](./playground/README.md) folder readme.
+
+## Publication
 
-# automatic reload when code changes
-yarn start:watch
+### Build
+
+Build the application
+
+```bash
+yarn build
 ```
 
-## 🐳 Deployments
+### Publish
+
+Build and publish your application to a docker registry
+
+```bash
+yarn publish
+```
+
+### Deploy
+
+For now, this will be considered a manual step. Basically all you have to do is pull the image that
+you've just pushed.
 
-> See the [extended documentation](https://docs.digital-alchemy.app/docs/home-automation/quickstart/automation-standalone/) for details
+> _**Note:** make sure that the same variables from `.env.dist` are passed into the container at
+> runtime._
 
 ## 📄 License