Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nihilor/flgs
Enables simple feature flagging, feature gating and co. by incorporating different ways to toggle features.
https://github.com/nihilor/flgs
Last synced: 16 days ago
JSON representation
Enables simple feature flagging, feature gating and co. by incorporating different ways to toggle features.
- Host: GitHub
- URL: https://github.com/nihilor/flgs
- Owner: nihilor
- License: mit
- Created: 2022-03-29T11:40:27.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-30T05:41:42.000Z (almost 3 years ago)
- Last Synced: 2025-01-02T19:46:20.181Z (24 days ago)
- Language: JavaScript
- Size: 26.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# flgs - The Feature Flag Manager for Node and Javascript
Enables simple feature flagging, feature gating and co. by incorporating different stages to toggle features.
## Why?
1. Quickly enable and disable features in a project.
2. Provide simplest A/B testing.
3. Create staging, test and production environments.
4. Converts to clear pure boolean.
5. Enables continuity.
6. Enables Gitops.
7. Enables `package.json` branching.
## What?
**flgs** is a simple feature flagging manager. It looks up different places for specific configurations and imports them. Possible options are:
* `package.json`
* `flgs.json`
* command line parameters
* global array
* class constructor
The order of priorization is `package > file > cli > global > constructor`.
Regard: A flag is set or unset. Because of this maxime **flgs** converts all values to either `true` or `false` based on an own strategy:
* `true`, `"true"`, `1`, `"1"`, `"on"`, `"yes"`, `"enable"` will be interpreted as `set`
* a `function` or an `object` as a value for a flag, even if the are empty, will be interpreted as `set`
* `null` will be interpreted as `unset`
* all other values and types will be interpreted as `unset`
## How?
First, install the package via NPM.
```sh
$ npm install --save ffm
```
Second, import the package and instantiate FFM.
```js
const Flgs = require('flgs')
let flgs = new Flgs()
```
Third, use it in a simple `if` clause:
```js
if (flgs.isSet('bluecolors')) {
// new behaviour
}
else {
// old behaviour
}
```
An example for `package.json` located in the root of the importing project:
```json
{
"featureflags": {
"bluecolors": true,
"redcolors": false,
"greencolors": false,
"violetcolors": {},
"orangecolors": [
"a",
"b"
]
}
}
```
An example for `flgs.json` located in the root of the importing project:
```json
{
"greencolors": false,
"redcolors": true,
"bluecolors": true,
"violetcolors": false,
"orangecolors": false
}
```
An example for the command line interface, provided via `scripts` of `package.json` in the root of the importing project. The cli argument must start with `FFM_`:
```json
{
"scripts": {
"flagging": "node index.js FFM_BLUECOLORS"
}
}
```
An example for a global array:
```js
const _FMM = {
"bluecolors": true
}
```
An example for a default configuration:
```js
let flgs = new Flgs({
"bluecolors": true
})
```
License
-------
Copyright (c) 2022 Mark Lubkowitz (https://mlu.io/)
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.