-
Notifications
You must be signed in to change notification settings - Fork 27
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
NPM plugin #70
NPM plugin #70
Conversation
CapitalizationPreview: docs |
use dm.relativePathPreview: docs |
use relativePath in markdown pluginPreview: docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
questions
src/launch.ts
Outdated
@@ -15,7 +16,9 @@ import { TypescriptPlugin } from "./plugins/typescript"; | |||
// Set breakpoints in original .ts source and debug in the editor! | |||
Documentalist.create() | |||
.use(".ts", new TypescriptPlugin()) | |||
.use(".json", new NpmPlugin()) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is too broad, it should only apply to package.jsons.
src/plugins/npm.ts
Outdated
name: data.name, | ||
// tslint:disable-next-line:object-literal-sort-keys | ||
description: data.description, | ||
latestVersion: data["dist-tags"].latest, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is this guaranteed to be non-null? what about not-yet released libraries?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes good catch. un-released libraries will actually die here because npm info
will return nothing
add private/published properties to npm package, add excludeNames/excludePrivate optionsPreview: docs |
commentPreview: docs |
sourceBaseDir
option forDocumentalist
controls relative pathing forsourcePath
in MD and NPMNpmPlugin
!excludePrivate
,excludePaths
optionsnpm info
if possible (async call to npm registry)