added Dria compatiblity SDK (#6)

.eslintrc.json

@@ -0,0 +1,67 @@
+{
+  "extends": ["eslint:recommended", "plugin:node/recommended", "prettier"],
+  "plugins": ["node", "prettier"],
+  "rules": {
+    "prettier/prettier": "error",
+    "block-scoped-var": "error",
+    "eqeqeq": "error",
+    "no-var": "error",
+    "prefer-const": "error",
+    "eol-last": "error",
+    "prefer-arrow-callback": "error",
+    "no-trailing-spaces": "error",
+    "no-restricted-properties": [
+      "error",
+      {
+        "object": "describe",
+        "property": "only"
+      },
+      {
+        "object": "it",
+        "property": "only"
+      }
+    ]
+  },
+  "ignorePatterns": [
+    // js output
+    "build",
+    "dist",
+    "lib",
+    // modules
+    "node_modules",
+    // dot files
+    ".parcel-cache",
+    ".github",
+    // protobufs
+    "proto"
+  ],
+  "overrides": [
+    {
+      "files": ["**/*.ts", "**/*.tsx"],
+      "parser": "@typescript-eslint/parser",
+      "extends": ["plugin:@typescript-eslint/recommended"],
+      "rules": {
+        "@typescript-eslint/no-non-null-assertion": "off",
+        "@typescript-eslint/no-use-before-define": "off",
+        "@typescript-eslint/no-warning-comments": "off",
+        "@typescript-eslint/no-empty-function": "off",
+        "@typescript-eslint/no-var-requires": "off",
+        "@typescript-eslint/explicit-function-return-type": "off",
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "@typescript-eslint/ban-types": "off",
+        "@typescript-eslint/camelcase": "off",
+        "node/no-missing-import": "off",
+        "node/no-empty-function": "off",
+        "node/no-unsupported-features/es-syntax": "off",
+        "node/no-missing-require": "off",
+        "node/shebang": "off",
+        "no-dupe-class-members": "off",
+        "require-atomic-updates": "off"
+      }
+    }
+  ],
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  }
+}

.github/workflows/tests.yml

@@ -40,14 +40,20 @@ jobs:
       - name: Install dependencies
         run: pnpm install --no-frozen-lockfile
 
+      - name: Lint everything
+        run: pnpm lint
+
+      - name: Check formatting
+        run: pnpm format
+
+      - name: Build
+        run: pnpm build
+
       - name: Start Redis
         uses: supercharge/[email protected]
         with:
           redis-version: 7
           redis-port: 6379
 
-      - name: Build
-        run: pnpm build
-
       - name: Run tests
         run: pnpm test

.prettierignore

@@ -0,0 +1,14 @@
+# js output
+build
+dist
+lib
+
+# modules
+node_modules
+
+# dot files
+.parcel-cache
+.github
+
+# protobufs
+proto

README.md

@@ -64,7 +64,6 @@ const vectordb = new HollowDBVector(hollowdb);
 With this, you can insert a new point:
 
 ```ts
-// an array of floats
 const point = [-0.28571999073028564 /* and many more... */, 0.13964000344276428];
 
 // any object
@@ -167,6 +166,18 @@ pnpm test
 
 Check the formatting with:
 
+```sh
+pnpm format
+```
+
+Lint everything with:
+
+```sh
+pnpm lint
+```
+
+You can also check types with:
+
 ```sh
 pnpm check
 ```
@@ -177,4 +188,4 @@ HollowDB Vector replaces DANNY, for the legacy code please [refer to this branch
 
 ## License
 
-Dria Docker is licensed under [Apache 2.0](./LICENSE).
+HollowDB Vector is licensed under [Apache 2.0](./LICENSE).