From 5f7b461b89876a24d66fa5cb26a93b0973466ba4 Mon Sep 17 00:00:00 2001 From: petruki <31597636+petruki@users.noreply.github.com> Date: Sat, 1 Nov 2025 14:52:37 -0700 Subject: [PATCH] chore: bump dev deps, improved docs --- .github/workflows/master.yml | 4 ++-- .github/workflows/npm-publish.yml | 4 ++-- .github/workflows/sonar.yml | 2 +- .github/workflows/staging.yml | 2 +- README.md | 26 +++++++++++++------------- package.json | 10 +++++----- sonar-project.properties | 2 +- 7 files changed, 25 insertions(+), 25 deletions(-) diff --git a/.github/workflows/master.yml b/.github/workflows/master.yml index 6c7f9e9..da28f58 100644 --- a/.github/workflows/master.yml +++ b/.github/workflows/master.yml @@ -18,7 +18,7 @@ jobs: fetch-depth: 0 - name: Use Node.js 24.x - uses: actions/setup-node@v5 + uses: actions/setup-node@v6 with: node-version: 24.x - run: npm install @@ -47,7 +47,7 @@ jobs: uses: actions/checkout@v5 - name: Build & Test with Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v5 + uses: actions/setup-node@v6 with: node-version: ${{ matrix.node-version }} diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml index ccda912..254a49f 100644 --- a/.github/workflows/npm-publish.yml +++ b/.github/workflows/npm-publish.yml @@ -11,7 +11,7 @@ jobs: steps: - uses: actions/checkout@v5 - - uses: actions/setup-node@v5 + - uses: actions/setup-node@v6 with: node-version: 24 - run: npm install @@ -29,7 +29,7 @@ jobs: steps: - uses: actions/checkout@v5 - - uses: actions/setup-node@v5 + - uses: actions/setup-node@v6 with: node-version: 24 registry-url: https://registry.npmjs.org/ diff --git a/.github/workflows/sonar.yml b/.github/workflows/sonar.yml index 6c2d6b7..b3217bd 100644 --- a/.github/workflows/sonar.yml +++ b/.github/workflows/sonar.yml @@ -34,7 +34,7 @@ jobs: fetch-depth: 0 - name: Use Node.js 24.x - uses: actions/setup-node@v5 + uses: actions/setup-node@v6 with: node-version: 24.x - run: npm install diff --git a/.github/workflows/staging.yml b/.github/workflows/staging.yml index d4ff1e4..b0b8232 100644 --- a/.github/workflows/staging.yml +++ b/.github/workflows/staging.yml @@ -25,7 +25,7 @@ jobs: fetch-depth: 0 - name: Setup Node - uses: actions/setup-node@v5 + uses: actions/setup-node@v6 with: node-version: ${{ github.event.inputs.node }} diff --git a/README.md b/README.md index ac9570a..a8d1cf2 100644 --- a/README.md +++ b/README.md @@ -23,22 +23,22 @@ A JavaScript SDK for Switcher API ## Table of Contents -- [๐ŸŽฏ About](#-about) -- [๐Ÿš€ Quick Start](#-quick-start) -- [โš™๏ธ Installation & Setup](#๏ธ-installation--setup) +- [About](#-about) +- [Quick Start](#-quick-start) +- [Installation & Setup](#๏ธ-installation--setup) - [Installation](#installation) - [Basic Configuration](#basic-configuration) - [Advanced Options](#advanced-options) -- [๐Ÿ’ก Usage Examples](#-usage-examples) +- [Usage Examples](#usage-examples) - [Basic Usage](#basic-usage) - [Strategy Validation](#strategy-validation) - [Throttling](#throttling) - [Hybrid Mode](#hybrid-mode) -- [๐Ÿงช Testing Features](#-testing-features) +- [Testing Features](#testing-features) - [Built-in Stub Feature](#built-in-stub-feature) - [Test Mode](#test-mode) - [Smoke Testing](#smoke-testing) -- [๐Ÿ“ Snapshot Management](#-snapshot-management) +- [Snapshot Management](#snapshot-management) - [Loading Snapshots](#loading-snapshots) - [Watching for Changes](#watching-for-changes) - [Version Checking](#version-checking) @@ -46,11 +46,11 @@ A JavaScript SDK for Switcher API --- -## ๐ŸŽฏ About +## About **Switcher Client JS** is a feature-rich SDK for integrating [Switcher API](https://github.com/switcherapi/switcher-api) into your JS-based applications (Web, Node.js, Bun, Cloudflare Workers). It provides robust feature flag management with enterprise-grade capabilities. -### โœจ Key Features +### Key Features - ๐Ÿš€ **Zero Latency**: Local mode with snapshot files or in-memory for instant feature flag resolution - ๐Ÿ”„ **Hybrid Configuration**: Silent mode with automatic fallback handling @@ -60,7 +60,7 @@ A JavaScript SDK for Switcher API --- -## ๐Ÿš€ Quick Start +## Quick Start Get up and running with Switcher Client in 3 simple steps: @@ -90,7 +90,7 @@ console.log('Feature enabled:', isFeatureEnabled); --- -## โš™๏ธ Installation & Setup +## Installation & Setup ### Installation @@ -170,7 +170,7 @@ Client.buildContext({ --- -## ๐Ÿ’ก Usage Examples +## Usage Examples ### Basic Usage @@ -255,7 +255,7 @@ const result = await switcher.remote().isItOn('FEATURE01'); --- -## ๐Ÿงช Testing Features +## Testing Features ### Built-in Stub Feature @@ -341,7 +341,7 @@ This feature validates using the current context and throws an exception if any --- -## ๐Ÿ“ Snapshot Management +## Snapshot Management ### Loading Snapshots diff --git a/package.json b/package.json index 8e04405..e4615dd 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "switcher-client", - "version": "4.5.0", + "version": "4.5.1", "description": "Client JS SDK for working with Switcher-API", "main": "./switcher-client.js", "type": "module", @@ -31,13 +31,13 @@ "src/" ], "devDependencies": { - "@babel/eslint-parser": "^7.28.4", - "@typescript-eslint/eslint-plugin": "^8.46.1", - "@typescript-eslint/parser": "^8.46.1", + "@babel/eslint-parser": "^7.28.5", + "@typescript-eslint/eslint-plugin": "^8.46.2", + "@typescript-eslint/parser": "^8.46.2", "c8": "^10.1.3", "chai": "^6.2.0", "env-cmd": "^11.0.0", - "eslint": "^9.38.0", + "eslint": "^9.39.0", "mocha": "^11.7.4", "mocha-sonarqube-reporter": "^1.0.2", "sinon": "^21.0.0" diff --git a/sonar-project.properties b/sonar-project.properties index 4067cc1..5322859 100644 --- a/sonar-project.properties +++ b/sonar-project.properties @@ -1,7 +1,7 @@ sonar.projectKey=switcherapi_switcher-client-master sonar.projectName=switcher-client-js sonar.organization=switcherapi -sonar.projectVersion=4.5.0 +sonar.projectVersion=4.5.1 sonar.links.homepage=https://github.com/switcherapi/switcher-client-js sonar.javascript.lcov.reportPaths=coverage/lcov.info