noshift.js 0.8.0 → 0.10.0

package/README-ja.md

@@ -21,38 +21,56 @@
 
 ## インストール
 
+### グローバルインストール
+
 ```bash
 npm install -g noshift.js@latest
 ```
 
+### ローカルインストール
+
+```bash
+npm install -D noshift.js@latest
+```
+
 ---
 
 ## はじめに
 
 ```bash
 # 新しいプロジェクトを作成
+
+# グローバル
 nsc create my-project
 
+# ローカル
+npx nsc create my-project
+
 # または、現在のディレクトリに nsjsconfig.json だけを作成
+
+# グローバル
 nsc init
+
+# ローカル
+npx nsc init
 ```
 
 ---
 
 ## CLI リファレンス
 
-`nsc` は TypeScript の `tsc` に似た使い心地を目指しています。
+`nsc` は NoShift.js のコンパイラ CLI です。
 
 | コマンド | エイリアス | 説明 |
 |---|---|---|
-| `nsc` | | `nsjsconfig.json` を使って `.nsjs` → `.js` にコンパイル |
-| `nsc watch` | `nsc -w` `nsc --watch` | 変更を監視して自動的に再コンパイル |
-| `nsc init` | `nsc --init` | 現在のディレクトリに `nsjsconfig.json` を作成 |
-| `nsc clean` | `nsc --clean` | 出力ディレクトリ (`outdir`) を削除 |
-| `nsc run <file>` | `nsc -r <file>` `nsc --run <file>` | `.nsjs` ファイルを直接実行 |
-| `nsc create [name]` | `nsc --create [name]` | 新しいプロジェクトを作成（`--no-prettier` で Prettier スキップ） |
-| `nsc version` | `nsc -v` `nsc --version` | バージョンを表示 |
-| `nsc help` | `nsc -h` `nsc --help` | ヘルプを表示 |
+| `nsc` / `npx nsc` | | `nsjsconfig.json` を使って `.nsjs` → `.js` にコンパイル |
+| `nsc watch` / `npx nsc watch` | `nsc -w` `nsc --watch` | 変更を監視して自動的に再コンパイル |
+| `nsc init` / `npx nsc init` | `nsc --init` | 現在のディレクトリに `nsjsconfig.json` を作成 |
+| `nsc clean` / `npx nsc clean` | `nsc --clean` | 出力ディレクトリ (`outdir`) を削除 |
+| `nsc run <file>` / `npx nsc run <file>` | `nsc -r <file>` `nsc --run <file>` | `.nsjs` ファイルを直接実行 |
+| `nsc create [name]` / `npx nsc create [name]` | `nsc --create [name]` | 新しいプロジェクトを作成（`--no-prettier` で Prettier スキップ） |
+| `nsc version` / `npx nsc version` | `nsc -v` `nsc --version` | バージョンを表示 |
+| `nsc help` / `npx nsc help` | `nsc -h` `nsc --help` | ヘルプを表示 |
 
 ---
 
