Add the react, app-connect, and localizaton packages. #1188
There are no files selected for viewing
This file contains hidden or 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,32 @@ | ||
| --- | ||
| "@godaddy/localizations": major | ||
| "@godaddy/app-connect": major | ||
| "@godaddy/react": major | ||
| --- | ||
|
|
||
| This marks the first stable major release of our GoDaddy JavaScript libraries, representing a significant milestone in our platform development. | ||
|
|
||
| A comprehensive React component library for GoDaddy checkout experiences, featuring: | ||
|
|
||
| - Complete checkout session management with GraphQL integration | ||
| - Support for multiple payment providers (Stripe, PayPal) | ||
| - Comprehensive checkout features including billing/shipping addresses, tips, promotions, and tax collection | ||
| - Multi-environment support (dev, ote, prod, test) | ||
| - Built with modern React patterns using Radix UI components and Tailwind CSS | ||
|
|
||
| Internationalization support for GoDaddy checkout components: | ||
|
|
||
| - Structured localization framework covering all checkout aspects | ||
| - Initial French (France) localization with comprehensive translation coverage | ||
| - Extensible architecture for adding additional locales | ||
| - Seamless integration with the React component library | ||
|
|
||
| Essential platform integration tools for GoDaddy app developers: | ||
|
|
||
| - Cryptographic request verification using ECDSA-P256-SHA256 | ||
| - Webhook subscription verification with HMAC-SHA256 | ||
| - Framework-specific adapters for Express.js and Next.js | ||
| - Comprehensive error handling following GoDaddy standards | ||
| - Environment-based configuration support | ||
|
|
||
| These packages provide the foundation for building robust, secure, and internationalized applications on the GoDaddy platform. |
This file contains hidden or 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 hidden or 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,23 @@ | ||
| # AGENTS.md - GoDaddy JavaScript Style Guide | ||
|
|
||
| ## Commands | ||
| - Root lint: `pnpm lint` (runs across all packages) | ||
| - Root test: `pnpm test` (runs all package tests in parallel) | ||
| - Package-specific: `cd packages/<package> && pnpm <command>` | ||
| - Single test: Navigate to package directory, then `pnpm test` | ||
| - Clean: `pnpm clean` (removes node_modules from all packages) | ||
|
|
||
| ## Architecture | ||
| - Monorepo with pnpm workspaces containing ESLint configs | ||
| - Main packages: `eslint-config-godaddy` (base), `eslint-config-godaddy-react`, `eslint-config-godaddy-typescript` | ||
| - `app-connect/` - Platform Applications Registry API (TypeScript with Biome) | ||
| - `react/` - React component library with GraphQL schema | ||
| - Uses changesets for versioning and publishing | ||
|
|
||
| ## Code Style | ||
| - ESLint configs define GoDaddy JavaScript standards for ES6+, React, TypeScript | ||
| - Base config enforces strict mode, jsdoc, mocha, and json rules | ||
| - TypeScript: strict typing, no `any`, functional approach over classes | ||
| - Naming: lowercase-with-dashes for directories, camelCase for variables | ||
| - Error handling: wrap async in try/catch, use Result<T> types where applicable | ||
| - Testing: Mocha for base packages, Vitest for modern TypeScript packages | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -1,178 +1,158 @@ | ||
| # GoDaddy JavaScript | ||
|
|
||
| [](https://www.npmjs.com/package/eslint-config-godaddy) | ||
| [](https://github.com/godaddy/javascript/blob/main/LICENSE) | ||
| [](https://github.com/godaddy/javascript) | ||
|
|
||
| Official collection of JavaScript libraries, tools, and configurations for building on the GoDaddy platform. This monorepo contains all the JavaScript SDKs, ESLint configurations, and React components under the `@godaddy` namespace. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### ESLint Configurations | ||
|
|
||
| Choose the configuration that fits your project: | ||
|
|
||
| ```bash | ||
| # For ES6 JavaScript applications | ||
| npm install eslint-config-godaddy --save-dev | ||
|
|
||
| # For React applications | ||
| npm install eslint-config-godaddy-react --save-dev | ||
|
|
||
| # For TypeScript applications | ||
| npm install eslint-config-godaddy-typescript --save-dev | ||
|
|
||
| # For React + TypeScript applications | ||
| npm install eslint-config-godaddy-react-typescript --save-dev | ||
| ``` | ||
|
|
||
| ### Other Packages | ||
|
|
||
| ```bash | ||
| # For GoDaddy platform integration | ||
| npm install @godaddy/app-connect | ||
|
|
||
| # For React components with commerce APIs | ||
| npm install @godaddy/react | ||
| ``` | ||
|
|
||
| ## Packages | ||
|
|
||
| This monorepo contains the following packages: | ||
|
|
||
| | Package | Description | NPM | | ||
| |---------|-------------|-----| | ||
| | [`eslint-config-godaddy`](/packages/eslint-config-godaddy) | Base ESLint configuration for ES6 JavaScript | [](https://www.npmjs.com/package/eslint-config-godaddy) | | ||
| | [`eslint-config-godaddy-react`](/packages/eslint-config-godaddy-react) | ESLint configuration for React applications | [](https://www.npmjs.com/package/eslint-config-godaddy-react) | | ||
| | [`eslint-config-godaddy-typescript`](/packages/eslint-config-godaddy-typescript) | ESLint configuration for TypeScript applications | [](https://www.npmjs.com/package/eslint-config-godaddy-typescript) | | ||
| | [`eslint-config-godaddy-react-typescript`](/packages/eslint-config-godaddy-react-typescript) | ESLint configuration for React + TypeScript applications | [](https://www.npmjs.com/package/eslint-config-godaddy-react-typescript) | | ||
| | [`@godaddy/app-connect`](/packages/app-connect) | Platform integration tools for GoDaddy apps | [](https://www.npmjs.com/package/@godaddy/app-connect) | | ||
| | [`@godaddy/react`](/packages/react) | React components and commerce API integration | [](https://www.npmjs.com/package/@godaddy/react) | | ||
|
|
||
| ## Why GoDaddy JavaScript? | ||
|
|
||
| - **Standard. No configuration.** – Stop worrying about style and focus on your work. | ||
| - **Modern** – Uses modern linting tools like ESLint with support for ES6+, React, and TypeScript. | ||
| - **Auto-fix** – Auto-fix is enabled by default. Many rules will fix themselves! | ||
| - **Battle-tested** – Used by dozens of product teams at GoDaddy in production. | ||
|
|
||
| ## Quick Start | ||
|
|
||
| ### ESLint Configuration | ||
|
|
||
| 1. Install the appropriate configuration for your project | ||
| 2. Create an `eslint.config.js` file: | ||
|
|
||
| ```js | ||
| import GDConfig from 'eslint-config-godaddy'; | ||
| import { defineConfig } from 'eslint-define-config'; | ||
|
|
||
| export default defineConfig({ | ||
| extends: [GDConfig], | ||
| rules: { | ||
| // Add your custom rules here | ||
| 'no-console': 'warn', | ||
| }, | ||
| }); | ||
| ``` | ||
|
|
||
| 3. Add a lint script to your `package.json`: | ||
|
|
||
| ```json | ||
| { | ||
| "scripts": { | ||
| "lint": "eslint --fix src/" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Platform Integration | ||
|
|
||
| For applications integrating with the GoDaddy platform: | ||
|
|
||
| ```typescript | ||
| import { verifyAction } from '@godaddy/app-connect'; | ||
|
|
||
| // Verify requests from GoDaddy platform | ||
| const result = verifyAction(request); | ||
| if (result.success) { | ||
| // Process verified request | ||
| } | ||
| ``` | ||
|
|
||
| ## Release Notes | ||
|
|
||
| Release information is available through: | ||
| - [GitHub Releases](https://github.com/godaddy/javascript/releases) page | ||
| - Individual `CHANGELOG.md` files within each package (e.g., [`packages/eslint-config-godaddy/CHANGELOG.md`](/packages/eslint-config-godaddy/CHANGELOG.md)) | ||
|
|
||
| ## How to Contribute | ||
|
|
||
| We welcome contributions! To get started: | ||
|
|
||
| 1. Fork this repository | ||
| 2. Make your changes | ||
| 3. Submit a pull request | ||
|
|
||
| ### Local Development | ||
|
|
||
| This repository uses [pnpm](https://pnpm.io/) for package management and workspace handling. | ||
|
|
||
| ```bash | ||
| # Install dependencies | ||
| pnpm install | ||
|
|
||
| # Run tests across all packages | ||
| pnpm test | ||
|
|
||
| # Run linting across all packages | ||
| pnpm lint | ||
|
|
||
| # Create a changeset for your changes | ||
| pnpm changeset | ||
| ``` | ||
|
|
||
| ### Submitting Changes | ||
|
|
||
| This repository uses [changesets](https://github.com/changesets/changesets) for versioning and publishing. Include a changeset with your pull request: | ||
|
|
||
| ```bash | ||
| pnpm changeset | ||
| ``` | ||
|
|
||
| Follow the prompts to select which packages should receive version bumps. | ||
|
|
||
| ## Support | ||
|
|
||
| Have a question or found an issue? | ||
|
|
||
| - [Open an issue](https://github.com/godaddy/javascript/issues/new) on GitHub | ||
| - Check out our [contributing guidelines](CONTRIBUTING.md) | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. | ||
|
|
||
| --- | ||
|
|
||
| Built with ❤️ by the GoDaddy engineering team |
This file contains hidden or 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
wcole1-godaddy marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
Binary file not shown.
wcole1-godaddy marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
Binary file not shown.
This file contains hidden or 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,19 @@ | ||
| # AGENT.md - Platform Applications Registry API | ||
|
|
||
| ## Commands | ||
| - Build: `pnpm build` | ||
| - Dev mode: `pnpm dev` | ||
| - Lint: `pnpm lint` (Biome linter) | ||
| - Type check: `pnpm check` (Biome checks) | ||
| - Test: `pnpm test`, `pnpm test:watch` | ||
|
|
||
| ## Code Style | ||
| - TypeScript with strict typing (no `any`) | ||
| - Functions must return `Result<T>` type, check with `if (result.success)` | ||
| - Use Zod for validation | ||
| - Functional approach - minimal classes | ||
| - Naming: lowercase-with-dashes for directories | ||
| - Error handling: wrap async in try/catch at lowest level | ||
| - Tests: use Vitest with small, focused tests | ||
|
|
||
| ## Architecture |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should just be GoDaddy JavaScript since it's no longer including components that are just for linting and formatting.