create-loutre 0.1.0 → 0.3.0

package/README.md

@@ -0,0 +1,65 @@
+# create-loutre
+
+Loutre Applicationをstarterから作成するproject initializerです。Runtime targetとpackage managerを選び、開発・test・buildまで始められるprojectを生成します。
+
+## Quick Start
+
+```sh
+npm create loutre@latest my-app
+```
+
+BunやDenoからも実行できます。
+
+```sh
+bun create loutre my-app
+deno x -A npm:create-loutre@latest my-app
+```
+
+対話形式でtargetとpackage managerを選択できます。
+
+## Targets
+
+- Node.js
+- Bun
+- Deno
+- Cloudflare Workers
+- AWS Lambda
+
+## Package managers
+
+- npm
+- pnpm
+- Yarn
+- Bun
+- Deno
+
+## Non-interactive usage
+
+Targetとpackage managerはoptionで指定できます。
+
+```sh
+npm create loutre@latest my-app -- --target cloudflare-workers --package-manager pnpm
+```
+
+主なoption:
+
+| Option                                | Description                   |
+| ------------------------------------- | ----------------------------- |
+| `--target <target>`                   | Runtime targetを指定          |
+| `--package-manager <package-manager>` | package managerを指定         |
+| `--yes`                               | 未指定項目にdefaultを使用     |
+| `--no-install`                        | dependency installationをskip |
+
+## Generated project
+
+starterにはTypeScript configurationに加えて、Vitest、Oxlint、Oxfmtとsample testが含まれます。生成したprojectでは`verify` scriptからformat、lint、type / Application Graph check、test、target固有buildをまとめて実行できます。
+
+## Documentation
+
+- [Getting Started](https://github.com/come25136/loutrejs/blob/main/docs/getting-started.md)
+- [Examples](https://github.com/come25136/loutrejs/tree/main/examples)
+- [Loutre](https://github.com/come25136/loutrejs)
+
+## License
+
+[MIT](https://github.com/come25136/loutrejs/blob/main/LICENSE)

package/dist/app.js

@@ -31,7 +31,7 @@ async function assertTargetIsEmpty(targetDirectory) {
     try {
         const entries = await readdir(targetDirectory);
         if (entries.length > 0) {
-            throw new Error(`生成先が空ではありません: ${targetDirectory}`);
+            throw new Error(`Target directory is not empty: ${targetDirectory}`);
         }
     }
     catch (error) {
@@ -56,7 +56,7 @@ function packageNameFor(targetDirectory) {
         name.length > 214 ||
         name.startsWith('.') ||
         name.startsWith('_')) {
-        throw new Error(`npm package名を生成できません: ${targetDirectory}`);
+        throw new Error(`Could not derive an npm package name from: ${targetDirectory}`);
     }
     return name;
 }

package/dist/cli.d.ts

@@ -1,3 +1,4 @@
+import { type PresentationRenderOptions } from '@loutrejs/loutre/presentation';
 import { type PackageManager } from './options.js';
 interface SelectOption {
     readonly value: string;
@@ -6,6 +7,7 @@ interface SelectOption {
 export interface CreateLoutreCliIO {
     readonly cwd: string;
     readonly detectedPackageManager?: PackageManager;
+    readonly terminal?: PresentationRenderOptions;
     readonly prompt?: (message: string, initialValue: string) => Promise<string | undefined>;
     readonly select?: (message: string, options: readonly SelectOption[], initialValue: string) => Promise<string | undefined>;
     readonly install: (directory: string, packageManager: PackageManager) => Promise<number>;

package/dist/cli.js

@@ -3,6 +3,7 @@ import { relative } from 'node:path';
 import { isCancel, select, text } from '@clack/prompts';
 import { Command, CommanderError, Option } from 'commander';
 import { bootstrap } from '@loutrejs/loutre/host';
+import { detectPresentationTerminal, renderLoutreBrand, } from '@loutrejs/loutre/presentation';
 import application, { createProject } from './app.js';
 import { installCommand, packageManagerLabels, packageManagers, projectTargets, runScriptCommand, targetLabels, } from './options.js';
 export async function runCreateLoutre(args, io = createProcessIO()) {
@@ -16,6 +17,7 @@ export async function runCreateLoutre(args, io = createProcessIO()) {
         io.stdout(helpText());
         return 0;
     }
+    io.stdout(renderLoutreBrand(io.terminal ?? { isTTY: false, color: false }));
     const directory = await resolveDirectory(parsed.directory, parsed.yes, io);
     if (!directory)
         return 2;
@@ -33,20 +35,20 @@ export async function runCreateLoutre(args, io = createProcessIO()) {
             packageManager,
             target,
         });
-        io.stdout(`Loutre Applicationを作成しました: ${result.targetDirectory}`);
+        io.stdout(`Created Loutre Application: ${result.targetDirectory}`);
         io.stdout(`Target: ${targetLabels[target]}`);
         io.stdout(`Package manager: ${packageManagerLabels[packageManager]}`);
         if (parsed.install) {
-            io.stdout('依存関係をインストールします。');
+            io.stdout('Installing dependencies...');
             const installCode = await io.install(result.targetDirectory, packageManager);
             if (installCode !== 0) {
-                io.stderr(`${installCommand(packageManager)}に失敗しました。生成したファイルは残しています。`);
+                io.stderr(`${installCommand(packageManager)} failed. Generated files have been kept.`);
                 return installCode;
             }
         }
         const nextDirectory = relative(io.cwd, result.targetDirectory);
         io.stdout('');
-        io.stdout('次のコマンド:');
+        io.stdout('Next steps:');
         if (nextDirectory && nextDirectory !== '.') {
             io.stdout(`  cd ${quoteShellArgument(nextDirectory)}`);
         }
@@ -77,9 +79,9 @@ function parseArgs(args) {
         .addOption(new Option('--package-manager <package-manager>').choices([
         ...packageManagers,
     ]))
-        .option('-y, --yes', '未指定の選択肢に既定値を使用する')
-        .option('--no-install', '依存関係をinstallしない')
-        .option('-h, --help', 'helpを表示する')
+        .option('-y, --yes', 'Use defaults for unspecified options')
+        .option('--no-install', 'Skip dependency installation')
+        .option('-h, --help', 'Show help')
         .allowExcessArguments(false);
     try {
         command.parse(args.filter((value) => value !== '--'), { from: 'user' });
@@ -108,7 +110,7 @@ async function resolveDirectory(requested, yes, io) {
     if (yes)
         return 'loutre-app';
     if (!io.prompt) {
-        io.stderr('生成先を指定してください。例: npm create loutre@latest my-app');
+        io.stderr('Specify a target directory. Example: npm create loutre@latest my-app');
         return undefined;
     }
     const answer = await io.prompt('Project name', 'loutre-app');
@@ -141,6 +143,7 @@ function createProcessIO() {
     return {
         cwd: process.cwd(),
         detectedPackageManager: detectPackageManager(process.env.npm_config_user_agent, globalThis),
+        terminal: detectPresentationTerminal(process.stdout, process.env),
         ...(interactive ? { prompt: terminalPrompt, select: terminalSelect } : {}),
         install: installDependencies,
         stdout: (value) => process.stdout.write(`${value}\n`),
@@ -201,8 +204,8 @@ function helpText() {
         'Options:',
         '  --target <target>                    node | bun | deno | cloudflare-workers | aws-lambda',
         '  --package-manager <package-manager>  npm | pnpm | yarn | bun | deno',
-        '  -y, --yes                            未指定の選択肢に既定値を使用する',
-        '  --no-install                         依存関係をinstallしない',
-        '  -h, --help                           helpを表示する',
+        '  -y, --yes                            Use defaults for unspecified options',
+        '  --no-install                         Skip dependency installation',
+        '  -h, --help                           Show help',
     ].join('\n');
 }

package/dist/starter.js

@@ -8,7 +8,7 @@ const loutreVersion = requiredDependencyVersion('@loutrejs/loutre');
 function requiredDependencyVersion(name) {
     const version = packageManifest.dependencies[name];
     if (!version)
-        throw new Error(`${name}のversionがpackage.jsonにありません。`);
+        throw new Error(`${name} version is missing from package.json.`);
     return version;
 }
 const baseTemplateDirectory = fileURLToPath(new URL('../templates/base/', import.meta.url));
@@ -136,9 +136,9 @@ function renderPackageJson(options) {
 function developmentSection(options) {
     if (options.target === 'aws-lambda') {
         return [
-            '## 開発',
+            '## Development',
             '',
-            'Lambda targetはlocal HTTP listenerを起動しません。Applicationの挙動はtestで確認します。',
+            'The Lambda target does not start a local HTTP listener. Verify Application behavior with tests.',
             '',
             '```sh',
             runScriptCommand(options.packageManager, 'test:watch'),
@@ -146,15 +146,15 @@ function developmentSection(options) {
         ].join('\n');
     }
     return [
-        '## 開発',
+        '## Development',
         '',
         '```sh',
         runScriptCommand(options.packageManager, 'dev'),
         '```',
         '',
         options.target === 'cloudflare-workers'
-            ? 'WranglerがlocalのCloudflare Workers環境を起動します。'
-            : '<http://127.0.0.1:3000> へアクセスするとJSONレスポンスを返します。',
+            ? 'Wrangler starts a local Cloudflare Workers environment.'
+            : 'Open <http://127.0.0.1:3000> to receive a JSON response.',
     ].join('\n');
 }
 function deploymentSection(options) {
@@ -175,7 +175,7 @@ function deploymentSection(options) {
             runScriptCommand(options.packageManager, 'build'),
             '```',
             '',
-            '`dist/index.mjs`の`handler`をAWS Lambdaのhandlerとしてdeployします。',
+            'Deploy the `handler` export from `dist/index.mjs` as the AWS Lambda handler.',
         ].join('\n');
     }
     return [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-loutre",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Loutre project initializer",
   "license": "MIT",
   "type": "module",
@@ -18,7 +18,7 @@
   },
   "dependencies": {
     "@clack/prompts": "^1.7.0",
-    "@loutrejs/loutre": "^0.1.0",
+    "@loutrejs/loutre": "^0.3.0",
     "commander": "^15.0.0"
   },
   "repository": {

package/templates/base/README.md

@@ -1,10 +1,10 @@
 # Loutre Application
 
-Loutreで作成した{{targetLabel}}向けApplicationです。
+A Loutre Application for {{targetLabel}}.
 
 {{developmentSection}}
 
-## 検証
+## Verify
 
 ```sh
 {{verifyCommand}}

package/templates/base/src/app.test.ts

@@ -2,7 +2,7 @@ import { bootstrap } from '@loutrejs/loutre/host'
 import { expect, it } from 'vitest'
 import application from './app.js'
 
-it('GET / がLoutre Applicationのレスポンスを返す', async () => {
+it('GET / returns a response from the Loutre Application', async () => {
   const app = bootstrap({ application })
   try {
     const response = await app.fetch(new Request('http://localhost/'))

package/templates/base/src/app.ts

@@ -3,34 +3,26 @@ import {
   defineApplication,
   defineModule,
   implementation,
-  procedure,
 } from '@loutrejs/loutre'
 import { http } from '@loutrejs/loutre/http'
 import { z } from 'zod'
-
-const AppContract = contract(
-  {
-    hello: procedure({
-      protocols: {
-        http: http({
-          method: 'GET',
-          path: '/',
-          responses: {
-            ok: {
-              status: 200,
-              body: z.object({
-                message: z.string(),
-              }),
-            },
-          },
-          pipeline: [http.controller],
-        }),
+const AppContract = contract([
+  http({
+    hello: {
+      method: 'GET',
+      path: '/',
+      responses: {
+        ok: {
+          status: 200,
+          body: z.object({
+            message: z.string(),
+          }),
+        },
       },
-    }),
-  },
-  { name: 'AppContract' },
-)
-
+      pipeline: [http.controller],
+    },
+  }),
+])
 const AppController = implementation({
   name: 'AppController',
   contract: AppContract,
@@ -43,13 +35,11 @@ const AppController = implementation({
     },
   }),
 })
-
 const AppModule = defineModule(() => ({
   name: 'AppModule',
-  description: 'HTTP Applicationのentry module',
+  description: 'HTTP Application entry module',
   implementations: [AppController],
 }))
-
 export default defineApplication({
   modules: [AppModule()],
 })

package/templates/targets/bun/src/main.ts

@@ -1,10 +1,4 @@
 import { bunRuntime } from '@loutrejs/loutre/runtime/bun'
 import application from './app.js'
 
-await bunRuntime.serve({
-  application,
-  hostname: '127.0.0.1',
-  port: 3000,
-})
-
-console.log('Loutre is swimming at http://127.0.0.1:3000')
+await bunRuntime.serve({ application })

package/templates/targets/deno/src/main.ts

@@ -1,10 +1,4 @@
 import { denoRuntime } from '@loutrejs/loutre/runtime/deno'
 import application from './app.ts'
 
-await denoRuntime.serve({
-  application,
-  hostname: '127.0.0.1',
-  port: 3000,
-})
-
-console.log('Loutre is swimming at http://127.0.0.1:3000')
+await denoRuntime.serve({ application })

package/templates/targets/node/src/main.ts

@@ -1,16 +1,4 @@
 import { nodeRuntime } from '@loutrejs/node'
 import application from './app.js'
 
-const server = await nodeRuntime.serve({
-  application,
-  hostname: '127.0.0.1',
-  port: 3000,
-})
-
-console.log('Loutre is swimming at http://127.0.0.1:3000')
-
-for (const signal of ['SIGINT', 'SIGTERM'] as const) {
-  process.once(signal, () => {
-    void server.close(signal)
-  })
-}
+await nodeRuntime.serve({ application })