You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@daffodil.apache.org by "JeremyYao (via GitHub)" <gi...@apache.org> on 2025/10/07 13:31:58 UTC
[I] Task: Document IntelliSense Functionality [daffodil-vscode]
JeremyYao opened a new issue, #1456:
URL: https://github.com/apache/daffodil-vscode/issues/1456
# Task: Document IntelliSense Functionality
## Description
Document how the codebase's IntelliSense functionality is currently setup.
## Acceptance Criteria
- [ ] [Intellisense is adequately described in wiki page](https://github.com/apache/daffodil-vscode/wiki/Intellisense-Code-Structure)
## Steps / Subtasks
- [ ] https://github.com/apache/daffodil-vscode/wiki/Intellisense-Code-Structure is adequately documented
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Task: Document IntelliSense Functionality [daffodil-vscode]
Posted by "JeremyYao (via GitHub)" <gi...@apache.org>.
JeremyYao closed issue #1456: Task: Document IntelliSense Functionality
URL: https://github.com/apache/daffodil-vscode/issues/1456
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Task: Document IntelliSense Functionality [daffodil-vscode]
Posted by "JeremyYao (via GitHub)" <gi...@apache.org>.
JeremyYao commented on issue #1456:
URL: https://github.com/apache/daffodil-vscode/issues/1456#issuecomment-3450968492
I'd say in terms of documenting utils.ts, I'm 50% through with adding comments and going through the file.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Task: Document IntelliSense Functionality [daffodil-vscode]
Posted by "JeremyYao (via GitHub)" <gi...@apache.org>.
JeremyYao commented on issue #1456:
URL: https://github.com/apache/daffodil-vscode/issues/1456#issuecomment-3377008868
Spoke with @rthomas320 yesterday regarding IntelliSense in the repo.
Some takeaways:
- When intellisense gets triggered—it triggers every registerItemProvider… there is logic for determining if the scenario applies or not for each registerItemProvider. Multiple providers here...
- Notable files: ElementCompletion.ts AttributeCompletion.ts
- XML Item-- refers to the entire XML element. Named XML item to not confused between `xs:element` and `dfdl:element`
- Many calls in `utils.ts` in the src/lanuage/providers folder
- Best to get hands on. Set breakpoints to explore intellisense logic. Ask @rthomas320 if any questions come up.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Task: Document IntelliSense Functionality [daffodil-vscode]
Posted by "JeremyYao (via GitHub)" <gi...@apache.org>.
JeremyYao commented on issue #1456:
URL: https://github.com/apache/daffodil-vscode/issues/1456#issuecomment-3452397344
I wrapped up commenting on utils.ts: https://github.com/ctc-oss/daffodil-vscode/commit/a293a1c7a691120ce467d9770254afc15d73d156 and then put in some high-level bullet points and other things in https://github.com/ctc-oss/daffodil-vscode/commit/57b71da034c239eed81194ae2626591c0e3fc974
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Task: Document IntelliSense Functionality [daffodil-vscode]
Posted by "JeremyYao (via GitHub)" <gi...@apache.org>.
JeremyYao commented on issue #1456:
URL: https://github.com/apache/daffodil-vscode/issues/1456#issuecomment-3457322323
From conversation with @hdalsania. given the scope and sizing of the ticket. It might best to break it down.
It'll be best to break this task down into 6 subtasks aligned with how the providers are registered in `src/language/dfdl.ts`.
```typescript
export function activate(context: vscode.ExtensionContext) {
let dfdlFormat = fs
.readFileSync(
context.asAbsolutePath(
'./src/language/providers/intellisense/DFDLGeneralFormat.dfdl.xsd'
)
)
.toLocaleString()
context.subscriptions.push(
getElementCompletionProvider(dfdlFormat),
getAttributeCompletionProvider(),
getAttributeValueCompletionProvider(),
getCloseElementProvider(),
getCloseElementSlashProvider(),
getAttributeHoverProvider()
)
}
```
Another subtask that should be added is documenting `src\language\providers\utils.ts`
To summarize, this ticket shall be broken down into the following sub-tasks
- `src\language\providers\utils.ts` -- used by every provider
- ElementCompletionProvider and all relevant files
- AttributeCompletionProvider and all relevant files
- AttributeValueCompletionProvider and all relevant files
- CloseElementProvider and all relevant files
- CloseElementSlashProvider and all relevant files
- AttributeHoverProvider and all relevant files
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Task: Document IntelliSense Functionality [daffodil-vscode]
Posted by "JeremyYao (via GitHub)" <gi...@apache.org>.
JeremyYao commented on issue #1456:
URL: https://github.com/apache/daffodil-vscode/issues/1456#issuecomment-3811998302
All tasks are done. Closing this and moving to done.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Task: Document IntelliSense Functionality [daffodil-vscode]
Posted by "JeremyYao (via GitHub)" <gi...@apache.org>.
JeremyYao commented on issue #1456:
URL: https://github.com/apache/daffodil-vscode/issues/1456#issuecomment-3456998537
Documentation + code comments for attributeHover: https://github.com/ctc-oss/daffodil-vscode/commit/d7429fac48acce762f000a58a8fbd2d910a55c9c
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Task: Document IntelliSense Functionality [daffodil-vscode]
Posted by "JeremyYao (via GitHub)" <gi...@apache.org>.
JeremyYao commented on issue #1456:
URL: https://github.com/apache/daffodil-vscode/issues/1456#issuecomment-3382255802
I created https://github.com/apache/daffodil-vscode/issues/1458 upon performing work for this issue.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Task: Document IntelliSense Functionality [daffodil-vscode]
Posted by "JeremyYao (via GitHub)" <gi...@apache.org>.
JeremyYao commented on issue #1456:
URL: https://github.com/apache/daffodil-vscode/issues/1456#issuecomment-3397721636
https://github.com/ctc-oss/daffodil-vscode/commit/d4788b36b710c40a3a5e90c9cd464a4e5310a2be Table of contents made, noted general Intellisense concepts, and started file deep-dive
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Task: Document IntelliSense Functionality [daffodil-vscode]
Posted by "JeremyYao (via GitHub)" <gi...@apache.org>.
JeremyYao commented on issue #1456:
URL: https://github.com/apache/daffodil-vscode/issues/1456#issuecomment-3381360632
In-progress work is being done in the following branch: https://github.com/ctc-oss/daffodil-vscode/tree/jy/1456. Additionally, I was advised to have the content inside of a document inside of the repo instead of having the information be on the wiki page.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Task: Document IntelliSense Functionality [daffodil-vscode]
Posted by "JeremyYao (via GitHub)" <gi...@apache.org>.
JeremyYao commented on issue #1456:
URL: https://github.com/apache/daffodil-vscode/issues/1456#issuecomment-3450965178
I think it's worth it to add comments to relevant files. I added some comments to utils.ts per https://github.com/apache/daffodil-vscode/compare/main...ctc-oss:daffodil-vscode:jy/1456?expand=1.
Additionally, renamed README.md to intellisense-development.md
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Task: Document IntelliSense Functionality [daffodil-vscode]
Posted by "JeremyYao (via GitHub)" <gi...@apache.org>.
JeremyYao commented on issue #1456:
URL: https://github.com/apache/daffodil-vscode/issues/1456#issuecomment-3437445045
@hdalsania's feedback
- This is a good start
- Refrain from making code changes in the PR...
- Move all of them into an issue. Document them and put them in to 1.6.0
- Comments are okay
- Rename the readme file to be intellisense-development.md
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org