Merge branch 'main' into first-variation-0-weight

* main: (48 commits)
  v1.22.0
  feat: show project info in CLI (#304)
  docs: deprecation (#302)
  v1.21.0
  feat: make test runner fast by default (#301)
  v1.20.0
  feat: allow evaluating in CLI with more verbosity (#300)
  docs: glossary (#291)
  v1.19.0
  feat: find duplicate segments with authors info (#299)
  v1.18.1
  fix: search features by any case in generated site (#298)
  v1.18.0
  feat: assess traffic distribution via CLI (#297)
  docs: updates
  v1.17.0
  feat: evaluate features in CLI (#295)
  v1.16.0
  feat: Added export of emitter module (#294)
  v1.15.0
  ...

.github/workflows/checks.yml

@@ -15,14 +15,14 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 10
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
 
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

.github/workflows/publish.yml

@@ -11,16 +11,16 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 10
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
 
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

CHANGELOG.md

@@ -3,6 +3,204 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.22.0](https://github.com/featurevisor/featurevisor/compare/v1.21.0...v1.22.0) (2024-05-21)
+
+
+### Features
+
+* show project info in CLI ([#304](https://github.com/featurevisor/featurevisor/issues/304)) ([d94cb87](https://github.com/featurevisor/featurevisor/commit/d94cb878f24fc4f2280c6126ab40a70aa6bebe9f))
+
+
+
+
+
+# [1.21.0](https://github.com/featurevisor/featurevisor/compare/v1.20.0...v1.21.0) (2024-05-09)
+
+
+### Features
+
+* make test runner fast by default ([#301](https://github.com/featurevisor/featurevisor/issues/301)) ([6ed5d0c](https://github.com/featurevisor/featurevisor/commit/6ed5d0cdba99b987fea4242c54aa74202a975142))
+
+
+
+
+
+# [1.20.0](https://github.com/featurevisor/featurevisor/compare/v1.19.0...v1.20.0) (2024-04-30)
+
+
+### Features
+
+* allow evaluating in CLI with more verbosity ([#300](https://github.com/featurevisor/featurevisor/issues/300)) ([8c3a096](https://github.com/featurevisor/featurevisor/commit/8c3a0962a5950abf424695db314ee5eeb8e6ccd5))
+
+
+
+
+
+# [1.19.0](https://github.com/featurevisor/featurevisor/compare/v1.18.1...v1.19.0) (2024-04-26)
+
+
+### Features
+
+* find duplicate segments with authors info ([#299](https://github.com/featurevisor/featurevisor/issues/299)) ([5008066](https://github.com/featurevisor/featurevisor/commit/5008066128fb7c732b633856dcffcb768f52c88c))
+
+
+
+
+
+## [1.18.1](https://github.com/featurevisor/featurevisor/compare/v1.18.0...v1.18.1) (2024-04-23)
+
+
+### Bug Fixes
+
+* search features by any case in generated site ([#298](https://github.com/featurevisor/featurevisor/issues/298)) ([1676e7e](https://github.com/featurevisor/featurevisor/commit/1676e7ea325a60bf482205dc32a91f77eba96655))
+
+
+
+
+
+# [1.18.0](https://github.com/featurevisor/featurevisor/compare/v1.17.0...v1.18.0) (2024-04-16)
+
+
+### Features
+
+* assess traffic distribution via CLI ([#297](https://github.com/featurevisor/featurevisor/issues/297)) ([2063ad9](https://github.com/featurevisor/featurevisor/commit/2063ad9a5408071bfb1636c748cabe616065191d))
+
+
+
+
+
+# [1.17.0](https://github.com/featurevisor/featurevisor/compare/v1.16.0...v1.17.0) (2024-04-07)
+
+
+### Features
+
+* evaluate features in CLI ([#295](https://github.com/featurevisor/featurevisor/issues/295)) ([5a3332a](https://github.com/featurevisor/featurevisor/commit/5a3332a226a3b4901445fe2fe04baa8320e94f48))
+
+
+
+
+
+# [1.16.0](https://github.com/featurevisor/featurevisor/compare/v1.15.0...v1.16.0) (2024-04-05)
+
+
+### Features
+
+* Added export of emitter module ([#294](https://github.com/featurevisor/featurevisor/issues/294)) ([aaf0afc](https://github.com/featurevisor/featurevisor/commit/aaf0afcf18a6bdad7d82349d70ac052c9f288ca0))
+
+
+
+
+
+# [1.15.0](https://github.com/featurevisor/featurevisor/compare/v1.14.0...v1.15.0) (2024-04-04)
+
+
+### Features
+
+* show project configuration via CLI ([#293](https://github.com/featurevisor/featurevisor/issues/293)) ([a83f6fa](https://github.com/featurevisor/featurevisor/commit/a83f6fa4d21012b2e0c0d97ab6bb182f9aa4c1af))
+
+
+
+
+
+# [1.14.0](https://github.com/featurevisor/featurevisor/compare/v1.13.1...v1.14.0) (2024-04-02)
+
+
+### Features
+
+* benchmarking option in CLI ([#292](https://github.com/featurevisor/featurevisor/issues/292)) ([6abcecc](https://github.com/featurevisor/featurevisor/commit/6abcecc3a92f00ccea7dcb542676126b6eb3b778))
+
+
+
+
+
+## [1.13.1](https://github.com/featurevisor/featurevisor/compare/v1.13.0...v1.13.1) (2024-03-27)
+
+
+### Bug Fixes
+
+* internal improvements for finding usage ([#290](https://github.com/featurevisor/featurevisor/issues/290)) ([070d7ec](https://github.com/featurevisor/featurevisor/commit/070d7eced9c20cbfdd4839345234dbafda39c1e3))
+
+
+
+
+
+# [1.13.0](https://github.com/featurevisor/featurevisor/compare/v1.12.0...v1.13.0) (2024-03-26)
+
+
+### Features
+
+* find usage of segments and attributes ([#289](https://github.com/featurevisor/featurevisor/issues/289)) ([c1319b3](https://github.com/featurevisor/featurevisor/commit/c1319b32d46ae7bbb03eb7b7e5dd19e37f2be51d))
+
+
+
+
+
+# [1.12.0](https://github.com/featurevisor/featurevisor/compare/v1.11.1...v1.12.0) (2024-03-23)
+
+
+### Features
+
+* introduce new project config stringify ([#286](https://github.com/featurevisor/featurevisor/issues/286)) ([96bd230](https://github.com/featurevisor/featurevisor/commit/96bd2309da6b45c44efdec764ff0a4f63d885fa6))
+
+
+
+
+
+## [1.11.1](https://github.com/featurevisor/featurevisor/compare/v1.11.0...v1.11.1) (2024-03-14)
+
+
+### Bug Fixes
+
+* move to next condition if parsing fails ([#279](https://github.com/featurevisor/featurevisor/issues/279)) ([9f198e2](https://github.com/featurevisor/featurevisor/commit/9f198e2303498c2c74fb2a9a2fcfa5c320acf93f))
+
+
+
+
+
+# [1.11.0](https://github.com/featurevisor/featurevisor/compare/v1.10.1...v1.11.0) (2024-03-10)
+
+
+### Features
+
+* revisioning info moved to its own file ([#274](https://github.com/featurevisor/featurevisor/issues/274)) ([6a175d1](https://github.com/featurevisor/featurevisor/commit/6a175d1be01c1ab78661bbd93d535de69af47135))
+
+
+
+
+
+## [1.10.1](https://github.com/featurevisor/featurevisor/compare/v1.10.0...v1.10.1) (2024-03-10)
+
+
+### Bug Fixes
+
+* init command ([#277](https://github.com/featurevisor/featurevisor/issues/277)) ([1e46d79](https://github.com/featurevisor/featurevisor/commit/1e46d7992a632ce956e8821dbaae9677bef59a43))
+
+
+
+
+
+# [1.10.0](https://github.com/featurevisor/featurevisor/compare/v1.9.0...v1.10.0) (2024-03-10)
+
+
+### Features
+
+* allow showing only failed specs in test runner ([#276](https://github.com/featurevisor/featurevisor/issues/276)) ([cefab8f](https://github.com/featurevisor/featurevisor/commit/cefab8f8c0eb091c10bee213039920d55fa3957a))
+
+
+
+
+
+# [1.9.0](https://github.com/featurevisor/featurevisor/compare/v1.8.0...v1.9.0) (2024-03-09)
+
+
+### Features
+
+* allow printing datafile per environment ([#275](https://github.com/featurevisor/featurevisor/issues/275)) ([28b4a0f](https://github.com/featurevisor/featurevisor/commit/28b4a0f776e2510f821a7c9d912c3c348857a729))
+
+
+
+
+
 # [1.8.0](https://github.com/featurevisor/featurevisor/compare/v1.7.3...v1.8.0) (2024-02-26)
 
 

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 Fahad Heylaal (https://fahad19.com)
+Copyright (c) 2024 Fahad Heylaal (https://fahad19.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -102,17 +102,13 @@ The whole process can be broken down into 3 steps:
 
 ## Step 1: Create a Featurevisor project
 
-Install Featurevisor CLI globally (or use `npx @featurevisor/cli`):
-
-```
-$ npm install -g @featurevisor/cli
-```
-
-Initialize a new Featurevisor project:
+Use `npx` to scaffold a new Featurevisor project:
 
 ```
 $ mkdir my-featurevisor-project && cd my-featurevisor-project
-$ featurevisor init
+
+$ npx @featurevisor/cli init
+$ npm install
 ```
 
 You can now create and manage your feature flags, experiments, and remote config in this directory expressed as YAMLs.
@@ -128,7 +124,7 @@ See the building block guides here:
 Once the project is ready, you can build your datafiles (JSON files containing configuration of your feature flags):
 
 ```
-$ featurevisor build
+$ npx featurevisor build
 ```
 
 You will find the output in `dist` directory, that you can upload to your CDN.

docs/building-datafiles.md

@@ -10,7 +10,7 @@ Datafiles are JSON files that are created against combinations of tags and envir
 Use Featurevisor CLI to build your datafiles:
 
 ```
-$ featurevisor build
+$ npx featurevisor build
 ```
 
 ## Output
@@ -49,15 +49,21 @@ By default, Featurevisor will use the `version` as exists in `package.json` of t
 You can optionally customize the `revision` value in datafiles by passing a `--revision` flag when building:
 
 ```
-$ featurevisor build --revision 1.2.3
+$ npx featurevisor build --revision 1.2.3
 ```
 
 ## Printing
 
-You can print the contents of a datafile for a single feature without writing anything to disk by passing these flags:
+You can print the contents of a datafile for a single feature in/or an environment without writing anything to disk by passing these flags:
 
 ```
-$ featurevisor build --feature=foo --environment=production --print --pretty
+$ npx featurevisor build --feature=foo --environment=production --print --pretty
+```
+
+Or if you with to print datafile containing all features for a specific environment:
+
+```
+$ npx featurevisor build --environment=production --print --pretty
 ```
 
 This is useful primarily for debugging and testing purposes.