v8scli 0.2.0 → 0.2.1

package/README.md

@@ -1,39 +1,35 @@
 # v8scli
 
-CLI (`v8s`) for building and publishing V8 `point_script` mods.
-Companion of the `v8_scripting` SDK.
-
-The first call runs through the package name — `npx v8s` would look for a
-package called `v8s`, which does not exist. Inside the scaffolded project the
-CLI is a devDependency, so plain `npx v8s` works from there on:
-
-```bash
-npx v8scli init my_mod             # scaffold (inside a project plain `npx v8s` works)
-cd my_mod && npm i
-npx v8s build         # bundle + dist/my_mod.vjs_c для теста на своём сервере
-npx v8s login         # portal url + api token (dpt_...)
-npx v8s upload        # pack sources, create a version on the portal
-npx v8s status        # versions + review status
-npx v8s deps          # download typings of library dependencies
+CLI for building and publishing V8 `point_script` mods (companion of `v8_scripting`).
+
+Every command is `npx v8scli <command>` — the package name matches the bin
+name, so it works both outside a project (npx fetches the package) and inside
+one (the scaffolded project has it as a devDependency).
+
+```
+npx v8scli init my_mod     # scaffold a new mod in ./my_mod
+cd my_mod && npm install
+
+npx v8scli build           # bundle + dist/my_mod.vjs_c для теста на своём сервере
+npx v8scli login           # portal url + api token (dpt_...)
+npx v8scli upload          # pack sources, create a version on the portal
+npx v8scli status          # versions + review status
+
+npx v8scli pull my_mod     # fetch the latest uploaded sources from the portal
+npx v8scli search          # browse published libraries
+npx v8scli add my_lib      # pin a library release (+ typings)
+npx v8scli remove my_lib   # drop a dependency (+ its typings)
+npx v8scli update          # bump pinned releases to the latest
+npx v8scli deps            # (re)download typings of dependencies
 ```
 
-Rules enforced at build time (same as on the portal):
-only your files and the `v8_scripting` SDK can be imported;
-`cs_script/point_script` is provided by the runtime.
+## Local SDK/CLI development
 
-Before the npm release the packages are installed from checkouts —
-`init --local` writes the SDK and the CLI into the project as `file:` deps,
-so `npm install` never touches the registry:
+`--local` wires the SDK and CLI as `file:` dependencies from your checkouts
+(place them next to each other or set `V8S_LOCAL_SDK`):
 
-```bash
+```
 cd dev_portal/cli && npm install
 cd ~/mods && node /path/to/dev_portal/cli/bin/v8s.js init my_mod --local
-cd my_mod && npm install && npx v8s build
+cd my_mod && npm install && npx v8scli build
 ```
-
-The SDK is looked up next to the CLI checkout (`dev_portal/sdk`);
-override with `V8S_LOCAL_SDK=/path/to/sdk`.
-
-Dev portals behind basic auth: pass credentials inside the url on login,
-e.g. `https://user:pass@developer.example.com` — the API token then goes
-in the `X-Api-Token` header automatically.

package/bin/v8s.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-// v8s — CLI разработчика модов. Команды: init, build, login, upload, status, deps.
+// v8scli — CLI разработчика модов. Команды: init, build, login, upload, status, deps.
 import { init } from '../src/commands/init.js';
 import { build } from '../src/commands/build.js';
 import { login } from '../src/commands/login.js';
@@ -14,7 +14,7 @@ const [, , command, ...args] = process.argv;
 
 const commands = { init, build, login, upload, status, deps, pull, search, add, remove, update };
 
-const usage = `v8s <command>
+const usage = `v8scli <command>
 
   init <slug> [--local]  scaffold a new mod in ./<slug> (--local: SDK/CLI from checkouts)
   build         bundle the mod locally (self-check, dist/<slug>.js)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "v8scli",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "CLI for building and publishing V8 point_script mods (companion of v8_scripting)",
   "license": "MIT",
   "type": "module",

package/src/commands/add.js

