chore: Update readmes fmt (#407)

* chore: run prettier; add note about nextjs app router Signed-off-by: Mark Phelps <[email protected]> * chore: add note to browser readme Signed-off-by: Mark Phelps <[email protected]> --------- Signed-off-by: Mark Phelps <[email protected]>
flipt-io · Sep 24, 2024 · 5defd65 · 5defd65
1 parent c72bffd
commit 5defd65
Show file tree

Hide file tree

Showing 16 changed files with 40 additions and 39 deletions.
diff --git a/.github/workflows/package-ffi-engine.yml b/.github/workflows/package-ffi-engine.yml
@@ -125,4 +125,4 @@ jobs:
         with:
           tag_name: flipt-engine-ffi-${{ github.event.inputs.tag }}
           files: |
-            flipt-engine-ffi-${{ matrix.platform.name }}.tar.gz
+            flipt-engine-ffi-${{ matrix.platform.name }}.tar.gz
diff --git a/.github/workflows/package-ffi-sdks.yml b/.github/workflows/package-ffi-sdks.yml
@@ -58,7 +58,7 @@ jobs:
             jq -r ".[] | select(.tag_name | startswith(\"flipt-engine-ffi-\")) | .tag_name" | \
             sort -Vr | head -n 1 | sed "s/^flipt-engine-ffi-//")" >> $GITHUB_ENV
           fi
-     
+
       - name: Generate token
         id: generate_token
         uses: tibdex/github-app-token@v2

diff --git a/.github/workflows/package-go-sdk.yml b/.github/workflows/package-go-sdk.yml
@@ -16,4 +16,4 @@ jobs:
       sdks: ${{ startsWith(github.ref, 'refs/tags/flipt-client-go-musl-') && 'go-musl' || 'go' }}
       engine-tag: "latest"
       tag: ${{ github.ref }}
-    secrets: inherit
+    secrets: inherit
diff --git a/.github/workflows/package-react-sdk.yml b/.github/workflows/package-react-sdk.yml
@@ -14,8 +14,8 @@ jobs:
 
       - uses: actions/setup-node@v4
         with:
-          node-version: '18'
-          registry-url: 'https://registry.npmjs.org'
+          node-version: "18"
+          registry-url: "https://registry.npmjs.org"
 
       - run: |
           npm ci
@@ -24,4 +24,3 @@ jobs:
         working-directory: flipt-client-react
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_API_KEY }}
-
diff --git a/README.md b/README.md
@@ -52,16 +52,16 @@ We are constantly growing our list of supported languages.
 
 Currently, we support the following languages/platforms:
 
-| Language | Implementation |
-|----------|----------------|
-| [Go](./flipt-client-go)            | FFI            |
-| [Python](./flipt-client-python)    | FFI            |
-| [Ruby](./flipt-client-ruby)        | FFI            |
-| [NodeJS](./flipt-client-node)      | WASM           |
-| [Java](./flipt-client-java)        | FFI            |
-| [JavaScript (Browser)](./flipt-client-browser) | WASM |
-| [React Web (Browser)](./flipt-client-react) | WASM         |
-| [Flutter/Dart](./flipt-client-dart)      | FFI            |
+| Language                                       | Implementation |
+| ---------------------------------------------- | -------------- |
+| [Go](./flipt-client-go)                        | FFI            |
+| [Python](./flipt-client-python)                | FFI            |
+| [Ruby](./flipt-client-ruby)                    | FFI            |
+| [NodeJS](./flipt-client-node)                  | WASM           |
+| [Java](./flipt-client-java)                    | FFI            |
+| [JavaScript (Browser)](./flipt-client-browser) | WASM           |
+| [React Web (Browser)](./flipt-client-react)    | WASM           |
+| [Flutter/Dart](./flipt-client-dart)            | FFI            |
 
 Documentation for each client can be found in the README of that client's directory.
 

