Skip to content

Commit 17fa857

Browse files
beeme1mrbeeme1mr
authored
refactor: rename the repo to be runtime agnostic (#189)
Renamed reference to the repo in preparation for the name change. It's worth mentioning that the repo name should be changed before this PR is merged. Also, the existing git tags will keep the old naming convention. While this isn't a breaking change, it will require consumers to update the package name in order to stay current. Signed-off-by: Michael Beemer <[email protected]> Signed-off-by: Michael Beemer <[email protected]>
1 parent 12230a5 commit 17fa857

File tree

4 files changed

+15318
-5218
lines changed

4 files changed

+15318
-5218
lines changed

‎CHANGELOG.md‎

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,40 +14,36 @@
1414

1515
* update the client to conform to the provider interface ([#187](https://github.com/open-feature/node-sdk/issues/187)) ([f1edb29](https://github.com/open-feature/node-sdk/commit/f1edb296346e9feb2bd86fed71bbe24e725e0531))
1616

17-
## [0.3.0](https://github.com/open-feature/node-sdk/compare/nodejs-sdk-v0.2.0...nodejs-sdk-v0.3.0) (2022-08-25)
18-
17+
## [0.3.0](https://github.com/open-feature/js-sdk/compare/nodejs-sdk-v0.2.0...nodejs-sdk-v0.3.0) (2022-08-25)
1918

2019
### ⚠ BREAKING CHANGES
2120

22-
* remove flag evaluation options from the provider interface (#185)
21+
- remove flag evaluation options from the provider interface (#185)
2322

2423
### Features
2524

26-
* remove flag evaluation options from the provider interface ([#185](https://github.com/open-feature/node-sdk/issues/185)) ([e9852e4](https://github.com/open-feature/node-sdk/commit/e9852e4f52fd598cebb9d74f3c22abdb832ebac9)), closes [#183](https://github.com/open-feature/node-sdk/issues/183)
27-
28-
## [0.2.0](https://github.com/open-feature/node-sdk/compare/nodejs-sdk-v0.1.10...nodejs-sdk-v0.2.0) (2022-08-15)
25+
- remove flag evaluation options from the provider interface ([#185](https://github.com/open-feature/js-sdk/issues/185)) ([e9852e4](https://github.com/open-feature/js-sdk/commit/e9852e4f52fd598cebb9d74f3c22abdb832ebac9)), closes [#183](https://github.com/open-feature/js-sdk/issues/183)
2926

27+
## [0.2.0](https://github.com/open-feature/js-sdk/compare/nodejs-sdk-v0.1.10...nodejs-sdk-v0.2.0) (2022-08-15)
3028

3129
### ⚠ BREAKING CHANGES
3230

33-
* context transformer and related interfaces removed.
31+
- context transformer and related interfaces removed.
3432

3533
### Features
3634

37-
* remove ctx transformer, add provider hooks ([#148](https://github.com/open-feature/node-sdk/issues/148)) ([260432c](https://github.com/open-feature/node-sdk/commit/260432c4f92f16f83635dfafff30ad9bc1697a47))
38-
39-
## [0.1.10](https://github.com/open-feature/node-sdk/compare/nodejs-sdk-v0.1.9...nodejs-sdk-v0.1.10) (2022-07-28)
35+
- remove ctx transformer, add provider hooks ([#148](https://github.com/open-feature/js-sdk/issues/148)) ([260432c](https://github.com/open-feature/js-sdk/commit/260432c4f92f16f83635dfafff30ad9bc1697a47))
4036

37+
## [0.1.10](https://github.com/open-feature/js-sdk/compare/nodejs-sdk-v0.1.9...nodejs-sdk-v0.1.10) (2022-07-28)
4138

4239
### Bug Fixes
4340

44-
* Fixing error with setProvider type ([#121](https://github.com/open-feature/node-sdk/issues/121)) ([df5d214](https://github.com/open-feature/node-sdk/commit/df5d2149ef15a1e9b58b9a3280c01bd77a2b3dd8))
45-
46-
## [0.1.9](https://github.com/open-feature/node-sdk/compare/nodejs-sdk-v0.1.8...nodejs-sdk-v0.1.9) (2022-07-22)
41+
- Fixing error with setProvider type ([#121](https://github.com/open-feature/js-sdk/issues/121)) ([df5d214](https://github.com/open-feature/js-sdk/commit/df5d2149ef15a1e9b58b9a3280c01bd77a2b3dd8))
4742

43+
## [0.1.9](https://github.com/open-feature/js-sdk/compare/nodejs-sdk-v0.1.8...nodejs-sdk-v0.1.9) (2022-07-22)
4844

4945
### Bug Fixes
5046

51-
* Add no-op tests ([#99](https://github.com/open-feature/node-sdk/issues/99)) ([a341f5c](https://github.com/open-feature/node-sdk/commit/a341f5c776035ca24b1323b4a37f5f166cdc55d7))
52-
* Dont push experiemental branches ([#101](https://github.com/open-feature/node-sdk/issues/101)) ([0a7a5ec](https://github.com/open-feature/node-sdk/commit/0a7a5ec562d5dcfdb044ebcc25fd1fed703b68f4))
53-
* Fix publish command ([#103](https://github.com/open-feature/node-sdk/issues/103)) ([4742ef1](https://github.com/open-feature/node-sdk/commit/4742ef14cc0ea07e3569eee56899937452a55a9c))
47+
- Add no-op tests ([#99](https://github.com/open-feature/js-sdk/issues/99)) ([a341f5c](https://github.com/open-feature/js-sdk/commit/a341f5c776035ca24b1323b4a37f5f166cdc55d7))
48+
- Don't push experimental branches ([#101](https://github.com/open-feature/js-sdk/issues/101)) ([0a7a5ec](https://github.com/open-feature/js-sdk/commit/0a7a5ec562d5dcfdb044ebcc25fd1fed703b68f4))
49+
- Fix publish command ([#103](https://github.com/open-feature/js-sdk/issues/103)) ([4742ef1](https://github.com/open-feature/js-sdk/commit/4742ef14cc0ea07e3569eee56899937452a55a9c))

‎README.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
1-
# OpenFeature SDK for NodeJS
1+
# OpenFeature SDK for JavaScript
22

33
[![a](https://img.shields.io/badge/slack-%40cncf%2Fopenfeature-brightgreen?style=flat&logo=slack)](https://cloud-native.slack.com/archives/C0344AANLA1)
4-
[![codecov](https://codecov.io/gh/open-feature/node-sdk/branch/main/graph/badge.svg?token=3DC5XOEHMY)](https://codecov.io/gh/open-feature/node-sdk)
5-
[![npm version](https://badge.fury.io/js/@openfeature%2Fnodejs-sdk.svg)](https://badge.fury.io/js/@openfeature%2Fnodejs-sdk)
6-
[![Known Vulnerabilities](https://snyk.io/test/github/open-feature/node-sdk/badge.svg)](https://snyk.io/test/github/open-feature/node-sdk)
4+
[![codecov](https://codecov.io/gh/open-feature/js-sdk/branch/main/graph/badge.svg?token=3DC5XOEHMY)](https://codecov.io/gh/open-feature/js-sdk)
5+
[![npm version](https://badge.fury.io/js/@openfeature%2Fjs-sdk.svg)](https://badge.fury.io/js/@openfeature%2Fjs-sdk)
6+
[![Known Vulnerabilities](https://snyk.io/test/github/open-feature/js-sdk/badge.svg)](https://snyk.io/test/github/open-feature/js-sdk)
77
[![Specification](https://img.shields.io/static/v1?label=Specification&message=v0.4.0&color=yellow)](https://github.com/open-feature/spec/tree/v0.4.0)
88

9-
This is the NodeJS implementation of [OpenFeature](https://openfeature.dev), a vendor-agnostic abstraction library for evaluating feature flags.
9+
This is the JavaScript implementation of [OpenFeature](https://openfeature.dev), a vendor-agnostic abstraction library for evaluating feature flags.
1010

1111
We support multiple data types for flags (numbers, strings, booleans, objects) as well as hooks, which can alter the lifecycle of a flag evaluation.
1212

13-
This library is intended to be used in server-side contexts and has not been evaluated for use in mobile devices.
13+
This library is intended to be used in server-side contexts and has not been evaluated for use client-side or on mobile devices.
1414

1515
## Installation
1616

1717
```shell
18-
npm install @openfeature/nodejs-sdk
18+
npm install @openfeature/js-sdk
1919
```
2020

2121
or
2222

2323
```shell
24-
yarn add @openfeature/nodejs-sdk
24+
yarn add @openfeature/js-sdk
2525
```
2626

2727
## Usage
2828

2929
```typescript
30-
import { OpenFeature } from '@openfeature/nodejs-sdk';
30+
import { OpenFeature } from '@openfeature/js-sdk';
3131

3232
OpenFeature.setProvider(new MyProvider());
3333

@@ -58,8 +58,8 @@ For testing purposes, you can add a comment containing "/publish" in any PR. Thi
5858

5959
Thanks so much to our contributors.
6060

61-
<a href="https://github.com/open-feature/node-sdk/graphs/contributors">
62-
<img src="https://contrib.rocks/image?repo=open-feature/node-sdk" />
61+
<a href="https://github.com/open-feature/js-sdk/graphs/contributors">
62+
<img src="https://contrib.rocks/image?repo=open-feature/js-sdk" />
6363
</a>
6464

6565
Made with [contrib.rocks](https://contrib.rocks).

0 commit comments

Comments
 (0)