prettier-plugin-noshift.js 0.0.0 → 0.0.2

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 [otoneko.]
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 [otoneko.]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README-ja.md

@@ -0,0 +1,114 @@
+[![npm](https://img.shields.io/npm/v/prettier-plugin-noshift.js)](https://www.npmjs.com/package/prettier-plugin-noshift.js) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+
+# prettier-plugin-noshift.js
+
+<div align="center">
+  <img src="https://raw.githubusercontent.com/otoneko1102/NoShift.js/refs/heads/main/icon.png" alt="noshift.js" width="128" height="128">
+</div>
+
+<div align="center">
+
+[English](./README.md) | **日本語**
+
+</div>
+
+> [NoShift.js](https://github.com/otoneko1102/NoShift.js) (`.nsjs`) ファイルをフォーマットする [Prettier](https://prettier.io/) プラグイン
+
+[Prettier](https://prettier.io/) はコードフォーマッターです。このプラグインは、Shift キーを押さずに JavaScript を書ける Joke 言語 [NoShift.js](https://github.com/otoneko1102/NoShift.js) の `.nsjs` ファイルに対応します。
+
+---
+
+## インストール
+
+```bash
+npm install --save-dev prettier prettier-plugin-noshift.js
+```
+
+---
+
+## 使い方
+
+`.prettierrc` にプラグインを追加します:
+
+```json
+{
+  "plugins": ["prettier-plugin-noshift.js"]
+}
+```
+
+`.nsjs` ファイルをフォーマット:
+
+```bash
+npx prettier --write "**/*.nsjs"
+```
+
+> **ヒント:** `nsc create` でプロジェクトを作成すると、Prettier とこのプラグインが自動的にインストール・設定されます。
+
+---
+
+## 仕組み
+
+プラグインは3段階のパイプラインでフォーマットします:
+
+1. **`.nsjs` → JavaScript** — NoShift.js 構文を JavaScript に変換
+2. **JavaScript → フォーマット済み JavaScript** — Prettier の組み込み babel パーサーでフォーマット
+3. **フォーマット済み JavaScript → `.nsjs`** — NoShift.js 構文に逆変換
+
+標準の Prettier オプションはすべてステージ 2 に転送されるため、既存の設定（`semi`、`singleQuote`、`tabWidth` など）がそのまま適用されます。
+
+---
+
+## 例
+
+**フォーマット前** (`src/index.nsjs`):
+
+```text
+const  x  =  1  ;
+function greet^8name^9 ^[
+  const msg=^2^3hello, ^2^;name;
+console.log^8msg^9 ;
+  return  msg ;
+^]
+```
+
+**フォーマット後** `npx prettier --write`:
+
+```text
+const x ^- 1;
+function greet^8name^9 ^[
+  const msg ^- ^2^3hello, ^2 ^; name;
+  console.log^8msg^9;
+  return msg;
+^]
+```
+
+---
+
+## 対応オプション
+
+すべての標準 Prettier オプションがサポートされています。主なもの:
+
+| オプション | デフォルト | 説明 |
+|---|---|---|
+| `semi` | `true` | 文末にセミコロンを付ける |
+| `singleQuote` | `false` | シングルクォートを使う |
+| `tabWidth` | `2` | インデント幅 |
+| `trailingComma` | `"all"` | 末尾カンマ |
+| `printWidth` | `80` | 1行の最大文字数 |
+| `bracketSpacing` | `true` | オブジェクト括弧内のスペース |
+| `arrowParens` | `"always"` | アロー関数の括弧 |
+| `endOfLine` | `"lf"` | 改行スタイル |
+
+---
+
+## 関連
+
+- [noshift.js](https://www.npmjs.com/package/noshift.js) — NoShift.js コンパイラ CLI
+- [NoShift.js VS Code 拡張機能](https://marketplace.visualstudio.com/items?itemName=otoneko1102.noshift-vscode) — シンタックスハイライトとスニペット
+- [ドキュメント](https://noshift.js.org/)
+
+---
+
+## ライセンス
+
+[MIT](./LICENSE) © [otoneko.](https://github.com/otoneko1102)

package/README.md

@@ -0,0 +1,114 @@
+[![npm](https://img.shields.io/npm/v/prettier-plugin-noshift.js)](https://www.npmjs.com/package/prettier-plugin-noshift.js) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+
+# prettier-plugin-noshift.js
+
+<div align="center">
+  <img src="https://raw.githubusercontent.com/otoneko1102/NoShift.js/refs/heads/main/icon.png" alt="noshift.js" width="128" height="128">
+</div>
+
+<div align="center">
+
+**English** | [日本語](./README-ja.md)
+
+</div>
+
+> A [Prettier](https://prettier.io/) plugin for formatting [NoShift.js](https://github.com/otoneko1102/NoShift.js) (`.nsjs`) files.
+
+[Prettier](https://prettier.io/) is an opinionated code formatter. This plugin adds support for `.nsjs` files — the [NoShift.js](https://github.com/otoneko1102/NoShift.js) joke language that lets you write JavaScript without pressing the Shift key.
+
+---
+
+## Install
+
+```bash
+npm install --save-dev prettier prettier-plugin-noshift.js
+```
+
+---
+
+## Usage
+
+Add the plugin to your `.prettierrc`:
+
+```json
+{
+  "plugins": ["prettier-plugin-noshift.js"]
+}
+```
+
+Then format your `.nsjs` files:
+
+```bash
+npx prettier --write "**/*.nsjs"
+```
+
+> **Tip:** If you scaffold a project with `nsc create`, Prettier and this plugin are automatically installed and configured.
+
+---
+
+## How It Works
+
+The plugin uses a three-stage pipeline:
+
+1. **`.nsjs` → JavaScript** — convert NoShift.js syntax to standard JS
+2. **JavaScript → formatted JavaScript** — format with Prettier's built-in babel parser
+3. **formatted JavaScript → `.nsjs`** — convert back to NoShift.js syntax
+
+All standard Prettier formatting options are forwarded to stage 2, so your existing config (`semi`, `singleQuote`, `tabWidth`, etc.) just works.
+
+---
+
+## Example
+
+**Before** (`src/index.nsjs`):
+
+```text
+const  x  =  1  ;
+function greet^8name^9 ^[
+  const msg=^2^3hello, ^2^;name;
+console.log^8msg^9 ;
+  return  msg ;
+^]
+```
+
+**After** `npx prettier --write`:
+
+```text
+const x ^- 1;
+function greet^8name^9 ^[
+  const msg ^- ^2^3hello, ^2 ^; name;
+  console.log^8msg^9;
+  return msg;
+^]
+```
+
+---
+
+## Supported Options
+
+All standard Prettier options are supported. Common ones:
+
+| Option | Default | Description |
+|---|---|---|
+| `semi` | `true` | Add semicolons at the end of statements |
+| `singleQuote` | `false` | Use single quotes instead of double quotes |
+| `tabWidth` | `2` | Indentation width |
+| `trailingComma` | `"all"` | Trailing commas |
+| `printWidth` | `80` | Max line width |
+| `bracketSpacing` | `true` | Spaces inside object braces |
+| `arrowParens` | `"always"` | Arrow function parentheses |
+| `endOfLine` | `"lf"` | Line ending style |
+
+---
+
+## Related
+
+- [noshift.js](https://www.npmjs.com/package/noshift.js) — The NoShift.js compiler CLI
+- [NoShift.js VS Code Extension](https://marketplace.visualstudio.com/items?itemName=otoneko1102.noshift-vscode) — Syntax highlighting & snippets
+- [Documentation](https://noshift.js.org/)
+
+---
+
+## License
+
+[MIT](./LICENSE) © [otoneko.](https://github.com/otoneko1102)

package/package.json

@@ -1,15 +1,12 @@
 {
   "name": "prettier-plugin-noshift.js",
-  "version": "0.0.0",
+  "version": "0.0.2",
   "description": "Prettier plugin for NoShift.js",
   "type": "module",
   "main": "src/index.js",
   "exports": {
     ".": "./src/index.js"
   },
-  "files": [
-    "src/"
-  ],
   "scripts": {
     "test": "node test/test.js"
   },
@@ -32,7 +29,7 @@
   "bugs": {
     "url": "https://github.com/otoneko1102/NoShift.js/issues"
   },
-  "homepage": "https://github.com/otoneko1102/NoShift.js#readme",
+  "homepage": "https://noshift.js.org",
   "peerDependencies": {
     "prettier": "^3.8.1"
   }