-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Scaffold browser SDK project. (#555)
For now I am using Vite to build. If we encounter problems with this we can move to a rollup based build like we are using in other projects. Vite is easier to use and is reasonably popular, so I think it is a good starting point. Currently all tests in the monorepo use jest, so this continues to use jest. We may want to consider, in the future, if we want to move to vitest if it supports everything we need. This would make the testing configuration simpler.
- Loading branch information
1 parent
5ecdf31
commit 30b822e
Showing
17 changed files
with
281 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| name: sdk/browser | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main, 'feat/**'] | ||
| paths-ignore: | ||
| - '**.md' #Do not need to run CI for markdown changes. | ||
| pull_request: | ||
| branches: [main, 'feat/**'] | ||
| paths-ignore: | ||
| - '**.md' | ||
|
|
||
| jobs: | ||
| build-test-browser: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| strategy: | ||
| matrix: | ||
| # Node versions to run on. | ||
| version: [18, 21] | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: ${{ matrix.version }} | ||
| registry-url: 'https://registry.npmjs.org' | ||
| - id: shared | ||
| name: Shared CI Steps | ||
| uses: ./actions/ci | ||
| with: | ||
| workspace_name: '@launchdarkly/js-client-sdk' | ||
| workspace_path: packages/sdk/browser |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| Copyright 2024 Catamorphic, Co. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| # LaunchDarkly JavaScript SDK for Browsers | ||
|
|
||
| <!-- | ||
| [![NPM][browser-sdk-npm-badge]][browser-sdk-npm-link] | ||
| [![Actions Status][browser-sdk-ci-badge]][browser-sdk-ci] | ||
| [![Documentation][browser-sdk-ghp-badge]][browser-sdk-ghp-link] | ||
| [![NPM][browser-sdk-dm-badge]][browser-sdk-npm-link] | ||
| [![NPM][browser-sdk-dt-badge]][browser-sdk-npm-link] | ||
| --> | ||
|
|
||
| > [!CAUTION] | ||
| > This library is a beta version and should not be considered ready for production use while this message is visible. | ||
| <!-- | ||
| ## Install | ||
| ```shell | ||
| # npm | ||
| npm i @launchdarkly/js-client-sdk | ||
| # yarn | ||
| yarn add -D @launchdarkly/js-client-sdk | ||
| ``` | ||
| --> | ||
|
|
||
| ## Getting started | ||
|
|
||
| Refer to the [SDK documentation](https://docs.launchdarkly.com/sdk/client-side/javascript#getting-started) for instructions on getting started with using the SDK. | ||
|
|
||
| Note: _If you are using JavaScript in a non-browser environment, please check our other SDK packages in [js-core](https://github.com/launchdarkly/js-core)_ | ||
| Please note that the JavaScript SDK has two special requirements in terms of your LaunchDarkly environment. First, in terms of the credentials for your environment that appear on your [Account Settings](https://app.launchdarkly.com/settings/projects) dashboard, the JavaScript SDK uses the "Client-side ID"-- not the "SDK key" or the "Mobile key". Second, for any feature flag that you will be using in JavaScript code, you must check the "Make this flag available to client-side SDKs" box on that flag's Settings page. | ||
|
|
||
| ## Verifying SDK build provenance with the SLSA framework | ||
|
|
||
| LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) (Supply-chain Levels for Software Artifacts) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the [provenance guide](PROVENANCE.md). | ||
|
|
||
| ## About LaunchDarkly | ||
|
|
||
| - LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can: | ||
| - Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases. | ||
| - Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?). | ||
| - Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file. | ||
| - Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). | ||
| - Disable parts of your application to facilitate maintenance, without taking everything offline. | ||
| - LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read [our documentation](https://docs.launchdarkly.com/sdk) for a complete list. | ||
| - Explore LaunchDarkly | ||
| - [launchdarkly.com](https://www.launchdarkly.com/ 'LaunchDarkly Main Website') for more information | ||
| - [docs.launchdarkly.com](https://docs.launchdarkly.com/ 'LaunchDarkly Documentation') for our documentation and SDK reference guides | ||
| - [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API documentation | ||
| - [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates | ||
|
|
||
| [browser-sdk-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/browser.yml/badge.svg | ||
| [browser-sdk-ci]: https://github.com/launchdarkly/js-core/actions/workflows/browser.yml | ||
| [browser-sdk-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/js-client-sdk.svg?style=flat-square | ||
| [browser-sdk-npm-link]: https://www.npmjs.com/package/@launchdarkly/js-client-sdk | ||
| [browser-sdk-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8 | ||
| [browser-sdk-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/browser/docs/ | ||
| [browser-sdk-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/js-client-sdk.svg?style=flat-square | ||
| [browser-sdk-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/js-client-sdk.svg?style=flat-square |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| it('can run tests', () => { | ||
| expect(true).toBe(true); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| { | ||
| "name": "@launchdarkly/js-client-sdk", | ||
| "version": "0.0.0", | ||
| "description": "LaunchDarkly SDK for JavaScript in Browsers", | ||
| "homepage": "https://github.com/launchdarkly/js-core/tree/main/packages/sdk/browser", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/launchdarkly/js-core.git" | ||
| }, | ||
| "license": "Apache-2.0", | ||
| "packageManager": "[email protected]", | ||
| "keywords": [ | ||
| "launchdarkly", | ||
| "feature flags", | ||
| "feature toggles", | ||
| "feature management", | ||
| "sdk" | ||
| ], | ||
| "exports": { | ||
| "types": "./dist/src/index.d.ts", | ||
| "require": "./dist/index.cjs.js", | ||
| "import": "./dist/index.es.js" | ||
| }, | ||
| "type": "module", | ||
| "files": [ | ||
| "dist" | ||
| ], | ||
| "scripts": { | ||
| "clean": "rimraf dist", | ||
| "build": "vite build", | ||
| "lint": "eslint . --ext .ts,.tsx", | ||
| "prettier": "prettier --write '**/*.@(js|ts|tsx|json|css)' --ignore-path ../../../.prettierignore", | ||
| "test": "jest", | ||
| "coverage": "yarn test --coverage", | ||
| "check": "yarn prettier && yarn lint && yarn build && yarn test" | ||
| }, | ||
| "dependencies": { | ||
| "@launchdarkly/js-client-sdk-common": "1.5.0" | ||
| }, | ||
| "devDependencies": { | ||
| "@launchdarkly/private-js-mocks": "0.0.1", | ||
| "@testing-library/react": "^14.1.2", | ||
| "@trivago/prettier-plugin-sort-imports": "^4.1.1", | ||
| "@types/jest": "^29.5.11", | ||
| "@typescript-eslint/eslint-plugin": "^6.20.0", | ||
| "@typescript-eslint/parser": "^6.20.0", | ||
| "eslint": "^8.45.0", | ||
| "eslint-config-airbnb-base": "^15.0.0", | ||
| "eslint-config-airbnb-typescript": "^17.1.0", | ||
| "eslint-config-prettier": "^8.8.0", | ||
| "eslint-plugin-import": "^2.27.5", | ||
| "eslint-plugin-jest": "^27.6.3", | ||
| "eslint-plugin-prettier": "^5.0.0", | ||
| "jest": "^29.7.0", | ||
| "prettier": "^3.0.0", | ||
| "rimraf": "^5.0.5", | ||
| "ts-jest": "^29.1.1", | ||
| "typedoc": "0.25.0", | ||
| "typescript": "^5.5.3", | ||
| "vite": "^5.4.1", | ||
| "vite-plugin-dts": "^4.0.3" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| export function Hello() { | ||
| // eslint-disable-next-line no-console | ||
| console.log('HELLO'); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "extends": "./tsconfig.json", | ||
| "include": ["/**/*.ts", "/**/*.tsx"], | ||
| "exclude": ["node_modules"] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| { | ||
| "compilerOptions": { | ||
| "allowSyntheticDefaultImports": true, | ||
| "declaration": true, | ||
| "declarationMap": true, | ||
| "jsx": "react-jsx", | ||
| "lib": ["es6", "dom"], | ||
| "module": "ES6", | ||
| "moduleResolution": "node", | ||
| "noImplicitOverride": true, | ||
| "resolveJsonModule": true, | ||
| // Uses "." so it can load package.json. | ||
| "rootDir": ".", | ||
| "skipLibCheck": true, | ||
| // enables importers to jump to source | ||
| "sourceMap": true, | ||
| "strict": true, | ||
| "stripInternal": true, | ||
| "target": "ES2017", | ||
| "types": ["node", "jest"], | ||
| "allowJs": true | ||
| }, | ||
| "exclude": [ | ||
| "vite.config.ts", | ||
| "__tests__", | ||
| "dist", | ||
| "docs", | ||
| "example", | ||
| "node_modules", | ||
| "babel.config.js", | ||
| "jest.config.ts", | ||
| "jestSetupFile.ts", | ||
| "**/*.test.ts*" | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "extends": "./tsconfig.json", | ||
| "include": ["src/**/*", "package.json", "__tests__/index.test.ts"], | ||
| "compilerOptions": { | ||
| "composite": true | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| { | ||
| "compilerOptions": { | ||
| "esModuleInterop": true, | ||
| "jsx": "react-jsx", | ||
| "lib": ["es6", "dom"], | ||
| "module": "ES6", | ||
| "moduleResolution": "node", | ||
| "resolveJsonModule": true, | ||
| "rootDir": ".", | ||
| "strict": true, | ||
| "types": ["jest", "node"] | ||
| }, | ||
| "exclude": ["dist", "node_modules", "__tests__", "example"] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "extends": ["../../../typedoc.base.json"], | ||
| "entryPoints": ["src/index.ts"], | ||
| "out": "docs" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| /* eslint-disable import/no-extraneous-dependencies */ | ||
| // This file intentionally uses dev dependencies as it is a build file. | ||
| import { resolve } from 'path'; | ||
| import { defineConfig } from 'vite'; | ||
| import dts from 'vite-plugin-dts'; | ||
|
|
||
| export default defineConfig({ | ||
| plugins: [dts()], | ||
| build: { | ||
| lib: { | ||
| entry: resolve(__dirname, 'src/index.ts'), | ||
| name: '@launchdarkly/js-client-sdk', | ||
| fileName: (format) => `index.${format}.js`, | ||
| formats: ['cjs', 'es'], | ||
| }, | ||
| rollupOptions: {}, | ||
| }, | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters