npm - rintenki - Versions diffs - 0.1.0 → 0.3.0 - Mend

@@ -0,0 +1,251 @@
+# rintenki
+A fast HTML linter powered by html5ever + napi-rs.
+The name "rintenki" comes from the Japanese word "輪転機" (rintenki), meaning a rotary printing press — a machine that prints large volumes at high speed. The name was chosen because "lint" and "rint" (輪転) sound alike, and like a rotary press that rapidly inspects and produces printed pages, rintenki quickly scans and checks your HTML.
+## Features
+- Parsing by html5ever (Rust)
+- Node.js native binding via napi-rs
+- 38 built-in rules
+- CLI / API / VS Code extension / LSP server
+- Auto-fix with `--fix`
+- JSON output for CI integration
+- Per-rule severity customization (error / warning / off)
+- Vue / JSX / eRuby support via parser plugins
+## Install
+```bash
+npm install rintenki
+```
+## CLI
+```bash
+npx rintenki "src/**/*.html"
+```
+### Options
+```
+rintenki [options] <files...>
+  -c, --config <path>       Path to config file (default: .rintenkirc.json)
+  -f, --format <format>     Output format: stylish (default), json
+  --fix                     Auto-fix fixable rules
+  --max-warnings <number>   Exit with error if warnings exceed this number
+  -h, --help                Show help
+```
+### Examples
+```bash
+# Basic usage
+rintenki "src/**/*.html"
+# JSON output
+rintenki --format json "src/**/*.html"
+# Auto-fix
+rintenki --fix "src/**/*.html"
+# Custom config
+rintenki --config custom.json "src/**/*.html"
+# Vue files
+rintenki "src/**/*.vue"
+# JSX/TSX files
+rintenki "src/**/*.tsx"
+# eRuby files
+rintenki "app/views/**/*.erb"
+```
+## API
+```js
+const { lint, fix } = require("rintenki");
+const result = lint("<html><body><img></body></html>");
+console.log(result.diagnostics);
+const fixed = fix('<DIV Class="foo">text</DIV>');
+console.log(fixed.output); // <div class="foo">text</div>
+```
+## Configuration
+Place `.rintenkirc.json` in your project root:
+```json
+{
+  "parser": {
+    ".vue": "@rintenki/vue-parser"
+  },
+  "rules": {
+    "doctype": "error",
+    "no-consecutive-br": "warning",
+    "no-hard-code-id": "off",
+    "required-attr": true,
+    "end-tag": false
+  },
+  "ignore": ["dist/**", "vendor/**"]
+}
+```
+### Severity
+| Value | Description |
+|-------|-------------|
+| `"error"` | Report as error (exit code 1) |
+| `"warning"` / `"warn"` | Report as warning |
+| `"off"` / `false` | Disable the rule |
+| `true` | Use default severity |
+### Ignore
+Use a `.rintenkiignore` file or the `ignore` field in config to exclude files by glob pattern. `node_modules` is always excluded automatically.
+## Parser Plugins
+rintenki supports non-HTML files via optional parser plugins.
+| Plugin | Syntax | Install |
+|--------|--------|---------|
+| `@rintenki/vue-parser` | Vue SFC (`.vue`) | `npm install @rintenki/vue-parser` |
+| `@rintenki/jsx-parser` | JSX/TSX (`.jsx`, `.tsx`) | `npm install @rintenki/jsx-parser` |
+| `@rintenki/erb-parser` | eRuby (`.erb`) | `npm install @rintenki/erb-parser` |
+Parsers are auto-detected from installed packages, or can be explicitly configured in `.rintenkirc.json`.
+### How It Works
+- **Vue**: Extracts `<template>` block via `@vue/compiler-sfc`, masks `{{ }}` interpolations
+- **JSX/TSX**: Parses AST via `oxc-parser` (Rust), extracts HTML elements, maps React attributes (`className` → `class`)
+- **eRuby**: Masks `<% %>` tags with same-length placeholders, preserving line numbers
+## Rules
+### Conformance Checking
+| Rule | Default | Description |
+|------|---------|-------------|
+| `attr-duplication` | error | Detect duplicate attributes |
+| `deprecated-attr` | error | Detect deprecated or obsolete attributes |
+| `deprecated-element` | error | Detect deprecated or obsolete elements |
+| `disallowed-element` | off | Detect disallowed elements |
+| `doctype` | error | Detect missing DOCTYPE declaration |
+| `heading-levels` | error | Detect skipped heading levels |
+| `id-duplication` | error | Detect duplicate id attribute values |
+| `invalid-attr` | error | Detect attributes not in the spec |
+| `no-duplicate-dt` | error | Detect duplicate dt names in dl |
+| `no-empty-palpable-content` | warning | Detect empty palpable content elements |
+| `no-orphaned-end-tag` | error | Detect end tags without matching start tags |
+| `permitted-contents` | error | Detect children not permitted by the spec |
+| `placeholder-label-option` | warning | Detect missing placeholder option in required select |
+| `require-datetime` | error | Detect missing datetime attribute on time element |
+| `required-attr` | error | Detect missing required attributes |
+| `required-element` | error | Detect missing required child elements |
+### Accessibility
+| Rule | Default | Description |
+|------|---------|-------------|
+| `label-has-control` | error | Detect label elements without associated control |
+| `landmark-roles` | warning | Detect nested landmark roles |
+| `neighbor-popovers` | off | Detect non-adjacent popover triggers and targets |
+| `no-ambiguous-navigable-target-names` | warning | Detect invalid target name keywords |
+| `no-consecutive-br` | warning | Detect consecutive br elements |
+| `no-refer-to-non-existent-id` | error | Detect references to non-existent ids |
+| `require-accessible-name` | error | Detect missing accessible names |
+| `required-h1` | error | Detect missing h1 element |
+| `table-row-column-alignment` | warning | Detect inconsistent table column counts |
+| `use-list` | warning | Suggest list elements for bullet-prefixed text |
+| `wai-aria` | error | Detect invalid WAI-ARIA roles and attributes |
+### Naming Convention
+| Rule | Default | Description |
+|------|---------|-------------|
+| `class-naming` | off | Enforce class name conventions |
+### Maintainability
+| Rule | Default | Description |
+|------|---------|-------------|
+| `no-hard-code-id` | off | Detect hardcoded id attributes |
+| `no-use-event-handler-attr` | warning | Detect event handler attributes |
+### Style
+| Rule | Default | Description |
+|------|---------|-------------|
+| `attr-value-quotes` | warning | Detect unquoted attribute values |
+| `case-sensitive-attr-name` | warning | Detect uppercase attribute names |
+| `case-sensitive-tag-name` | warning | Detect uppercase tag names |
+| `character-reference` | warning | Detect unescaped `&` characters |
+| `end-tag` | warning | Detect missing end tags |
+| `ineffective-attr` | warning | Detect attributes with no effect on element |
+| `no-boolean-attr-value` | warning | Detect values on boolean attributes |
+| `no-default-value` | warning | Detect attributes set to their default value |
+### Auto-fixable Rules
+The following rules can be auto-fixed with `--fix`:
+- `case-sensitive-tag-name`
+- `case-sensitive-attr-name`
+- `no-boolean-attr-value`
+- `no-default-value`
+## VS Code Extension
+The `packages/rintenki-vscode` package provides a VS Code extension with real-time linting and Quick Fix support via the LSP server.
+### Development
+```bash
+pnpm build        # Build all packages
+code .            # Open project root in VS Code
+# Press F5 to launch Extension Development Host
+```
+### Settings
+```json
+{
+  "rintenki.rules": {
+    "case-sensitive-attr-name": "off",
+    "no-hard-code-id": "warning"
+  }
+}
+```
+## Packages
+| Package | Description |
+|---------|-------------|
+| `rintenki` | Linter core (Rust + napi-rs) |
+| `rintenki-lsp-server` | LSP server |
+| `rintenki-vscode` | VS Code extension |
+| `@rintenki/parser-utils` | Shared parser interface |
+| `@rintenki/vue-parser` | Vue SFC parser plugin |
+| `@rintenki/jsx-parser` | JSX/TSX parser plugin |
+| `@rintenki/erb-parser` | eRuby parser plugin |
+## Supported Platforms
+- macOS (arm64, x64)
+- Linux (x64, arm64)
+- Windows (x64, arm64)
+## Inspired by
+- [markuplint](https://markuplint.dev/) — The rule set design is inspired by markuplint.
+## License
+MIT

@@ -5,6 +5,13 @@ const { resolve, relative } = require("path");
 const { glob } = require("tinyglobby");
 const { lint, fix } = require("../index");
+let loadParser;
+try {
+  loadParser = require("@rintenki/parser-utils").loadParser;
+} catch {
+  loadParser = () => undefined;
+}
 const COLORS = {
   red: "\x1b[31m",
   yellow: "\x1b[33m",
@@ -144,7 +151,19 @@ Examples:
   let totalFixed = 0;
   for (const file of files) {
-    let html = readFileSync(file, "utf-8");
+    let source = readFileSync(file, "utf-8");
+    let lineOffset = 0;
+    // Preprocess non-HTML files (Vue, ERB, etc.)
+    const parser = loadParser(file, config?.parser);
+    if (parser) {
+      const preprocessed = parser.preprocess(source);
+      source = preprocessed.html;
+      lineOffset = preprocessed.lineOffset;
+      if (!source) continue;
+    }
+    let html = source;
     if (args.fix) {
       const fixResult = fix(html, config);
@@ -158,6 +177,14 @@ Examples:
     const result = lint(html, config);
     const rel = relative(process.cwd(), file);
+    // Remap line numbers to original file positions
+    if (lineOffset > 0) {
+      for (const d of result.diagnostics) {
+        if (d.line != null) d.line += lineOffset;
+        if (d.endLine != null) d.endLine += lineOffset;
+      }
+    }
     for (const d of result.diagnostics) {
       if (d.severity === "error") totalErrors++;
       else totalWarnings++;

@@ -3,6 +3,9 @@ export interface LintDiagnostic {
   message: string;
   severity: "error" | "warning";
   line: number | null;
+  col: number | null;
+  endLine: number | null;
+  endCol: number | null;
   fixable: boolean;
 }

@@ -1,6 +1,6 @@
 {
   "name": "rintenki",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "A fast HTML linter powered by html5ever + napi-rs",
   "author": "Kazuhiro Kobayashi <https://github.com/kzhrk>",
   "license": "MIT",
@@ -32,7 +32,8 @@
     "index.js",
     "index.d.ts",
     "bin/rintenki.js",
-    "rintenki.*.node"
+    "rintenki.*.node",
+    "README.md"
   ],
   "napi": {
     "binaryName": "rintenki",

rintenki 0.1.0 → 0.3.0