Merge pull request #40 from sillsdev/plugins

Plugins (#40)

Author: hatton

.gitignore

@@ -5,3 +5,4 @@ i18n/
 node_modules/
 version.json
 docs/
+yarn-error.log

README.md

@@ -129,3 +129,7 @@ Options:
 | -i, --img-output-path <string>        |           | Path to directory where images will be stored. If this is not included, images will be placed in the same directory as the document that uses them, which then allows for localization of screenshots.             |
 | -p, --img-prefix-in-markdown <string> |           | When referencing an image from markdown, prefix with this path instead of the full img-output-path. Should be used only in conjunction with --img-output-path.                                                     |
 | -h, --help                            |           | display help for command                                                                                                                                                                                           |
+
+# Plugins
+
+If your project needs some processing that docu-notion doesn't already provide, you can provide a plugin that does it. See the [plugin readme](src/plugins/README.md).

docu-notion.config.ts

@@ -0,0 +1,37 @@
+/* This file is only used when testing docu-notion itself, not when it is used as a library.
+  E.g., if you run `yarn pull-test-tagged`, docu-notion will read this file and use it to configure itself,
+  using these example plugins.
+ */
+
+import { IDocuNotionConfig } from "./dist/config/configuration";
+import { IPlugin, Log } from "./dist";
+import { NotionBlock } from "./dist/types";
+
+const dummyBlockModifier: IPlugin = {
+  name: "dummyBlockModifier",
+
+  notionBlockModifications: [
+    {
+      modify: (block: NotionBlock) => {
+        Log.verbose("dummyBlockModifier was called");
+      },
+    },
+  ],
+};
+
+const dummyMarkdownModifier: IPlugin = {
+  name: "dummyMarkdownModifier",
+
+  regexMarkdownModifications: [
+    {
+      regex: /aaa(.*)aaa/,
+      replacementPattern: "bbb$1bbb",
+    },
+  ],
+};
+
+const config: IDocuNotionConfig = {
+  plugins: [dummyBlockModifier, dummyMarkdownModifier],
+};
+
+export default config;

package.json

@@ -15,12 +15,15 @@
     "typecheck": "tsc --noEmit",
     "notion-download": "node dist/index.js",
     "cmdhelp": "ts-node --compiler-options \"{\\\"module\\\": \\\"commonjs\\\"}\" src/index.ts",
+    "// note that we're not using ts-node at the moment because of ": "https://github.com/Codex-/cosmiconfig-typescript-loader/issues/70",
+    "ts": "yarn tsc && rm -rf ./docs/ && cross-var node dist/index.js",
     "// test out with a private sample notion db": "",
-    "pull-test-tagged": "cross-var rm -rf ./docs/ && ts-node src/index.ts -n %DOCU_NOTION_INTEGRATION_TOKEN% -r %DOCU_NOTION_TEST_ROOT_PAGE_ID%  --log-level debug --status-tag test",
-    "pull-test-outline": "cross-var rm -rf ./docs/ && ts-node --compiler-options \"{\\\"module\\\": \\\"commonjs\\\"}\" src/index.ts -n %DOCU_NOTION_INTEGRATION_TOKEN% -r %DOCU_NOTION_TEST_ROOT_PAGE_ID%  --log-level debug",
+    "pull-test-tagged": "yarn ts -n $DOCU_NOTION_INTEGRATION_TOKEN -r $DOCU_NOTION_TEST_ROOT_PAGE_ID  --log-level debug --status-tag test",
+    "pull-sample-site": "yarn ts -n $DOCU_NOTION_INTEGRATION_TOKEN -r $DOCU_NOTION_SAMPLE_ROOT_PAGE  --log-level debug",
     "// test with a semi-stable/public site:": "",
-    "pull-sample": "cross-var ts-node --compiler-options \"{\\\"module\\\": \\\"commonjs\\\"}\" src/index.ts -n %DOCU_NOTION_INTEGRATION_TOKEN% -r %DOCU_NOTION_SAMPLE_ROOT_PAGE% -m ./sample --locales en,es,fr,de --log-level verbose",
-    "pull-sample-with-paths": "cross-var ts-node --compiler-options \"{\\\"module\\\": \\\"commonjs\\\"}\" src/index.ts -n %DOCU_NOTION_INTEGRATION_TOKEN% -r %DOCU_NOTION_SAMPLE_ROOT_PAGE% -m ./sample --img-output-path ./sample_img"
+    "pull-sample": "yarn ts -n $DOCU_NOTION_INTEGRATION_TOKEN -r $DOCU_NOTION_SAMPLE_ROOT_PAGE -m ./sample --locales en,es,fr,de --log-level verbose",
+    "pull-sample-with-paths": "yarn ts -n $DOCU_NOTION_INTEGRATION_TOKEN -r $DOCU_NOTION_SAMPLE_ROOT_PAGE -m ./sample --img-output-path ./sample_img",
+    "postinstall": "patch-package"
   },
   "repository": {
     "type": "git",
@@ -49,9 +52,11 @@
   "//chalk@4": "also ESM related problem",
   "//notion-client@4": "also ESM related problem",
   "dependencies": {
-    "@notionhq/client": "^1.0.4",
+    "@notionhq/client": "2.2.3",
     "chalk": "^4.1.2",
     "commander": "^9.2.0",
+    "cosmiconfig": "^8.0.0",
+    "cosmiconfig-typescript-loader": "^4.3.0",
     "file-type": "16.5.1",
     "fs-extra": "^10.1.0",
     "limiter": "^2.1.0",
@@ -60,7 +65,6 @@
     "notion-client": "^4",
     "notion-to-md": "^2.5.5",
     "path": "^0.12.7",
-    "postinstall-postinstall": "^2.1.0",
     "sanitize-filename": "^1.6.3"
   },
   "devDependencies": {
@@ -78,6 +82,7 @@
     "eslint-plugin-prettier": "^3.4.0",
     "jest": "^28.1.3",
     "lint-staged": "^10.5.4",
+    "patch-package": "^6.5.1",
     "prettier": "^2.2.1",
     "semantic-release": "^19.0.2",
     "ts-jest": "^28.0.7",

src/DocusaurusTweaks.ts

@@ -36,7 +36,7 @@ export class HierarchicalNamedLayoutStrategy extends LayoutStrategy {
       .replaceAll("'", "")
       .replaceAll("?", "-");
 
-    const context = ("/" + page.context + "/").replaceAll("//", "/");
+    const context = ("/" + page.layoutContext + "/").replaceAll("//", "/");
     const path =
       this.rootDirectory + context + sanitizedName + extensionWithDot;