Write with Harper

https://writewithharper.com/docs
Admin
Write with Harper is an API and set of tools designed to assist with writing tasks.
Tokens:61,456
Snippets:638
Trust Score:8.8
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install harper-cli for PR #445

Source: https://writewithharper.com/docs/contributors/review

Example command to install the patched harper-cli from a specific branch (somewhat-something) for PR #445. After installation, run harper-cli lint <path> on any file.

```bash
cargo install --git https://github.com/automattic/harper --branch somewhat-something harper-cli --locked
```

--------------------------------

### Basic harper-ls setup in init.lua

Source: https://writewithharper.com/docs/integrations/neovim

Add this to your init.lua after installing harper-ls and nvim-lspconfig. It enables Harper's language server with default settings.

```lua
require('lspconfig').harper_ls.setup {}

```

--------------------------------

### BinaryModule.setup()

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.binarymodule.setup.html

The setup() method is an asynchronous method that returns a Promise that resolves to void. It is used to perform setup operations for the BinaryModule.

```APIDOC
## BinaryModule.setup()

### Description
Performs setup operations for the BinaryModule. Returns a Promise that resolves to void.

### Method
setup()

### Signature
```
setup(): Promise<void>;
```

### Returns
Promise<void>
```

--------------------------------

### Install Harper with Scoop

Source: https://writewithharper.com/docs/integrations/language-server

Installs Harper on Windows via Scoop.

```bash
scoop install harper
```

--------------------------------

### setup()

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.linter.html

