Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
feat(web): moved the Node.js example to its own page
Elijah Potter2075d2c77760
diff --git a/packages/harper.js/examples/commonjs-simple/index.cjs b/packages/harper.js/examples/commonjs-simple/index.jssimilarity index 100%rename from packages/harper.js/examples/commonjs-simple/index.cjsrename to packages/harper.js/examples/commonjs-simple/index.jsdiff --git a/packages/harper.js/examples/commonjs-simple/package.json b/packages/harper.js/examples/commonjs-simple/package.jsonindex 74bd5808d..5c5d138af 100644--- a/packages/harper.js/examples/commonjs-simple/package.json+++ b/packages/harper.js/examples/commonjs-simple/package.json@@ -3,7 +3,7 @@"version": "0.0.1","private": true,"scripts": {- "start": "node index.cjs"+ "start": "node index.js"},"dependencies": {"harper.js": "^0.13.0"diff --git a/packages/web/src/routes/docs/harperjs/introduction/+page.md b/packages/web/src/routes/docs/harperjs/introduction/+page.mdindex 49e503f57..f2cc9b9ee 100644--- a/packages/web/src/routes/docs/harperjs/introduction/+page.md+++ b/packages/web/src/routes/docs/harperjs/introduction/+page.md@@ -18,40 +18,6 @@ Today, it serves as the foundation for our [Obsidian plugin](/docs/integrations/`harper.js` is an ECMAScript module designed to be easy to import into any project.On the inside, it uses a copy of Harper's core algorithm compiled to [WebAssembly](https://webassembly.org/).-It can be imported [natively in a browser](./CDN) or through [npm](https://www.npmjs.com/package/harper.js).+It can be imported [natively in a browser](./CDN) or through [npm](https://www.npmjs.com/package/harper.js) and [consumed in Node.js](./node).@install-pkg(harper.js)--## Sample Usage:--```js-let harper = require('harper.js');--async function main() {- // We cannot use `WorkerLinter` on Node.js since it relies on web-specific APIs.- let linter = new harper.LocalLinter();- linter.setup();-- let lints = await linter.lint('This is a example of how to use `harper.js`.');-- console.log('Here are the results of linting the above text:');-- for (let lint of lints) {- console.log(' - ', lint.span().start, ':', lint.span().end, lint.message());-- if (lint.suggestion_count() != 0) {- console.log('Suggestions:');-- for (let sug of lint.suggestions()) {- console.log(- '\t - ',- sug.kind() == 1 ? 'Remove' : 'Replace with',- sug.get_replacement_text()- );- }- }- }-}--main();-```diff --git a/packages/web/src/routes/docs/harperjs/node/+page.md b/packages/web/src/routes/docs/harperjs/node/+page.mdnew file mode 100644index 000000000..ef9ca2de5--- /dev/null+++ b/packages/web/src/routes/docs/harperjs/node/+page.md@@ -0,0 +1,15 @@+---+title: Using Harper in Node.js+---++Harper.js can run in Node.js.+There is just one consideration: as described in [more detailed here](./linting), we cannot use the `WorkerLinter`.+That means we must use the `LocalLinter`.++Additionally, since `harper.js` is an ECMAScript module, it must be imported in a relatively recent version of Node.js.++## Example Code++The example below can be found in [the Harper monorepo.](https://github.com/Automattic/harper/tree/master/packages/harper.js/examples/commonjs-simple)++@code(../../../../../../harper.js/examples/commonjs-simple/index.js)diff --git a/packages/web/vite.config.ts b/packages/web/vite.config.tsindex 53c76f399..8f5adb17f 100644--- a/packages/web/vite.config.ts+++ b/packages/web/vite.config.ts@@ -80,6 +80,10 @@ export default defineConfig({title: 'Linting',to: '/docs/harperjs/linting'},+ {+ title: 'Node.js',+ to: '/docs/harperjs/node'+ },{title: 'CDN',to: '/docs/harperjs/CDN'