@@ -1,4 +1,4 @@
1−# PureLint
1+# Purslint
22
33<p align="center">
44 <img src="vscode-extension/purslint.jpg" alt="Purslint logo" width="180" />
@@ -9,40 +9,20 @@
99
1010A PureScript linter inspired by [hlint](https://github.com/ndmitchell/hlint), providing suggestions for cleaner, more idiomatic PureScript code.
1111
12−## Features
13−
14−PureLint currently ships with **81 lint rules**, covering common PureScript refactors and simplifications.
12+## Install
1513
16−For a complete list, see `lib/purslint/src/Purslint/Rules/`.
14+### VS Code (Marketplace)
1715
18−## Installation
16+Install from the Visual Studio Marketplace:
17+[Purslint](https://marketplace.visualstudio.com/items?itemName=RowtypeYoga.purslint).
1918
20−### npm (recommended)
19+### CLI (npm)
2120
2221```bash
2322npm install -g purslint
2423
2524# CLI
26−purelint --help
27−```
28−
29−### Prerequisites
30−
31−- [PureScript](https://www.purescript.org/) compiler (`purs`)
32−- [Spago](https://github.com/purescript/spago) package manager
33−- [Node.js](https://nodejs.org/) 18+
34−
35−### Building
36−
37−```bash
38−# Install dependencies
39−npm install
40−
41−# Build and bundle CLI + LSP
42−npm run dist
43−
44−# Run tests
45−npm test
25+purslint --help
4626```
4727
4828## Usage
@@ -51,18 +31,18 @@ npm test
5131
5232```bash
5333# Lint a single file
54−./purelint src/Main.purs
34+./purslint src/Main.purs
5535
5636# Lint multiple files
57−./purelint src/*.purs
37+./purslint src/*.purs
5838
5939# Lint with config file (optional)
60−./purelint --config purelint.json src/*.purs
40+./purslint --config purslint.json src/*.purs
6141```
6242
6343### LSP (Language Server Protocol)
6444
65−The LSP binary (`purelint-lsp`) provides IDE integration. It communicates via stdio using the standard LSP protocol.
45+The LSP binary (`purslint-lsp`) provides IDE integration. It communicates via stdio using the standard LSP protocol.
6646
6747#### Zed Editor
6848
@@ -73,33 +53,39 @@ A Zed extension is available in the `zed-extension/` directory. To install:
73533. Click "Install Dev Extension"
74544. Select the `zed-extension/` directory
7555
76−The extension will automatically use the `purelint-lsp` binary.
56+The extension will automatically use the `purslint-lsp` binary.
7757
7858#### Neovim (nvim-lspconfig)
7959
80−After building `purelint-lsp` (see build steps below), you can configure Neovim like this:
60+After building `purslint-lsp` (see build steps below), you can configure Neovim like this:
8161
8262```lua
83−require("lspconfig").purelint = {
63+require("lspconfig").purslint = {
8464 default_config = {
85− cmd = { "/path/to/purelint-lsp" },
65+ cmd = { "/path/to/purslint-lsp" },
8666 filetypes = { "purescript" },
8767 root_dir = require("lspconfig.util").root_pattern(".git", "spago.yaml", "package.json"),
8868 },
8969}
9070
91−require("lspconfig").purelint.setup({})
71+require("lspconfig").purslint.setup({})
9272```
9373
9474If you prefer to run the bundled JS directly:
9575
9676```lua
97−cmd = { "node", "/path/to/dist/purelint-lsp.js" }
77+cmd = { "node", "/path/to/dist/purslint-lsp.js" }
9878```
9979
80+## Features
81+
82+Purslint currently ships with **81 lint rules**, covering common PureScript refactors and simplifications.
83+
84+For a complete list, see `lib/purslint/src/Purslint/Rules/`.
85+
10086## Configuration
10187
102−Create a `purelint.json` file in your project root:
88+Create a `purslint.json` file in your project root:
10389
10490```json
10591{
@@ -109,7 +95,7 @@ Create a `purelint.json` file in your project root:
10995
11096## Architecture
11197
112−PureLint is written in PureScript and compiled to JavaScript via
98+Purslint is written in PureScript and compiled to JavaScript via
11399`purs-backend-es`, then bundled for Node.js. This allows:
114100
115101- Full access to the PureScript CST parser (`purescript-language-cst-parser`)
@@ -119,7 +105,7 @@ PureLint is written in PureScript and compiled to JavaScript via
119105### Project Structure
120106
121107```
122−purelint/
108+purslint/
123109├── lib/purslint/src/ # Core library
124110│ └── Purslint/
125111│ ├── Rules/ # Lint rules
@@ -135,6 +121,25 @@ purelint/
135121
136122## Development
137123
124+### Prerequisites
125+
126+- [PureScript](https://www.purescript.org/) compiler (`purs`)
127+- [Spago](https://github.com/purescript/spago) package manager
128+- [Node.js](https://nodejs.org/) 18+
129+
130+### Building
131+
132+```bash
133+# Install dependencies
134+npm install
135+
136+# Build and bundle CLI + LSP
137+npm run dist
138+
139+# Run tests
140+npm test
141+```
142+
138143### Publishing to npm
139144
140145Publishing is handled by GitHub Actions. Add an `NPM_TOKEN` secret with an