Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(graph): add expandedTargets to project details on nx dev #26911

Merged
merged 2 commits into from
Aug 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/nx-cloud/features/split-e2e-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ You can view the available tasks for your project in the project detail view:
nx show project myproject-e2e --web
```

{% project-details title="Project Details View" height="100px" %}
{% project-details title="Project Details View" %}

```json
{
Expand Down
2 changes: 1 addition & 1 deletion docs/shared/migration/adding-to-existing-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ details in a browser window.
nx show project my-workspace --web
```

{% project-details title="Project Details View" height="100px" %}
{% project-details title="Project Details View" %}

```json
{
Expand Down
2 changes: 1 addition & 1 deletion docs/shared/migration/adding-to-monorepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ details in a browser window.
nx show project my-workspace --web
```

{% project-details title="Project Details View" height="100px" %}
{% project-details title="Project Details View" %}

```json
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ For this recipe we'll use a project with the following `project.json` file:

And the following [final configuration](/reference/project-configuration):

{% project-details title="Project Details View" height="100px" %}
{% project-details title="Project Details View" %}

```json
{
Expand Down
2 changes: 1 addition & 1 deletion docs/shared/reference/project-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Each source will [overwrite the previous source](/recipes/running-tasks/pass-arg
nx show project myproject --web
```

{% project-details title="Project Details View" height="100px" %}
{% project-details title="Project Details View" %}

```json
{
Expand Down
2 changes: 1 addition & 1 deletion docs/shared/tutorials/angular-monorepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -619,7 +619,7 @@ Nx identifies available tasks for your project from [tooling configuration files
npx nx show project angular-store-e2e --web
```

{% project-details title="Project Details View" height="100px" %}
{% project-details title="Project Details View" %}

```json
{
Expand Down
2 changes: 1 addition & 1 deletion docs/shared/tutorials/angular-standalone.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ Nx identifies available tasks for your project from [tooling configuration files
nx show project e2e --web
```

{% project-details title="Project Details View" height="100px" %}
{% project-details title="Project Details View" %}

```json
{
Expand Down
2 changes: 1 addition & 1 deletion docs/shared/tutorials/gradle.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ that we've installed reflects Gradle's tasks to Nx, which allows it to run any o
./nx show project application --web
```

{% project-details title="Project Details View" jsonFile="shared/tutorials/gradle-pdv.json" %}
{% project-details title="Project Details View" jsonFile="shared/tutorials/gradle-pdv.json" expandedTargets=["build"] height="520px" %}
{% /project-details %}

The Nx command to run the `build` task for the `application` project is:
Expand Down
2 changes: 1 addition & 1 deletion docs/shared/tutorials/react-monorepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Nx identifies available tasks for your project from [tooling configuration files
npx nx show project react-store
```

{% project-details title="Project Details View (Simplified)" height="100px" %}
{% project-details title="Project Details View (Simplified)" %}

```json
{
Expand Down
12 changes: 10 additions & 2 deletions graph/shared/src/lib/expanded-targets-provider.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,16 @@ export const ExpandedTargetsContext = createContext<{
collapseAllTargets?: () => void;
}>({});

export const ExpandedTargetsProvider = ({ children }) => {
const [expandedTargets, setExpandedTargets] = useState<string[]>([]);
export const ExpandedTargetsProvider = ({
children,
initialExpanededTargets = [],
}: {
children: React.ReactNode;
initialExpanededTargets?: string[];
}) => {
const [expandedTargets, setExpandedTargets] = useState<string[]>(
initialExpanededTargets
);

const toggleTarget = (targetName: string) => {
setExpandedTargets((prevExpandedTargets) => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@ export function TargetConfigurationGroupContainer({
return null;
}
return (
<div className="mb-4 w-full">
<div
id={`target-group-container-${targetGroupName}`}
className="mb-4 w-full"
>
<TargetConfigurationGroupHeader
targetGroupName={targetGroupName}
targetsNumber={targetsNumber}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export const TargetConfigurationGroupHeader = ({
}: TargetConfigurationGroupHeaderProps) => {
return (
<header
id={`target-group-header-${targetGroupName}`}
className={`flex items-center gap-2 px-4 py-2 text-lg capitalize ${className}`}
>
{targetGroupName}{' '}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ export const TargetConfigurationDetailsHeader = ({
? 'border-b bg-slate-50 dark:border-slate-700/60 dark:bg-slate-800'
: ''
)}
id={`target-${targetName}`}
onClick={collapsable ? toggleCollapse : undefined}
>
<div className="flex items-center justify-between gap-4">
Expand Down
56 changes: 45 additions & 11 deletions nx-dev/ui-markdoc/src/lib/tags/project-details.component.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
'use client';
import { JSX, ReactElement, useEffect, useState } from 'react';
import {
createRef,
JSX,
ReactElement,
useEffect,
useLayoutEffect,
useState,
} from 'react';
import { ProjectDetails as ProjectDetailsUi } from '@nx/graph/ui-project-details';
import { ExpandedTargetsProvider } from '@nx/graph/shared';

Expand All @@ -20,14 +27,17 @@ export function ProjectDetails({
height,
title,
jsonFile,
expandedTargets = [],
children,
}: {
height: string;
title: string;
jsonFile?: string;
expandedTargets?: string[];
children: ReactElement;
}): JSX.Element {
const [parsedProps, setParsedProps] = useState<any>();
const elementRef = createRef<HTMLDivElement>();
const getData = async (path: string) => {
const response = await fetch('/documentation/' + path, {
headers: {
Expand All @@ -43,6 +53,27 @@ export function ProjectDetails({
}
}, [jsonFile, setParsedProps]);

useLayoutEffect(() => {
if (elementRef && expandedTargets?.length > 0) {
const header = document.getElementById('target-' + expandedTargets[0]);
const container = document.getElementById('project-details-container');
if (header && container) {
const groupHeaderOffset =
header
.closest('[id^="target-group-container-"]')
?.querySelector('[id^="target-group-header-"]')
?.getBoundingClientRect().height ?? 0;
elementRef.current?.scrollTo({
top:
header?.getBoundingClientRect().top -
container.getBoundingClientRect()?.top -
groupHeaderOffset,
behavior: 'instant',
});
}
}
}, [elementRef, expandedTargets]);

if (!jsonFile && !parsedProps) {
if (!children || !children.hasOwnProperty('props')) {
return (
Expand Down Expand Up @@ -78,17 +109,20 @@ export function ProjectDetails({
</div>
)}
<div
className={`not-prose ${
height ? `p-4 h-[${height}] overflow-y-auto` : 'p-4'
}`}
id="project-details-container"
className="not-prose overflow-y-auto"
style={{ height }}
ref={elementRef}
>
<ExpandedTargetsProvider>
<ProjectDetailsUi
project={parsedProps.project}
sourceMap={parsedProps.sourceMap}
variant="compact"
/>
</ExpandedTargetsProvider>
<div className="m-4">
<ExpandedTargetsProvider initialExpanededTargets={expandedTargets}>
<ProjectDetailsUi
project={parsedProps.project}
sourceMap={parsedProps.sourceMap}
variant="compact"
/>
</ExpandedTargetsProvider>
</div>
</div>
</div>
);
Expand Down
3 changes: 3 additions & 0 deletions nx-dev/ui-markdoc/src/lib/tags/project-details.schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,8 @@ export const projectDetails: Schema = {
height: {
type: 'String',
},
expandedTargets: {
type: 'Array',
},
},
};