diff --git a/flipt-client-browser/README.md b/flipt-client-browser/README.md
@@ -10,6 +10,9 @@ The `flipt-client-browser` library contains the JavaScript/TypeScript source cod
 npm install @flipt-io/flipt-client-browser
 ```
 
+> [!IMPORTANT]
+> The latest version of the Flipt Browser SDK does not currently work with Next.js App Router because Next.js App Router does not support WASM dependencies. See [this issue](https://github.com/vercel/next.js/issues/55537) for more information.
+
 ## Usage
 
 In your JavaScript/Typescript code you can import this client and use it as so:

diff --git a/flipt-client-dart/README.md b/flipt-client-dart/README.md
@@ -88,4 +88,4 @@ Contributions are welcome! Please feel free to open an issue or submit a Pull Re
 
 ## License
 
-This project is licensed under the [MIT License](LICENSE).
+This project is licensed under the [MIT License](LICENSE).
diff --git a/flipt-client-dart/analysis_options.yaml b/flipt-client-dart/analysis_options.yaml
@@ -12,7 +12,6 @@
 # The core lints are also what is used by pub.dev for scoring packages.
 
 include: package:lints/recommended.yaml
-
 # Uncomment the following section to specify additional rules.
 
 # linter:

diff --git a/flipt-client-dart/build.yaml b/flipt-client-dart/build.yaml
@@ -2,9 +2,9 @@ targets:
   $default:
     sources:
       exclude:
-        - 'example/**'
+        - "example/**"
     builders:
       json_serializable:
         options:
-          explicit_to_json: true 
-          field_rename: snake
+          explicit_to_json: true
+          field_rename: snake
diff --git a/flipt-client-dart/pubspec.yaml b/flipt-client-dart/pubspec.yaml
@@ -4,7 +4,7 @@ version: 0.1.0
 homepage: https://flipt.io
 
 environment:
-  sdk: '>=2.12.0 <4.0.0'
+  sdk: ">=2.12.0 <4.0.0"
 
 dependencies:
   ffi: ^2.0.1
@@ -22,4 +22,4 @@ flutter:
     - lib/src/ffi/linux_x86_64/libfliptengine.so
     - lib/src/ffi/linux_arm64/libfliptengine.so
     - lib/src/ffi/darwin_x86_64/libfliptengine.dylib
-    - lib/src/ffi/darwin_arm64/libfliptengine.dylib
+    - lib/src/ffi/darwin_arm64/libfliptengine.dylib
diff --git a/flipt-client-java/README.md b/flipt-client-java/README.md
@@ -98,4 +98,4 @@ Contributions are welcome! Please feel free to open an issue or submit a Pull Re
 
 ## License
 
-This project is licensed under the [MIT License](LICENSE).
+This project is licensed under the [MIT License](LICENSE).
diff --git a/flipt-client-node/README.md b/flipt-client-node/README.md
@@ -10,6 +10,9 @@ The `flipt-client-node` library contains the JavaScript/TypeScript source code f
 npm install @flipt-io/flipt-client
 ```
 
+> [!IMPORTANT]
+> The latest version of the Flipt Node.js SDK does not currently work with Next.js App Router because Next.js App Router does not support WASM dependencies. See [this issue](https://github.com/vercel/next.js/issues/55537) for more information. Use version `0.9.0` of the SDK until this is resolved.
+
 ## Usage
 
 In your Node.js code you can import this client and use it as so:

diff --git a/flipt-client-react/README.md b/flipt-client-react/README.md
@@ -10,6 +10,9 @@ The Flipt React SDK provides a convenient way to integrate [Flipt](https://flipt
 npm install @flipt-io/flipt-client-react
 ```
 
+> [!IMPORTANT]
+> The Flipt React SDK does not currently work with Next.js App Router because Next.js App Router does not support WASM dependencies. See [this issue](https://github.com/vercel/next.js/issues/55537) for more information.
+
 ## Usage
 
 There are two ways to use the Flipt React SDK.

diff --git a/flipt-client-ruby/README.md b/flipt-client-ruby/README.md
@@ -99,4 +99,4 @@ Contributions are welcome! Please feel free to open an issue or submit a Pull Re
 
 ## License
 
-This project is licensed under the [MIT License](LICENSE).
+This project is licensed under the [MIT License](LICENSE).
diff --git a/flipt-engine-ffi/CHANGELOG.md b/flipt-engine-ffi/CHANGELOG.md
@@ -2,37 +2,33 @@
 
 ## [0.1.18](https://github.com/flipt-io/flipt-client-sdks/compare/flipt-engine-ffi-v0.1.17...flipt-engine-ffi-v0.1.18) (2024-09-14)
 
-
 ### Features
 
-* add dart client ([#351](https://github.com/flipt-io/flipt-client-sdks/issues/351)) ([2cd64f8](https://github.com/flipt-io/flipt-client-sdks/commit/2cd64f80e782eed30069694408ff524cbe66ae5e))
+- add dart client ([#351](https://github.com/flipt-io/flipt-client-sdks/issues/351)) ([2cd64f8](https://github.com/flipt-io/flipt-client-sdks/commit/2cd64f80e782eed30069694408ff524cbe66ae5e))
 
 ## [0.1.17](https://github.com/flipt-io/flipt-client-sdks/compare/flipt-engine-ffi-v0.1.16...flipt-engine-ffi-v0.1.17) (2024-09-03)
 
-
 ### Bug Fixes
 
-* **ffi:** handle errors from http response ([#347](https://github.com/flipt-io/flipt-client-sdks/issues/347)) ([0c86da9](https://github.com/flipt-io/flipt-client-sdks/commit/0c86da9e4cf13e827266c6e7019db76b41019cdf)), closes [#346](https://github.com/flipt-io/flipt-client-sdks/issues/346)
+- **ffi:** handle errors from http response ([#347](https://github.com/flipt-io/flipt-client-sdks/issues/347)) ([0c86da9](https://github.com/flipt-io/flipt-client-sdks/commit/0c86da9e4cf13e827266c6e7019db76b41019cdf)), closes [#346](https://github.com/flipt-io/flipt-client-sdks/issues/346)
 
 ## [0.1.16](https://github.com/flipt-io/flipt-client-sdks/compare/flipt-engine-ffi-v0.1.15...flipt-engine-ffi-v0.1.16) (2024-08-25)
 
 ### Miscellaneous Chores
 
-* release 0.1.16 ([ffa7c53](https://github.com/flipt-io/flipt-client-sdks/commit/ffa7c535b7023eb218a78e949548b3fd6df4dd9d))
+- release 0.1.16 ([ffa7c53](https://github.com/flipt-io/flipt-client-sdks/commit/ffa7c535b7023eb218a78e949548b3fd6df4dd9d))
 
 ## [0.1.15](https://github.com/flipt-io/flipt-client-sdks/compare/flipt-engine-ffi-v0.1.14...flipt-engine-ffi-v0.1.15) (2024-07-29)
 
-
 ### Features
 
-* add support for default variant eval ([#309](https://github.com/flipt-io/flipt-client-sdks/issues/309)) ([ad88594](https://github.com/flipt-io/flipt-client-sdks/commit/ad88594b3f56acf62a72ca6c988409eb07c89a65))
+- add support for default variant eval ([#309](https://github.com/flipt-io/flipt-client-sdks/issues/309)) ([ad88594](https://github.com/flipt-io/flipt-client-sdks/commit/ad88594b3f56acf62a72ca6c988409eb07c89a65))
 
 ## [0.1.14](https://github.com/flipt-io/flipt-client-sdks/compare/flipt-engine-ffi-v0.1.13...flipt-engine-ffi-v0.1.14) (2024-07-14)
 
-
 ### Features
 
-* support etags in clients ([#299](https://github.com/flipt-io/flipt-client-sdks/issues/299)) ([e2acce3](https://github.com/flipt-io/flipt-client-sdks/commit/e2acce311f7531cfba831112222e7c63cb364759))
+- support etags in clients ([#299](https://github.com/flipt-io/flipt-client-sdks/issues/299)) ([e2acce3](https://github.com/flipt-io/flipt-client-sdks/commit/e2acce311f7531cfba831112222e7c63cb364759))
 
 ## [0.1.13](https://github.com/flipt-io/flipt-client-sdks/compare/flipt-engine-ffi-v0.1.12...flipt-engine-ffi-v0.1.13) (2024-04-27)
 

diff --git a/flipt-engine-wasm/CHANGELOG.md b/flipt-engine-wasm/CHANGELOG.md
@@ -2,16 +2,14 @@
 
 ## [0.1.1](https://github.com/flipt-io/flipt-client-sdks/compare/flipt-engine-wasm-v0.1.0...flipt-engine-wasm-v0.1.1) (2024-09-14)
 
-
 ### Features
 
-* add list flags to wasm/node SDK ([#381](https://github.com/flipt-io/flipt-client-sdks/issues/381)) ([7ac4f66](https://github.com/flipt-io/flipt-client-sdks/commit/7ac4f664e9333de1d7428440b61de6d0c043ed47))
-
+- add list flags to wasm/node SDK ([#381](https://github.com/flipt-io/flipt-client-sdks/issues/381)) ([7ac4f66](https://github.com/flipt-io/flipt-client-sdks/commit/7ac4f664e9333de1d7428440b61de6d0c043ed47))
 
 ### Bug Fixes
 
-* **wasm:** add wasm tests ([#383](https://github.com/flipt-io/flipt-client-sdks/issues/383)) ([67fc718](https://github.com/flipt-io/flipt-client-sdks/commit/67fc718d0868ee9795d4edab43f6cf06f8dd0e78))
-* **wasm:** prevent panic in the wasm ([#382](https://github.com/flipt-io/flipt-client-sdks/issues/382)) ([6b9ab25](https://github.com/flipt-io/flipt-client-sdks/commit/6b9ab2541596028455cba5ba0747372950b094be))
+- **wasm:** add wasm tests ([#383](https://github.com/flipt-io/flipt-client-sdks/issues/383)) ([67fc718](https://github.com/flipt-io/flipt-client-sdks/commit/67fc718d0868ee9795d4edab43f6cf06f8dd0e78))
+- **wasm:** prevent panic in the wasm ([#382](https://github.com/flipt-io/flipt-client-sdks/issues/382)) ([6b9ab25](https://github.com/flipt-io/flipt-client-sdks/commit/6b9ab2541596028455cba5ba0747372950b094be))
 
 ## [0.1.0](https://github.com/flipt-io/flipt-client-sdks/compare/flipt-engine-wasm-v0.0.3...flipt-engine-wasm-v0.1.0) (2024-04-10)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -88,4 +88,4 @@ Contributions are welcome! Please feel free to open an issue or submit a Pull Re

		## License

		This project is licensed under the [MIT License](LICENSE).
		This project is licensed under the [MIT License](LICENSE).
Original file line number	Diff line number	Diff line change
Expand Up		@@ -98,4 +98,4 @@ Contributions are welcome! Please feel free to open an issue or submit a Pull Re

		## License

		This project is licensed under the [MIT License](LICENSE).
		This project is licensed under the [MIT License](LICENSE).
Original file line number	Diff line number	Diff line change
Expand Up		@@ -99,4 +99,4 @@ Contributions are welcome! Please feel free to open an issue or submit a Pull Re

		## License

		This project is licensed under the [MIT License](LICENSE).
		This project is licensed under the [MIT License](LICENSE).