Skip to content

chore(ci): setup scene and plot - #212

Open
coryrylan wants to merge 1 commit into
mainfrom
topic-setup-projects
Open

chore(ci): setup scene and plot#212
coryrylan wants to merge 1 commit into
mainfrom
topic-setup-projects

Conversation

@coryrylan

@coryrylan coryrylan commented Aug 11, 2026

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • New Features
    • Added Plot and Scene components, available as <nve-plot> and <nve-scene>.
    • Published initial 0.0.0 packages with examples and custom-element registration.
    • Integrated both components into the workspace and site build.
  • Documentation
    • Added introductory documentation, changelogs, development guidance, and licensing notices.
  • Quality
    • Added accessibility, visual, server-rendering, performance, and unit test coverage for both components.
    • Updated bundled dependency notices and license attributions.

@coryrylan coryrylan self-assigned this Aug 11, 2026
@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Added initial @nvidia-elements/plot and @nvidia-elements/scene packages. Each package includes a Lit custom element, exports, examples, build tooling, validation suites, workspace integration, API metadata, and site documentation.

Changes

Plot and Scene packages

Layer / File(s) Summary
Plot package implementation
projects/plot/*
Added the @nvidia-elements/plot package, including the Plot custom element, nve-plot registration, exports, styles, examples, metadata, notices, and validation tests.
Scene package implementation
projects/scene/*
Added the @nvidia-elements/scene package, including the Scene custom element, nve-scene registration, exports, styles, examples, metadata, notices, and validation tests.
Package build and test tooling
projects/plot/package.json, projects/plot/*.config.*, projects/plot/tsconfig*, projects/scene/package.json, projects/scene/*.config.*, projects/scene/tsconfig*
Added package build, lint, unit-test, accessibility, Lighthouse, SSR, visual-test, coverage, and publishing workflows.
Workspace and site integration
knip.config.js, package.json, pnpm-workspace.yaml, projects/internals/metadata/*, projects/site/*
Added workspace, CI, dependency, API metadata, site build, and documentation integration for Plot and Scene.
Dependency notices
NOTICE.md, projects/cli/NOTICE.md
Updated bundled dependency versions and license attributions. Added Plot as a Lit consumer.

Estimated code review effort: 4 (Complex) | ~45 minutes

Suggested reviewers: johnyanarella

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: setting up the new Scene and Plot projects, including their CI integration.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch topic-setup-projects

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install failed. For unrecoverable errors, disable the tool in CodeRabbit configuration.


Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 7

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@projects/internals/metadata/package.json`:
- Around line 117-121: Add the ../../plot:build task to the generate:api
dependency list in package.json, ensuring Plot’s custom-elements manifest is
built before API generation and Plot elements are included in static/api.json.

In `@projects/plot/NOTICE.md`:
- Line 1: Resolve MD041 for all affected Markdown files: in
projects/plot/NOTICE.md (line 1), change the plain NOTICE text to a top-level
heading or exclude intentional plain-text notices from linting; in
projects/scene/CHANGELOG.md (line 1), add a top-level Changelog heading before
the existing version heading; and in projects/scene/NOTICE.md (line 1), change
NOTICE to a top-level heading or exclude it from Markdown linting.

In `@projects/plot/package.json`:
- Line 8: Update the package metadata description field to a concise, accurate
description of the Plot element, such as “Plot element for NVIDIA Elements,” so
metadata consumers receive a non-empty value.
- Around line 309-333: Update the lint target dependencies so lint:style is
reachable, and add lint:style to the ci target dependencies alongside
lint:eslint. Preserve the existing lint:style command and file configuration.
- Around line 326-333: Update the lint:style configuration in package.json to
use ../../stylelint.config.mjs instead of ../../../stylelint.config.mjs in both
the stylelint command and the files array.

In `@projects/scene/package.json`:
- Around line 67-80: Add a lint:style script to the scripts section and update
the lint task configuration so lint depends on lint:style alongside the existing
lint:eslint task, ensuring CSS sources are checked in CI.

In `@projects/site/src/docs/plot/index.md`:
- Around line 1-7: Update the documentation sidebar in common.js to add links
for /docs/plot/ and /docs/scene/, and include both routes in the group’s
expanded/selected condition. The affected pages are
projects/site/src/docs/plot/index.md (lines 1-7) and
projects/site/src/docs/scene/index.md (lines 1-7); neither page requires a
direct change.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: ee5d83d4-b5cd-4704-9de5-a64b88e68073

📥 Commits

Reviewing files that changed from the base of the PR and between 3fd90ca and c88b885.

⛔ Files ignored due to path filters (5)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
  • projects/plot/.visual/plot.dark.png is excluded by !**/*.png
  • projects/plot/.visual/plot.png is excluded by !**/*.png
  • projects/scene/.visual/scene.dark.png is excluded by !**/*.png
  • projects/scene/.visual/scene.png is excluded by !**/*.png
📒 Files selected for processing (72)
  • NOTICE.md
  • knip.config.js
  • package.json
  • pnpm-workspace.yaml
  • projects/cli/NOTICE.md
  • projects/internals/metadata/package.json
  • projects/internals/metadata/src/tasks/api.utils.ts
  • projects/plot/.gitignore
  • projects/plot/CHANGELOG.md
  • projects/plot/DEVELOPMENT.md
  • projects/plot/NOTICE.md
  • projects/plot/README.md
  • projects/plot/eslint.config.js
  • projects/plot/package.json
  • projects/plot/src/declarations.d.ts
  • projects/plot/src/index.test.lighthouse.ts
  • projects/plot/src/index.test.ts
  • projects/plot/src/index.ts
  • projects/plot/src/plot/define.ts
  • projects/plot/src/plot/index.ts
  • projects/plot/src/plot/plot.css
  • projects/plot/src/plot/plot.examples.ts
  • projects/plot/src/plot/plot.test.axe.ts
  • projects/plot/src/plot/plot.test.lighthouse.ts
  • projects/plot/src/plot/plot.test.ssr.ts
  • projects/plot/src/plot/plot.test.ts
  • projects/plot/src/plot/plot.test.visual.ts
  • projects/plot/src/plot/plot.ts
  • projects/plot/tsconfig.json
  • projects/plot/tsconfig.lib.json
  • projects/plot/vite.config.ts
  • projects/plot/vitest.axe.ts
  • projects/plot/vitest.config.ts
  • projects/plot/vitest.lighthouse.html
  • projects/plot/vitest.lighthouse.ts
  • projects/plot/vitest.ssr.ts
  • projects/plot/vitest.visual.html
  • projects/plot/vitest.visual.ts
  • projects/scene/.gitignore
  • projects/scene/CHANGELOG.md
  • projects/scene/DEVELOPMENT.md
  • projects/scene/NOTICE.md
  • projects/scene/README.md
  • projects/scene/eslint.config.js
  • projects/scene/package.json
  • projects/scene/src/declarations.d.ts
  • projects/scene/src/index.test.lighthouse.ts
  • projects/scene/src/index.test.ts
  • projects/scene/src/index.ts
  • projects/scene/src/scene/define.ts
  • projects/scene/src/scene/index.ts
  • projects/scene/src/scene/scene.css
  • projects/scene/src/scene/scene.examples.ts
  • projects/scene/src/scene/scene.test.axe.ts
  • projects/scene/src/scene/scene.test.lighthouse.ts
  • projects/scene/src/scene/scene.test.ssr.ts
  • projects/scene/src/scene/scene.test.ts
  • projects/scene/src/scene/scene.test.visual.ts
  • projects/scene/src/scene/scene.ts
  • projects/scene/tsconfig.json
  • projects/scene/tsconfig.lib.json
  • projects/scene/vite.config.ts
  • projects/scene/vitest.axe.ts
  • projects/scene/vitest.config.ts
  • projects/scene/vitest.lighthouse.html
  • projects/scene/vitest.lighthouse.ts
  • projects/scene/vitest.ssr.ts
  • projects/scene/vitest.visual.html
  • projects/scene/vitest.visual.ts
  • projects/site/package.json
  • projects/site/src/docs/plot/index.md
  • projects/site/src/docs/scene/index.md

Comment thread projects/internals/metadata/package.json
Comment thread projects/plot/NOTICE.md
Comment thread projects/plot/package.json
Comment thread projects/plot/package.json
Comment thread projects/plot/package.json
Comment thread projects/scene/package.json
Comment thread projects/site/src/docs/plot/index.md
@coryrylan
coryrylan force-pushed the topic-setup-projects branch from c88b885 to 61e0f5c Compare August 12, 2026 00:27
Signed-off-by: Cory Rylan <crylan@nvidia.com>
@coryrylan
coryrylan force-pushed the topic-setup-projects branch from 61e0f5c to dbc418e Compare August 12, 2026 00:31

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@projects/scene/package.json`:
- Line 8: Replace the empty description value in the package metadata with a
concise description of the Scene package, keeping the existing package metadata
unchanged.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: b040dd76-797c-49ef-9e5e-e892fc7cc678

📥 Commits

Reviewing files that changed from the base of the PR and between c88b885 and 61e0f5c.

📒 Files selected for processing (3)
  • projects/internals/metadata/package.json
  • projects/plot/package.json
  • projects/scene/package.json

"release": {
"extends": "../../release.config.js"
},
"description": "",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Add a package description.

description is empty. The PR adds package metadata and site documentation. An empty value produces incomplete package metadata. Add a concise Scene package description.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@projects/scene/package.json` at line 8, Replace the empty description value
in the package metadata with a concise description of the Scene package, keeping
the existing package metadata unchanged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant