noshift.js 0.1.0 → 0.2.0

package/.prettierrc.json

@@ -0,0 +1,3 @@
+{
+  "tabWidth": 2
+}

package/README-ja.md

@@ -0,0 +1,251 @@
+# noshift.js
+
+> Shift キーを押さずに JavaScript を書ける Joke 言語
+
+[![npm](https://img.shields.io/npm/v/noshift.js)](https://www.npmjs.com/package/noshift.js)
+[![license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![en](https://img.shields.io/badge/lang-English_version-blue)](README.md)
+
+---
+
+## インストール
+
+```bash
+npm install -g noshift.js@latest
+```
+
+---
+
+## はじめに
+
+```bash
+# インタラクティブなプロジェクトスキャフォールド
+nsc create
+
+# または、現在のディレクトリに nsjsconfig.json だけを作成
+nsc --init
+```
+
+---
+
+## CLI リファレンス
+
+`nsc` は TypeScript の `tsc` に似た使い心地を目指しています。
+
+| コマンド | 説明 |
+|---|---|
+| `nsc` | `nsjsconfig.json` を使って `.nsjs` → `.js` にコンパイル |
+| `nsc -w` / `nsc --watch` | 変更を監視して自動的に再コンパイル |
+| `nsc --init` | 現在のディレクトリに `nsjsconfig.json` を作成 |
+| `nsc --clean` | 出力ディレクトリ (`outDir`) を削除 |
+| `nsc run <file>` | `.nsjs` ファイルを直接実行 |
+| `nsc create [name]` | インタラクティブに新しいプロジェクトを作成 |
+| `nsc -V` | バージョンを表示 |
+| `nsc -h` | ヘルプを表示 |
+
+---
+
+## nsjsconfig.json
+
+プロジェクトルートに `nsjsconfig.json` を置くとコンパイル設定を行えます。
+`nsc --init` または `nsc create` で自動生成されます。
+
+```json
+{
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "build"
+  }
+}
+```
+
+| オプション | デフォルト | 説明 |
+|---|---|---|
+| `compilerOptions.rootDir` | `"src"` | ソースディレクトリ |
+| `compilerOptions.outDir` | `"build"` | 出力ディレクトリ |
+
+---
+
+## 記号マップ
+
+> この変換表は NoShift.js 開発者のキーボード（JIS 配列）が基準です。
+
+![開発者のキーボード](https://raw.githubusercontent.com/otoneko1102/NoShift.js/refs/heads/main/my-keyboard.jpg)
+
+| NoShift | JS | | NoShift | JS |
+|:-------:|:--:|---|:-------:|:--:|
+| `^1`    | `!`        | | `^^`    | `~`        |
+| `^2`    | `"`        | | `^\`    | `\|`       |
+| `^4`    | `$`        | | `^@`    | `` ` ``    |
+| `^5`    | `%`        | | `^[`    | `{`        |
+| `^6`    | `&`        | | `^]`    | `}`        |
+| `^7`    | `'`        | | `^;`    | `+`        |
+| `^8`    | `(`        | | `^:`    | `*`        |
+| `^9`    | `)`        | | `^,`    | `<`        |
+| `^-`    | `=`        | | `^.`    | `>`        |
+|         |            | | `^/`    | `?`        |
+
+テンプレート式: `^4^[` → `${`
+
+---
+
+## 構文サンプル
+
+### Hello World
+
+```nsjs
+console.log^8^2Hello, World!^2^9;
+```
+
+```js
+console.log("Hello, World!");
+```
+
+### 変数とアロー関数
+
+```nsjs
+const add ^- ^8a, b^9 ^-^. a ^; b;
+
+const result ^- add^85, 3^9;
+console.log^8result^9; // 8
+```
+
+```js
+const add = (a, b) => a + b;
+
+const result = add(5, 3);
+console.log(result); // 8
+```
+
+### 文字列
+
+```nsjs
+// ダブルクォート文字列
+const s1 ^- ^2Hello^2;
+
+// シングルクォート文字列
+const s2 ^- ^7World^7;
+
+// テンプレートリテラル
+const s3 ^- ^@^4^[s1^] ^4^[s2^]^@;
+
+// エスケープ: ^2...^2 内の \^2 はリテラルの ^2 に展開される
+const s4 ^- ^2quote: \^2^2;
+```
+
+```js
+const s1 = "Hello";
+const s2 = 'World';
+const s3 = `Hello World`;
+const s4 = "quote: ^2";
+```
+
+### オブジェクトと配列
+
+```nsjs
+const obj ^- ^[
+  name: ^2NoShift^2,
+  version: 1,
+  isJoke: true
+^];
+
+const arr ^- [1, 2, 3];
+```
+
+```js
+const obj = {
+  name: "NoShift",
+  version: 1,
+  isJoke: true
+};
+
+const arr = [1, 2, 3];
+```
+
+### クラス
+
+```nsjs
+class Animal ^[
+  constructor^8name^9 ^[
+    this.name ^- name;
+  ^]
+
+  speak^8^9 ^[
+    console.log^8^@^4^[this.name^] speaks.^@^9;
+  ^]
+^]
+
+const dog ^- new Animal^8^2Dog^2^9;
+dog.speak^8^9;
+```
+
+```js
+class Animal {
+  constructor(name) {
+    this.name = name;
+  }
+
+  speak() {
+    console.log(`${this.name} speaks.`);
+  }
+}
+
+const dog = new Animal("Dog");
+dog.speak();
+```
+
+### 条件分岐とループ
+
+```nsjs
+const x ^- 10;
+
+if ^8x ^. 5^9 ^[
+  console.log^8^2big^2^9;
+^] else ^[
+  console.log^8^2small^2^9;
+^]
+
+for ^8let i ^- 0; i ^, 3; i^;^;^9 ^[
+  console.log^8i^9;
+^]
+```
+
+```js
+const x = 10;
+
+if (x > 5) {
+  console.log("big");
+} else {
+  console.log("small");
+}
+
+for (let i = 0; i < 3; i++) {
+  console.log(i);
+}
+```
+
+---
+
+## ファイル名の規則
+
+`_` で始まるファイルはコンパイル対象から除外されます（パーシャル・ユーティリティ用途に便利）。
+
+```
+src/
+  index.nsjs       ← コンパイルされる
+  _helpers.nsjs    ← スキップされる
+```
+
+---
+
+## リンク
+
+- [VS Code 拡張機能](https://marketplace.visualstudio.com/items?itemName=otoneko1102.noshift-vscode)
+- [ウェブサイト](https://noshift.js.org)
+- [リポジトリ](https://github.com/otoneko1102/NoShift.js)
+
+---
+
+## ライセンス
+
+MIT © otoneko.

package/README.md

@@ -1,79 +1,251 @@
-# NoShift.js
-
-## Setup
-```bash
-npm install -g noshift.js@latest
-npx nsjs create
-```
-
-## English
-
-### Language
-NoShift.js
-
-### Extension
-`.nsjs`
-
-### Summary
-Typing symbols with Shift is tiring. NoShift.js is a JavaScript-like language that allows you to write JavaScript **without using the Shift key**.  
-It compiles to plain JavaScript.
-
-The mapping is based on the keyboard layout of the creator’s laptop.
-
-## 日本語
-### 言語名
-NoShift.js
-
-### 張子
-.nsjs
-
-### 概略
-記号を入力するときに Shift を押すのが面倒なので、Shift を押さずに JavaScript が書ける言語を作りました。
-NoShift.js は JavaScript に変換されます。
-
-この記号変換の基準は、作者のノートパソコンのキーボード配列です。
-
-```
-! --> ^1
-" --> ^2
-$ --> ^4
-% --> ^5
-& --> ^6
-' --> ^7
-( --> ^8
-) --> ^9
-= --> ^-
-~ --> ^^
-| --> ^\
-` --> ^@
-{ --> ^[
-} --> ^]
-+ --> ^;
-* --> ^:
-< --> ^,
-> --> ^.
-? --> ^/
-```
-
-### Escaping in strings
-Examples:
-```nsjs
-^2^5^2 --> "^5"
-^7^5^7 --> '^5'
-^@^5^@ --> `^5`
-```
-Template literals (${} syntax)
-
-```nsjs
-^@^5^4^[^2Hello World!^2^]^@ --> `^5${"Hello World!"}`
-```
-Hello World!
-Example:
-
-```nsjs
-console.log^8^2Hello World!^2^9;
-Result:
-```
-```js
-console.log("Hello World!");
-```
+# noshift.js
+
+> A joke language that lets you write JavaScript without pressing the Shift key.
+
+[![npm](https://img.shields.io/npm/v/noshift.js)](https://www.npmjs.com/package/noshift.js)
+[![license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![ja](https://img.shields.io/badge/lang-日本語_バージョン-red)](README-ja.md)
+
+---
+
+## Installation
+
+```bash
+npm install -g noshift.js@latest
+```
+
+---
+
+## Getting Started
+
+```bash
+# Interactive full project scaffold
+nsc create
+
+# Or initialize only a nsjsconfig.json in the current directory
+nsc --init
+```
+
+---
+
+## CLI Reference
+
+`nsc` is designed to feel like TypeScript's `tsc`.
+
+| Command | Description |
+|---|---|
+| `nsc` | Compile `.nsjs` → `.js` using `nsjsconfig.json` |
+| `nsc -w` / `nsc --watch` | Watch for changes and recompile automatically |
+| `nsc --init` | Create `nsjsconfig.json` in the current directory |
+| `nsc --clean` | Delete the output directory (`outDir`) |
+| `nsc run <file>` | Run a `.nsjs` file directly |
+| `nsc create [name]` | Scaffold a new project interactively |
+| `nsc -V` | Show version |
+| `nsc -h` | Show help |
+
+---
+
+## nsjsconfig.json
+
+Place a `nsjsconfig.json` at the project root to configure compilation.
+Generated automatically by `nsc --init` or `nsc create`.
+
+```json
+{
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "build"
+  }
+}
+```
+
+| Option | Default | Description |
+|---|---|---|
+| `compilerOptions.rootDir` | `"src"` | Source directory |
+| `compilerOptions.outDir` | `"build"` | Output directory |
+
+---
+
+## Symbol Map
+
+> This symbol mapping is based on the NoShift.js developer's keyboard (JIS layout).
+
+![Developer's Keyboard](https://raw.githubusercontent.com/otoneko1102/NoShift.js/refs/heads/main/my-keyboard.jpg)
+
+| NoShift | JS | | NoShift | JS |
+|:-------:|:--:|---|:-------:|:--:|
+| `^1`    | `!`        | | `^^`    | `~`        |
+| `^2`    | `"`        | | `^\`    | `\|`       |
+| `^4`    | `$`        | | `^@`    | `` ` ``    |
+| `^5`    | `%`        | | `^[`    | `{`        |
+| `^6`    | `&`        | | `^]`    | `}`        |
+| `^7`    | `'`        | | `^;`    | `+`        |
+| `^8`    | `(`        | | `^:`    | `*`        |
+| `^9`    | `)`        | | `^,`    | `<`        |
+| `^-`    | `=`        | | `^.`    | `>`        |
+|         |            | | `^/`    | `?`        |
+
+Template expression: `^4^[` → `${`
+
+---
+
+## Syntax Examples
+
+### Hello World
+
+```nsjs
+console.log^8^2Hello, World!^2^9;
+```
+
+```js
+console.log("Hello, World!");
+```
+
+### Variables & Arrow Functions
+
+```nsjs
+const add ^- ^8a, b^9 ^-^. a ^; b;
+
+const result ^- add^85, 3^9;
+console.log^8result^9; // 8
+```
+
+```js
+const add = (a, b) => a + b;
+
+const result = add(5, 3);
+console.log(result); // 8
+```
+
+### Strings
+
+```nsjs
+// Double-quote string
+const s1 ^- ^2Hello^2;
+
+// Single-quote string
+const s2 ^- ^7World^7;
+
+// Template literal
+const s3 ^- ^@^4^[s1^] ^4^[s2^]^@;
+
+// Escape: \^2 inside ^2...^2 yields a literal ^2 in the output
+const s4 ^- ^2quote: \^2^2;
+```
+
+```js
+const s1 = "Hello";
+const s2 = 'World';
+const s3 = `Hello World`;
+const s4 = "quote: ^2";
+```
+
+### Objects & Arrays
+
+```nsjs
+const obj ^- ^[
+  name: ^2NoShift^2,
+  version: 1,
+  isJoke: true
+^];
+
+const arr ^- [1, 2, 3];
+```
+
+```js
+const obj = {
+  name: "NoShift",
+  version: 1,
+  isJoke: true
+};
+
+const arr = [1, 2, 3];
+```
+
+### Classes
+
+```nsjs
+class Animal ^[
+  constructor^8name^9 ^[
+    this.name ^- name;
+  ^]
+
+  speak^8^9 ^[
+    console.log^8^@^4^[this.name^] speaks.^@^9;
+  ^]
+^]
+
+const dog ^- new Animal^8^2Dog^2^9;
+dog.speak^8^9;
+```
+
+```js
+class Animal {
+  constructor(name) {
+    this.name = name;
+  }
+
+  speak() {
+    console.log(`${this.name} speaks.`);
+  }
+}
+
+const dog = new Animal("Dog");
+dog.speak();
+```
+
+### Conditionals & Loops
+
+```nsjs
+const x ^- 10;
+
+if ^8x ^. 5^9 ^[
+  console.log^8^2big^2^9;
+^] else ^[
+  console.log^8^2small^2^9;
+^]
+
+for ^8let i ^- 0; i ^, 3; i^;^;^9 ^[
+  console.log^8i^9;
+^]
+```
+
+```js
+const x = 10;
+
+if (x > 5) {
+  console.log("big");
+} else {
+  console.log("small");
+}
+
+for (let i = 0; i < 3; i++) {
+  console.log(i);
+}
+```
+
+---
+
+## File Naming
+
+Files starting with `_` are excluded from compilation (useful for partials/utilities).
+
+```
+src/
+  index.nsjs       ← compiled
+  _helpers.nsjs    ← skipped
+```
+
+---
+
+## Links
+
+- [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=otoneko1102.noshift-vscode)
+- [Website](https://noshift.js.org)
+- [Repository](https://github.com/otoneko1102/NoShift.js)
+
+---
+
+## License
+
+MIT © otoneko.

package/bin/cli.js

@@ -1,11 +1,57 @@
-#!/usr/bin/env node
-
-import create from "../commands/create.js";
-
-const command = process.argv[2];
-
-if (command === "create") {
-  create();
-} else {
-  console.log("Unknown command.");
-}
+#!/usr/bin/env node
+
+import { Command } from "commander";
+import { readFileSync } from "fs";
+import { fileURLToPath } from "url";
+import path from "path";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const pkg = JSON.parse(
+  readFileSync(path.join(__dirname, "../package.json"), "utf-8"),
+);
+
+const program = new Command();
+
+// nsc [options]  ←  デフォルト動作: compile
+program
+  .name("nsc")
+  .description("NoShift.js compiler")
+  .version(pkg.version)
+  .option("-w, --watch", "Watch for file changes and recompile")
+  .option("--init", "Create a nsjsconfig.json in the current directory")
+  .option("--clean", "Delete the output directory (outDir)")
+  .action(async (options) => {
+    if (options.init) {
+      const { default: init } = await import("../commands/init.js");
+      await init();
+    } else if (options.clean) {
+      const { default: clean } = await import("../commands/clean.js");
+      await clean();
+    } else if (options.watch) {
+      const { default: dev } = await import("../commands/dev.js");
+      await dev();
+    } else {
+      const { default: compile } = await import("../commands/compile.js");
+      await compile();
+    }
+  });
+
+// nsc run <file>
+program
+  .command("run <file>")
+  .description("Run a .nsjs file directly")
+  .action(async (file) => {
+    const { default: run } = await import("../commands/run.js");
+    await run(file);
+  });
+
+// nsc create [name]  ← 対話式プロジェクト作成
+program
+  .command("create [name]")
+  .description("Scaffold a new NoShift.js project interactively")
+  .action(async (name) => {
+    const { default: create } = await import("../commands/create.js");
+    await create(name);
+  });
+
+program.parse();

package/commands/clean.js

@@ -0,0 +1,29 @@
+import { rm, access } from "fs/promises";
+import path from "path";
+import { loadConfig } from "../src/config.js";
+
+export default async function clean() {
+  const cwd = process.cwd();
+
+  let config;
+  try {
+    config = await loadConfig(cwd);
+  } catch (e) {
+    console.error(`error NS0: ${e.message}`);
+    process.exit(1);
+  }
+
+  const outDir = path.resolve(cwd, config.compilerOptions.outDir);
+
+  try {
+    await access(outDir);
+  } catch {
+    console.log(
+      `Nothing to clean ('${config.compilerOptions.outDir}' does not exist).`,
+    );
+    return;
+  }
+
+  await rm(outDir, { recursive: true, force: true });
+  console.log(`Deleted '${config.compilerOptions.outDir}'.`);
+}