fix: update match pattern docs. Add ReadMe associated pattern test.

Author: luxscious

README.md

@@ -1,5 +1,4 @@
-DevCycle CLI & MCP Server
-=========================
+# DevCycle CLI & MCP Server
 
 This repository contains the DevCycle CLI for managing feature flags from the command line, plus an MCP (Model Context Protocol) server that enables AI coding assistants to interact with DevCycle.
 
@@ -8,7 +7,7 @@ Major features include:
 - Fully manage your Features, Variables, Variations and Targeting Rules from the command line
 - Detect and list DevCycle Variable usages in your codebase
 - Manage your Self-Targeting Overrides to quickly switch between Variable values
-- Generate type definitions for type-safe usage of DevCycle (Typescript only)
+- Generate type definitions for type-safe usage of DevCycle (TypeScript only)
 - MCP (Model Context Protocol) server for AI-powered feature flag management with Cursor and Claude
 
 The CLI can be customized in several ways using command-line args or by creating a [configuration file](#repo-configuration).
@@ -18,14 +17,15 @@ The CLI can be customized in several ways using command-line args or by creating
 [![License](https://img.shields.io/npm/l/@devcycle/cli.svg)](https://github.com/DevCycleHQ/cli/blob/main/package.json)
 
 <!-- toc -->
-* [Command Topics](#command-topics)
+
+- [Command Topics](#command-topics)
 <!-- tocstop -->
 
-## MCP Server for AI Assistants
+### MCP Server for AI Assistants
 
 The DevCycle MCP (Model Context Protocol) server enables AI coding assistants like Cursor and Claude to manage feature flags directly from your development environment. DevCycle offers a hosted MCP server that requires no local installation.
 
-### Quick Setup (No Installation Required)
+#### Quick Setup (No Installation Required)
 
 1. **Configure your AI assistant to use the hosted MCP server:**
 
@@ -48,10 +48,7 @@ The DevCycle MCP (Model Context Protocol) server enables AI coding assistants li
        "mcpServers": {
          "devcycle": {
            "command": "npx",
-           "args": [
-             "mcp-remote",
-             "https://mcp.devcycle.com/mcp"
-           ]
+           "args": ["mcp-remote", "https://mcp.devcycle.com/mcp"]
          }
        }
      }
@@ -63,11 +60,11 @@ Your AI assistant can now create, update, and manage feature flags on your behal
 
 For local installation options, detailed configuration, available tools, and advanced usage, see the [complete MCP documentation](docs/mcp.md).
 
-## CLI Documentation
+### CLI Documentation
 
-## Setup
+### Setup
 
-### Install the CLI
+#### Install the CLI
 
 Using NPM
 
@@ -82,13 +79,13 @@ $ brew tap devcyclehq/cli
 $ brew install devcycle
 ```
 
-## Authentication
+### Authentication
 
 Many of the CLI commands require DevCycle API authorization. There are several ways to provide these credentials.
 
-### Using Access Tokens (preferred)
+#### Using Access Tokens (preferred)
 
-#### Login Command
+##### Login Command
 
 By using the [`login sso` command](docs/login.md#dvc-login-sso), the CLI will retrieve and store an access token, which is valid for 24 hours.
 
@@ -100,13 +97,13 @@ To switch organizations once logged in, the [`organizations select` command](doc
 
 If executing the CLI in a containerized environment, please ensure one of the following PORTs can be accessed via Port Forwarding: 2194 (default), 2195, 2196 or 8080. This will allow the authentication process to complete and set the access token appropriately.
 
-#### Repo Init Command
+##### Repo Init Command
 
 The [`repo init` command](docs/repo.md#dvc-repo-init) behaves in the same way as `login sso`, but creates a [repo configuration file](#repo-configuration) and stores the project and organization choices there instead.
 
-### Using Client Credentials
+#### Using Client Credentials
 
-#### Client Credentials in Auth File
+##### Client Credentials in Auth File
 
 Use the [`dvc status` command](docs/status.md#dvc-status) to find the configuration file location for your platform. The credentials can be stored in the file pointed to by the Auth config path. Create the file if it does not exist, with the following contents.
 
@@ -122,15 +119,15 @@ The default location is based on the [oclif configDir](https://oclif.io/docs/con
 
 If you intend to run the CLI using options that override config file locations, the [`dvc status` command](docs/status.md#dvc-status) command can be run with those options to confirm that the file locations are as expected.
 
-### Project Selection
+#### Project Selection
 
 You also need to specify the default project ID for the CLI to use.
 
 If there is a repo configuration file, the [`dvc diff`](docs/diff.md) and [`dvc usages`](docs/usages.md) commands will use the project defined there.
 
 Otherwise, this is chosen during login or set using the [project select command](docs/projects.md#dvc-projects-select)
 
-### Environment Variables
+#### Environment Variables
 
 Set the following environment variables:
 
@@ -140,61 +137,65 @@ $ export DEVCYCLE_CLIENT_SECRET=<your client secret>
 $ export DEVCYCLE_PROJECT_KEY=<your project key>
 ```
 
-### Command-Line Arguments
+#### Command-Line Arguments
 
 The CLI can be run with the following arguments:
 
 ```sh-session
 $ dvc --client-id=<your client id> --client-secret=<your client secret> --project=<your project key>
 ```
 
-### Github Action
+#### GitHub Action
 
-The Devcycle Github actions are configured with auth information through the `project-key`, `client-id` and `client-secret` configuration parameters. This is passed to the CLI via command line arguments.
+The DevCycle GitHub actions are configured with auth information through the `project-key`, `client-id` and `client-secret` configuration parameters. This is passed to the CLI via command line arguments.
 
-## Usage
+### Usage
 
 <!-- usage -->
+
 ```sh-session
 $ npm install -g @devcycle/cli
 $ dvc COMMAND
 running command...
 $ dvc (--version)
-@devcycle/cli/6.1.4 linux-x64 node-v22.20.0
+@devcycle/cli/6.1.2 linux-x64 node-v22.20.0
 $ dvc --help [COMMAND]
 USAGE
   $ dvc COMMAND
 ...
 ```
+
 <!-- usagestop -->
 
 <!-- commands -->
-# Command Topics
-
-* [`dvc alias`](docs/alias.md) - Manage repository variable aliases.
-* [`dvc autocomplete`](docs/autocomplete.md) - display autocomplete installation instructions
-* [`dvc cleanup`](docs/cleanup.md) - Replace a DevCycle variable with a static value in the current version of your code. Currently only JavaScript is supported.
-* [`dvc diff`](docs/diff.md) - Print a diff of DevCycle variable usage between two versions of your code.
-* [`dvc environments`](docs/environments.md) - Create a new Environment for an existing Feature.
-* [`dvc features`](docs/features.md) - Create, view, or modify Features with the Management API.
-* [`dvc generate`](docs/generate.md) - Generate Devcycle related files.
-* [`dvc help`](docs/help.md) - Display help for dvc.
-* [`dvc identity`](docs/identity.md) - View or manage your DevCycle Identity.
-* [`dvc keys`](docs/keys.md) - Retrieve SDK keys from the Management API.
-* [`dvc login`](docs/login.md) - Log in to DevCycle.
-* [`dvc logout`](docs/logout.md) - Discards any auth configuration that has been stored in the auth configuration file.
-* [`dvc organizations`](docs/organizations.md) - List or switch organizations.
-* [`dvc overrides`](docs/overrides.md) - Create, view, or modify Overrides for a Project with the Management API.
-* [`dvc projects`](docs/projects.md) - Create, or view Projects with the Management API.
-* [`dvc repo`](docs/repo.md) - Manage repository configuration.
-* [`dvc status`](docs/status.md) - Check CLI status.
-* [`dvc targeting`](docs/targeting.md) - Create, view, or modify Targeting Rules for a Feature with the Management API.
-* [`dvc usages`](docs/usages.md) - Print all DevCycle variable usages in the current version of your code.
-* [`dvc variables`](docs/variables.md) - Create, view, or modify Variables with the Management API.
-* [`dvc variations`](docs/variations.md) - Create a new Variation for an existing Feature.
+
+## Command Topics
+
+- [`dvc alias`](docs/alias.md) - Manage repository variable aliases.
+- [`dvc autocomplete`](docs/autocomplete.md) - display autocomplete installation instructions
+- [`dvc cleanup`](docs/cleanup.md) - Replace a DevCycle variable with a static value in the current version of your code. Currently only JavaScript is supported.
+- [`dvc diff`](docs/diff.md) - Print a diff of DevCycle variable usage between two versions of your code.
+- [`dvc environments`](docs/environments.md) - Create a new Environment for an existing Feature.
+- [`dvc features`](docs/features.md) - Create, view, or modify Features with the Management API.
+- [`dvc generate`](docs/generate.md) - Generate DevCycle related files.
+- [`dvc help`](docs/help.md) - Display help for dvc.
+- [`dvc identity`](docs/identity.md) - View or manage your DevCycle Identity.
+- [`dvc keys`](docs/keys.md) - Retrieve SDK keys from the Management API.
+- [`dvc login`](docs/login.md) - Log in to DevCycle.
+- [`dvc logout`](docs/logout.md) - Discards any auth configuration that has been stored in the auth configuration file.
+- [`dvc organizations`](docs/organizations.md) - List or switch organizations.
+- [`dvc overrides`](docs/overrides.md) - Create, view, or modify Overrides for a Project with the Management API.
+- [`dvc projects`](docs/projects.md) - Create, or view Projects with the Management API.
+- [`dvc repo`](docs/repo.md) - Manage repository configuration.
+- [`dvc status`](docs/status.md) - Check CLI status.
+- [`dvc targeting`](docs/targeting.md) - Create, view, or modify Targeting Rules for a Feature with the Management API.
+- [`dvc usages`](docs/usages.md) - Print all DevCycle variable usages in the current version of your code.
+- [`dvc variables`](docs/variables.md) - Create, view, or modify Variables with the Management API.
+- [`dvc variations`](docs/variations.md) - Create a new Variation for an existing Feature.
 
 <!-- commandsstop -->
-## Repo Configuration
+
+### Repo Configuration
 
 The following commands can only be run from the root of a configured repository
 
@@ -208,43 +209,48 @@ location for this file is `<REPO ROOT>/.devcycle/config.yml`.
 
 This location can be overridden using the `--repo-config-path` flag.
 
+Create or update this file using the [`dvc repo init`](docs/repo.md#dvc-repo-init) command.
+
 The configuration file format is documented below:
 
 ```yml
-## the project and organization to use when connecting to the DevCycle Rest API for this repo
-project: "project-key"
+### the project and organization to use when connecting to the DevCycle Rest API for this repo
+project: 'project-key'
 org:
-  id: "org_xxxxxx"
-  name: "unique-org-key"
-  display_name: "Human Readable Org Name"
-## block for configuring "code insights" features like diff and variable usage scanning
-## use this section to improve the detection of DevCycle usage within your code
+  id: 'org_xxxxxx'
+  name: 'unique-org-key'
+  display_name: 'Human Readable Org Name'
+### block for configuring "code insights" features like diff and variable usage scanning
+### use this section to improve the detection of DevCycle usage within your code
 codeInsights:
-  ## add additional names to check for when looking for instances of DVCClient from an SDK
+  ### add additional names to check for when looking for instances of DVCClient from an SDK
   clientNames:
-    - "dvcClient"
-  ## map the values used in your code to the corresponding variable key in DevCycle
+    - 'dvcClient'
+  ### map the values used in your code to the corresponding variable key in DevCycle
   variableAliases:
-    "VARIABLES.ENABLE_V1": "enable-v1"
-  ## additional regex patterns used to match variables for a specific file extension
+    'VARIABLES.ENABLE_V1': 'enable-v1'
+  ### additional regex patterns used to match variables for a specific file extension
   matchPatterns:
-    ## file extension to override for, containing a list of patterns to use
+    ### file extension to override for, containing a list of patterns to use
     js:
       - dvcClient\.variable\(\s*["']([^"']*)["']
-  ## an array of file glob patterns to include in usage scan
+  ### an array of file glob patterns to include in usage scan
   includeFiles:
-    - "*.[jt]s"
-  ## an array of file glob patterns to exclude from usage scan
+    - '*.[jt]s'
+  ### an array of file glob patterns to exclude from usage scan
   excludeFiles:
-    - "dist/*"
+    - 'dist/*'
 ```
 
-### Match Patterns
+### Match Patterns and Aliases
 
 When identifying variable usages in the code, the CLI will identify DevCycle SDK methods by default. To capture
-other usages you may define match patterns. Match patterns are defined by file extension, and each pattern should
-contain exactly one capture group which matches the key of the variable. Make sure the captured value contains the
-entire key parameter (including quotes, if applicable).
+other usages you may define match patterns. Match patterns are defined by file extension.
+
+:::note
+Each pattern must include exactly one capture group for the variable key. Capture the entire key value
+(including surrounding quotes if you choose the “with quotes” pattern).
+:::
 
 Match patterns can be defined in the configuration file, for example:
 
@@ -263,14 +269,57 @@ codeInsights:
       - customVariableGetter\(\s*["']([^"']*)["']
 ```
 
+#### Capturing with or without quotes
+
+Match patterns can capture variable keys with or without quotes, which affects whether aliases are needed:
+
+With quotes:
+
+```yml
+# Pattern captures the key including surrounding quotes
+- dvcClient\.variable\(\s*(["'][^"']*["'])\s*,
+```
+
+- Matches: `dvcClient.variable('my-variable', default)`
+- Captures: `'my-variable'` (with quotes)
+
+Without quotes (aliases or generated constants required):
+
+```yml
+# Pattern strips quotes, capturing only the content
+- dvcClient\.variable\(\s*["']([^"']*)["']
+```
+
+- Matches: `dvcClient.variable('my-variable', default)`
+- Captures: `my-variable`
+
 Match patterns can also be passed directly to relevant commands using the `--match-pattern` flag:
 
 ```bash
-dvc usages --match-pattern ts="customVariableGetter\(\s*[\"']([^\"']*)[\"']" js="customVariableGetter\(\s*[\"']([^\"']*)[\"']"
+dvc usages --match-pattern ts="customVariableGetter\(\s*["']([^"']*)["']" js="customVariableGetter\(\s*["']([^"']*)["']"
 ```
 
 When testing your regex the `--show-regex` flag can be helpful. This will print all patterns used to find matches in your codebase.
 
 ```bash
 dvc usages --show-regex
 ```
+
+#### Custom Wrapper Functions
+
+If you use wrapper functions around the SDK, add patterns for them.
+
+**Example: Custom wrapper functions**
+
+```yml
+codeInsights:
+  matchPatterns:
+    ts:
+      # Matches: getFeatureFlag('my-variable', defaultValue)
+      - getFeatureFlag\(\s*([^,)]*)\s*,
+      # Matches: isFeatureEnabled('my-variable')
+      - isFeatureEnabled\(\s*([^,)]*)\s*\)
+    tsx:
+      # Matches: useFeatureFlag('my-variable', defaultValue)
+      - useFeatureFlag\(\s*([^,)]*)\s*,
+```

src/commands/diff/__snapshots__/diff.test.ts.snap

@@ -1,5 +1,26 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
+exports[`diff > correctly matches using custom patterns from README examples 1`] = `
+"
+DevCycle Variable Changes:
+
+🟢  2 Variables Added
+🔴  1 Variable Removed
+
+🟢 Added
+
+  1. my-variable
+	   Location: test-utils/fixtures/diff/sampleDiff.ts:L1
+  2. enable-feature
+	   Location: test-utils/fixtures/diff/sampleDiff.ts:L2
+
+🔴 Removed
+
+  1. removed-variable
+	   Location: test-utils/fixtures/diff/sampleDiff.ts:L1
+"
+`;
+
 exports[`diff > enriches output with API data 1`] = `
 "
 DevCycle Variable Changes:

src/commands/diff/diff.test.ts

@@ -292,6 +292,22 @@ describe('diff', () => {
         .it('identifies aliased variables specified in config file', (ctx) => {
             expect(ctx.stdout).toMatchSnapshot()
         })
+
+    test.stdout()
+        .command([
+            'diff',
+            '--file',
+            'test-utils/fixtures/diff/readme-examples',
+            '--no-api',
+            '--repo-config-path',
+            './test-utils/fixtures/configs/readmeExamplesConfig.yml',
+        ])
+        .it(
+            'correctly matches using custom patterns from README examples',
+            (ctx) => {
+                expect(ctx.stdout).toMatchSnapshot()
+            },
+        )
     test.stdout()
         .command([
             'diff',