Comments (8)
I like this. The user experience would be better if the tool was working on any application without modification.
Actually, it could use all the modules found in source directories if exposed-modules
is not provided (making elm-application.json
optional) but it could even optionally stub itself empty documentation for undocumented exposed symbols during the current ports stubbing phase 🤔
This would allow to have by default all the signatures by module in any application. Of course, the behavior for packages would be unchanged.
Also a strict
mode flag could be added to let the user list the modules and add documentation. This could be useful for CI checks.
Let me think about it for the next release.
from elm-doc-preview.
@Kurren123 Sure! If you want to give a try at the PR, go ahead!
I'm on slack (@dmy) if you have issues.
from elm-doc-preview.
@rlefevre brilliant! Would you like any help?
from elm-doc-preview.
@Kurren123 Let's make two different PRs, one that that adds the feature you propose, the other one stubbing documentation with the -s, --strict
option.
from elm-doc-preview.
I was also thinking, a nice default for the name
would be user_name/dir
where dir
is the name of the directory containing the elm.json
file, as I think this directory is usually a kind of project name.
from elm-doc-preview.
@Kurren123 The potential issue with that is that sometimes the elm app is in a sub-directory of the project. For example, for one of my Elixir/Phoenix app, the elm application is in assets/elm
, so the application would be named my/elm
🤔
Let's discuss this in another issue if you want to.
from elm-doc-preview.
Ah okay, no worries. I’m just happy if I don’t need to maintain a list of exposed modules
from elm-doc-preview.
@Kurren123 Feel free to open another issue, maybe there is a better solution.
Another issue is that there are a lot more restrictions on package names that directory names (and the application is transformed to a package before generating the documentation). A lot of characters are forbidden, and a few more rules.
from elm-doc-preview.
Related Issues (20)
- Add an option to check whether the documentation is correct HOT 2
- Maintain scroll position when hot reloading? HOT 4
- Error: ENOENT: no such file or directory, mkdir ... when building application doc
- The doc server can't find `elm.json` in some folder structures HOT 1
- `npm audit` warns about vulnerabilites HOT 3
- works nicely HOT 3
- Feature request: Generate docs.json, then exit HOT 1
- Add a CLI option to check whether application documentation is correct HOT 5
- Doc server quits with error below after 10-30 seconds. HOT 4
- elm-doc-preview can get confused if multiple files are modified simultaneously HOT 1
- npm complains about peer dependencies HOT 8
- A better default for the application name HOT 3
- Online version should mention that this works also for applications
- elm-doc-preview crashes after 30 seconds HOT 4
- Static site generation HOT 5
- modules not shown HOT 7
- No output seen when doc format is missing/has errors
- Handle documentation for unexposed code
- Configurable binding address with loopback as default
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 elm-doc-preview.