@@ -280,6 +298,55 @@ for (let i = 0; i < 3; i++) {
 
 ---
 
+## プログラマティック API
+
+コード内からライブラリとして `.nsjs` コードをコンパイルできます。
+
+### ESM
+
+```js
+import { compile } from "noshift.js";
+
+const result = compile('console.log^8^2^3hello^2^9;');
+console.log(result.outputText);
+// => console.log("Hello");
+```
+
+### CJS
+
+```js
+const { compile } = require("noshift.js");
+
+const result = compile('console.log^8^2^3hello^2^9;');
+console.log(result.outputText);
+// => console.log("Hello");
+```
+
+### オプション
+
+```js
+const result = compile(source, {
+  capitalizeInStrings: false, // 文字列内の ^3 を無効化
+});
+```
+
+### 構文診断
+
+`diagnose()` を使ってコンパイル前に構文エラーをチェックできます:
+
+```js
+import { diagnose } from "noshift.js";
+
+const errors = diagnose(source);
+if (errors.length > 0) {
+  for (const e of errors) {
+    console.error(`Line ${e.line}:${e.column} - ${e.message}`);
+  }
+}
+```
+
+---
+
 ## ファイル名の規則
 
 `_` で始まるファイルはコンパイル対象から除外されます（パーシャル・ユーティリティ用途に便利）。

package/README.md

@@ -22,38 +22,56 @@ Typing shifted symbols (`!`, `"`, `(`, `)`, `{`, `}` …) is tiring.
 
 ## Installation
 
+### Global Install
+
 ```bash
 npm install -g noshift.js@latest
 ```
 
+### Local Install
+
+```bash
+npm install -D noshift.js@latest
+```
+
 ---
 
 ## Getting Started
 
 ```bash
 # Create a new project
+
+# Global
 nsc create my-project
 
+# Local
+npx nsc create my-project
+
 # Or initialize only a nsjsconfig.json in the current directory
+
+# Global
 nsc init
+
+# Local
+npx nsc init
 ```
 
 ---
 
 ## CLI Reference
 
-`nsc` is designed to feel like TypeScript's `tsc`.
+`nsc` is the NoShift.js compiler CLI.
 
 | Command | Alias | Description |
 |---|---|---|
-| `nsc` | | Compile `.nsjs` → `.js` using `nsjsconfig.json` |
-| `nsc watch` | `nsc -w` `nsc --watch` | Watch for changes and recompile automatically |
-| `nsc init` | `nsc --init` | Create `nsjsconfig.json` in the current directory |
-| `nsc clean` | `nsc --clean` | Delete the output directory (`outdir`) |
-| `nsc run <file>` | `nsc -r <file>` `nsc --run <file>` | Run a `.nsjs` file directly |
-| `nsc create [name]` | `nsc --create [name]` | Scaffold a new project (`--no-prettier` to skip Prettier) |
-| `nsc version` | `nsc -v` `nsc --version` | Show version |
-| `nsc help` | `nsc -h` `nsc --help` | Show help |
+| `nsc` / `npx nsc` | | Compile `.nsjs` → `.js` using `nsjsconfig.json` |
+| `nsc watch` / `npx nsc watch` | `nsc -w` `nsc --watch` | Watch for changes and recompile automatically |
+| `nsc init` / `npx nsc init` | `nsc --init` | Create `nsjsconfig.json` in the current directory |
+| `nsc clean` / `npx nsc clean` | `nsc --clean` | Delete the output directory (`outdir`) |
+| `nsc run <file>` / `npx nsc run <file>` | `nsc -r <file>` `nsc --run <file>` | Run a `.nsjs` file directly |
+| `nsc create [name]` / `npx nsc create [name]` | `nsc --create [name]` | Scaffold a new project (`--no-prettier` to skip Prettier) |
+| `nsc version` / `npx nsc version` | `nsc -v` `nsc --version` | Show version |
+| `nsc help` / `npx nsc help` | `nsc -h` `nsc --help` | Show help |
 
 ---
 
@@ -281,6 +299,55 @@ for (let i = 0; i < 3; i++) {
 
 ---
 
+## Programmatic API
+
+You can use NoShift.js as a library to compile `.nsjs` code from within your own scripts.
+
+### ESM
+
+```js
+import { compile } from "noshift.js";
+
+const result = compile('console.log^8^2^3hello^2^9;');
+console.log(result.outputText);
+// => console.log("Hello");
+```
+
+### CJS
+
+```js
+const { compile } = require("noshift.js");
+
+const result = compile('console.log^8^2^3hello^2^9;');
+console.log(result.outputText);
+// => console.log("Hello");
+```
+
+### Options
+
+```js
+const result = compile(source, {
+  capitalizeInStrings: false, // Disable ^3 inside strings
+});
+```
+
+### Syntax Diagnostics
+
+Use `diagnose()` to check for syntax errors before compiling:
+
+```js
+import { diagnose } from "noshift.js";
+
+const errors = diagnose(source);
+if (errors.length > 0) {
+  for (const e of errors) {
+    console.error(`Line ${e.line}:${e.column} - ${e.message}`);
+  }
+}
+```
+
+---
+
 ## File Naming
 
 Files starting with `_` are excluded from compilation (useful for partials/utilities).

package/commands/compile.js

@@ -1,6 +1,6 @@
 import { promises as fs } from "fs";
 import path from "path";
-import convert, { checkUppercaseWarnings } from "../src/convert.js";
+import convert, { checkUppercaseWarnings, diagnose } from "../src/convert.js";
 import { loadConfig } from "../src/config.js";
 import { handleSigint } from "../src/signal-handler.js";
 import * as logger from "../src/logger.js";
@@ -74,6 +74,19 @@ export default async function compile() {
     try {
       const code = await fs.readFile(file, "utf-8");
 
+      // 構文エラーチェック
+      const syntaxErrors = diagnose(code);
+      if (syntaxErrors.length > 0) {
+        for (const e of syntaxErrors) {
+          logger.errorCode(
+            "NS1",
+            `${relative.replace(/\\/g, "/")}:${e.line}:${e.column} - ${e.message}`,
+          );
+        }
+        errors += syntaxErrors.length;
+        continue;
+      }
+
       // 大文字警告チェック
       if (warnUppercase) {
         const warnings = checkUppercaseWarnings(code, convertOptions);

package/commands/create.js

@@ -42,12 +42,14 @@ export default async function create(projectNameArg, options = {}) {
   // Add scripts to package.json
   const pkgPath = path.join(projectPath, "package.json");
   const pkg = JSON.parse(await fs.readFile(pkgPath, "utf-8"));
-  pkg.scripts = pkg.scripts ?? {};
-  pkg.scripts.compile = "nsc";
-  pkg.scripts.dev = "nsc watch";
+  pkg.scripts = {};
   if (usePrettier) {
     pkg.scripts.format = "prettier --write ./src";
   }
+  pkg.scripts.compile = "nsc";
+  pkg.scripts.dev = "nsc watch";
+  pkg.scripts.clean = "nsc clean";
+  pkg.scripts.script = "nsc run";
   await fs.writeFile(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
 
   // Create nsjsconfig.json

package/commands/dev.js

@@ -1,6 +1,6 @@
 import { promises as fs, watch } from "fs";
 import path from "path";
-import convert from "../src/convert.js";
+import convert, { diagnose } from "../src/convert.js";
 import { loadConfig } from "../src/config.js";
 import { handleSigint } from "../src/signal-handler.js";
 import * as logger from "../src/logger.js";
@@ -35,6 +35,17 @@ async function compileFile(file, rootDir, outDir, cwd, convertOptions = {}) {
     .join(outDir, path.relative(rootDir, file))
     .replace(/\.nsjs$/, ".js");
   const code = await fs.readFile(file, "utf-8");
+
+  // 構文エラーチェック
+  const syntaxErrors = diagnose(code);
+  if (syntaxErrors.length > 0) {
+    const rel = relative;
+    for (const e of syntaxErrors) {
+      logger.errorCode("NS1", `${rel}:${e.line}:${e.column} - ${e.message}`);
+    }
+    throw new Error(`${syntaxErrors.length} syntax error(s)`);
+  }
+
   const js = convert(code, convertOptions);
   await fs.mkdir(path.dirname(destPath), { recursive: true });
   await fs.writeFile(destPath, js, "utf-8");

package/commands/run.js

@@ -1,14 +1,23 @@
 import { promises as fs } from "fs";
 import path from "path";
 import { spawn } from "child_process";
-import convert from "../src/convert.js";
+import convert, { diagnose } from "../src/convert.js";
 import { loadConfig } from "../src/config.js";
 import { handleSigint } from "../src/signal-handler.js";
 import * as logger from "../src/logger.js";
+import { askInput } from "../src/prompt.js";
 
 export default async function run(file) {
   handleSigint();
 
+  if (!file) {
+    file = await askInput("File path");
+    if (!file) {
+      logger.error("File path is required.");
+      process.exit(1);
+    }
+  }
+
   const cwd = process.cwd();
   let config;
   try {
@@ -31,6 +40,17 @@ export default async function run(file) {
     process.exit(1);
   }
 
+  // 構文エラーチェック
+  const syntaxErrors = diagnose(code);
+  if (syntaxErrors.length > 0) {
+    const relative = path.relative(cwd, filePath).replace(/\\/g, "/");
+    for (const e of syntaxErrors) {
+      logger.errorCode("NS1", `${relative}:${e.line}:${e.column} - ${e.message}`);
+    }
+    logger.error(`Found ${syntaxErrors.length} syntax error(s).`);
+    process.exit(1);
+  }
+
   const js = convert(code, convertOptions);
 
   // ソースファイルと同じディレクトリに一時ファイルを作成する。

package/package.json

@@ -1,10 +1,17 @@
 {
   "name": "noshift.js",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "Joke language.",
   "bin": {
     "nsc": "./bin/cli.js"
   },
+  "main": "./src/index.cjs",
+  "exports": {
+    ".": {
+      "import": "./src/index.js",
+      "require": "./src/index.cjs"
+    }
+  },
   "type": "module",
   "scripts": {
     "compile": "node commands/compile.js",