feat: support run generator with version (#381)

* ⬆️  eslint

* ✨  store-dir in cmd-run

* ✅  cmd-run

* 🔥  merge prepack.test

* 🚨  fix

* ✅  cmd-run test with name@version

* 🔥  remove dead fixtures dirs

* 📝  changeset

* 🚨  fix

* 🏷️ (mario) built-use typo

* 💚  latest runner

* ✅  update related bin-template new version released

Author: JiangWeixian

.changeset/new-eagles-enjoy.md

@@ -0,0 +1,5 @@
+---
+"@aiou/neo": minor
+---
+
+support run generator with version `neo run generator@version`

.github/workflows/neo.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   build:
-    runs-on: 'ubuntu-18.04'
+    runs-on: ubuntu-latest
     strategy:
       matrix:
         # pin node version: https://github.com/JiangWeixian/esrua/issues/12

.vscode/settings.json

@@ -2,5 +2,6 @@
   "cSpell.words": [
     "Listr",
     "postgenerate"
-  ]
+  ],
+  "typescript.tsdk": "node_modules/typescript/lib"
 }

package.json

@@ -18,8 +18,8 @@
   "author": {
     "name": "jiangweixian"
   },
-  "main": "index.js",
   "files": ["packages/core"],
+  "main": "index.js",
   "scripts": {
     "lint": "eslint '**/*.{js,ts,tsx,json}'",
     "lint:fix": "eslint . --fix",
@@ -35,7 +35,7 @@
     "**/**/*.{js,ts,tsx,vue,json}": ["eslint --fix"]
   },
   "devDependencies": {
-    "@aiou/eslint-config": "^0.7.8",
+    "@aiou/eslint-config": "^0.10.0",
     "@changesets/cli": "^2.19.0",
     "cz-emoji": "^1.3.1",
     "eslint": "^8.12.0",

packages/core/package.json

@@ -3,6 +3,9 @@
   "version": "3.5.7",
   "description": "templates cli",
   "license": "MIT",
+  "engines": {
+    "node": ">=12"
+  },
   "homepage": "https://github.com/neo-hack/neo#readme",
   "repository": {
     "directory": "packages/core",
@@ -12,16 +15,13 @@
   "author": {
     "name": "JW"
   },
-  "bin": {
-    "neo": "bin/index.mjs"
-  },
   "files": [
     "bin",
     "lib",
     "assets"
   ],
-  "engines": {
-    "node": ">=12"
+  "bin": {
+    "neo": "bin/index.mjs"
   },
   "scripts": {
     "clean": "rimraf lib compiled",
@@ -95,7 +95,7 @@
     "terminal-link": "^3.0.0",
     "typescript": "4.5.4",
     "vitest": "^0.7.7",
-    "vitest-extra": "^0.0.2",
+    "vitest-extra": "^0.0.4",
     "write-yaml-file": "^4.2.0",
     "zen-observable": "^0.8.15"
   }

packages/core/rollup.config.js

@@ -1,11 +1,11 @@
-import commonjs from '@rollup/plugin-commonjs'
 import alias from '@rollup/plugin-alias'
-import { nodeResolve } from '@rollup/plugin-node-resolve'
+import commonjs from '@rollup/plugin-commonjs'
 import json from '@rollup/plugin-json'
+import { nodeResolve } from '@rollup/plugin-node-resolve'
 import { defineConfig } from 'rollup'
 import size from 'rollup-plugin-size'
-import ts from 'rollup-plugin-typescript2'
 import { terser } from 'rollup-plugin-terser'
+import ts from 'rollup-plugin-typescript2'
 
 export default defineConfig([
   // CommonJS (for Node) and ES module (for bundlers) build.

packages/core/src/cli.ts

@@ -1,13 +1,14 @@
+import { fileURLToPath } from 'node:url'
+
 import { program } from 'commander'
-import tl from 'terminal-link'
 import consola from 'consola'
-import { fileURLToPath } from 'url'
+import tl from 'terminal-link'
 
 import { readPkg } from './utils'
-import { getBanner } from './utils/show-brand'
-import { usage } from './utils/show-usage'
 import { HOMEPAGE } from './utils/constants'
 import logger from './utils/logger'
+import { getBanner } from './utils/show-brand'
+import { usage } from './utils/show-usage'
 
 // polyfill node12 & 14 global variable
 global.__filename = fileURLToPath(import.meta.url)
@@ -23,12 +24,12 @@ const cli = program
   .addHelpText('beforeAll', () => `${getBanner()}\n`)
 
 const commands = {
-  create: async () => await import('./commands/create').then((res) => res.create),
-  list: async () => await import('./commands/list').then((res) => res.list),
-  add: async () => await import('./commands/add').then((res) => res.add),
-  run: async () => await import('./commands/run').then((res) => res.run),
-  prepack: async () => await import('./commands/prepack').then((res) => res.prepack),
-  whoami: async () => await import('./commands/whoami').then((res) => res.whoami),
+  create: async () => await import('./commands/create').then(res => res.create),
+  list: async () => await import('./commands/list').then(res => res.list),
+  add: async () => await import('./commands/add').then(res => res.add),
+  run: async () => await import('./commands/run').then(res => res.run),
+  prepack: async () => await import('./commands/prepack').then(res => res.prepack),
+  whoami: async () => await import('./commands/whoami').then(res => res.whoami),
 }
 
 const handler = (cmdName: string) => {
@@ -80,6 +81,7 @@ cli
     )} generator`,
   )
   .option('-m, --module [modules...]', 'Partial modules of workflow will run')
+  .option('--store-dir [storeDir]', 'Set store dir')
   .action(handler('run'))
   .addHelpText('after', usage.run())
 
@@ -100,7 +102,7 @@ cli
 program.parse(process.argv)
 
 consola.wrapConsole()
-process.on('unhandledRejection', (err) => consola.error('[unhandledRejection]', err))
-process.on('uncaughtException', (err) => consola.error('[uncaughtException]', err))
-// @ts-ignore http://nodejs.cn/api/process/process_nodeprecation.html
+process.on('unhandledRejection', err => consola.error('[unhandledRejection]', err))
+process.on('uncaughtException', err => consola.error('[uncaughtException]', err))
+// @ts-expect-error http://nodejs.cn/api/process/process_nodeprecation.html
 process.noDeprecation = true

packages/core/src/commands/add.ts

@@ -1,10 +1,11 @@
-import logger, { debug } from '../utils/logger'
+import Listr from 'listr'
+import pc from 'picocolors'
+
 import createStore from '../store'
 import { STORE_PATH } from '../utils/constants'
-import { CommonOptions } from '../interface'
+import logger, { debug } from '../utils/logger'
 
-import Listr from 'listr'
-import pc from 'picocolors'
+import type { CommonOptions } from '../interface'
 
 type AddOptions = CommonOptions & {
   preset?: boolean

packages/core/src/commands/create.ts

@@ -1,23 +1,29 @@
-import path from 'path'
-import inquirer from 'inquirer'
+import path from 'node:path'
+
 import fsExtra from 'fs-extra'
+import gitconfig from 'gitconfig'
+import inquirer from 'inquirer'
 import InquirerSearchList from 'inquirer-search-list'
-import type { ListrTask } from 'listr'
-import Listr from 'listr'
-import type { PackageResponse } from '@pnpm/package-store'
 import isOffline from 'is-offline-node'
-import pc from 'picocolors'
-import gitconfig from 'gitconfig'
+import Listr from 'listr'
 import { merge } from 'lodash-es'
+import pc from 'picocolors'
 
-import { isMonorepo, isYaml } from '../utils'
-import logger, { debug } from '../utils/logger'
-import type { AsyncReturnType, CommonOptions, Package } from '../interface'
 import createStore from '../store'
-import { usage } from '../utils/show-usage'
+import { isMonorepo, isYaml } from '../utils'
 import { findPrefPackageByPk } from '../utils/find-pref-package'
-import { runMario } from '../utils/mario'
 import { loadConfig } from '../utils/load-config'
+import logger, { debug } from '../utils/logger'
+import { runMario } from '../utils/mario'
+import { usage } from '../utils/show-usage'
+
+import type { PackageResponse } from '@pnpm/package-store'
+import type { ListrTask } from 'listr'
+import type {
+  AsyncReturnType,
+  CommonOptions,
+  Package,
+} from '../interface'
 
 type CreateOptions = Pick<Package, 'name' | 'pref'> & {
   version?: Package['version']

packages/core/src/commands/list/index.ts

@@ -1,12 +1,13 @@
-import pc from 'picocolors'
 import cols from 'cli-columns'
-import { groupBy, countBy } from 'lodash-es'
+import { countBy, groupBy } from 'lodash-es'
+import pc from 'picocolors'
 
-import { ListOptions } from '../../interface'
-import logger, { debug } from '../../utils/logger'
 import createStore from '../../store'
-import { listConfigs } from './list-configs'
 import { colorify } from '../../utils'
+import logger, { debug } from '../../utils/logger'
+import { listConfigs } from './list-configs'
+
+import type { ListOptions } from '../../interface'
 
 /**
  * @description List all templates
@@ -24,7 +25,7 @@ export const list = async (config: string, params: ListOptions) => {
   const templates = await store.lockFile.readTemplates({ presetNames: params.preset })
   const counters = countBy(templates, 'name')
   if (!templates.length) {
-    logger.log(`No templates...`)
+    logger.log('No templates...')
     return
   }
   logger.log(`${pc.cyan('Note:')} ${pc.green('cached')}, ${pc.gray('uncached')}\n`)

packages/core/src/commands/list/list-configs.ts

@@ -1,20 +1,22 @@
 /**
  * @fileoverview select and copy rc file
  */
+import path from 'node:path'
+
+import cols from 'cli-columns'
+import copy from 'clipboardy'
+import fs from 'fs-extra'
 import inquirer from 'inquirer'
 import InquirerSearchList from 'inquirer-search-list'
-import path from 'path'
-import tempy from 'tempy'
-import fs from 'fs-extra'
-import copy from 'clipboardy'
+import { groupBy } from 'lodash-es'
 import pc from 'picocolors'
-import cols from 'cli-columns'
+import tempy from 'tempy'
 
-import { AsyncReturnType, ListOptions } from '../../interface'
-import type createStore from '../../store'
-import logger, { debug } from '../../utils/logger'
 import { colorify } from '../../utils'
-import { groupBy } from 'lodash-es'
+import logger, { debug } from '../../utils/logger'
+
+import type { AsyncReturnType, ListOptions } from '../../interface'
+import type createStore from '../../store'
 
 inquirer.registerPrompt('search-list', InquirerSearchList)
 
@@ -25,7 +27,7 @@ export const listConfigs = async (
   // read all config files
   const configs = await store.lockFile.readConfigs({ presetNames: params.preset })
   if (!configs.length) {
-    logger.log(`  No configs...`)
+    logger.log('  No configs...')
     return
   }
   if (!params.interactive) {
@@ -49,12 +51,12 @@ export const listConfigs = async (
       type: 'search-list',
       name: 'config',
       message: 'Please select config',
-      choices: configs.map((c) => ({
+      choices: configs.map(c => ({
         name: c.name,
       })),
     },
   ])
-  const pref = configs.find((choice) => choice.name === answers.config)
+  const pref = configs.find(choice => choice.name === answers.config)
   if (!pref) {
     debug.list('config not found in preset')
     return

packages/core/src/commands/prepack.ts

@@ -1,7 +1,8 @@
 import logger from '../utils/logger'
-import { run, RunOptions } from './run'
-
 import { usage } from '../utils/show-usage'
+import { run } from './run'
+
+import type { RunOptions } from './run'
 
 export const prepack = async (options: RunOptions) => {
   logger.log(`Prepack will deprecate in next version, please use: \n ${usage.run()}\n`)

packages/core/src/commands/run.ts

@@ -1,13 +1,16 @@
-import Listr from 'listr'
-import path from 'path'
+import path from 'node:path'
+
+import parseWantedDependency from '@pnpm/parse-wanted-dependency'
 import fs from 'fs-extra'
+import Listr from 'listr'
 
-import { debug } from '../utils/logger'
-import { usage } from '../utils/show-usage'
 import createStore from '../store'
-import { CommonOptions } from '../interface'
 import { isYaml } from '../utils'
+import { debug } from '../utils/logger'
 import { runMario } from '../utils/mario'
+import { usage } from '../utils/show-usage'
+
+import type { CommonOptions } from '../interface'
 
 export type RunOptions = CommonOptions & { module?: string[] }
 
@@ -30,7 +33,8 @@ export const run = async (alias: string, params: RunOptions) => {
     {
       title: `Download mario generator ${alias}`,
       task: async () => {
-        const response = await store.pm.request({ alias, latest: true })
+        const result = parseWantedDependency(alias)
+        const response = await store.pm.request({ alias: result.alias, pref: result.pref })
         await store.pm.import(target, await response.files?.())
         return true
       },

packages/core/src/commands/whoami.ts

@@ -1,13 +1,13 @@
-import { getBanner, showFooter } from '../utils/show-brand'
-import logger from '../utils/logger'
-
 import pc from 'picocolors'
 
+import logger from '../utils/logger'
+import { getBanner, showFooter } from '../utils/show-brand'
+
 /**
  * @description display neo image on terminal
  */
 export const whoami = () => {
-  ;(async () => {
+  (async () => {
     logger.log(`${getBanner()}\n`)
     logger.log(pc.blue(' ⎯⎯'))
     showFooter()

packages/core/src/interface/index.ts

@@ -1,9 +1,9 @@
+import type { Preset, PresetTemplate } from '@aiou/schema'
 import type { ResolveResult } from '@pnpm/package-store'
-import type { PresetTemplate, Preset } from '@aiou/schema'
 
 export type { Config } from '@aiou/schema'
 
-export type CommonOptions = {
+export interface CommonOptions {
   storeDir?: string
 }
 
@@ -26,7 +26,7 @@ export interface Package extends PresetTemplate {
   _name?: string
 }
 
-export type LockFile = {
+export interface LockFile {
   templates?: Record<string, Package>
   presets?: Record<string, Preset>
 }
@@ -37,6 +37,6 @@ export type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extend
   ? R
   : any
 
-export type AppConfig = {
+export interface AppConfig {
   mario: string
 }