-
Notifications
You must be signed in to change notification settings - Fork 185
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* api index * fix crosshair link * externalize list style
- Loading branch information
Showing
8 changed files
with
401 additions
and
183 deletions.
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
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,34 @@ | ||
| <script setup> | ||
|
|
||
| import {data} from "./data/api.data"; | ||
|
|
||
| </script> | ||
|
|
||
| # API index | ||
|
|
||
| ## Methods | ||
|
|
||
| <ul :class="$style.oneline"> | ||
| <li v-for="({name, href, comment}) in data.methods"> | ||
| <span><a :href="href">{{ name }}</a> - {{ comment }}</span> | ||
| </li> | ||
| </ul> | ||
|
|
||
| ## Options | ||
|
|
||
| <ul> | ||
| <li v-for="[name, contexts] in data.options"> | ||
| <b>{{ name }}</b> - <span v-for="({name, href}, index) in contexts"><a :href="href">{{ name }}</a><span v-if="index < contexts.length - 1">, </span></span> | ||
| </li> | ||
| </ul> | ||
|
|
||
| <style module> | ||
|
|
||
| ul.oneline span { | ||
| display: block; | ||
| white-space: nowrap; | ||
| overflow: hidden; | ||
| text-overflow: ellipsis; | ||
| } | ||
|
|
||
| </style> |
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,140 @@ | ||
| import {rollup, sort} from "d3"; | ||
| import {Node, FunctionDeclaration, InterfaceDeclaration, Project, VariableDeclaration, VariableStatement} from "ts-morph"; | ||
|
|
||
| // These interfaces tend to represent things that Plot constructs internally, | ||
| // rather than objects that the user is expected to provide. | ||
| function isInternalInterface(name) { | ||
| return ( | ||
| name === "AutoSpec" || | ||
| name === "Channel" || | ||
| name === "ChannelDomainOptions" || // TODO | ||
| name === "ChannelTransform" || | ||
| name === "Context" || | ||
| name === "Dimensions" || | ||
| name === "Plot" || | ||
| name === "Scale" | ||
| ); | ||
| } | ||
|
|
||
| // This tries to get a brief human-readable, one-sentence summary description of | ||
| // the exported symbol. We might want to formalize this so that we can be more | ||
| // intentional when authoring documentation. | ||
| function getDescription(node: FunctionDeclaration | VariableStatement): string { | ||
| return node | ||
| .getJsDocs()[0] | ||
| ?.getDescription() | ||
| .replace(/\n/g, " ") // replace newlines with spaces | ||
| .replace(/[*_]/g, "") // remove bold and italics formatting | ||
| .replace(/[.:]($|\s+).*/g, "") // truncate at the first period or colon | ||
| .replace(/\[([^[]+)\]\[\d+\]/g, "$1") // strip links (assuming [1] syntax) | ||
| .trim(); | ||
| } | ||
|
|
||
| // While we try to keep the source code file structure as close as possible to | ||
| // the documentation URL structure, there are some inevitable deviations that | ||
| // are codified by this function. When new files are added, please try to keep | ||
| // this function up-to-date, and try to generalize patterns so that we | ||
| // automatically generate correct links. (TODO Verify that the links are valid.) | ||
| function getHref(name: string, path: string): string { | ||
| path = path.replace(/\.d\.ts$/, ""); // drop trailing .d.ts | ||
| path = path.replace(/([a-z0-9])([A-Z])/, (_, a, b) => `${a}-${b.toLowerCase()}`); // camel case conversion | ||
| if (path.split("/").length === 1) path = `features/${path}`; // top-level declarations are features | ||
| switch (path) { | ||
| case "features/curve": | ||
| case "features/format": | ||
| case "features/mark": | ||
| case "features/plot": | ||
| return `${path}s`; | ||
| case "features/options": | ||
| return "features/transforms"; | ||
| case "marks/axis": { | ||
| switch (name) { | ||
| case "gridX": | ||
| case "gridY": | ||
| case "gridFx": | ||
| case "gridFy": | ||
| return "marks/grid"; | ||
| } | ||
| break; | ||
| } | ||
| case "marks/crosshair": | ||
| return "interactions/crosshair"; | ||
| case "transforms/basic": { | ||
| switch (name) { | ||
| case "filter": | ||
| return "transforms/filter"; | ||
| case "reverse": | ||
| case "shuffle": | ||
| case "sort": | ||
| return "transforms/sort"; | ||
| } | ||
| return "features/transforms"; | ||
| } | ||
| } | ||
| return path; | ||
| } | ||
|
|
||
| function getInterfaceName(name: string, path: string): string { | ||
| name = name.replace(/(Transform|Corner|X|Y|Output)?(Defaults|Options|Styles)$/, ""); | ||
| name = name.replace(/([a-z0-9])([A-Z])/, (_, a, b) => `${a} ${b}`); // camel case conversion | ||
| name = name.toLowerCase(); | ||
| if (name === "curve auto") name = "curve"; | ||
| if (name === "plot facet") name = "plot"; | ||
| if (path.startsWith("marks/")) name += " mark"; | ||
| else if (path.startsWith("transforms/")) name += " transform"; | ||
| return name; | ||
| } | ||
|
|
||
| export default { | ||
| watch: [], | ||
| async load() { | ||
| const project = new Project({tsConfigFilePath: "tsconfig.json"}); | ||
| const allMethods: {name: string; comment: string; href: string}[] = []; | ||
| const allOptions: {name: string; context: {name: string; href: string}}[] = []; | ||
| const index = project.getSourceFile("src/index.d.ts")!; | ||
| for (const [name, declarations] of index.getExportedDeclarations()) { | ||
| for (const declaration of declarations) { | ||
| if (Node.isInterfaceDeclaration(declaration)) { | ||
| if (isInternalInterface(name)) continue; | ||
| for (const property of declaration.getProperties()) { | ||
| const path = index.getRelativePathTo(declaration.getSourceFile()); | ||
| const href = getHref(name, path); | ||
| if (property.getJsDocs().some((d) => d.getTags().some((d) => Node.isJSDocDeprecatedTag(d)))) continue; | ||
| allOptions.push({name: property.getName(), context: {name: getInterfaceName(name, path), href}}); | ||
| } | ||
| } else if (Node.isFunctionDeclaration(declaration)) { | ||
| const comment = getDescription(declaration); | ||
| if (comment) { | ||
| const href = getHref(name, index.getRelativePathTo(declaration.getSourceFile())); | ||
| allMethods.push({name, comment, href}); | ||
| } | ||
| } else if (Node.isVariableDeclaration(declaration)) { | ||
| const comment = getDescription(declaration.getVariableStatement()!); | ||
| if (comment) { | ||
| const href = getHref(name, index.getRelativePathTo(declaration.getSourceFile())); | ||
| allMethods.push({name, comment, href}); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| return { | ||
| methods: sort(allMethods, ({name}) => name), | ||
| options: sort( | ||
| rollup( | ||
| allOptions, | ||
| (D) => | ||
| sort( | ||
| rollup( | ||
| D.map((d) => d.context), | ||
| ([d]) => d, | ||
| (d) => d.name | ||
| ).values(), | ||
| (d) => d.name | ||
| ), | ||
| (d) => d.name | ||
| ), | ||
| ([name]) => name | ||
| ) | ||
| }; | ||
| } | ||
| }; |
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
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
Oops, something went wrong.