@valkey/valkey-glide-darwin-x64 1.2.0-rc000 → 1.2.0-rc003

package/package.json

@@ -67,10 +67,12 @@
             "tests/",
             "rust-client/**",
             "!build-ts/**",
-            "babel.config.js",
+            ".prettierignore",
             "jest.config.js",
             "hybrid-node-tests/**",
-            "docs/"
+            "docs/",
+            "DEVELOPER.md",
+            ".ort.yml"
         ]
     },
     "//": [
@@ -83,5 +85,5 @@
         "darwin"
     ],
     "name": "@valkey/valkey-glide-darwin-x64",
-    "version": "1.2.0-rc000"
+    "version": "1.2.0-rc003"
 }

package/.ort.yml

@@ -1,9 +0,0 @@
-excludes:
-    scopes:
-        - pattern: "devDependencies"
-          reason: "DEV_DEPENDENCY_OF"
-          comment: "Packages for development only."
-    paths:
-        - pattern: "npm/glide/**"
-          reason: "BUILD_TOOL_OF"
-          comment: "Template file for CD"

package/.prettierignore

@@ -1,7 +0,0 @@
-# ignore that dir, because there are a lot of files which we don't manage, e.g. json files in cargo crates
-rust-client/*
-# unignore specific files
-!rust-client/package.json
-!rust-client/tsconfig.json
-# ignore docs dir
-docs/*

package/DEVELOPER.md

@@ -1,191 +0,0 @@
-# Developer Guide
-
-This document describes how to set up your development environment to build and test Valkey GLIDE Node wrapper.
-
-### Development Overview
-
-The GLIDE Node wrapper consists of both TypeScript and Rust code. Rust bindings for Node.js are implemented using [napi-rs](https://github.com/napi-rs/napi-rs). The Node and Rust components communicate using the [protobuf](https://github.com/protocolbuffers/protobuf) protocol.
-
-### Build from source
-
-#### Prerequisites
-
-Software Dependencies
-
-##### **Note:** Nodejs Supported Version
-
-If your Nodejs version is below the supported version specified in the client's [documentation](https://github.com/valkey-io/valkey-glide/blob/main/node/README.md#nodejs-supported-version), you can upgrade it using [NVM](https://github.com/nvm-sh/nvm?tab=readme-ov-file#install--update-script).
-
--   npm
--   git
--   GCC
--   pkg-config
--   protoc (protobuf compiler)
--   openssl
--   openssl-dev
--   rustup
-
-**Dependencies installation for Ubuntu**
-
-```bash
-sudo apt update -y
-sudo apt install -y nodejs npm git gcc pkg-config protobuf-compiler openssl libssl-dev
-curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
-source "$HOME/.cargo/env"
-# Check the installed node version
-node -v
-```
-
-> **Note:** Ensure that you installed a supported Node.js version. For Ubuntu 22.04 or earlier, please refer to the instructions [here](#note-nodejs-supported-version) to upgrade your Node.js version.
-
-**Dependencies installation for CentOS**
-
-```bash
-sudo yum update -y
-sudo yum install -y nodejs git gcc pkgconfig protobuf-compiler openssl openssl-devel gettext
-curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
-source "$HOME/.cargo/env"
-```
-
-**Dependencies installation for MacOS**
-
-```bash
-brew update
-brew install nodejs git gcc pkgconfig protobuf openssl
-curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
-source "$HOME/.cargo/env"
-```
-
-#### Building and installation steps
-
-Before starting this step, make sure you've installed all software requirments.
-
-1. Clone the repository:
-    ```bash
-    git clone https://github.com/valkey-io/valkey-glide.git
-    cd valkey-glide
-    ```
-2. Install all node dependencies:
-
-    ```bash
-    cd node
-    npm i
-    cd rust-client
-    npm i
-    cd ..
-    ```
-
-3. Build the Node wrapper (Choose a build option from the following and run it from the `node` folder):
-
-    1. Build in release mode, stripped from all debug symbols (optimized and minimized binary size):
-
-    ```bash
-    npm run build:release
-    ```
-
-    2. Build in release mode with debug symbols (optimized but large binary size):
-
-    ```bash
-    npm run build:benchmark
-    ```
-
-    3. For testing purposes, you can execute an unoptimized but fast build using:
-
-    ```bash
-    npm run build
-    ```
-
-    Once building completed, you'll find the compiled JavaScript code in the`./build-ts` folder.
-
-4. Run tests:
-    1. Ensure that you have installed server and valkey-cli on your host. You can download Valkey at the following link: [Valkey Download page](https://valkey.io/download/).
-    2. Execute the following command from the node folder:
-        ```bash
-        npm run build # make sure we have a debug build compiled first
-        npm test
-        ```
-5. Integrating the built GLIDE package into your project:
-   Add the package to your project using the folder path with the command `npm install <path to GLIDE>/node`.
-
--   For a fast build, execute `npm run build`. This will perform a full, unoptimized build, which is suitable for developing tests. Keep in mind that performance is significantly affected in an unoptimized build, so it's required to build with the `build:release` or `build:benchmark` option when measuring performance.
--   If your modifications are limited to the TypeScript code, run `npm run build-external` to build the external package without rebuilding the internal package.
--   If your modifications are limited to the Rust code, execute `npm run build-internal` to build the internal package and generate TypeScript code.
--   To generate Node's protobuf files, execute `npm run build-protobuf`. Keep in mind that protobuf files are generated as part of full builds (e.g., `build`, `build:release`, etc.).
-
-> Note: Once building completed, you'll find the compiled JavaScript code in the `node/build-ts` folder.
-
-### Troubleshooting
-
--   If the build fails after running `npx tsc` because `glide-rs` isn't found, check if your npm version is in the range 9.0.0-9.4.1, and if so, upgrade it. 9.4.2 contains a fix to a change introduced in 9.0.0 that is required in order to build the library.
-
-### Test
-
-To run tests, use the following command:
-
-```bash
-npm test
-```
-
-To execute a specific test, include the [`testNamePattern`](https://jestjs.io/docs/cli#--testnamepatternregex) option. For example:
-
-```bash
-npm run test -- --testNamePattern="transaction"
-```
-
-IT suite starts the server for testing - standalone and cluster installation using `cluster_manager` script.
-To run the integration tests with existing servers, run the following command:
-
-```bash
-npm run test -- --cluster-endpoints=localhost:7000 --standalone-endpoints=localhost:6379
-```
-
-### Submodules
-
-After pulling new changes, ensure that you update the submodules by running the following command:
-
-```bash
-git submodule update
-```
-
-### Linters
-
-Development on the Node wrapper may involve changes in either the TypeScript or Rust code. Each language has distinct linter tests that must be passed before committing changes.
-
-#### Language-specific Linters
-
-**TypeScript:**
-
--   ESLint
--   Prettier
-
-**Rust:**
-
--   clippy
--   fmt
-
-#### Running the linters
-
-1. TypeScript
-
-    ```bash
-    # Run from the node folder
-    npm run lint
-    # To automatically apply ESLint and/or prettier recommendations
-    npx run lint:fix
-    ```
-
-2. Rust
-    ```bash
-    # Run from the `node/rust-client` folder
-    rustup component add clippy rustfmt
-    cargo clippy --all-features --all-targets -- -D warnings
-    cargo fmt --manifest-path ./Cargo.toml --all
-    ```
-
-### Recommended extensions for VS Code
-
--   [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - JavaScript / TypeScript formatter.
--   [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - linter.
--   [Jest Runner](https://marketplace.visualstudio.com/items?itemName=firsttris.vscode-jest-runner) - in-editor test runner.
--   [Jest Test Explorer](https://marketplace.visualstudio.com/items?itemName=kavod-io.vscode-jest-test-adapter) - adapter to the VSCode testing UI.
--   [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) - Rust language support for VSCode.