feat: add typedoc support

Signed-off-by: Michael Beemer <[email protected]>
beeme1mr · Oct 7, 2022 · 0c9a853 · 0c9a853
1 parent 49a734b
commit 0c9a853
Show file tree

Hide file tree

Showing 11 changed files with 328 additions and 80 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,48 +1,56 @@
 {
-	"env":{
-		 "browser":true,
-		 "es2021":true
+	"env": {
+		"browser": true,
+		"es2021": true
 	},
-	"extends":[
-		 "eslint:recommended",
-		 "plugin:@typescript-eslint/recommended",
-		 "prettier",
-		 "plugin:jsdoc/recommended"
+	"extends": [
+		"eslint:recommended",
+		"plugin:@typescript-eslint/recommended",
+		"prettier",
+		"plugin:jsdoc/recommended"
 	],
-	"parser":"@typescript-eslint/parser",
-	"parserOptions":{
-		 "ecmaVersion":"latest",
-		 "sourceType":"module"
+	"parser": "@typescript-eslint/parser",
+	"parserOptions": {
+		"ecmaVersion": "latest",
+		"sourceType": "module"
 	},
-	"plugins":[
-		 "@typescript-eslint",
-		 "check-file",
-		 "jsdoc"
+	"plugins": [
+		"@typescript-eslint",
+		"check-file",
+		"jsdoc"
 	],
-	"rules":{
-		 "linebreak-style":[
-				"error",
-				"unix"
-		 ],
-		 "quotes":[
-				"error",
-				"single",
-				{
-					"avoidEscape": true
-				}
-		 ],
-		 "semi":[
-				"error",
-				"always"
-		 ],
-		 "check-file/filename-naming-convention":[
+	"rules": {
+		"jsdoc/check-tag-names": [
+			"warn",
+			{
+				"definedTags": [
+					"experimental"
+				]
+			}
+		],
+		"linebreak-style": [
+			"error",
+			"unix"
+		],
+		"quotes": [
+			"error",
+			"single",
+			{
+				"avoidEscape": true
+			}
+		],
+		"semi": [
+			"error",
+			"always"
+		],
+		"check-file/filename-naming-convention": [
 			"error",
 			{
-				"**/*.{js,ts}":"KEBAB_CASE"
+				"**/*.{js,ts}": "KEBAB_CASE"
 			},
-      {
-      	"ignoreMiddleExtensions": true
-      }
+			{
+				"ignoreMiddleExtensions": true
+			}
 		]
 	}
-}
+}
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
@@ -15,19 +15,24 @@ jobs:
           command: manifest
           token: ${{secrets.GITHUB_TOKEN}}
           default-branch: main
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      release_tag_name: ${{ steps.release.outputs.tag_name }}
 
+  npm-release:
+    needs: Release-please
+    runs-on: ubuntu-latest
+    if: ${{ needs.release-please.outputs.release_created }}
+    steps:
       # The logic below handles the npm publication:
       - name: Checkout Repository
-        if: ${{ steps.release.outputs.releases_created }}
         uses: actions/checkout@v3
       - name: Setup Node
         uses: actions/setup-node@v3
-        if: ${{ steps.release.outputs.releases_created }}
         with:
           node-version: 16
-          registry-url: 'https://registry.npmjs.org'
+          registry-url: "https://registry.npmjs.org"
       - name: Build Packages
-        if: ${{ steps.release.outputs.releases_created }}
         run: |
           npm ci
           npm run build
@@ -36,7 +41,16 @@ jobs:
       # need to publish all unpublished versions to NPM here
       # Our scripts only publish versions that do not already exist.
       - name: Publish to NPM
-        if: ${{ steps.release.outputs.releases_created }}
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
         run: npm publish --access public
+
+      - name: Build Docs
+        run: npm run docs
+
+      - name: Deploy Documentation 🚀
+        uses: JamesIves/github-pages-deploy-action@releases/v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages
+          FOLDER: typedoc
diff --git a/.gitignore b/.gitignore
@@ -105,4 +105,7 @@ dist
 
 # yalc stuff
 yalc.lock
-.yalc/
+.yalc/
+
+# Ignore generated doc folder
+typedoc
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "0.5.0"
+  ".": "0.6.0"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,37 @@
 # Changelog
 
+## [0.6.0](https://github.com/beeme1mr/js-sdk/compare/js-sdk-v0.5.0...js-sdk-v0.6.0) (2022-10-07)
+
+
+### ⚠ BREAKING CHANGES
+
+* errorCode as enum, reason as string (#244)
+* improve generic type accuracy (#224)
+* convert to chainable methods (#221)
+* remove flag evaluation options from the provider interface (#185)
+* context transformer and related interfaces removed.
+
+### Features
+
+* add client context mutation ([#207](https://github.com/beeme1mr/js-sdk/issues/207)) ([5b0442a](https://github.com/beeme1mr/js-sdk/commit/5b0442aee952e694496f3d15770a69b334015802))
+* add logger ([#219](https://github.com/beeme1mr/js-sdk/issues/219)) ([763f167](https://github.com/beeme1mr/js-sdk/commit/763f16717a4dd199a84bf90302551d3b24c862af))
+* add transaction propagation ([#212](https://github.com/beeme1mr/js-sdk/issues/212)) ([1d251ff](https://github.com/beeme1mr/js-sdk/commit/1d251ff99e8fc6c03c3f2fd2faa16320e01909fe))
+* convert to chainable methods ([#221](https://github.com/beeme1mr/js-sdk/issues/221)) ([5253ad9](https://github.com/beeme1mr/js-sdk/commit/5253ad9b47299c375bbf1151c672454fb11b9f40))
+* errorCode as enum, reason as string ([#244](https://github.com/beeme1mr/js-sdk/issues/244)) ([ce7c4ad](https://github.com/beeme1mr/js-sdk/commit/ce7c4ad80cedf5c40b6ce1e123caae737b14f6aa))
+* experimental web support ([#200](https://github.com/beeme1mr/js-sdk/issues/200)) ([fd144bb](https://github.com/beeme1mr/js-sdk/commit/fd144bb13457c29102e60f2075243f52b1ce6d0b))
+* improve generic type accuracy ([#224](https://github.com/beeme1mr/js-sdk/issues/224)) ([12230a5](https://github.com/beeme1mr/js-sdk/commit/12230a5cd7c4a5a1ae55f117fed5d6778118f4ee))
+* remove ctx transformer, add provider hooks ([#148](https://github.com/beeme1mr/js-sdk/issues/148)) ([260432c](https://github.com/beeme1mr/js-sdk/commit/260432c4f92f16f83635dfafff30ad9bc1697a47))
+* remove flag evaluation options from the provider interface ([#185](https://github.com/beeme1mr/js-sdk/issues/185)) ([e9852e4](https://github.com/beeme1mr/js-sdk/commit/e9852e4f52fd598cebb9d74f3c22abdb832ebac9)), closes [#183](https://github.com/beeme1mr/js-sdk/issues/183)
+
+
+### Bug Fixes
+
+* Add no-op tests ([#99](https://github.com/beeme1mr/js-sdk/issues/99)) ([a341f5c](https://github.com/beeme1mr/js-sdk/commit/a341f5c776035ca24b1323b4a37f5f166cdc55d7))
+* Dont push experiemental branches ([#101](https://github.com/beeme1mr/js-sdk/issues/101)) ([0a7a5ec](https://github.com/beeme1mr/js-sdk/commit/0a7a5ec562d5dcfdb044ebcc25fd1fed703b68f4))
+* Fix publish command ([#103](https://github.com/beeme1mr/js-sdk/issues/103)) ([4742ef1](https://github.com/beeme1mr/js-sdk/commit/4742ef14cc0ea07e3569eee56899937452a55a9c))
+* Fixing error with setProvider type ([#121](https://github.com/beeme1mr/js-sdk/issues/121)) ([df5d214](https://github.com/beeme1mr/js-sdk/commit/df5d2149ef15a1e9b58b9a3280c01bd77a2b3dd8))
+* update the client to conform to the provider interface ([#187](https://github.com/beeme1mr/js-sdk/issues/187)) ([f1edb29](https://github.com/beeme1mr/js-sdk/commit/f1edb296346e9feb2bd86fed71bbe24e725e0531))
+
 ## [0.5.0](https://github.com/open-feature/js-sdk/compare/js-sdk-v0.4.0...js-sdk-v0.5.0) (2022-10-03)