Update documentation on custom CJS/ESM plugins

[Harjun751]

What is the purpose of this pull request?

• Documentation update
• Bug fix
• Feature addition or enhancement
• Code maintenance
• DevOps
• Improve developer experience
• Others, please explain:

Resolves #2867

Overview of changes:
Adds documentation on how to manage the different module systems with plugins. Check out the deploy preview's "Writing Plugins" page for the changes

Details

Anything you'd like to highlight/discuss:

Testing instructions:

Proposed commit message: (wrap lines at 72 characters)

Update documentation on custom CJS/ESM plugins

---

Checklist: ☑️

• Updated the documentation for feature additions and enhancements
• Added tests for bug fixes or features
• Linked all related issues
• No unrelated changes

---

Reviewer checklist:

Indicate the SEMVER impact of the PR:

• Major (when you make incompatible API changes)
• Minor (when you add functionality in a backward compatible manner)
• Patch (when you make backward compatible bug fixes)

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

• To be included in the release note for any feature that is made obsolete/breaking

Give a brief explanation note about:

• what was the old feature that was made obsolete
• any replacement feature (if any), and
• how the author should modify his website to migrate from the old feature to the replacement feature (if possible).

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.04%. Comparing base (2228bbb) to head (eaf2619).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2876   +/-   ##
=======================================
  Coverage   71.04%   71.04%           
=======================================
  Files         131      131           
  Lines        7117     7117           
  Branches     1586     1621   +35     
=======================================
  Hits         5056     5056           
- Misses       1961     2055   +94     
+ Partials      100        6   -94     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[gerteck]

LGTM! thanks for the PR, just some notes or possible nits

[gerteck]

just wondering, is it possible to mix and match? Or to mix and match, i need to be explicit and use .cjs and .mjs?

[Harjun751]

There's 2 cases:

---

1. No package.json or package.json without "type": "module" set

In this case, CJS/ESM is inferred on a per-file basis, see the third rule of loading ESM with require.

2. package.json with "type":"module"

In this case all code is simply inferred to be ESM. Using CJS with this is invalid, and the import process will skip over CJS plugins.

Using the .cjs extension will not help either, as we currently hardcode to use .js:

markbind/packages/core/src/plugins/PluginManager.ts

Lines 123 to 124 in b641bc9

	// Check in current (__dirname) folder
	const markbindPluginPath = path.join(MARKBIND_PLUGIN_DIRECTORY, `${pluginName}.js`);

---

Do you think it's worth noting?

[gerteck]

hmm, should we remove the hardcode to make it such that .cjs and .mjs filenames work as expected? I think it's worth nothing it, if it is not too much work i suppose