@@ -5,10 +5,10 @@ import { api, readConfig, readManifest } from '../common.js';
 import { deps } from './deps.js';
 
 /**
- * v8s add <slug>[@version] — подключить библиотеку точным пином релиза.
+ * v8scli add <slug>[@version] — подключить библиотеку точным пином релиза.
  * Без версии берётся последний published; typings скачиваются сразу.
  *
- * v8s update [slug] — поднять пин(ы) до последнего published-релиза.
+ * v8scli update [slug] — поднять пин(ы) до последнего published-релиза.
  */
 
 async function resolveLibrary(config, slug) {
@@ -38,7 +38,7 @@ async function writeDependency(slug, version) {
 
 export async function add(args) {
   const spec = args[0];
-  if (!spec) throw new Error('usage: v8s add <slug>[@version]');
+  if (!spec) throw new Error('usage: v8scli add <slug>[@version]');
 
   const [slug, requested] = spec.split('@');
   if (!/^[a-z][a-z0-9_]{2,31}$/.test(slug)) throw new Error(`invalid slug "${slug}"`);
@@ -64,7 +64,7 @@ export async function add(args) {
 
 export async function remove(args) {
   const slug = args[0];
-  if (!slug) throw new Error('usage: v8s remove <slug>');
+  if (!slug) throw new Error('usage: v8scli remove <slug>');
 
   const raw = JSON.parse(await readFile('mod.json', 'utf-8'));
   const dependencies = raw.dependencies || [];

package/src/commands/init.js

@@ -23,7 +23,7 @@ export async function init(args) {
   const isLocal = args.includes('--local');
   const slug = args.find((arg) => !arg.startsWith('-'));
   if (!slug || !/^[a-z][a-z0-9_]{2,31}$/.test(slug))
-    throw new Error('usage: v8s init <slug> [--local]  (slug: [a-z][a-z0-9_]{2,31})');
+    throw new Error('usage: v8scli init <slug> [--local]  (slug: [a-z][a-z0-9_]{2,31})');
 
   const local = isLocal ? await resolveLocalPackages() : null;
 
@@ -55,7 +55,7 @@ export async function init(args) {
 next steps:
   cd ${slug}
   npm install
-  npx v8s build      # self-check bundle
-  npx v8s login      # portal url + api token
-  npx v8s upload     # create a version on the portal`);
+  npx v8scli build      # self-check bundle
+  npx v8scli login      # portal url + api token
+  npx v8scli upload     # create a version on the portal`);
 }

package/src/commands/login.js

@@ -1,7 +1,7 @@
 import { createInterface } from 'node:readline/promises';
 import { api, readConfig, writeConfig, CONFIG_PATH } from '../common.js';
 
-// v8s login [portalUrl] [token] — с аргументами работает без интерактива (CI-friendly).
+// v8scli login [portalUrl] [token] — с аргументами работает без интерактива (CI-friendly).
 export async function login(args = []) {
   const config = await readConfig();
   let [portalUrl, token] = args;

package/src/commands/pull.js

@@ -8,7 +8,7 @@ import { api, apiBinary, readConfig } from '../common.js';
 const TEMPLATES = join(dirname(fileURLToPath(import.meta.url)), '..', '..', 'templates');
 
 /**
- * v8s pull <slug> — скачивает исходники последней версии мода с портала.
+ * v8scli pull <slug> — скачивает исходники последней версии мода с портала.
  *
  * В папке существующего мода (mod.json с тем же slug) обновляет исходники
  * на месте; иначе создаёт ./<slug> с полной обвязкой проекта (package.json,
@@ -17,7 +17,7 @@ const TEMPLATES = join(dirname(fileURLToPath(import.meta.url)), '..', '..', 'tem
 export async function pull(args) {
   const slug = args[0];
   if (!slug || !/^[a-z][a-z0-9_]{2,31}$/.test(slug))
-    throw new Error('usage: v8s pull <slug>');
+    throw new Error('usage: v8scli pull <slug>');
 
   const config = await readConfig();
 
@@ -63,5 +63,5 @@ export async function pull(args) {
   console.log(`pulled ${slug}@${latest.version} -> ${created ? `./${slug}` : '.'}`);
   if (created) console.log(`next: cd ${slug} && npm install`);
   if ((JSON.parse(await readFile(join(target, 'mod.json'), 'utf-8')).dependencies || []).length)
-    console.log('dependencies present — run `npx v8s deps` to fetch typings');
+    console.log('dependencies present — run `npx v8scli deps` to fetch typings');
 }

package/src/commands/search.js

@@ -1,6 +1,6 @@
 import { api, readConfig } from '../common.js';
 
-/** v8s search [query] — публичный каталог библиотек портала */
+/** v8scli search [query] — публичный каталог библиотек портала */
 export async function search(args) {
   const config = await readConfig();
   const query = encodeURIComponent(args.join(' ').trim());
@@ -15,6 +15,6 @@ export async function search(args) {
   for (const lib of libraries) {
     console.log(`${lib.slug}@${lib.latest}  ${lib.name} — ${lib.description || 'no description'}`);
     console.log(`  by ${lib.ownerNickname || 'unknown'} | versions: ${lib.versions.join(', ')}`);
-    console.log(`  add: npx v8s add ${lib.slug}`);
+    console.log(`  add: npx v8scli add ${lib.slug}`);
   }
 }

package/src/common.js

@@ -23,7 +23,7 @@ export async function readManifest(dir = process.cwd()) {
   try {
     raw = await readFile(join(dir, 'mod.json'), 'utf-8');
   } catch {
-    throw new Error('mod.json not found — run from the mod root (or v8s init first)');
+    throw new Error('mod.json not found — run from the mod root (or v8scli init first)');
   }
   const manifest = JSON.parse(raw);
   if (!manifest.slug || !manifest.entry) throw new Error('mod.json must contain slug and entry');
@@ -37,7 +37,7 @@ export async function readManifest(dir = process.cwd()) {
  */
 /** Как api(), но возвращает Buffer — для скачивания архивов исходников */
 export async function apiBinary(config, path) {
-  if (!config.portalUrl) throw new Error('not logged in — run `v8s login` first');
+  if (!config.portalUrl) throw new Error('not logged in — run `v8scli login` first');
   const url = new URL(config.portalUrl);
   const headers = {};
   if (config.token) headers['X-Api-Token'] = config.token;
@@ -53,7 +53,7 @@ export async function apiBinary(config, path) {
 }
 
 export async function api(config, path, options = {}) {
-  if (!config.portalUrl) throw new Error('not logged in — run `v8s login` first');
+  if (!config.portalUrl) throw new Error('not logged in — run `v8scli login` first');
   const url = new URL(config.portalUrl);
   const headers = { ...(options.headers ?? {}) };
   if (config.token) headers['X-Api-Token'] = config.token;

package/templates/package.json

@@ -3,8 +3,8 @@
   "private": true,
   "type": "module",
   "scripts": {
-    "build": "v8s build",
-    "upload": "v8s upload"
+    "build": "v8scli build",
+    "upload": "v8scli upload"
   },
   "devDependencies": {
     "v8_scripting": "^0.2.1",