asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore: cleanup typedoc plugin (#2801)

Browse Source 
* chore: added gitignore for typedoc plugin

* remove unnecessary files

* docs: added a note about building the plugin

* chore: added .yarn to gitignore

Co-authored-by: olivermrbl <oliver@mrbltech.com>
This commit is contained in:
Shahed Nasser
2022-12-14 19:48:48 +02:00
committed by GitHub
parent 6b73d087b6
commit c1659f81ac
4 changed files with 10 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs-util/typedoc-plugins/typedoc-frontmatter-plugin/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
dist
.yarn

8
docs-util/typedoc-plugins/typedoc-frontmatter-plugin/README.md
View File

@@ -33,3 +33,11 @@ frontmatterData: {
pagesPattern: "internal\\.",
},
```
## Building the Plugin
Before using any command that makes use of this plugin, make sure to run the `build` command:
```bash
yarn build
```

49
docs-util/typedoc-plugins/typedoc-frontmatter-plugin/dist/index.js vendored
View File

@@ -1,49 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.load = void 0;
const typedoc_1 = require("typedoc");
function load(app) {
app.options.addDeclaration({
name: "frontmatterData",
help: "An object of key-value pairs to be added to frontmatter",
type: typedoc_1.ParameterType.Mixed,
defaultValue: {},
validate: (value) => {
if (typeof value === 'string') {
//decode it with JSON to check if it's an object
value = JSON.parse(value);
}
if (!(typeof value === 'object' &&
!Array.isArray(value) &&
value !== null)) {
throw new Error("Value should be an object");
}
}
});
app.options.addDeclaration({
name: "pagesPattern",
help: "A string of pages pattern. The pattern will be tested using RegExp to determine whether the frontmatterData will be added or not.",
type: typedoc_1.ParameterType.String,
defaultValue: ""
});
app.renderer.on(typedoc_1.PageEvent.END, (page) => {
const patternStr = app.options.getValue("pagesPattern");
const pattern = new RegExp(patternStr);
let frontmatterData = app.options.getValue("frontmatterData");
if (typeof frontmatterData === 'string') {
frontmatterData = JSON.parse(frontmatterData);
}
const frontmatterDataEntries = Object.entries(frontmatterData);
if (!frontmatterDataEntries.length || !pattern.test(page.filename)) {
return;
}
let frontmatterStr = `---\n`;
for (const [key, value] of frontmatterDataEntries) {
frontmatterStr += `${key}: ${value}\n`;
}
frontmatterStr += `---\n\n`;
page.contents = frontmatterStr + page.contents;
});
}
exports.load = load;
//# sourceMappingURL=index.js.map

1
docs-util/typedoc-plugins/typedoc-frontmatter-plugin/dist/index.js.map vendored
View File

@@ -1 +0,0 @@
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qCAAgE;AAEhE,SAAgB,IAAI,CAAC,GAAgB;IACjC,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC;QACvB,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,yDAAyD;QAC/D,IAAI,EAAE,uBAAa,CAAC,KAAK;QACzB,YAAY,EAAE,EAAE;QAChB,QAAQ,EAAE,CAAC,KAAU,EAAE,EAAE;YACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBAC7B,gDAAgD;gBAChD,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aAC3B;YAED,IAAI,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ;gBAC/B,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBACrB,KAAK,KAAK,IAAI,CAAC,EAAE;gBACf,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;aAC7C;QACH,CAAC;KACJ,CAAC,CAAC;IAEH,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC;QACzB,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,mIAAmI;QACzI,IAAI,EAAE,uBAAa,CAAC,MAAM;QAC1B,YAAY,EAAE,EAAE;KACjB,CAAC,CAAA;IAEF,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,mBAAS,CAAC,GAAG,EAAE,CAAC,IAAe,EAAE,EAAE;QAC/C,MAAM,UAAU,GAAiB,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAA;QACrE,MAAM,OAAO,GAAW,IAAI,MAAM,CAAC,UAAU,CAAC,CAAA;QAC9C,IAAI,eAAe,GAAiB,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAA;QAC3E,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE;YACvC,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;SAC/C;QACD,MAAM,sBAAsB,GAAG,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;QAE9D,IAAI,CAAC,sBAAsB,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YAClE,OAAO;SACR;QAED,IAAI,cAAc,GAAG,OAAO,CAAA;QAE5B,KAAI,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,sBAAsB,EAAE;YAChD,cAAc,IAAI,GAAG,GAAG,KAAK,KAAK,IAAI,CAAA;SACvC;QAED,cAAc,IAAI,SAAS,CAAA;QAE3B,IAAI,CAAC,QAAQ,GAAG,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAA;IAClD,CAAC,CAAC,CAAC;AACP,CAAC;AAlDD,oBAkDC"}