Link to unpkg.com #20
+176
−7
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| [submodule "typedoc-plugin-sourcefile-url"] | ||
| path = typedoc-plugin-sourcefile-url | ||
| url = https://github.com/gdelmas/typedoc-plugin-sourcefile-url |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,17 @@ | ||
| { | ||
| "prettier.enable": true, | ||
| "editor.formatOnSave": true, | ||
| "editor.defaultFormatter": "esbenp.prettier-vscode", | ||
| "[typescript]": { | ||
| "editor.defaultFormatter": "esbenp.prettier-vscode", | ||
| }, | ||
| "[typescriptreact]": { | ||
| "editor.defaultFormatter": "esbenp.prettier-vscode", | ||
| }, | ||
| "[javascript]": { | ||
| "editor.defaultFormatter": "esbenp.prettier-vscode", | ||
| }, | ||
| "[javascriptreact]": { | ||
| "editor.defaultFormatter": "esbenp.prettier-vscode", | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| require('ts-node').register({ | ||
| projectSearchDir: __dirname, | ||
| }); | ||
| const { UnpkgPlugin } = require('./UnpkgPluginImpl'); | ||
|
|
||
| module.exports = function (PluginHost) { | ||
| var app = PluginHost.owner; | ||
|
|
||
| // app.options.addDeclaration({name: 'sourcefile-url-map'}); | ||
| // app.options.addDeclaration({name: 'sourcefile-url-prefix'}); | ||
|
|
||
| app.converter.addComponent('unpkg-plugin', UnpkgPlugin); | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| // Built by modifying https://github.com/gdelmas/typedoc-plugin-sourcefile-url | ||
|
|
||
| import * as path from 'path'; | ||
| import * as fs from 'fs'; | ||
| import { Component } from 'typedoc/dist/lib/utils/component'; | ||
| import { ConverterComponent } from 'typedoc/dist/lib/converter/components'; | ||
| import { Converter } from 'typedoc/dist/lib/converter/converter'; | ||
| import { Context } from 'typedoc/dist/lib/converter/context'; | ||
| import { SourceReference } from 'typedoc/dist/lib/models/sources/file'; | ||
| import { Options } from 'typedoc/dist/lib/utils/options/options'; | ||
| import { sync as pkgUp } from 'pkg-up'; | ||
| import { URL } from 'url'; | ||
| import { dirname, relative } from 'path'; | ||
|
|
||
| @Component({ name: 'unpkg-plugin' }) | ||
| export class UnpkgPlugin extends ConverterComponent { | ||
| private pkgUpCache = new Map<string, string | null>(); | ||
| private pkgUp(cwd: string) { | ||
| let cacheEntry = this.pkgUpCache.get(cwd); | ||
| if (cacheEntry !== undefined) return cacheEntry; | ||
| cacheEntry = pkgUp({ cwd }); | ||
| this.pkgUpCache.set(cwd, cacheEntry); | ||
| return cacheEntry; | ||
| } | ||
|
|
||
| public initialize(): void { | ||
| this.listenTo(this.owner, Converter.EVENT_BEGIN, this.onBegin); | ||
| } | ||
|
|
||
| private onBegin(): void { | ||
| // register handler | ||
| this.listenTo(this.owner, Converter.EVENT_RESOLVE_END, this.onEndResolve); | ||
|
There was a problem hiding this comment. Why is the event registration split up? There was a problem hiding this comment. Same reason as above, it was copy-pasted from https://github.com/gdelmas/typedoc-plugin-sourcefile-url |
||
| } | ||
|
|
||
| private onEndResolve(context: Context): void { | ||
| const project = context.project; | ||
|
|
||
| // process mappings | ||
| for (const sourceFile of project.files) { | ||
| const { fullFileName } = sourceFile; | ||
| if (fullFileName) { | ||
| const pkgPath = this.pkgUp(dirname(fullFileName)); | ||
| if (pkgPath) { | ||
| const pkg = require(pkgPath); | ||
| const url = new URL('https://unpkg.com/'); | ||
| url.pathname = `browse/${pkg.name}@${pkg.version}/${relative( | ||
| dirname(pkgPath), | ||
| fullFileName, | ||
| )}`; | ||
| sourceFile.url = url.toString(); | ||
| // TODO should we include version number in this path? | ||
| // e.g. [email protected]/dist/index.d.ts instead of outdent/dist/index.d.ts? | ||
| sourceFile.fileName = relative(dirname(dirname(pkgPath)), fullFileName); | ||
| // TODO we are mutating the sourceFile.fileName solely so we can copy the value below. | ||
| // Should we avoid mutating sourceFile.fileName, *only* modifying `source.fileName` below? | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // add line anchors | ||
| for (let key in project.reflections) { | ||
| const reflection = project.reflections[key]; | ||
|
|
||
| if (reflection.sources) { | ||
| reflection.sources.forEach((source: SourceReference) => { | ||
| if (source.file && source.file.url) { | ||
| source.url = source.file.url + '#L' + source.line; | ||
| source.fileName = source.file.fileName; | ||
| } | ||
| }); | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "type": "commonjs" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "extends": "../../tsconfig.json", | ||
| "compilerOptions": { | ||
| "module": "CommonJS" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Submodule typedoc-plugin-sourcefile-url
added at
0e26a6
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Nooooooooooo
module.exports =style plugins are deprecated, useexports.load = functioninsteadApplicationinstanceaddComponentis going to go away. The whole idea of components overcomplicates everything. Plugins should never have used the@Componentdecorator.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.
Ok, this was copy-pasted from https://github.com/gdelmas/typedoc-plugin-sourcefile-url