Comments (6)
what plugins are you thinking of?
from doclets.
@lipp I was thinking of allowing any custom plugin, just like JSDoc does. Personally, I use JSDoc's underscore, and a few of my own, like false-booleans and named-defaults. They are pretty handy when it comes to tailoring JSDoc to one's coding style.
from doclets.
@zandaqo nice work! added plug-in support to the feature list. at the moment i am still working on more basic things.
from doclets.
Plugins would probably have to be whitelisted somehow, right? It basically means running arbitrary code on your infrastructure...
from doclets.
yes. maybe there will be a list of plugins you can choose from. unfortunatly this feature will have to wait for orga and private support being implemented.
from doclets.
It basically means running arbitrary code on your infrastructure...
@tf Indeed. That was my main concern about this feature: whether or not the author(s) planned infrastructure in the way that might allow that scenario in the future.
@lipp Ideally you would want to "containerize" each run of jsdoc to mitigate the security/performance risks. Even with whitelisted plugins, or no plugins at all, there is a possibility that jsdoc might hung up on a given code. I'm not yet familiar enough with your infrastructure to say whether it's already the case, or how to make it so, but it's something worth considering in the long run.
That said, I support the idea of maintaining a set of whitelisted plugins. Not just for the sake of allowing users to use them, but if and when doclets.io decide to add extra features to JSDoc3 (like allowing non-orthodox flavors of JSDoc, e.g. Closure and the likes), IMO it would be easier, faster, and more user friendly to do that by creating plugins for JSDoc3, rather than, say, try to push modification into JSDoc3 itself.
Speaking on implementation, the way I see it, if we go with whitelisted plugins, all it takes to implement this feature is a) decide where and how to store the whitelisted plugins, b) add an option to .doclets.yaml where user lists the needed plugins, c) while gathering configs just create a new jsdoc config file for each run with the required options, instead of trying to push them all through the command line. That is all if I'm not missing something. If we can settle/implement the first parts (how and where to store plugins), I'm willing to help with the last part.
from doclets.
Related Issues (20)
- Documentation breaks when formatting is wrong HOT 3
- add HTMLElement to built-in types/links
- Display function.name instead of module.exports HOT 1
- doclets.io not picking up changes HOT 12
- Unselected branches may get visible after server restart
- branch name with '/' not supported HOT 1
- Support for other repo source (Gitlab, pull on hooks) HOT 1
- Consider using documentation.js instead of jsdoc HOT 3
- 504 Gateway Timeout HOT 6
- Build docs for PRs
- Support for JSDoc Tutorials HOT 1
- TypeScript support
- Instance and static members with the same name are conflated
- Incorrect date on documentation header HOT 2
- nps-utils doclets not rendering HOT 2
- Manual update
- SSL Certificate Expired HOT 1
- SSL Certificate Expired
- Login-Issues, session can't be saved HOT 7
- SSL certificate exired on 12.12.2018
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from doclets.