@neuxnet/neux-cli 0.2.3 → 0.2.5

package/assets/init/schemas/app.schema.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://neuxnet.com/schemas/neux/app.schema.json",
+  "title": "Neux app configuration",
+  "description": "Application-level configuration consumed by the Neux mini program compiler.",
+  "type": "object",
+  "properties": {
+    "pages": { "type": "array", "description": "Page entry paths, relative to miniprogramRoot.", "items": { "type": "string", "minLength": 1 } },
+    "entryPagePath": { "type": "string", "description": "Optional initial page path." },
+    "window": { "$ref": "#/definitions/window" },
+    "tabBar": { "$ref": "#/definitions/tabBar" },
+    "subPackages": { "$ref": "#/definitions/subPackages" },
+    "subpackages": { "$ref": "#/definitions/subPackages" },
+    "preloadRule": { "type": "object", "description": "Page preload configuration.", "additionalProperties": { "type": "object" } },
+    "networkTimeout": { "type": "object", "properties": { "request": { "type": "number", "minimum": 0 }, "connectSocket": { "type": "number", "minimum": 0 }, "uploadFile": { "type": "number", "minimum": 0 }, "downloadFile": { "type": "number", "minimum": 0 } }, "additionalProperties": true },
+    "permission": { "type": "object", "description": "Permission declarations used by the host runtime.", "additionalProperties": true },
+    "usingComponents": { "$ref": "#/definitions/usingComponents" },
+    "style": { "type": "string" },
+    "sitemapLocation": { "type": "string" }
+  },
+  "additionalProperties": true,
+  "definitions": {
+    "window": {
+      "type": "object",
+      "properties": {
+        "navigationBarTitleText": { "type": "string" },
+        "navigationBarBackgroundColor": { "type": "string", "pattern": "^#?[0-9a-fA-F]{3,8}$" },
+        "navigationBarTextStyle": { "type": "string", "enum": ["black", "white"] },
+        "backgroundColor": { "type": "string", "pattern": "^#?[0-9a-fA-F]{3,8}$" },
+        "backgroundTextStyle": { "type": "string", "enum": ["dark", "light"] },
+        "enablePullDownRefresh": { "type": "boolean" },
+        "onReachBottomDistance": { "type": "number", "minimum": 0 },
+        "pageOrientation": { "type": "string" }
+      },
+      "additionalProperties": true
+    },
+    "tabBar": {
+      "type": "object",
+      "properties": {
+        "color": { "type": "string" },
+        "selectedColor": { "type": "string" },
+        "backgroundColor": { "type": "string" },
+        "borderStyle": { "type": "string", "enum": ["black", "white"] },
+        "position": { "type": "string", "enum": ["bottom", "top"] },
+        "custom": { "type": "boolean" },
+        "list": { "type": "array", "minItems": 1, "maxItems": 5, "items": { "$ref": "#/definitions/tabBarItem" } }
+      },
+      "required": ["list"],
+      "additionalProperties": true
+    },
+    "tabBarItem": {
+      "type": "object",
+      "properties": { "pagePath": { "type": "string" }, "text": { "type": "string" }, "iconPath": { "type": "string" }, "selectedIconPath": { "type": "string" } },
+      "required": ["pagePath", "text"],
+      "additionalProperties": true
+    },
+    "subPackages": {
+      "type": "array",
+      "items": { "type": "object", "properties": { "root": { "type": "string" }, "pages": { "type": "array", "items": { "type": "string" } }, "independent": { "type": "boolean" } }, "required": ["root", "pages"], "additionalProperties": true }
+    },
+    "usingComponents": { "type": "object", "description": "Maps component names to component files or package names.", "additionalProperties": { "type": "string", "minLength": 1 } }
+  }
+}

package/assets/init/schemas/neux-config.schema.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://neuxnet.com/schemas/neux/neux-config.schema.json",
+  "title": "Neux CLI project configuration",
+  "description": "Non-secret project settings read by the Neux CLI. Never put CLI keys in this file.",
+  "type": "object",
+  "properties": {
+    "serverUrl": { "type": "string", "format": "uri", "description": "Signed service base URL." },
+    "appId": { "type": "string" },
+    "appid": { "type": "string" },
+    "profile": { "type": "string" },
+    "version": { "type": "string" },
+    "versionName": { "type": "string" },
+    "versionCode": { "type": "integer", "minimum": 1 }
+  },
+  "not": { "anyOf": [ { "required": ["key"] }, { "required": ["cliKey"] }, { "required": ["neuxCliKey"] } ] },
+  "additionalProperties": true
+}

package/assets/init/schemas/page.schema.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://neuxnet.com/schemas/neux/page.schema.json",
+  "title": "Neux page configuration",
+  "description": "Page-level configuration consumed by the Neux mini program compiler.",
+  "type": "object",
+  "properties": {
+    "navigationBarTitleText": { "type": "string" },
+    "navigationBarBackgroundColor": { "type": "string" },
+    "navigationBarTextStyle": { "type": "string", "enum": ["black", "white"] },
+    "backgroundColor": { "type": "string" },
+    "backgroundTextStyle": { "type": "string", "enum": ["dark", "light"] },
+    "enablePullDownRefresh": { "type": "boolean" },
+    "onReachBottomDistance": { "type": "number", "minimum": 0 },
+    "usingComponents": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1 } },
+    "disableScroll": { "type": "boolean" },
+    "pageOrientation": { "type": "string" }
+  },
+  "additionalProperties": true
+}

package/assets/init/schemas/project-config.schema.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://neuxnet.com/schemas/neux/project-config.schema.json",
+  "title": "Neux project configuration",
+  "description": "Project and compiler settings consumed by neux and the Neux compiler.",
+  "type": "object",
+  "properties": {
+    "description": { "type": "string" }, "appid": { "type": "string" }, "appId": { "type": "string" },
+    "projectname": { "type": "string" }, "projectName": { "type": "string" },
+    "compileType": { "type": "string", "enum": ["miniprogram"] }, "libVersion": { "type": "string" },
+    "miniprogramRoot": { "type": "string" }, "versionName": { "type": "string" }, "version": { "type": "string" }, "versionCode": { "type": "integer", "minimum": 1 },
+    "setting": { "$ref": "#/definitions/setting" }, "condition": { "type": "object", "additionalProperties": true },
+    "packOptions": { "$ref": "#/definitions/packOptions" }, "editorSetting": { "$ref": "#/definitions/editorSetting" },
+    "neux": { "$ref": "#/definitions/neux" }, "neuxCli": { "$ref": "#/definitions/neux" }
+  },
+  "additionalProperties": true,
+  "definitions": {
+    "setting": { "type": "object", "properties": { "urlCheck": { "type": "boolean" }, "es6": { "type": "boolean" }, "postcss": { "type": "boolean" }, "minified": { "type": "boolean" }, "newFeature": { "type": "boolean" }, "babelSetting": { "type": "object", "properties": { "ignore": { "type": "array", "items": { "type": "string" } }, "disablePlugins": { "type": "array", "items": { "type": "string" } }, "outputPath": { "type": "string" } }, "additionalProperties": true } }, "additionalProperties": true },
+    "packOptions": { "type": "object", "properties": { "ignore": { "type": "array", "items": { "type": "string" } }, "include": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true },
+    "editorSetting": { "type": "object", "properties": { "tabIndent": { "type": "string", "enum": ["insertSpaces", "indexSize"] }, "tabSize": { "type": "integer", "minimum": 1 } }, "additionalProperties": true },
+    "neux": { "type": "object", "properties": { "serverUrl": { "type": "string", "format": "uri" }, "appId": { "type": "string" }, "profile": { "type": "string" } }, "additionalProperties": true }
+  }
+}

package/assets/init/schemas/project-private-config.schema.json

