Comments (6)
Ironicaly, cljdoc-analyzer cannot analyze itself as it tries to parse metagetta source. We could add an option to exclude-dirs from analysis.
from cljdoc-analyzer.
What you could do is also packaging metagetta as it’s own jar and then in the cljdoc analyzer project use something like MrRanderson to online the sources. This would also remove the namespace conflicts. I’m not 100% sure if that’s the issue but might be worth a look.
Might also make it easier for people to use metagetta on its own.
from cljdoc-analyzer.
Thanks @martinklepsch, I guess I am weighing the technical awkwardness of including metagetta as a subproject against the maintenance awkwardness of splitting it out.
The MrAnderson idea is interesting and merits its own git issue. I’m wondering it we used MrAnderson throughout we would even need to treat metagetta as a subproject and subprocess.
from cljdoc-analyzer.
That would mean people could not use metagetta on its own which I think might be desirable. It’s essentially a codox Alternative that’s more focused on programmatic data extraction.
@borkdude is doing a great job naming and announcing all the projects in the clj-kondo periphery so maybe it would make sense for us to follow a similar approach and just announce it as a separate thing. As changes won’t be too frequent the burden of packaging it as a separate library shouldn’t be too high (just use Leiningen).
And then the cljdoc analyzer project — is much more specific essentially trying to create more isolation and construct the class path in more specific ways.
I dont know - what do you think?
from cljdoc-analyzer.
Thanks @martinklepsch.
Because metagetta focuses on the use case of working from jars, rather than source trees, it is not currently really a codox alternative (it could become that, but we decided not to take on that cost initially). Because of its focus on the jar, I didn't really see it as being useful to others outside of cljdoc-analyzer. But yeah, I could be totally wrong, I guess feedback from the community will tell us.
I currently see cljdoc-analyzer as codox data extraction - but for jars. I am actually using it as that in my personally little diff-apis project.
I also did not necessarily want to encourage the support burden of a separate metagetta project and/or jar, at least initially.
There is nothing stopping us from extracting out metagetta to its own project in the future, but right now, I am thinking I'll keep it embedded. I'm currently working on packing it as a jar which I'll bundle inside the cljoc analyzer jar.
Anyway, I very much appreciate your thoughts on this topic! Continued discussion/objections/ideas are most welcome!
from cljdoc-analyzer.
I can now analyze cljdoc-analyzer with cljdoc: 36e5c6e
from cljdoc-analyzer.
Related Issues (20)
- Analysis of POM-only artifacts fails HOT 4
- Consider a release workflow HOT 1
- org.clojure/clojure is failing to analyze HOT 7
- Metagetta tests fail after upgrading to ClojureScript 1.11.60 HOT 1
- Continue analysing other namespaces after a failure HOT 2
- Metosin malli 0.10.0 is failing analysis
- Our dependency parsing is sometimes too naive HOT 2
- dev: add eastwood linting
- Review clojure tools use and general use invokations
- ClojureScript API analysis does not always pick up `:arglists` overriden via metadata HOT 3
- Macros that are not loaded should be included in cljs analysis HOT 3
- User facing command line will fail if artifact references additional maven repos
- Consider omitting blank docstrings
- Language autodetect is detecting clj for some cljs only projects
- JavaScript requires are only faked for lib sources and not its deps HOT 2
- Older artifacts that refernce `http` maven repos will fail to build
- Metagetta analysis duration reporting can throw
- Support excluding namespaces before analysis (internally for now)
- cljdoc-analyzer is failing to analyze versions of zprint that it previously analyzed successfully HOT 10
- regresssion: reitit main project is failing to analyze
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 cljdoc-analyzer.