Require an additional check on every PR to ensure the entry has been added in the table
Require contributors to modify the readme
Prone to error/inconsistencies:
Mismatch between: prefixes and descriptions (table and snippets file)
Not very usable:
The table is not intuitive to explore, even in alphabetical order (other programming cheat sheets group snippets, and use multiple columns). This affect users, but also for maintainers/contributors trying to understand if a code snippet already exists.
I think making a web interface should be pretty simple. I have been testing, and I think we can add "custom properties" to the custom snippets:
That, way we could create properties like:
category: To be able to group snippets (we could consider subcategories if needed; e.g. using a delimitation character)
url: if we want to add additional hyperlinks on each snippets. For example, we could add to help build an interface which in addition to showing the snippets, also add a link to a reference page:
Problem
As I mentioned in the Snippet cheatsheet issue. Maintain the table of snippets available manually is:
This also apply to the one I made with cheatography.com. But I think is worth to have a mechanism that can ensure it is always updated.
Proposal
I think making a web interface should be pretty simple. I have been testing, and I think we can add "custom properties" to the custom snippets:![2023-09-26_12-40-35](https://github.com/Esri/arcgis-js-vscode-snippets/assets/826965/b1aa05d1-c8d6-41ea-8805-9b9598e166cc)
That, way we could create properties like:
category
: To be able to group snippets (we could consider subcategories if needed; e.g. using a delimitation character)url
: if we want to add additional hyperlinks on each snippets. For example, we could add to help build an interface which in addition to showing the snippets, also add a link to a reference page:What do you think? I envision something a simple serverless SPA, like this: