create-inferative 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,70 @@
+Copyright (c) 2024 WP Online Magyarország Kft.
+Website: https://wpo.hu
+All Rights Reserved.
+
+==============================================================================
+WP Online Magyarország Kft. - Internal Use Software License
+==============================================================================
+
+This software package and its accompanying documentation (collectively, "the Software")
+are the proprietary and confidential information of WP Online Magyarország Kft.
+("the Company").
+
+1.  GRANT OF LICENSE:
+    Subject to the terms and conditions of this License, the Company grants to
+    its employees and authorized contractors ("Authorized Users") a non-exclusive,
+    non-transferable, revocable license to install, use, copy, and modify the
+    Software solely for internal Company business purposes.
+
+2.  RESTRICTIONS:
+    Authorized Users shall not:
+    a.  Distribute, sublicense, sell, rent, lease, lend, or otherwise transfer
+        the Software, or any part thereof, to any third party outside of
+        WP Online Magyarország Kft. without the express prior written permission
+        of an authorized representative of the Company.
+    b.  Use the Software for any purpose not expressly permitted by this License,
+        including any personal or commercial projects unrelated to the
+        Company's business.
+    c.  Remove or alter any copyright, trademark, or other proprietary notices
+        contained in the Software.
+    d.  Reverse engineer, decompile, or disassemble the Software, except and
+        only to the extent that such activity is expressly permitted by
+        applicable law notwithstanding this limitation.
+
+3.  OWNERSHIP AND INTELLECTUAL PROPERTY:
+    The Company retains all right, title, and interest in and to the Software,
+    including all copyrights, patents, trade secrets, trademarks, and other
+    intellectual property rights therein. No rights are granted to Authorized
+    Users other than those expressly set forth in this License.
+
+4.  CONFIDENTIALITY:
+    The Software, including its source code, design, and structure, is
+    confidential information of the Company. Authorized Users shall treat the
+    Software with the same degree of care as they treat other Company
+    confidential information and shall not disclose it to any third party
+    without the Company's prior written consent.
+
+5.  NO WARRANTY:
+    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 COMPANY 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.
+
+6.  TERMINATION:
+    This License will terminate automatically if an Authorized User breaches any
+    of its terms and conditions. The license granted herein is also contingent
+    upon continued employment or contract with the Company and terminates
+    immediately upon the cessation of that relationship. Upon termination, the
+    Authorized User must cease all use of the Software and destroy all copies
+
+    of the Software in their possession or control.
+
+7.  GOVERNING LAW:
+    This License shall be governed by and construed in accordance with the laws
+    of Hungary, without regard to its conflict of law principles. Any disputes
+    arising under or in connection with this License shall be subject to the
+        exclusive jurisdiction of the courts of Hungary.
+
+For questions regarding this license, please contact office@wpo.hu.

package/README.md

@@ -1,3 +1,54 @@
-# Temporary Holding Version
+# `create-inferative`
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Create a new Inferative project with nothing installed first. `npm create inferative` runs the same command as
+`inferative init`, so every flag works the same way.
+
+## Create a project
+
+Run one command for your package manager.
+
+```sh
+npm create inferative@latest my-site
+pnpm create inferative my-site
+yarn create inferative my-site
+bun create inferative my-site
+```
+
+The command writes the project into the folder `my-site`. Leave the name out to fill the current folder. The folder
+must not exist, or must be empty. The command never overwrites a file.
+
+## What it does
+
+1. It writes the `@inferative` and `@heximon` lines into the `.npmrc` of the project. Both scopes live on GitHub
+   Packages.
+2. It checks that npm can read both scopes. If it cannot, it removes what it wrote, prints the lines to add to your
+   `~/.npmrc`, and stops.
+3. It downloads the starter from the `inferative/starters` repository.
+4. It sets the `name` of the project and the version of `inferative` and of every `@inferative/*` package.
+5. It runs `pnpm install`.
+
+The package itself comes from public npm. Its dependencies come from GitHub Packages, so the command needs these
+lines in your `~/.npmrc` before it starts:
+
+```ini
+@inferative:registry=https://npm.pkg.github.com
+@heximon:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=<a GitHub token with the read:packages scope>
+```
+
+## Flags
+
+| Flag | What it does |
+| :-- | :-- |
+| `--starter <name>` | The starter to use. `nuxt-cloudflare` by default. |
+| `--source <giget source>` | Download this source instead of the default starters. |
+| `--local <folder>` | Copy the starter from this starters folder. Nothing is downloaded. |
+| `--no-install` | Do not run `pnpm install`. |
+| `--cwd <folder>` | The folder in which a named project folder is created. |
+
+`pnpm`, `yarn` and `bun` pass a `--` to this package. The package drops the first one, so
+`pnpm create inferative my-site -- --no-install` works as written.
+
+## Works with
+
+- [`inferative`](../cli) holds the `init` command. This package only runs it under the name `create-inferative`.

package/dist/bin.d.mts

@@ -0,0 +1 @@
+export {}

package/dist/bin.mjs

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+import { t as CreateFrontDoor } from "./front-door-Blirg1zz.mjs";
+import { runMain } from "citty";
+//#region src/bin.ts
+await runMain(CreateFrontDoor.command(), { rawArgs: [...CreateFrontDoor.rawArgs(process.argv.slice(2))] });
+//#endregion
+export {};

package/dist/front-door-Blirg1zz.mjs

@@ -0,0 +1,44 @@
+import { createRequire } from "node:module";
+import { InitCommand } from "inferative";
+//#region src/front-door.ts
+/**
+* The front door of `npm create inferative`.
+*
+* It reuses the arguments and the `run` of {@link InitCommand}, so the two names never differ. It sets its own
+* `meta`: `--help` then prints the binary that the user typed, and `--version` has a version to print.
+*/
+var CreateFrontDoor = class CreateFrontDoor {
+	/** The binary name, as the usage line of `--help` shows it. */
+	static binaryName = "create-inferative";
+	/** The end-of-options marker that some package managers pass on to the binary. */
+	static optionsSeparator = "--";
+	/** The command that citty runs. */
+	static command() {
+		return {
+			...InitCommand.definition(),
+			meta: {
+				name: CreateFrontDoor.binaryName,
+				version: CreateFrontDoor.version(),
+				description: "Create a new Inferative project (the `npm create inferative` front door)."
+			}
+		};
+	}
+	/**
+	* The arguments that citty parses, without the first bare `--`.
+	*
+	* `npm create` removes the separator itself. `pnpm`, `yarn` and `bun` pass it on, and citty puts every
+	* argument after it into the positional list, where no flag reads it.
+	*
+	* @param argv - The arguments after the executable's name.
+	*/
+	static rawArgs(argv) {
+		const separator = argv.indexOf(CreateFrontDoor.optionsSeparator);
+		return separator === -1 ? [...argv] : [...argv.slice(0, separator), ...argv.slice(separator + 1)];
+	}
+	/** The version of this package, which `--version` prints. */
+	static version() {
+		return createRequire(import.meta.url)("../package.json").version;
+	}
+};
+//#endregion
+export { CreateFrontDoor as t };

package/dist/index.d.mts

@@ -0,0 +1,30 @@
+import { CommandDef } from "citty";
+import { InitCommand } from "inferative";
+//#region src/front-door.d.ts
+/**
+ * The front door of `npm create inferative`.
+ *
+ * It reuses the arguments and the `run` of {@link InitCommand}, so the two names never differ. It sets its own
+ * `meta`: `--help` then prints the binary that the user typed, and `--version` has a version to print.
+ */
+export declare class CreateFrontDoor {
+  /** The binary name, as the usage line of `--help` shows it. */
+  static readonly binaryName: string;
+  /** The end-of-options marker that some package managers pass on to the binary. */
+  private static readonly optionsSeparator;
+  /** The command that citty runs. */
+  static command(): CommandDef;
+  /**
+   * The arguments that citty parses, without the first bare `--`.
+   *
+   * `npm create` removes the separator itself. `pnpm`, `yarn` and `bun` pass it on, and citty puts every
+   * argument after it into the positional list, where no flag reads it.
+   *
+   * @param argv - The arguments after the executable's name.
+   */
+  static rawArgs(argv: readonly string[]): readonly string[];
+  /** The version of this package, which `--version` prints. */
+  private static version;
+}
+//#endregion
+export { InitCommand };

package/dist/index.mjs

@@ -0,0 +1,3 @@
+import { t as CreateFrontDoor } from "./front-door-Blirg1zz.mjs";
+import { InitCommand } from "inferative";
+export { CreateFrontDoor, InitCommand };

package/package.json

@@ -1,6 +1,51 @@
 {
   "name": "create-inferative",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "Create a new Inferative project: the `npm create inferative` front door of `inferative init`.",
+  "keywords": [
+    "create",
+    "inferative",
+    "scaffolding",
+    "starter"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/inferative/inferative.git",
+    "directory": "packages/create-inferative"
+  },
+  "bin": {
+    "create-inferative": "./dist/bin.mjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "citty": "0.1.6",
+    "inferative": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.13.3",
+    "typescript": "^6.0.3",
+    "vite-plus": "^0.3.1",
+    "vitest": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=24"
+  },
+  "scripts": {
+    "build": "vp pack",
+    "test": "vitest run"
+  }
 }