featurevisor · fahad19 · Nov 29, 2025 · Nov 29, 2025 · Nov 29, 2025 · Nov 29, 2025
diff --git a/examples/example-yml-scopes/.gitignore b/examples/example-yml-scopes/.gitignore
@@ -0,0 +1,8 @@
+node_modules
+*.log
+npm-debug.log*
+.DS_Store
+
+datafiles
+out
+src
diff --git a/examples/example-yml-scopes/README.md b/examples/example-yml-scopes/README.md
@@ -0,0 +1,46 @@
+# example-yml-scopes
+
+Example project showing how to use `scopes` in Featurevisor.
+
+Visit [https://featurevisor.com](https://featurevisor.com) for more information.
+
+## Initialize
+
+```
+$ mkdir my-featurevisor-project && cd my-featurevisor-project
+$ npx @featurevisor/cli init --example example-yml-scopes
+```
+
+## Installation
+
+```
+$ npm install
+```
+
+## Usage
+
+### Lint YAMLs
+
+```
+$ npm run lint
+```
+
+### Build datafiles
+
+```
+$ npm run build
+```
+
+### Test features
+
+```
+$ npm test
+```
+
+### Start local server
+
+Generates and serves status site:
+
+```
+$ npm start
+```
diff --git a/examples/example-yml-scopes/attributes/country.yml b/examples/example-yml-scopes/attributes/country.yml
@@ -0,0 +1,2 @@
+description: country code in lower case (two lettered)
+type: string
diff --git a/examples/example-yml-scopes/attributes/deviceId.yml b/examples/example-yml-scopes/attributes/deviceId.yml
@@ -0,0 +1,2 @@
+description: Device ID
+type: string
diff --git a/examples/example-yml-scopes/attributes/platform.yml b/examples/example-yml-scopes/attributes/platform.yml
@@ -0,0 +1,2 @@
+description: device platform (like web, iOS, android)
+type: string
diff --git a/examples/example-yml-scopes/attributes/userId.yml b/examples/example-yml-scopes/attributes/userId.yml
@@ -0,0 +1,2 @@
+description: User ID
+type: string
diff --git a/examples/example-yml-scopes/features/checkout.yml b/examples/example-yml-scopes/features/checkout.yml
@@ -0,0 +1,17 @@
+description: Checkout feature
+tags:
+  - all
+  - ios
+
+bucketBy: userId
+
+rules:
+  staging:
+    - key: everyone
+      segments: "*"
+      percentage: 100
+
+  production:
+    - key: everyone
+      segments: "*"
+      percentage: 0
diff --git a/examples/example-yml-scopes/features/newRedesign.yml b/examples/example-yml-scopes/features/newRedesign.yml
@@ -0,0 +1,35 @@
+description: New redesign feature
+tags:
+  - all
+  - web
+
+bucketBy: userId
+
+rules:
+  staging:
+    - key: everyone
+      segments: "*"
+      percentage: 100
+
+  production:
+    - key: nl-web
+      segments:
+        - netherlands
+        - web
+      percentage: 100
+
+    - key: nl-ios
+      segments:
+        - netherlands
+        - ios
+      percentage: 100
+
+    - key: nl-android
+      segments:
+        - netherlands
+        - android
+      percentage: 100
+
+    - key: everyone
+      segments: "*"
+      percentage: 0
diff --git a/examples/example-yml-scopes/features/showBanner.yml b/examples/example-yml-scopes/features/showBanner.yml
@@ -0,0 +1,28 @@
+description: Show banner feature
+tags:
+  - all
+  - web
+  - ios
+  - android
+  - mobile
+
+bucketBy: userId
+
+rules:
+  staging:
+    - key: everyone
+      segments: "*"
+      percentage: 100
+
+  production:
+    - key: web
+      segments: web
+      percentage: 100
+
+    - key: ios
+      segments: ios
+      percentage: 50
+
+    - key: android
+      segments: android
+      percentage: 25
diff --git a/examples/example-yml-scopes/featurevisor.config.js b/examples/example-yml-scopes/featurevisor.config.js
@@ -0,0 +1,52 @@
+/** @type {import('@featurevisor/core').ProjectConfig} */
+module.exports = {
+  environments: ["staging", "production"],
+  tags: ["all", "web", "ios", "android"],
+  scopes: [
+    {
+      name: "browsers",
+      tag: "web",
+      context: { platform: "web" },
+    },
+    {
+      name: "ios",
+      tag: "ios",
+      context: { platform: "ios" },
+    },
+    {
+      name: "android",
+      tag: "android",
+      context: { platform: "android" },
+    },
+
+    // multiple tags
+    {
+      name: "nl",
+      tags: ["web"],
+      context: { country: "nl" },
+    },
+    {
+      name: "web-or-mobile-simple",
+      tags: {
+        or: ["web", "ios"],
+      },
+      context: {},
+    },
+    {
+      name: "web-or-mobile-explicit",
+      tags: {
+        or: ["web", "ios"],
+      },
+      context: {},
+    },
+    {
+      name: "web-and-mobile",
+      tags: {
+        and: ["web", "ios"],
+      },
+      context: {},
+    },
+  ],
+  prettyState: true,
+  prettyDatafile: true, // enabled for readability while developing
+};
diff --git a/examples/example-yml-scopes/package.json b/examples/example-yml-scopes/package.json
@@ -0,0 +1,18 @@
+{
+  "name": "@featurevisor/example-yml-scopes",
+  "private": true,
+  "version": "2.3.3",
+  "description": "Featurevisor project with YAML definitions",
+  "scripts": {
+    "lint": "featurevisor lint",
+    "build": "featurevisor build",
+    "test": "featurevisor test",
+    "export": "featurevisor site export",
+    "start": "npm run export && featurevisor site serve",
+    "generate-code": "featurevisor generate-code --language typescript --out-dir ./src",
+    "find-duplicate-segments": "featurevisor find-duplicate-segments"
+  },
+  "dependencies": {
+    "@featurevisor/cli": "2.5.0"
+  }
+}
diff --git a/examples/example-yml-scopes/segments/android.yml b/examples/example-yml-scopes/segments/android.yml
@@ -0,0 +1,5 @@
+description: Target Android devices
+conditions:
+  - attribute: platform
+    operator: equals
+    value: android
diff --git a/examples/example-yml-scopes/segments/ios.yml b/examples/example-yml-scopes/segments/ios.yml
@@ -0,0 +1,5 @@
+description: Target iOS devices
+conditions:
+  - attribute: platform
+    operator: equals
+    value: ios
diff --git a/examples/example-yml-scopes/segments/netherlands.yml b/examples/example-yml-scopes/segments/netherlands.yml
@@ -0,0 +1,5 @@
+description: The Netherlands
+conditions:
+  - attribute: country
+    operator: equals
+    value: nl
diff --git a/examples/example-yml-scopes/segments/web.yml b/examples/example-yml-scopes/segments/web.yml
@@ -0,0 +1,5 @@
+description: Target browsers
+conditions:
+  - attribute: platform
+    operator: equals
+    value: web
diff --git a/examples/example-yml-scopes/tests/features/showBanner.spec.yml b/examples/example-yml-scopes/tests/features/showBanner.spec.yml
@@ -0,0 +1,121 @@
+feature: showBanner
+assertions:
+  ##
+  # Enabled
+  #
+  - at: 10
+    environment: staging
+    context: {}
+    expectedToBeEnabled: true
+
+  - matrix:
+      at: [10, 20, 30]
+      platform: [web]
+    at: ${{ at }}
+    environment: production
+    description: "At ${{ at }}% in production, the feature should be enabled for web"
+    context:
+      platform: ${{ platform }}
+    expectedToBeEnabled: true
+
+  - matrix:
+      at: [10, 20, 30]
+      platform: [ios]
+    at: ${{ at }}
+    environment: production
+    description: "At ${{ at }}% in production, the feature should be enabled for ios"
+    context:
+      platform: ${{ platform }}
+    expectedToBeEnabled: true
+
+  - matrix:
+      at: [10, 20]
+      platform: [android]
+    at: ${{ at }}
+    environment: production
+    description: "At ${{ at }}% in production, the feature should be enabled for android"
+    context:
+      platform: ${{ platform }}
+    expectedToBeEnabled: true
+
+  ##
+  # Disabled
+  #
+  - matrix:
+      at: [60, 80, 90]
+      platform: [ios]
+    at: ${{ at }}
+    environment: production
+    description: "At ${{ at }}% in production, the feature should be disabled for ios"
+    context:
+      platform: ${{ platform }}
+    expectedToBeEnabled: false
+
+  - matrix:
+      at: [40, 50, 60]
+      platform: [android]
+    at: ${{ at }}
+    environment: production
+    description: "At ${{ at }}% in production, the feature should be disabled for android"
+    context:
+      platform: ${{ platform }}
+    expectedToBeEnabled: false
+
+  ##
+  # Enabled (with scope)
+  #
+  # No additional context is needed to be passed
+  #
+
+  # enabled
+  - at: 10
+    environment: staging
+    scope: browsers
+    context: {}
+    expectedToBeEnabled: true
+
+  - matrix:
+      at: [10, 20, 30, 40, 80, 100]
+    at: ${{ at }}
+    environment: production
+    scope: browsers
+    description: "At ${{ at }}% in production, the feature should be enabled for browsers scope"
+    context: {}
+    expectedToBeEnabled: true
+
+  - matrix:
+      at: [10, 20, 30, 40]
+    at: ${{ at }}
+    environment: production
+    scope: ios
+    description: "At ${{ at }}% in production, the feature should be enabled for ios scope"
+    context: {}
+    expectedToBeEnabled: true
+
+  - matrix:
+      at: [10, 20]
+    at: ${{ at }}
+    environment: production
+    scope: ios
+    description: "At ${{ at }}% in production, the feature should be enabled for android scope"
+    context: {}
+    expectedToBeEnabled: true
+
+  # disabled
+  - matrix:
+      at: [60, 80]
+    at: ${{ at }}
+    environment: production
+    scope: ios
+    description: "At ${{ at }}% in production, the feature should be disabled for ios scope"
+    context: {}
+    expectedToBeEnabled: false
+
+  - matrix:
+      at: [40, 80]
+    at: ${{ at }}
+    environment: production
+    scope: android
+    description: "At ${{ at }}% in production, the feature should be disabled for android scope"
+    context: {}
+    expectedToBeEnabled: false
diff --git a/examples/example-yml-scopes/tests/segments/netherlands.spec.yml b/examples/example-yml-scopes/tests/segments/netherlands.spec.yml
@@ -0,0 +1,14 @@
+segment: netherlands
+assertions:
+  - context:
+      country: nl
+    expectedToMatch: true
+
+  - context:
+      country: de
+      someOtherAttribute: someOtherValue
+    expectedToMatch: false
+
+  - context:
+      country: notNl
+    expectedToMatch: false
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		description: country code in lower case (two lettered)
		type: string
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		description: device platform (like web, iOS, android)
		type: string