CLAUDE.md in dotCMS/core runs 582 words across 30 headings.

The Visual Headless Content Management System for Enterprises

Java950 starsChanged 1 month ago4.2 kBNested, not at the rootCLAUDE.md

Covers

13 of the 20 section tags

In the order a file is read in

Setup & install Build Tests Lint & format Code style Architecture Types Testing strategy Dependencies UI & components Deploy & release Monorepo Agent behaviour

Headings

30 headings, in the order the file writes them

01CLAUDE.md

02Essential Commands

03Development Commands

04Build the library

05Run tests

06Run tests with coverage

07Lint code

08Run specific test file

09Package Management

10Install dependencies (run from workspace root)

11Publish package (from dist directory)

12Architecture Overview

13Key Technologies

14Project Structure

15Core Components & Patterns

16Component Architecture

17Key Dependencies

18Export Strategy

19Development Workflow

20Testing Standards

21Building & Distribution

22Code Quality

23Key Integration Points

24dotCMS Integration

25React Patterns

26Universal Visual Editor (UVE)

27Important Notes

28Peer Dependencies

29Build Configuration

30Testing Environment

Commands

8 commands this file writes down

Extracted from the file, verbatim

nx build sdk-react

nx test sdk-react

nx test sdk-react --configuration=ci

nx lint sdk-react

nx test sdk-react --testNamePattern="DotCMSLayoutBody"

npm install

nx nx-release-publish sdk-react

jest.config.ts

The file

core-web/libs/sdk/react/CLAUDE.md

144 lines

1# CLAUDE.md

3This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

5## Essential Commands

7### Development Commands

8```bash

9# Build the library

10nx build sdk-react

12# Run tests

13nx test sdk-react

15# Run tests with coverage

16nx test sdk-react --configuration=ci

18# Lint code

19nx lint sdk-react

21# Run specific test file

22nx test sdk-react --testNamePattern="DotCMSLayoutBody"

23```

25### Package Management

26```bash

27# Install dependencies (run from workspace root)

28npm install

30# Publish package (from dist directory)

31nx nx-release-publish sdk-react

32```

34## Architecture Overview

36This is the **@dotcms/react** SDK - a React component library that provides components and hooks for integrating React applications with dotCMS. The library is built using **Nx** as a monorepo tool with **Rollup** for bundling.

38### Key Technologies

39- **React 18+** (peer dependency)

40- **TypeScript** with strict mode

41- **Nx** for build tooling and project management

42- **Rollup** for ESM bundling

43- **Jest** for testing

44- **ESLint** for linting

45- **Babel** for transformation

47### Project Structure

48```

49src/

50├── index.ts # Main export file

51└── lib/

52 └── next/ # Next.js optimized components

53 ├── components/ # React components

54 │ ├── DotCMSLayoutBody/

55 │ ├── DotCMSShow/

56 │ ├── DotCMSEditableText/

57 │ └── DotCMSBlockEditorRenderer/

58 ├── hooks/ # Custom React hooks

59 └── contexts/ # React contexts

60```

62## Core Components & Patterns

64### Component Architecture

65All components follow these patterns:

671. **Client-side only components** - Use React hooks and contexts

682. **TypeScript interfaces** - Proper typing with `@dotcms/types`

693. **Modular CSS** - CSS modules where needed

704. **Comprehensive testing** - Jest with React Testing Library

72### Key Dependencies

73- `@dotcms/uve`: Universal Visual Editor integration

74- `@dotcms/client`: Core dotCMS client functionality

75- `@dotcms/types`: TypeScript definitions

76- `@tinymce/tinymce-react`: Rich text editing

78### Export Strategy

79The library uses a clean export pattern from `src/index.ts`:

80- All public components and hooks are explicitly exported

81- Components are exported with their prop types

82- Follows tree-shaking friendly patterns

84## Development Workflow

86### Testing Standards

87- **Jest** configuration in `jest.config.ts`

88- Tests located in `__test__/` directories

89- Test files follow pattern: `ComponentName.test.tsx`

90- Use React Testing Library for component testing

91- Mock external dependencies in `mock.ts`

93### Building & Distribution

94- **Rollup** builds ESM modules for distribution

95- Output goes to `dist/libs/sdk/react/`

96- Package includes README.md as asset

97- Generates exports field automatically

98- External dependencies: `react/jsx-runtime`

100### Code Quality

101- **ESLint** configuration for React/TypeScript

102- **Strict TypeScript** mode enabled

103- **Babel** transformation for Jest

104- **Coverage** reporting to workspace root

105

106## Key Integration Points

107

108### dotCMS Integration

109- Integrates with dotCMS Universal Visual Editor (UVE)

110- Uses `@dotcms/client` for API communication

111- Supports real-time page editing through UVE context

112- Handles dotCMS page asset rendering

113

114### React Patterns

115- Uses React 18+ features (jsx-runtime)

116- Context-based state management

117- Custom hooks for dotCMS functionality

118- Supports both development and production modes

119

120### Universal Visual Editor (UVE)

121- `useEditableDotCMSPage` hook for real-time editing

122- `DotCMSShow` component for conditional rendering

123- `DotCMSEditableText` for inline text editing

124- Mode detection (EDIT, PREVIEW, PUBLISHED)

125

126## Important Notes

127

128### Peer Dependencies

129- React 18+ and React DOM 18+ are required

130- No direct React dependencies to avoid version conflicts

131- Uses latest versions of internal dotCMS packages

132

133### Build Configuration

134- Targets ESM format only

135- Uses Babel for Jest transformation

136- Rollup handles bundling with React plugins

137- CSS extraction is disabled (CSS-in-JS approach)

138

139### Testing Environment

140- Jest preset from workspace root

141- React-specific transformations

142- Coverage directory in workspace root

143- Supports CI configuration with coverage reporting

144

The rest of the repository

dotCMS/core ships 20 other instruction files

.cursor/rules/java-context.mdccore-web/libs/sdk/client/CLAUDE.md.github/instructions/frontend.instructions.mdcore-web/CLAUDE.md core-web/apps/dotcms-ui/AGENTS.md core-web/apps/mcp-server/CLAUDE.mddotCMS/src/main/java/com/dotcms/rest/CLAUDE.mdtest-jmeter/CLAUDE.mdcore-web/apps/dotcms-ui-e2e/AGENTS.md.cursor/rules/doc-updates.mdc.cursor/rules/frontend-context.mdc .cursor/rules/e2e-rules.mdccore-web/AGENTS.md.github/copilot-instructions.md.cursor/rules/dotcms-guide.mdc.cursor/rules/test-context.mdc CLAUDE.mdcore-web/libs/block-editor/CLAUDE.mdcore-web/libs/new-block-editor/CLAUDE.mdcore-web/libs/portlets/CLAUDE.md

A row that is not a link is a file this repository ships that this app did not freeze a sheet for. It is listed because the corpus knows it exists, and it is not linked because there is nothing here to open.

This listing

Whoever runs dotCMS/core can claim it

This is yours? Claim this config and we will write to you when the measurement moves. The check is one token placed where only you can place it, and there is no account and no password.