-
-
Sebastian Retweeted Sebastian
Sebastian added,
1 reply 0 retweets 7 likesShow this thread -
Sebastian Retweeted Sebastian
Sebastian added,
SebastianVerified account @sebmckWorking on config validation for a tool I'm working on with nice error messages, references to source code, consumption via a type-safe API, parses JSON with comments, and allows manipulation and reserialisation with original source comments pic.twitter.com/D3AWSPtLPvShow this thread1 reply 0 retweets 5 likesShow this thread -
Sebastian Retweeted Sebastian
Sebastian added,
1 reply 0 retweets 7 likesShow this thread -
Sebastian Retweeted Sebastian
Sebastian added,
SebastianVerified account @sebmckContinuing the trend of nice error messages. Validation of package.json including parsing of semver ranges/versions with frames pointing to the exact source location in JSON. A combination of a custom JSON parser, and then chaining it with a custom semver parser with an offset. pic.twitter.com/dQC3U5JEI9Show this thread1 reply 0 retweets 3 likesShow this thread -
Sebastian Retweeted Sebastian
Sebastian added,
1 reply 0 retweets 4 likesShow this thread -
Sebastian Retweeted Sebastian
Sebastian added,
2 replies 0 retweets 12 likesShow this thread -
All of these tweets seem fairly vague alone, but in aggregate they tell a larger story. This will be open source. I don't know when. I am the only one working on it (hopefully not for long). Happy to answer any questions.
9 replies 4 retweets 106 likesShow this thread -
Replying to @sebmck
Are you planning to include any tool for API documentation? I've always thought it'd be cool if documentation were built into my package manager, e.g. `rome docs react` might let me browse the docs for a package right there in the terminal.
2 replies 0 retweets 3 likes -
Replying to @mjackson
npm already has a solution for that, man pages. It's a specific field in package.json. It could be a lot easier to automatically build and consume them though. Using existing standards is preferred, I wouldn't want to bifurcate the ecosystem unless it was substantially worth it.
2 replies 0 retweets 6 likes
Generating HTML/JSON documentation from a JS file, with inferred types and reading comments would be dope though. It would definitely be possible, I will likely build it anyway just to generate docs for Rome.
-
-
If you generate man pages, there's already existing tools to convert man pages to HTML.
1 reply 0 retweets 2 likes -
man pages for CLI documentation, special HTML documentation for JS APIs IMO
1 reply 0 retweets 0 likes - 1 more reply
New conversation -
-
-
I've heard of JSDoc and Typedoc, unsure how full-featured they are though.
0 replies 0 retweets 2 likesThanks. Twitter will use this to make your timeline better. UndoUndo
-
Loading seems to be taking a while.
Twitter may be over capacity or experiencing a momentary hiccup. Try again or visit Twitter Status for more information.
he/him 