Skip to content

CodingMarco/opencode-line-endings

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

opencode-line-endings

npm

An OpenCode plugin that enforces consistent line endings (LF or CRLF) on all file edits, independent of the platform OpenCode runs on.

The primary use case is running OpenCode inside WSL while editing Windows files — the platform reports Linux (LF), but the files need CRLF line endings.

Installation

Add the plugin to your opencode.json:

{
  "plugin": ["opencode-line-endings"]
}

OpenCode installs the package and its dependencies automatically at startup.

Alternative: local file

If you prefer not to use npm, copy index.ts directly into your plugins directory. Since this plugin depends on the editorconfig package, you also need a package.json in the config directory.

Project-level:

cp index.ts <project>/.opencode/plugins/line-endings.ts

Add to .opencode/package.json:

{
  "dependencies": {
    "editorconfig": "^3.0.2"
  }
}

Global:

cp index.ts ~/.config/opencode/plugins/line-endings.ts

Add to ~/.config/opencode/package.json:

{
  "dependencies": {
    "editorconfig": "^3.0.2"
  }
}

Configuration

Line ending style is determined in this order:

1. Environment variable (highest priority)

export OPENCODE_LINE_ENDINGS=crlf  # or lf

2. .editorconfig

The plugin reads .editorconfig files, walking up the directory tree as per the spec. The end_of_line property is used:

# .editorconfig
root = true

[*]
end_of_line = crlf

Per-pattern overrides work as expected:

[*.sh]
end_of_line = lf

[*.{cs,csproj,sln}]
end_of_line = crlf

3. Default

If neither the environment variable nor .editorconfig specifies a line ending style, the plugin defaults to CRLF.

How it works

The plugin hooks into OpenCode's tool execution pipeline at two points:

  • Before tool execution (tool.execute.before): Transforms content in write, edit, and multiedit tool arguments before they reach disk. This ensures diffs shown to the user reflect the correct line endings.

  • After file edits (file.edited event): Re-reads the entire file and normalizes all line endings. This catches cases where partial edits produce mixed line endings (e.g., existing LF content with CRLF insertions from the edit tool).

Binary files are skipped automatically based on file extension.

License

MIT

About

An OpenCode plugin that enforces consistent line endings (LF or CRLF) on all file edits, independent of the platform OpenCode runs on.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors