Local docusaurus plugins in typescript

Question

I want to write local docusaurus plugins using typescript. (it works fine using js)

Is this possible? Like the docs here suggest to put them under ./src/plugins/name-of-plugin.

Reading the docs there are examples with ts, but if I just try and replace is with ts i get various errors. (eg "Cannot find module").

I'm using typescript for pages as well.

Could you provide a link to a repro giving the "Cannot find module" error. — Saiansh Singh, Aug 10 '22 at 01:30
Not at the moment unfortunately. Is it suppose to "just work"? — Gustav, Aug 10 '22 at 14:08
Could you copy-paste the error into the question, as the stack trace and all could help understand it? — Saiansh Singh, Aug 10 '22 at 20:05

score 0 · Answer 1 · answered Aug 10 '22 at 06:52

0

Adding the file extension worked for me. For example:

plugins: ['./src/plugins/my-plugin.ts'],

my-plugin.ts

module.exports = async function myPlugin(context, options) {
  return {
    name: "my-plugin",
    async loadContent() {
      console.log("Hello World plugin wow!");
    },
    async contentLoaded({ content, actions }) {
      console.log(content);
    },
  };
};

removing the extension shows the same error :)

answered Aug 10 '22 at 06:52

Anas Laham

21
2

That doesn't work if I'm importing packages. Then i get "Cannot use import statement outside a module" – Gustav Aug 10 '22 at 14:01
Do you mean if you're importing packages inside of the plugin itself? – Anas Laham Aug 11 '22 at 06:18

Local docusaurus plugins in typescript

1 Answers1