docs(nx-dev): fix inputs syntax and document missing object formats #33298
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✅ Deploy Preview for nx-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
AgentEnder
changed the title
- Fix Source Files section to show inputs as an array (was incorrectly shown as object)
- Add documentation for fileset object format: { fileset: string }
- Add new section "Named Inputs from Other Projects" documenting:
- { input: string, projects: string | string[] }
- { input: string, dependencies: true }
- { input: string }
- All formats now match the TypeScript type definition
Co-authored-by: AgentEnder <[email protected]>
Co-authored-by: AgentEnder <[email protected]>
| // Reference a named input from all project dependencies | ||
| { "input": "production", "dependencies": true }, | ||
|
|
||
| // Reference a named input from the current project (equivalent to just using the string) | ||
| { "input": "production" } |
There was a problem hiding this comment.
@copilot These are equivalent to a syntactic sugar string form - production for the self input, and ^production for the dependencies one - Lets flip them to use the string, and the comment explain the equivalence
There was a problem hiding this comment.
Updated in commit 54f6971 to use the string syntactic sugar forms ("production" and "^production") with comments explaining their equivalence to the object forms.
|
@copilot two things:
|
- Remove targetDefaults wrapper from Source Files example - Use string syntactic sugar forms (production and ^production) in examples - Explain equivalence between string and object forms Co-authored-by: AgentEnder <[email protected]>
Both changes addressed in commit 54f6971:
Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
|
View your CI Pipeline Execution ↗ for commit 2577ed7
☁️ Nx Cloud last updated this comment at |
|
|
||
| // Reference a named input from the current project | ||
| // Equivalent to: "production" | ||
| "production", |
There was a problem hiding this comment.
@copilot the comment should have the object form, right now it says its equivalent to itself
There was a problem hiding this comment.
Fixed in commit 2577ed7. Changed the comment to show the object form { "input": "production" } instead of repeating the string form.
Change comment from showing string form to showing the equivalent object form Co-authored-by: AgentEnder <[email protected]>
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
| Source file inputs are defined like this: | ||
|
|
||
| ```jsonc | ||
| // nx.json |
There was a problem hiding this comment.
This line should not be removed
| // nx.json | |
| // nx.json |
meeroslav
changed the title
Plan to Fix Inputs Documentation
Based on the issue, I need to correct the inputs documentation at
/astro-docs/src/content/docs/reference/inputs.mdoc. The problems are:{ input: someNamedInput, projects: [] }format for referencing named inputs from specific projects{ input: someNamedInput, dependencies: true }format for referencing named inputs from dependencies{ fileset: string })Changes Made
Fixed Source Files section syntax:
Added new section "Named Inputs from Other Projects":
{ input: "production", projects: "mylib" }format{ input: "production", projects: ["mylib", "myapp"] }format for multiple projects"production"and"^production"in examples"production"is shorthand for{ "input": "production" },"^production"is shorthand for{ "input": "production", "dependencies": true }Fixed typo: Changed "to to not invalidate" to "to not invalidate"
All changes validated with prettier formatting checks.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.