@@ -0,0 +1,161 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://neuxnet.com/schemas/neux/project-private-config.schema.json",
+  "title": "Neux private project configuration",
+  "description": "Optional local overrides for project.config.json. All fields are optional.",
+  "type": "object",
+  "properties": {
+    "description": {
+      "type": "string"
+    },
+    "appid": {
+      "type": "string"
+    },
+    "appId": {
+      "type": "string"
+    },
+    "projectname": {
+      "type": "string"
+    },
+    "projectName": {
+      "type": "string"
+    },
+    "compileType": {
+      "type": "string",
+      "enum": [
+        "miniprogram"
+      ]
+    },
+    "libVersion": {
+      "type": "string"
+    },
+    "miniprogramRoot": {
+      "type": "string"
+    },
+    "versionName": {
+      "type": "string"
+    },
+    "version": {
+      "type": "string"
+    },
+    "versionCode": {
+      "type": "integer",
+      "minimum": 1
+    },
+    "setting": {
+      "$ref": "#/definitions/setting"
+    },
+    "condition": {
+      "type": "object",
+      "additionalProperties": true
+    },
+    "packOptions": {
+      "$ref": "#/definitions/packOptions"
+    },
+    "editorSetting": {
+      "$ref": "#/definitions/editorSetting"
+    },
+    "neux": {
+      "$ref": "#/definitions/neux"
+    },
+    "neuxCli": {
+      "$ref": "#/definitions/neux"
+    }
+  },
+  "additionalProperties": true,
+  "definitions": {
+    "setting": {
+      "type": "object",
+      "properties": {
+        "urlCheck": {
+          "type": "boolean"
+        },
+        "es6": {
+          "type": "boolean"
+        },
+        "postcss": {
+          "type": "boolean"
+        },
+        "minified": {
+          "type": "boolean"
+        },
+        "newFeature": {
+          "type": "boolean"
+        },
+        "babelSetting": {
+          "type": "object",
+          "properties": {
+            "ignore": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "disablePlugins": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "outputPath": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": true
+    },
+    "packOptions": {
+      "type": "object",
+      "properties": {
+        "ignore": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "include": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": true
+    },
+    "editorSetting": {
+      "type": "object",
+      "properties": {
+        "tabIndent": {
+          "type": "string",
+          "enum": [
+            "insertSpaces",
+            "indexSize"
+          ]
+        },
+        "tabSize": {
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "additionalProperties": true
+    },
+    "neux": {
+      "type": "object",
+      "properties": {
+        "serverUrl": {
+          "type": "string",
+          "format": "uri"
+        },
+        "appId": {
+          "type": "string"
+        },
+        "profile": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": true
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neuxnet/neux-cli",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "Standalone CLI and Node API for Neux mini program build, pack, preview, and CI automation.",
   "type": "module",
   "bin": {
@@ -24,9 +24,12 @@
     "sync:compiler": "node ./scripts/sync-compiler.js",
     "prepare:publish": "npm run sync:compiler && npm run sync:container",
     "generate:init-types": "node ./scripts/generate-init-types.js",
+    "smoke:init-types": "node ./scripts/smoke-init-types.mjs",
+    "smoke:init-types:registry": "node ./scripts/smoke-init-types.mjs --registry",
     "test": "node --test",
     "smoke:help": "node ./src/bin/cli.js --help",
-    "pack:dry": "npm pack --dry-run"
+    "pack:dry": "npm pack --dry-run",
+    "verify:schemas": "node ./scripts/verify-json-schemas.mjs"
   },
   "engines": {
     "node": ">=20"
@@ -58,6 +61,12 @@
     "preview"
   ],
   "license": "Apache-2.0",
+  "neux": {
+    "typesPackage": {
+      "name": "@neuxnet/neux-miniapp-types",
+      "versionRange": "^0.1.8"
+    }
+  },
   "publishConfig": {
     "access": "public"
   },

package/scripts/smoke-init-types.mjs

@@ -0,0 +1,114 @@
+import fs from 'node:fs/promises'
+import os from 'node:os'
+import path from 'node:path'
+import { execFile } from 'node:child_process'
+import { promisify } from 'node:util'
+import { initProject } from '../src/core/init.js'
+
+const execFileAsync = promisify(execFile)
+const cliRoot = path.resolve(import.meta.dirname, '..')
+const repoRoot = path.resolve(cliRoot, '..')
+const typesRoot = path.join(repoRoot, 'neux-miniapp-types')
+const tscPath = path.join(repoRoot, 'fe', 'node_modules', '.bin', 'tsc')
+const tempRoot = await fs.mkdtemp(path.join(os.tmpdir(), 'neux-cli-types-smoke-'))
+const registryMode = process.argv.includes('--registry')
+
+async function pack(directory, destination) {
+  const { stdout } = await execFileAsync('npm', [
+    'pack',
+    '--pack-destination',
+    destination,
+    '--json',
+  ], { cwd: directory })
+  const result = JSON.parse(stdout)
+  return path.join(destination, result[0].filename)
+}
+
+try {
+  const project = path.join(tempRoot, 'starter-app')
+  await initProject({
+    _: [project],
+    appId: 'wxlocaltypes123',
+    name: 'Local Types Smoke',
+  })
+
+  const packageJsonPath = path.join(project, 'package.json')
+  const packageJson = JSON.parse(await fs.readFile(packageJsonPath, 'utf8'))
+  const typesPackage = packageJson.devDependencies['@neuxnet/neux-miniapp-types']
+  const cliPackage = JSON.parse(await fs.readFile(
+    path.join(cliRoot, 'package.json'),
+    'utf8',
+  ))
+  const expectedTypesRange = cliPackage.neux?.typesPackage?.versionRange
+  if (typesPackage !== expectedTypesRange) {
+    throw new Error(
+      `Unexpected generated types dependency: ${typesPackage}; ` +
+      `expected ${expectedTypesRange}`,
+    )
+  }
+
+  if (!registryMode) {
+    const typesTarball = await pack(typesRoot, tempRoot)
+    const cliTarball = await pack(cliRoot, tempRoot)
+    packageJson.devDependencies['@neuxnet/neux-cli'] = `file:${cliTarball}`
+    packageJson.devDependencies['@neuxnet/neux-miniapp-types'] = `file:${typesTarball}`
+  }
+  await fs.writeFile(packageJsonPath, `${JSON.stringify(packageJson, null, 2)}\n`, 'utf8')
+
+  await fs.writeFile(path.join(project, 'types', 'consumer.ts'), [
+    'Page({',
+    '  data: { count: 0 },',
+    '  onLoad(query) {',
+    '    const id: string | undefined = query.id',
+    '    this.setData({ count: this.data.count + 1, dynamicallyAdded: true })',
+    '    void id',
+    '  },',
+    '})',
+    '',
+    'wx.request({',
+    "  url: '/api/profile',",
+    "  method: 'GET',",
+    '  success(result) { result }',
+    '})',
+    '',
+    "Component({ properties: { title: String }, methods: { emitChange() {",
+    "  this.triggerEvent<{ value: string }>('change', { value: this.properties.title })",
+    '} } })',
+    '',
+  ].join('\n'), 'utf8')
+
+  const installArgs = [
+    'install',
+    '--ignore-scripts',
+    '--no-package-lock',
+  ]
+  if (registryMode) {
+    installArgs.push('--registry=https://registry.npmjs.org/')
+  }
+  await execFileAsync('npm', installArgs, {
+    cwd: project,
+    maxBuffer: 1024 * 1024,
+  })
+
+  await execFileAsync(tscPath, [
+    '-p',
+    path.join(project, 'jsconfig.json'),
+    '--noEmit',
+  ], { cwd: project, maxBuffer: 1024 * 1024 })
+
+  const installedTypesPackage = JSON.parse(await fs.readFile(
+    path.join(project, 'node_modules', '@neuxnet', 'neux-miniapp-types', 'package.json'),
+    'utf8',
+  ))
+  if (installedTypesPackage.name !== '@neuxnet/neux-miniapp-types') {
+    throw new Error('Installed types package has an unexpected name')
+  }
+  if (installedTypesPackage.types !== './index.d.ts') {
+    throw new Error('Installed types package does not expose index.d.ts')
+  }
+
+  console.log(`Passed: neux init -> ${registryMode ? 'registry' : 'local'} npm install -> TypeScript consumer check.`)
+}
+finally {
+  await fs.rm(tempRoot, { recursive: true, force: true })
+}

package/scripts/verify-json-schemas.mjs

@@ -0,0 +1,40 @@
+import fs from 'node:fs/promises'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..')
+const schemaDir = path.join(root, 'assets', 'init', 'schemas')
+const initSource = await fs.readFile(path.join(root, 'src', 'core', 'init.js'), 'utf8')
+const projectSource = await fs.readFile(path.join(root, 'src', 'core', 'project.js'), 'utf8')
+const serviceSource = await fs.readFile(path.join(root, 'src', 'providers', 'service-config.js'), 'utf8')
+
+const manifest = {
+  'app.schema.json': { fields: ['pages', 'entryPagePath', 'window', 'tabBar', 'subPackages', 'subpackages', 'preloadRule', 'networkTimeout', 'permission', 'usingComponents'] },
+  'page.schema.json': { fields: ['navigationBarTitleText', 'navigationBarBackgroundColor', 'navigationBarTextStyle', 'backgroundColor', 'backgroundTextStyle', 'enablePullDownRefresh', 'onReachBottomDistance', 'usingComponents', 'disableScroll', 'pageOrientation'] },
+  'project-config.schema.json': { fields: ['appid', 'projectname', 'compileType', 'libVersion', 'miniprogramRoot', 'versionName', 'versionCode', 'setting', 'condition', 'packOptions', 'editorSetting', 'neuxCli'] },
+  'project-private-config.schema.json': { fields: ['appid', 'projectname', 'versionName', 'versionCode', 'setting', 'packOptions', 'neuxCli'] },
+  'neux-config.schema.json': { fields: ['serverUrl', 'appId', 'appid', 'profile', 'version', 'versionName', 'versionCode'] },
+}
+
+const errors = []
+for (const [name, entry] of Object.entries(manifest)) {
+  const file = path.join(schemaDir, name)
+  let schema
+  try { schema = JSON.parse(await fs.readFile(file, 'utf8')) } catch (error) { errors.push(`${name}: invalid JSON (${error.message})`); continue }
+  if (schema.$schema !== 'http://json-schema.org/draft-07/schema#') errors.push(`${name}: missing draft-07 $schema`)
+  if (!schema.title || !schema.description) errors.push(`${name}: title and description are required`)
+  const serialized = JSON.stringify(schema)
+  for (const field of entry.fields) if (!serialized.includes(`"${field}"`)) errors.push(`${name}: source field is missing from schema: ${field}`)
+  if (name === 'neux-config.schema.json') {
+    for (const secret of ['key', 'cliKey', 'neuxCliKey']) if (schema.properties?.[secret]) errors.push(`${name}: secret field must not be declared: ${secret}`)
+    if (!schema.not?.anyOf?.some(rule => rule.required?.includes('key'))) errors.push(`${name}: must reject key`)
+  }
+}
+const settings = initSource.match(/function createJsonSchemaSettings\(\)\s*\{([\s\S]*?)\n\}/)?.[1] || ''
+for (const name of Object.keys(manifest)) {
+  if (!settings.includes(name)) errors.push(`init.js: schema is not registered: ${name}`)
+  try { await fs.access(path.join(schemaDir, name)) } catch { errors.push(`missing schema asset: ${name}`) }
+}
+if (!projectSource.includes('readProjectCliConfig') || !serviceSource.includes('assertNoKey')) errors.push('source guard: expected configuration readers were not found')
+if (errors.length) { console.error(['JSON Schema verification failed:', ...errors.map(error => `- ${error}`)].join('\n')); process.exitCode = 1 }
+else console.log(`JSON Schema verification passed (${Object.keys(manifest).length} schemas, ${Object.values(manifest).reduce((n, item) => n + item.fields.length, 0)} source-backed fields).`)

package/src/bin/cli.js

@@ -307,6 +307,12 @@ async function writeResult(result, rawOptions) {
     process.stdout.write(`key: ${result.key?.present ? 'configured' : 'missing'}\n`)
     if (result.missing?.length) process.stdout.write(`missing: ${result.missing.join(', ')}\n`)
   }
+  if (Array.isArray(result.diagnostics) && result.diagnostics.length > 0) {
+    process.stdout.write(`diagnostics: ${result.diagnostics.length}\n`)
+    for (const diagnostic of result.diagnostics) {
+      process.stdout.write(`  [${diagnostic.severity}] ${diagnostic.code}: ${diagnostic.message}\n`)
+    }
+  }
   if (result.qrPayload && qrFormat === 'terminal') {
     process.stdout.write('\n')
     process.stdout.write(await renderTerminalQr(result.qrPayload))
@@ -315,6 +321,12 @@ async function writeResult(result, rawOptions) {
 
 function formatErrorPayload(payload, locale = 'en') {
   const lines = [`${payload.code}: ${payload.message}`]
+  if (payload.details?.diagnostics?.length) {
+    lines.push('', 'Diagnostics:')
+    for (const diagnostic of payload.details.diagnostics) {
+      lines.push(`  [${diagnostic.severity}] ${diagnostic.code}: ${diagnostic.message}`)
+    }
+  }
   const suggestions = payload.details?.suggestions
   if (payload.code === 'NEUX_CLI_CONFIG_MISSING' && Array.isArray(suggestions) && suggestions.length > 0) {
     lines.push('', translate(locale, 'suggestedFixes'))

package/src/core/compiler.js

@@ -49,6 +49,7 @@ async function loadCompiler(moduleSpecifier) {
 
 export async function buildProject(options = {}) {
   const projectInfo = await inspectProject(options)
+  assertProjectConfiguration(projectInfo, options)
   const out = resolvePath(options.out || options.output || defaultOut('build'))
   const compilerModule = options.compiler || await loadCompiler(options.compilerModule || process.env.DIMINA_COMPILER_MODULE)
   const build = compilerModule.default || compilerModule.build || compilerModule
@@ -92,12 +93,22 @@ export async function buildProject(options = {}) {
     compilerInputCreated: compilerInput.created,
     outputPath: out,
     appId: projectInfo.appId,
+    diagnostics: projectInfo.diagnostics,
     compilerResult,
     logs,
     errors,
   }
 }
 
+function assertProjectConfiguration(projectInfo, options = {}) {
+  if (options.validate === false || projectInfo.ok) return
+  throw new DiminaCliError(
+    'NEUX_PROJECT_CONFIG_INVALID',
+    `Project configuration validation failed with ${projectInfo.diagnostics.length} error(s).`,
+    { diagnostics: projectInfo.diagnostics },
+  )
+}
+
 export async function buildStyleOnlyProject(options = {}) {
   const projectInfo = await inspectProject(options)
   const out = resolvePath(options.out || options.output || defaultOut('build'))