@neuxnet/neux-cli 0.2.3 → 0.2.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neuxnet/neux-cli",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "Standalone CLI and Node API for Neux mini program build, pack, preview, and CI automation.",
   "type": "module",
   "bin": {
@@ -24,6 +24,8 @@
     "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"
@@ -58,6 +60,12 @@
     "preview"
   ],
   "license": "Apache-2.0",
+  "neux": {
+    "typesPackage": {
+      "name": "@neuxnet/neux-miniapp-types",
+      "versionRange": "^0.1.7"
+    }
+  },
   "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/src/core/init.js

@@ -3,7 +3,7 @@ import path from 'node:path'
 import { fileURLToPath } from 'node:url'
 import { DiminaCliError } from './errors.js'
 import { pathExists, resolvePath, writeJson } from './fs.js'
-import { getCliVersion } from './package-info.js'
+import { getCliPackageInfo } from './package-info.js'
 import { saveCliKey } from '../providers/service-config.js'
 import { promptLines, shouldPrompt } from './prompts.js'
 
@@ -12,7 +12,6 @@ const DEFAULT_LIB_VERSION = '3.3.3'
 export const DEFAULT_SERVER_URL = 'https://demo-c.paas.superapp.neuvision.cn'
 const CLI_PACKAGE_NAME = '@neuxnet/neux-cli'
 const TEMPLATE_ASSET_DIR = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../assets/init')
-const DEFAULT_DOCS_BASE_URL = `${DEFAULT_SERVER_URL}/miniappdoc`
 
 export async function initProject(options = {}) {
   const targetArg = options._?.[0] || options.project || '.'
@@ -25,8 +24,14 @@ export async function initProject(options = {}) {
   const appId = options.appId || prompts.appId || DEFAULT_APP_ID
   const serverUrl = options.serverUrl || prompts.serverUrl || DEFAULT_SERVER_URL
   const cliKey = options.key || prompts.cliKey
-  const cliVersion = await getCliVersion()
-  const files = createTemplateFiles({ appId, projectName, serverUrl, cliVersion })
+  const cliPackage = await getCliPackageInfo()
+  const files = createTemplateFiles({
+    appId,
+    projectName,
+    serverUrl,
+    cliVersion: cliPackage.version,
+    typesPackage: cliPackage.typesPackage,
+  })
 
   for (const file of files) {
     const filePath = path.join(projectPath, file.path)
@@ -36,9 +41,7 @@ export async function initProject(options = {}) {
       await fs.mkdir(path.dirname(filePath), { recursive: true })
       const sourcePath = path.join(TEMPLATE_ASSET_DIR, file.source)
       if (file.source === 'types/neux-api.d.ts') {
-        const docsBaseUrl = `${String(serverUrl || DEFAULT_SERVER_URL).replace(/\/+$/, '')}/miniappdoc`
-        const content = await fs.readFile(sourcePath, 'utf8')
-        await fs.writeFile(filePath, content.replaceAll(DEFAULT_DOCS_BASE_URL, docsBaseUrl), 'utf8')
+        await fs.writeFile(filePath, `/// <reference types="${file.typesPackage.name}" />\n`, 'utf8')
       }
       else await fs.copyFile(sourcePath, filePath)
     }
@@ -142,7 +145,20 @@ async function mergeJsonFile(filePath, generated) {
   await writeJson(filePath, merged)
 }
 
-function createTemplateFiles({ appId, projectName, serverUrl = DEFAULT_SERVER_URL, cliVersion }) {
+function createTemplateFiles({
+  appId,
+  projectName,
+  serverUrl = DEFAULT_SERVER_URL,
+  cliVersion,
+  typesPackage,
+}) {
+  if (!typesPackage?.name || !typesPackage?.versionRange) {
+    throw new DiminaCliError(
+      'NEUX_CLI_TYPES_PACKAGE_METADATA_MISSING',
+      'The CLI package does not declare a compatible miniapp types package.',
+    )
+  }
+
   return [
     {
       path: 'project.config.json',
@@ -198,6 +214,7 @@ function createTemplateFiles({ appId, projectName, serverUrl = DEFAULT_SERVER_UR
         },
         devDependencies: {
           [CLI_PACKAGE_NAME]: `^${cliVersion}`,
+          [typesPackage.name]: typesPackage.versionRange,
         },
       },
     },
@@ -276,11 +293,17 @@ function createTemplateFiles({ appId, projectName, serverUrl = DEFAULT_SERVER_UR
           checkJs: false,
           noEmit: true,
           target: 'ES2020',
+          types: [typesPackage.name],
         },
         include: ['**/*.js', '**/*.ts', 'types/**/*.d.ts'],
       },
     },
-    { path: 'types/neux-api.d.ts', kind: 'asset', source: 'types/neux-api.d.ts' },
+    {
+      path: 'types/neux-api.d.ts',
+      kind: 'asset',
+      source: 'types/neux-api.d.ts',
+      typesPackage,
+    },
     { path: 'assets/tabbar/home.png', kind: 'asset', source: 'tabbar/home.png' },
     { path: 'assets/tabbar/home-active.png', kind: 'asset', source: 'tabbar/home-active.png' },
     { path: 'assets/tabbar/list.png', kind: 'asset', source: 'tabbar/list.png' },

package/src/core/package-info.js

@@ -15,6 +15,7 @@ export async function getCliPackageInfo() {
     packageName: packageJson.name || brand.packageName,
     version: packageJson.version,
     packageRoot,
+    typesPackage: packageJson.neux?.typesPackage || null,
   }
 }