noshift.js 0.2.1 → 0.4.0

package/README-ja.md

@@ -1,10 +1,21 @@
-# noshift.js
+[![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)
+
+# 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>
 
 > 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)
+記号 (`!`, `"`, `(`, `)`, `{`, `}` …) を入力するときに Shift を押すのが面倒なので、Shift を押さずに JavaScript が書けるようにした Joke 言語です。  
+`^` プレフィックスのシーケンスで Shift が必要な記号を表現し、`.nsjs` ファイルは `nsc` CLI を使って JavaScript にコンパイルされます。
 
 ---
 
@@ -19,11 +30,11 @@ npm install -g noshift.js@latest
 ## はじめに
 
 ```bash
-# インタラクティブなプロジェクトスキャフォールド
-nsc create
+# 新しいプロジェクトを作成
+nsc create my-project
 
 # または、現在のディレクトリに nsjsconfig.json だけを作成
-nsc --init
+nsc init
 ```
 
 ---
@@ -32,37 +43,41 @@ nsc --init
 
 `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` | ヘルプを表示 |
+| コマンド | エイリアス | 説明 |
+|---|---|---|
+| `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` | ヘルプを表示 |
 
 ---
 
 ## nsjsconfig.json
 
 プロジェクトルートに `nsjsconfig.json` を置くとコンパイル設定を行えます。
-`nsc --init` または `nsc create` で自動生成されます。
+`nsc init` または `nsc create` で自動生成されます。
 
 ```json
 {
-  "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "build"
+  "compileroptions": {
+    "rootdir": "src",
+    "outdir": "dist",
+    "warnuppercase": true,
+    "capitalizeinstrings": true
   }
 }
 ```
 
 | オプション | デフォルト | 説明 |
 |---|---|---|
-| `compilerOptions.rootDir` | `"src"` | ソースディレクトリ |
-| `compilerOptions.outDir` | `"build"` | 出力ディレクトリ |
+| `compileroptions.rootdir` | `"src"` | ソースディレクトリ |
+| `compileroptions.outdir` | `"dist"` | 出力ディレクトリ |
+| `compileroptions.warnuppercase` | `true` | ソースコード内の大文字を警告 |
+| `compileroptions.capitalizeinstrings` | `true` | 文字列リテラル内で `^3` 大文字化修飾子を有効にする |
 
 ---
 
@@ -76,14 +91,14 @@ nsc --init
 |:-------:|:--:|---|:-------:|:--:|
 | `^1`    | `!`        | | `^^`    | `~`        |
 | `^2`    | `"`        | | `^\`    | `\|`       |
-| `^4`    | `$`        | | `^@`    | `` ` ``    |
-| `^5`    | `%`        | | `^[`    | `{`        |
-| `^6`    | `&`        | | `^]`    | `}`        |
-| `^7`    | `'`        | | `^;`    | `+`        |
-| `^8`    | `(`        | | `^:`    | `*`        |
-| `^9`    | `)`        | | `^,`    | `<`        |
-| `^-`    | `=`        | | `^.`    | `>`        |
-|         |            | | `^/`    | `?`        |
+| `^3x`   | `X`（大文字化） | | `^@`    | `` ` ``    |
+| `^4`    | `$`        | | `^[`    | `{`        |
+| `^5`    | `%`        | | `^]`    | `}`        |
+| `^6`    | `&`        | | `^;`    | `+`        |
+| `^7`    | `'`        | | `^:`    | `*`        |
+| `^8`    | `(`        | | `^,`    | `<`        |
+| `^9`    | `)`        | | `^.`    | `>`        |
+| `^-`    | `=`        | | `^/`    | `?`        |
 
 テンプレート式: `^4^[` → `${`
 
@@ -101,6 +116,44 @@ console.log^8^2Hello, World!^2^9;
 console.log("Hello, World!");
 ```
 
+### 大文字化修飾子
+
+`^3` は次の文字を大文字にします:
+
+```nsjs
+class ^3animal ^[
+^]
+```
+
+```js
+class Animal {
+}
+```
+
+### コメント
+
+```nsjs
+// 行コメント
+
+/^: ブロックコメント ^:/
+
+/^:
+  複数行の
+  ブロックコメント
+^:/
+```
+
+```js
+// 行コメント
+
+/* ブロックコメント */
+
+/*
+  複数行の
+  ブロックコメント
+*/
+```
+
 ### 変数とアロー関数
 
 ```nsjs
@@ -165,7 +218,7 @@ const arr = [1, 2, 3];
 ### クラス
 
 ```nsjs
-class Animal ^[
+class ^3animal ^[
   constructor^8name^9 ^[
     this.name ^- name;
   ^]
@@ -175,7 +228,7 @@ class Animal ^[
   ^]
 ^]
 
-const dog ^- new Animal^8^2Dog^2^9;
+const dog ^- new ^3animal^8^2Dog^2^9;
 dog.speak^8^9;
 ```
 

package/README.md

@@ -1,10 +1,22 @@
-# noshift.js
+[![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)
+
+# 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 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)
+Typing shifted symbols (`!`, `"`, `(`, `)`, `{`, `}` …) is tiring.  
+**NoShift.js** replaces every shift-required symbol with a `^`-prefixed sequence, so you can write JavaScript using only unshifted keys.  
+`.nsjs` files compile directly to plain JavaScript via the `nsc` CLI.
 
 ---
 
@@ -19,11 +31,11 @@ npm install -g noshift.js@latest
 ## Getting Started
 
 ```bash
-# Interactive full project scaffold
-nsc create
+# Create a new project
+nsc create my-project
 
 # Or initialize only a nsjsconfig.json in the current directory
-nsc --init
+nsc init
 ```
 
 ---
@@ -32,37 +44,41 @@ nsc --init
 
 `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 |
+| 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 |
 
 ---
 
 ## nsjsconfig.json
 
 Place a `nsjsconfig.json` at the project root to configure compilation.
-Generated automatically by `nsc --init` or `nsc create`.
+Generated automatically by `nsc init` or `nsc create`.
 
 ```json
 {
-  "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "build"
+  "compileroptions": {
+    "rootdir": "src",
+    "outdir": "dist",
+    "warnuppercase": true,
+    "capitalizeinstrings": true
   }
 }
 ```
 
 | Option | Default | Description |
 |---|---|---|
-| `compilerOptions.rootDir` | `"src"` | Source directory |
-| `compilerOptions.outDir` | `"build"` | Output directory |
+| `compileroptions.rootdir` | `"src"` | Source directory |
+| `compileroptions.outdir` | `"dist"` | Output directory |
+| `compileroptions.warnuppercase` | `true` | Warn about uppercase characters in source code |
+| `compileroptions.capitalizeinstrings` | `true` | Enable `^3` capitalize modifier inside string literals |
 
 ---
 
@@ -76,14 +92,14 @@ Generated automatically by `nsc --init` or `nsc create`.
 |:-------:|:--:|---|:-------:|:--:|
 | `^1`    | `!`        | | `^^`    | `~`        |
 | `^2`    | `"`        | | `^\`    | `\|`       |
-| `^4`    | `$`        | | `^@`    | `` ` ``    |
-| `^5`    | `%`        | | `^[`    | `{`        |
-| `^6`    | `&`        | | `^]`    | `}`        |
-| `^7`    | `'`        | | `^;`    | `+`        |
-| `^8`    | `(`        | | `^:`    | `*`        |
-| `^9`    | `)`        | | `^,`    | `<`        |
-| `^-`    | `=`        | | `^.`    | `>`        |
-|         |            | | `^/`    | `?`        |
+| `^3x`   | `X` (capitalize) | | `^@`    | `` ` ``    |
+| `^4`    | `$`        | | `^[`    | `{`        |
+| `^5`    | `%`        | | `^]`    | `}`        |
+| `^6`    | `&`        | | `^;`    | `+`        |
+| `^7`    | `'`        | | `^:`    | `*`        |
+| `^8`    | `(`        | | `^,`    | `<`        |
+| `^9`    | `)`        | | `^.`    | `>`        |
+| `^-`    | `=`        | | `^/`    | `?`        |
 
 Template expression: `^4^[` → `${`
 
@@ -101,6 +117,44 @@ console.log^8^2Hello, World!^2^9;
 console.log("Hello, World!");
 ```
 
+### Capitalize Modifier
+
+`^3` capitalizes the next character:
+
+```nsjs
+class ^3animal ^[
+^]
+```
+
+```js
+class Animal {
+}
+```
+
+### Comments
+
+```nsjs
+// line comment
+
+/^: block comment ^:/
+
+/^:
+  multi-line
+  block comment
+^:/
+```
+
+```js
+// line comment
+
+/* block comment */
+
+/*
+  multi-line
+  block comment
+*/
+```
+
 ### Variables & Arrow Functions
 
 ```nsjs
@@ -165,7 +219,7 @@ const arr = [1, 2, 3];
 ### Classes
 
 ```nsjs
-class Animal ^[
+class ^3animal ^[
   constructor^8name^9 ^[
     this.name ^- name;
   ^]
@@ -175,7 +229,7 @@ class Animal ^[
   ^]
 ^]
 
-const dog ^- new Animal^8^2Dog^2^9;
+const dog ^- new ^3animal^8^2Dog^2^9;
 dog.speak^8^9;
 ```
 

package/bin/cli.js

@@ -10,32 +10,52 @@ const pkg = JSON.parse(
   readFileSync(path.join(__dirname, "../package.json"), "utf-8"),
 );
 
+const DOCS_URL = "https://noshift.js.org/";
+
 const program = new Command();
 
-// nsc [options]  ←  デフォルト動作: compile
 program
   .name("nsc")
   .description("NoShift.js compiler")
-  .version(pkg.version, '-v, --version', 'output the version number')
+  .version(pkg.version, "-v, --version", "output the version number")
   .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)")
+  .option("--clean", "Delete the output directory (outdir)")
+  .option("-r, --run <file>", "Run a .nsjs file directly")
+  .option("--create [name]", "Scaffold a new NoShift.js project")
+  .addHelpText("after", `\nDocumentation: ${DOCS_URL}`)
   .action(async (options) => {
-    if (options.init) {
+    if (options.watch) {
+      const { default: dev } = await import("../commands/dev.js");
+      await dev();
+    } else 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 if (options.run) {
+      const { default: run } = await import("../commands/run.js");
+      await run(options.run);
+    } else if (options.create !== undefined) {
+      const { default: create } = await import("../commands/create.js");
+      await create(options.create || undefined);
     } else {
       const { default: compile } = await import("../commands/compile.js");
       await compile();
     }
   });
 
+// nsc watch
+program
+  .command("watch")
+  .alias("w")
+  .description("Watch for file changes and recompile")
+  .action(async () => {
+    const { default: dev } = await import("../commands/dev.js");
+    await dev();
+  });
+
 // nsc run <file>
 program
   .command("run <file>")
@@ -45,13 +65,49 @@ program
     await run(file);
   });
 
-// nsc create [name]  ← 対話式プロジェクト作成
+// nsc create [name]
 program
   .command("create [name]")
-  .description("Scaffold a new NoShift.js project interactively")
-  .action(async (name) => {
+  .description("Scaffold a new NoShift.js project")
+  .option("--prettier", "Include Prettier (default)")
+  .option("--no-prettier", "Skip Prettier setup")
+  .action(async (name, options) => {
     const { default: create } = await import("../commands/create.js");
-    await create(name);
+    await create(name, options);
+  });
+
+// nsc init
+program
+  .command("init")
+  .description("Create a nsjsconfig.json in the current directory")
+  .action(async () => {
+    const { default: init } = await import("../commands/init.js");
+    await init();
+  });
+
+// nsc clean
+program
+  .command("clean")
+  .description("Delete the output directory (outdir)")
+  .action(async () => {
+    const { default: clean } = await import("../commands/clean.js");
+    await clean();
+  });
+
+// nsc version
+program
+  .command("version")
+  .description("Display the current version")
+  .action(() => {
+    console.log(pkg.version);
+  });
+
+// nsc help
+program
+  .command("help")
+  .description("Show help information")
+  .action(() => {
+    program.outputHelp();
   });
 
 program.parse();

package/commands/clean.js

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

package/commands/compile.js

@@ -1,7 +1,9 @@
 import { promises as fs } from "fs";
 import path from "path";
-import convert from "../src/convert.js";
+import convert, { checkUppercaseWarnings } from "../src/convert.js";
 import { loadConfig } from "../src/config.js";
+import { handleSigint } from "../src/signal-handler.js";
+import * as logger from "../src/logger.js";
 
 async function findNsjsFiles(dir) {
   let entries;
@@ -25,30 +27,33 @@ async function findNsjsFiles(dir) {
 }
 
 export default async function compile() {
+  handleSigint();
+
   const cwd = process.cwd();
 
   let config;
   try {
     config = await loadConfig(cwd);
   } catch (e) {
-    console.error(`error TS0: ${e.message}`);
+    logger.errorCode("NS0", e.message);
     process.exit(1);
   }
 
-  const rootDir = path.resolve(cwd, config.compilerOptions.rootDir);
-  const outDir = path.resolve(cwd, config.compilerOptions.outDir);
+  const rootDir = path.resolve(cwd, config.compileroptions.rootdir);
+  const outDir = path.resolve(cwd, config.compileroptions.outdir);
 
   const files = await findNsjsFiles(rootDir);
 
   if (files === null) {
-    console.error(
-      `error NS0: rootDir '${config.compilerOptions.rootDir}' not found.`,
+    logger.errorCode(
+      "NS0",
+      `rootdir '${config.compileroptions.rootdir}' not found.`,
     );
     process.exit(1);
   }
 
   if (files.length === 0) {
-    console.log("No .nsjs files found.");
+    logger.info("No .nsjs files found.");
     return;
   }
 
@@ -56,6 +61,11 @@ export default async function compile() {
 
   let compiled = 0;
   let errors = 0;
+  let totalWarnings = 0;
+  const warnUppercase = config.compileroptions.warnuppercase !== false;
+  const convertOptions = {
+    capitalizeInStrings: config.compileroptions.capitalizeinstrings !== false,
+  };
 
   for (const file of files) {
     const relative = path.relative(rootDir, file);
@@ -63,27 +73,42 @@ export default async function compile() {
 
     try {
       const code = await fs.readFile(file, "utf-8");
-      const js = convert(code);
+
+      // 大文字警告チェック
+      if (warnUppercase) {
+        const warnings = checkUppercaseWarnings(code);
+        for (const w of warnings) {
+          logger.warn(
+            `${relative.replace(/\\/g, "/")}:${w.line}:${w.column} - ${w.message}`,
+          );
+          totalWarnings++;
+        }
+      }
+
+      const js = convert(code, convertOptions);
 
       await fs.mkdir(path.dirname(destPath), { recursive: true });
       await fs.writeFile(destPath, js, "utf-8");
 
-      console.log(
+      logger.dim(
         `  ${relative.replace(/\\/g, "/")} → ${path.relative(cwd, destPath).replace(/\\/g, "/")}`,
       );
       compiled++;
     } catch (e) {
-      console.error(
-        `  error NS1: ${relative.replace(/\\/g, "/")}: ${e.message}`,
-      );
+      logger.errorCode("NS1", `${relative.replace(/\\/g, "/")}: ${e.message}`);
       errors++;
     }
   }
 
+  console.log("");
   if (errors > 0) {
-    console.error(`\nFound ${errors} error(s). Compiled ${compiled} file(s).`);
+    logger.error(`Found ${errors} error(s). Compiled ${compiled} file(s).`);
     process.exit(1);
   } else {
-    console.log(`\nSuccessfully compiled ${compiled} file(s).`);
+    let msg = `Compiled ${compiled} file(s).`;
+    if (totalWarnings > 0) {
+      msg += ` (${totalWarnings} warning(s))`;
+    }
+    logger.success(msg);
   }
 }