Complete any setup that is necessary before linting. This may include downloading and compiling the WebAssembly binary. This setup will complete when needed regardless of whether you call this function. This function exists to allow you to do this work when it is of least impact to the user experiences (i.e. while you're loading something else).

```APIDOC
## setup()

### Description
Complete any setup that is necessary before linting. This may include downloading and compiling the WebAssembly binary. This setup will complete when needed regardless of whether you call this function. This function exists to allow you to do this work when it is of least impact to the user experiences (i.e. while you're loading something else).

### Method
setup

### Parameters
None

### Returns
- **Promise<void>** - A promise that resolves when setup is complete.
```

--------------------------------

### Install the extension: code --install-extension

Source: https://writewithharper.com/docs/contributors/visual-studio-code

Installs the packaged .vsix file. Replace `path/to/created/.vsix` with the actual path.

```bash
code --install-extension path/to/created/.vsix
```

--------------------------------

### setup()

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.binarymodule.html

Sets up the binary module.

```APIDOC
## setup()

### Description
Sets up the binary module.

### Method
N/A (interface method)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **Returns** (void) - No return value.

#### Response Example
N/A
```

--------------------------------

### Install Harper extension via command line

Source: https://writewithharper.com/docs/integrations/visual-studio-code

Use this command to install the Harper extension from the command line. It installs the extension with ID elijah-potter.harper.

```bash
code --install-extension elijah-potter.harper
```

--------------------------------

### Install Harper with Homebrew

Source: https://writewithharper.com/docs/integrations/language-server

Installs Harper on macOS and Linux via Homebrew.

```bash
brew install harper
```

--------------------------------

### Install harper-cli from a branch with Cargo

Source: https://writewithharper.com/docs/contributors/review

Use this command to install a specific binary artifact (e.g., harper-cli) from a branch of the Harper repository. Replace <branch-name> and <binary-artifact> with the actual branch and artifact name. For example, for PR #445, use --branch somewhat-something and harper-cli.

```bash
cargo install --git https://github.com/automattic/harper --branch <branch-name> <binary-artifact> --locked
```

--------------------------------

### Linter.setup()

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.linter.setup.html

Documentation for the Linter.setup() method, which performs necessary setup before linting.

```APIDOC
## Linter.setup()

### Description
Completes any setup that is necessary before linting, such as downloading and compiling the WebAssembly binary. This setup will complete when needed regardless of whether you call this function. This function exists to allow you to do this work when it is of least impact to the user experience (e.g., while you're loading something else).

### Method
setup

### Signature
```typescript
setup(): Promise<void>;
```

### Parameters
None.

### Returns
- **Promise<void>** - A promise that resolves when setup is complete.
```

--------------------------------

### Example: Enable harper-ls for Markdown with default servers

Source: https://writewithharper.com/docs/integrations/helix

Example configuration for enabling harper-ls for Markdown while keeping the default language servers (Marksman and Markdown-Oxide). Include default servers because there is no way to append to the default list.

```toml
[[language]]
name = "markdown"
language-servers = ["marksman", "markdown-oxide", "harper-ls"]

```

--------------------------------

### harper-ls linter example with defaults

Source: https://writewithharper.com/docs/integrations/language-server

Example linter configuration with default values for several boolean linters.

```json
{
	"harper-ls": {
		"linters": {
			"SpellCheck": true,
			"SpelledNumbers": false,
			"AnA": true,
			"SentenceCapitalization": true,
			"UnclosedQuotes": true,
			"WrongApostrophe": false,
			"LongSentences": true,
			"RepeatedWords": true,
			"Spaces": true,
			"CorrectNumberSuffix": true
		}
	}
}
```

--------------------------------

### Install Harper on Termux

Source: https://writewithharper.com/docs/integrations/language-server

Installs Harper on Termux using the built-in package manager.

```bash
apt install harper
```

--------------------------------

### Install integration test dependencies with apt-get

Source: https://writewithharper.com/docs/contributors/environment

Install the libnss3 and libasound2 packages on Ubuntu using apt-get. These are required to run integration tests.

```bash
sudo apt-get install libnss3
sudo apt-get install libasound2
```

--------------------------------

### Install harper.js with npm

Source: https://writewithharper.com/docs/harperjs/introduction

Install the harper.js package via npm. The package is currently in early access, so the API is not yet stable.

```sh
npm install --save harper.js
```

--------------------------------

### Manifest JSON example

Source: https://writewithharper.com/docs/weir

Example manifest.json for a Weirpack. Must include required fields: author, version, description, and license. Additional metadata like keywords and website are optional.

```json
{
  "author": "Ada Lovelace",
  "version": "1.0.0",
  "description": "Rules for Victorian technical writing.",
  "license": "MIT",
  "keywords": ["victorian", "technical", "style"],
  "website": "https://example.com"
}
```

--------------------------------

### Install Harper Stable Release on Arch Linux

Source: https://writewithharper.com/docs/integrations/language-server

Installs the latest stable Harper release from the Arch Linux 'extra' repository.

```bash
sudo pacman -S harper
```

--------------------------------

### Optional harper-ls configuration with defaults

Source: https://writewithharper.com/docs/integrations/helix

Example configuration showing all available options with their default values. You can adjust linters, code actions, and other settings here.

```toml
[language-server.harper-ls.config.harper-ls]
userDictPath = ""
workspaceDictPath = ""
fileDictPath = ""
diagnosticSeverity = "hint"
isolateEnglish = false
dialect = "American"
maxFileLength = 120000
ignoredLintsPath = ""
excludePatterns = []

[language-server.harper-ls.config.harper-ls.linters]
SpellCheck = true
SpelledNumbers = false
AnA = true
SentenceCapitalization = true
UnclosedQuotes = true
WrongApostrophe = false
LongSentences = true
RepeatedWords = true
Spaces = true
CorrectNumberSuffix = true

[language-server.harper-ls.config.harper-ls.codeActions]
ForceStable = false

[language-server.harper-ls.config.harper-ls.markdown]
IgnoreLinkTitle = false

```

--------------------------------

### Create test.md with example error

Source: https://writewithharper.com/docs/contributors/author-a-rule

Create a test file named test.md at the root of the Harper monorepo. This file should contain an example of the error your rule looks for, so you can verify the rule catches it.

```markdown
This is an test of the `an_a` rule.
Your test should look different.
```

--------------------------------

### Enter Nix development shell

Source: https://writewithharper.com/docs/contributors/environment

Start a bash shell with the build environment for Harper. If using nix-direnv, the shell loads automatically when entering the project directory.

```bash
nix develop
```

--------------------------------

### Full harper-ls configuration with defaults in init.lua

Source: https://writewithharper.com/docs/integrations/neovim

Example configuration showing all available settings with their default values. Note that only some linters are listed; see the rules page for the full list. Refer to the harper-ls configuration documentation for details on each option.

```lua
require('lspconfig').harper_ls.setup {
  settings = {
    ["harper-ls"] = {
      userDictPath = "",
      workspaceDictPath = "",
      fileDictPath = "",
      linters = {
        SpellCheck = true,
        SpelledNumbers = false,
        AnA = true,
        SentenceCapitalization = true,
        UnclosedQuotes = true,
        WrongApostrophe = false,
        LongSentences = true,
        RepeatedWords = true,
        Spaces = true,
        CorrectNumberSuffix = true
      },
      codeActions = {
        ForceStable = false
      },
      markdown = {
        IgnoreLinkTitle = false
      },
      diagnosticSeverity = "hint",
      isolateEnglish = false,
      dialect = "American",
      maxFileLength = 120000,
      ignoredLintsPath = "",
      excludePatterns = {}
    }
  }
}

```

--------------------------------

### Install Harper Bleeding-Edge on Arch Linux

Source: https://writewithharper.com/docs/integrations/language-server

Installs the bleeding-edge harper-git package from the Arch User Repository using an AUR helper like paru or yay.

```bash
paru -S harper-git
# or yay -S harper-git, etc.
```

--------------------------------

### Install harper-ls with Cargo

Source: https://writewithharper.com/docs/integrations/language-server

Installs harper-ls from crates.io. Requires Rust and that ~/.cargo/bin is in your system $PATH. On Debian-based Linux, you may need build-essential. Only the latest stable Rust is supported.

```bash
cargo install harper-ls --locked
```

--------------------------------

### Run dev server with just dev-web

Source: https://writewithharper.com/docs/contributors/website

Starts a development server for the website, building all site dependencies. Hot-reloads changes to the web package, but changes to dependency packages (e.g., components, harper-editor) require rerunning this command. Use just build-web for a production build instead.

```bash
just dev-web
```

--------------------------------

### getLintDescriptionsHTMLAsJSON()

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.linter.getlintdescriptionshtmlasjson.html

Get the linting rule descriptions as a JSON map, formatted in HTML. Wraps the function on the BinaryModule by the same name.

```APIDOC
## getLintDescriptionsHTMLAsJSON()

### Description
Get the linting rule descriptions as a JSON map, formatted in HTML. Wraps the function on the BinaryModule by the same name.

### Method
N/A (SDK method)

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **Promise<string>** - A promise that resolves to a string containing the linting rule descriptions as a JSON map, formatted in HTML.

#### Response Example
N/A
```

--------------------------------

### Compile and watch for changes

Source: https://writewithharper.com/docs/contributors/obsidian

Compiles and starts watching for changes, continuously rebuilding main.js on any change to files in the packages/obsidian-plugin directory.

```bash
just setup && cd packages/obsidian-plugin && pnpm dev
```

--------------------------------

### harper-cli lint with --weirpack

Source: https://writewithharper.com/docs/weir

Command to load one or more Weirpacks at lint time using the --weirpack flag. The example lints README.md with rules from path/to/rules.weirpack.

```bash
harper-cli lint --weirpack path/to/rules.weirpack README.md
```

--------------------------------

### CDN usage example with WorkerLinter

Source: https://writewithharper.com/docs/harperjs/CDN

A complete HTML page that imports harper.js from unpkg, creates a WorkerLinter with the inlined binary, and lints textarea input to display errors in a list. Uses native ECMAScript module syntax and the SimpleCSS stylesheet.

```html
<!doctype html>
<html lang="en">

<head>
  <meta charset="utf-8" />
  <script type="module">
    // We can import `harper.js` using native ECMAScript syntax.
    import { binaryInlined } from 'https://unpkg.com/harper.js@2.4.0/dist/binaryInlined.js';
    import { WorkerLinter } from 'https://unpkg.com/harper.js@2.4.0/dist/index.js';

    // Since we are working in the browser, we can use either `WorkerLinter`, which doesn't block the event loop, or `LocalLinter`, which does.
    const linter = new WorkerLinter({ binary: binaryInlined });

    // Every time the `<textarea/>` received an input, we process it and update our list.
    async function onInput(e) {
      const lints = await linter.lint(e.target.value);

      const list = document.getElementById('errorlist');
      // Clear previous results
      list.innerHTML = '';

      for (const lint of lints) {
        const item = document.createElement('LI');
        const text = document.createTextNode(lint.message());
        item.appendChild(text);
        list.appendChild(item);
      }
    }

    const inputField = document.getElementById('maininput');
    inputField.addEventListener('input', onInput);
    onInput({ target: inputField });
  </script>

  <!--Make the page look good using SimpleCSS-->
  <link rel="stylesheet" href="https://cdn.simplecss.org/simple.min.css" />
</head>

<body>
  <h1>Demo</h1>

  <p>
    This page is a simple example of using <code>harper.js</code> on a plain HTML page with a CDN.
    It isn't pretty, but it demonstrates the fundamentals of using Harper. Start typing in the
    text box below to start getting suggestions right in your browser.
  </p>

  <!--This is an intentional mistake to highlight the technology.-->
  <textarea id="maininput">This is an test</textarea>

  <h2>Errors</h2>

  <ul id="errorlist">
    Loading...
  </ul>
</body>

</html>
```

--------------------------------

### WorkerLinter.setup()

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.workerlinter.setup.html

Documentation for the WorkerLinter.setup() method, which initializes the WorkerLinter instance.

```APIDOC
## WorkerLinter.setup()

### Description
Initializes the WorkerLinter instance. This method must be called before using the linter.

### Method
setup

### Signature
```typescript
setup(): Promise<void>;
```

### Returns
- **Promise<void>** - A promise that resolves when setup is complete.
```

--------------------------------

### Linter.summarizeStats(start?, end?)

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.linter.summarizestats.html

Summarizes the linter's usage statistics. Optionally accepts start and end times to filter the data to only include entries after the start time and before the end time.

```APIDOC
## Linter.summarizeStats(start?, end?)

### Description
Summarize the linter's usage statistics. You may optionally pass in a start and/or end time. If so, the summary will only include data from _after_ the start time but _before_ the end time.

### Method
summarizeStats

### Signature
```
summarizeStats(start?: bigint, end?: bigint): Promise<Summary>;
```

### Parameters
- **start** (bigint) - Optional - Start time filter.
- **end** (bigint) - Optional - End time filter.

### Returns
Promise<Summary>
```

--------------------------------

### Build and run Harper Docker image for testing

Source: https://writewithharper.com/docs/contributors/review

Clone the repository, switch to the PR branch, build the Docker image, and run it on port 3000. Then open http://localhost:3000 to test changes in the demo.

```bash
git clone https://github.com/automattic/harper
cd harper
git switch <branch from PR>
IMAGE_HASH=$(docker build . -q)
docker run -p 3000:3000 -it $IMAGE_HASH
```

--------------------------------

### Span.new(start, end)

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.span.new.html

Creates a new Span instance with the specified start and end positions. This is a static factory method.

```APIDOC
## Span.new(start, end)

### Description
Creates a new Span instance with the given start and end positions.

### Method
static new

### Signature
typescript
static new(start: number, end: number): Span;


### Parameters
- **start** (number) - Required - The start position.
- **end** (number) - Required - The end position.

### Returns
- **Span** - A new Span instance.

```

--------------------------------

### Native Neovim LSP configuration in init.lua

Source: https://writewithharper.com/docs/integrations/neovim

Sets up Harper using Neovim's native LSP support. Requires harper-ls on your system path. Enables semantic token multiline support, virtual lines diagnostics, and configures the harper server for markdown, text, tex, and typst filetypes.

```lua
-- General LSP setup
vim.lsp.config['*'] = {
    capabilities = { textDocument = { semanticTokens = { multilineTokenSupport = true } } },
    root_markers = { '.git' },
}
vim.diagnostic.config({ virtual_lines = true })

-- Harper specific setup
vim.lsp.config['harper'] = {
    cmd = { 'harper-ls', '--stdio' },
    filetypes = { 'markdown', 'text', 'tex', 'typst' }
}
vim.lsp.enable('harper')

```

--------------------------------

### List available just commands

Source: https://writewithharper.com/docs/contributors/environment

List all available tools in the Harper development toolbox, which are defined in the justfile at the repository root.

```bash
just --list
```

--------------------------------

### createBinaryModuleFromUrl(url, glueFlavor?)

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.createbinarymodulefromurl.html

Documentation for the createBinaryModuleFromUrl function, including its signature, parameters, and return type.

```APIDOC
## createBinaryModuleFromUrl(url, glueFlavor?)

### Description
Creates a binary module from a URL. The optional glueFlavor parameter specifies the WebAssembly glue flavor.

### Signature
```typescript
export declare function createBinaryModuleFromUrl(url: string, glueFlavor?: WasmGlueFlavor): BinaryModule;
```

### Parameters
- **url** (string) - Required - The URL to load the binary module from.
- **glueFlavor** (WasmGlueFlavor) - Optional - The WebAssembly glue flavor to use.

### Returns
- **BinaryModule** - The created binary module.
```

--------------------------------

### UPOS rule example: DET NOUN

Source: https://writewithharper.com/docs/weir

Matches a determiner followed by a noun using Universal Part-of-Speech tags. Examples include "the word", "a banana", and "an apple".

```plaintext
expr main DET NOUN
```

--------------------------------

### Run tests via command line: just test-vscode

Source: https://writewithharper.com/docs/contributors/visual-studio-code

Recommended way to run the extension tests. Ensure `harper-ls` is in `packages/vscode-plugin/bin` (this command does that for you).

```bash
just test-vscode
```

--------------------------------

### setDialect(dialect)

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.linter.html

Get the dialect of English this linter was constructed for.

```APIDOC
## setDialect(dialect)

### Description
Get the dialect of English this linter was constructed for.

### Method
setDialect

### Parameters
- **dialect** (Dialect) - Required - The dialect to set.

### Returns
- **void** - No return value.
```

--------------------------------

### Lint.suggestions()

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.lint.suggestions.html

Get an array of any suggestions that may resolve the issue.

```APIDOC
## Lint.suggestions()

### Description
Get an array of any suggestions that may resolve the issue.

### Method
suggestions()

### Signature
```
suggestions(): Suggestion[];
```

### Returns
Suggestion[]
```

--------------------------------

### Class: Span

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.html

Represents a range of character indices in a string, with start and end properties.

```APIDOC
## Class: Span

### Description
A struct that represents two character indices in a string: a start and an end.

### Properties
- `start` (number) - The starting character index.
- `end` (number) - The ending character index.

### Methods
- (No methods explicitly documented)

```

--------------------------------

### Progressive verb rule example: PROG

Source: https://writewithharper.com/docs/weir

Requires a token to be a progressive verb using the keyword PROG.

```plaintext
expr main PROG
```

--------------------------------

### LocalLinter.applySuggestion()

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.locallinter.applysuggestion.html

Documentation for the LocalLinter.applySuggestion method, including its signature, parameters, and return type.

```APIDOC
## LocalLinter.applySuggestion()

### Description
Applies a suggested correction to the given text based on the provided lint and suggestion objects. Returns a promise that resolves to the corrected text.

### Method
applySuggestion

### Signature
```typescript
applySuggestion(text: string, lint: Lint, suggestion: Suggestion): Promise<string>;
```

### Parameters
- **text** (string) - Required - The original text to which the suggestion will be applied.
- **lint** (Lint) - Required - The lint object containing information about the detected issue.
- **suggestion** (Suggestion) - Required - The suggestion object containing the correction to apply.

### Returns
- **Promise<string>** - A promise that resolves to the corrected text after applying the suggestion.
```

--------------------------------

### Function: createBinaryModuleFromUrl

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.html

Creates a binary module from a URL, used for loading Harper's core binary.

```APIDOC
## Function: createBinaryModuleFromUrl(url, glueFlavor)

### Description
Creates a binary module from a URL with the given glue flavor.

### Parameters
- `url` (string) - The URL to load the binary module from.
- `glueFlavor` (string) - The glue flavor to use.

### Returns
- `Promise<BinaryModule>` - A promise that resolves to a BinaryModule.

```

--------------------------------

### Exclude a token with ! in Weir

Source: https://writewithharper.com/docs/weir

Use the exclamation mark to exclude a token from a match. This example matches all determiners that are not followed by a noun.

```weir
expr main DET !NOUN
```

--------------------------------

### Exclude a list of tokens with ! in Weir

Source: https://writewithharper.com/docs/weir

Exclude a list of tokens from a match. This example matches all determiners that are not followed by either 'break' or 'braking'.

```weir
expr main DET ![break, braking]
```

--------------------------------

### Try Harper with Nix Flakes

Source: https://writewithharper.com/docs/integrations/language-server

Runs Harper in an ephemeral Nix shell when the nix-command and flakes experimental features are enabled.

```bash
nix shell 'nixpkgs#harper'
```

--------------------------------

### getDefaultLintConfig()

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.linter.html

Get the default (unset) linter configuration. This method does not affect the caller's lint configuration, nor does it return the current one.

```APIDOC
## getDefaultLintConfig()

### Description
Get the default (unset) linter configuration. This method does not affect the caller's lint configuration, nor does it return the current one.

### Method
getDefaultLintConfig

### Parameters
None

### Returns
- **LintConfig** - The default linter configuration.
```

--------------------------------

### LocalLinter.organizedLints()

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.locallinter.organizedlints.html

Documentation for the LocalLinter.organizedLints() method, including its signature, parameters, and return type.

```APIDOC
## LocalLinter.organizedLints(text, options?)

### Description
Organizes lint results by category for a given text input.

### Signature
```typescript
organizedLints(text: string, options?: LintOptions): Promise<Record<string, Lint[]>>;
```

### Parameters
- **text** (string) - Required - The text to lint.
- **options** (LintOptions) - Optional - Options for linting.

### Returns
Promise<Record<string, Lint[]>> - A promise that resolves to an object mapping lint categories to arrays of Lint objects.
```

--------------------------------

### packWeirpackFiles(files)

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.packweirpackfiles.html

Documentation for the packWeirpackFiles function, which converts a Weirpack file system into a real Weirpack binary.

```APIDOC
## packWeirpackFiles(files)

### Description
Converts a Weirpack file system into a real Weirpack binary by compressing and serializing them into a byte array.

### Signature
```typescript
export declare function packWeirpackFiles(files: Map<string, string>): Uint8Array;
```

### Parameters
- **files** (Map<string, string>) - Required - A map representing the Weirpack file system.

### Returns
- **Uint8Array** - The resulting Weirpack binary as a byte array.
```

--------------------------------

### Reference an expression with @ in Weir

Source: https://writewithharper.com/docs/weir

Refer to a previously defined expression using the `@` symbol. This example defines a list of vehicles and then uses it in a main expression.

```weir
expr vehicles [bikes, trains, automobiles]
expr main @vehicles aren't fast enough
```

--------------------------------

### Import rule in lint_group.rs

Source: https://writewithharper.com/docs/contributors/author-a-rule

Import your rule at the top of the lint_group file (harper-core/src/linting/lint_group.rs). The example shows the existing imports and the new `MyRule` import.

```rust
use super::an_a::AnA;
use super::avoid_curses::AvoidCurses;
use super::boring_words::BoringWords;
use super::capitalize_personal_pronouns::CapitalizePersonalPronouns;
use super::correct_number_suffix::CorrectNumberSuffix;
use super::my_rule::MyRule;
```

--------------------------------

### Try Harper in an Ephemeral Nix Shell

Source: https://writewithharper.com/docs/integrations/language-server

Runs Harper in an ephemeral Nix shell using the harper package from Nixpkgs.

```bash
nix-shell -p harper
```

--------------------------------

### Weir rule: like as if

Source: https://writewithharper.com/docs/weir

Example Weir rule that corrects redundant 'like as if' to either 'like' or 'as if'. Includes a test case showing the transformation.

```plaintext
expr main (like as if)

let message "Avoid redundancy. Use either `like` or `as if`."
let description "Corrects redundant `like as if` to `like` or `as if`."
let becomes ["like", "as if"]

test "And looks like as if linux-personality hasn't got any changes for 8 years." "And looks as if linux-personality hasn't got any changes for 8 years."
```

--------------------------------

### Match any token with wildcard * in Weir

Source: https://writewithharper.com/docs/weir

Use the wildcard `*` to match any token between two others. This example matches any token that is preceded by a noun and succeeded by a noun.

```weir
# To match any token that is preceded by a noun and succeeded by a noun.
expr main NOUN * NOUN
```

--------------------------------

### LocalLinter.getLintDescriptions()

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.locallinter.getlintdescriptions.html

Documentation for the LocalLinter.getLintDescriptions() method, which returns a promise of a record mapping lint rule names to descriptions.

```APIDOC
## LocalLinter.getLintDescriptions()

### Description
Retrieves a mapping of lint rule identifiers to their human-readable descriptions.

### Method
`getLintDescriptions()`

### Returns
`Promise<Record<string, string>>` - A promise that resolves to an object where keys are lint rule names and values are their descriptions.

### Example
```typescript
const descriptions = await linter.getLintDescriptions();
```
```

--------------------------------

### Linter.getLintDescriptions()

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.linter.getlintdescriptions.html

Documentation for the Linter.getLintDescriptions() method, which returns linting rule descriptions in Markdown format.

```APIDOC
## Linter.getLintDescriptions()

### Description
Retrieves the linting rule descriptions as an object, formatted in Markdown.

### Method
`getLintDescriptions()`

### Returns
`Promise<Record<string, string>>` - A promise that resolves to an object mapping rule names to their Markdown-formatted descriptions.

```

--------------------------------

### Weir rule: w/o to without

Source: https://writewithharper.com/docs/weir

Example Weir rule that expands the abbreviation 'w/o' to the full word 'without' for clarity. Sets the rule kind to 'Style'.

```plaintext
expr main (w/o)

let message "Use `without` instead of `w/o`"
let description "Expands the abbreviation `w/o` to the full word `without` for clarity."
let kind "Style"
let becomes "without"
```

--------------------------------

### BinaryModule.getDefaultLintConfig()

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.binarymodule.getdefaultlintconfig.html

Method signature and return type for retrieving the default lint configuration.

```APIDOC
## BinaryModule.getDefaultLintConfig()

### Description
Retrieves the default lint configuration as a Promise that resolves to a LintConfig object.

### Method
getDefaultLintConfig()

### Returns
Promise<LintConfig>
```

--------------------------------

### Add module to mod.rs

Source: https://writewithharper.com/docs/contributors/author-a-rule

Add your rule's module to the top of the mod file (harper-core/src/linting/mod.rs). The example shows the existing modules and the new `my_rule` module.

```rust
mod an_a;
mod avoid_curses;
mod boring_words;
mod capitalize_personal_pronouns;
mod my_rule;
```

--------------------------------

### Match punctuation like -- in Weir

Source: https://writewithharper.com/docs/weir

Match punctuation that has no special meaning in Weir. This example matches doubled hyphens and defines a rule to replace them with a single hyphen.

```weir
# Looks for all doubled hyphens.
expr main --

let message "The second mark is redundant."
let description "Looks for redundant doubling of hyphens."
let kind "Punctuation"
let becomes "-"
```

--------------------------------

### LocalLinter.getStructuredLintConfig()

Source: https://writewithharper.com/docs/harperjs/ref/harper.js.locallinter.getstructuredlintconfig.html

Documentation for the getStructuredLintConfig method of the LocalLinter class.

```APIDOC
## LocalLinter.getStructuredLintConfig()

### Description
Retrieves the structured lint configuration for the LocalLinter instance.

### Method
`getStructuredLintConfig()`

### Returns
`Promise<StructuredLintConfig>` - A promise that resolves to the structured lint configuration.

```

--------------------------------

### Word rule example: teh to the

Source: https://writewithharper.com/docs/weir

Defines a simple word rule that matches the literal word "teh" and corrects it to "the". The matches are case-insensitive, as shown by the tests.

```plaintext
expr main teh

let message "Did you mean the definite article?"
let description "Fixes especially common misspellings of the word `the`"
let kind "Typo"
let becomes "the"

test "I adore teh light of the moon." "I adore the light of the moon."
test "I adore TEH LIGHT OF THE MOON." "I adore THE LIGHT OF THE MOON."
```
Tokens:
Raw