feat: list configs

.changeset/thin-hats-perform.md

@@ -0,0 +1,7 @@
+---
+"@aiou/neo": minor
+"@aiou/preset-aiou": minor
+"@aiou/schema": minor
+---
+
+list configs

packages/core/package.json

@@ -41,6 +41,7 @@
     "@pnpm/logger": "^4.0.0",
     "@pnpm/package-store": "^12.1.3",
     "cli-columns": "^4.0.0",
+    "clipboardy": "^3.0.0",
     "commander": "8.0.0",
     "debug": "4.3.2",
     "find-up": "^6.2.0",

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

@@ -4,9 +4,10 @@ import groupby from 'lodash.groupby'
 import countby from 'lodash.countby'
 import uniqby from 'lodash.uniqby'
 
-import { CommonOptions, Package } from './interface'
-import logger from './utils/logger'
-import createStore from './store'
+import { CommonOptions, Package } from '../../interface'
+import logger, { debug } from '../../utils/logger'
+import createStore from '../../store'
+import { listConfigs } from './list-configs'
 
 type ListOptions = CommonOptions & {
   preset: string[]
@@ -29,8 +30,14 @@ const colorify = (pkgs: Partial<Package>[], counters: Record<string, number>) =>
  * @description List all templates
  * @todo list template with detail
  */
-export const list = async (params: ListOptions) => {
+export const list = async (config: string, params: ListOptions) => {
   const store = await createStore(params)
+  if (config === 'configs') {
+    debug.list('list config %s', config)
+    await listConfigs(store)
+    return
+  }
+  // list all packages
   const templates = uniqby(
     await store.lockFile.readTemplates({ presetNames: params.preset }),
     'pref',

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

@@ -0,0 +1,51 @@
+/**
+ * @fileoverview select and copy rc file
+ */
+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 { AsyncReturnType } from '../../interface'
+import type createStore from '../../store'
+import logger from '../../utils/logger'
+
+inquirer.registerPrompt('search-list', InquirerSearchList)
+
+export const listConfigs = async (store: AsyncReturnType<typeof createStore>) => {
+  // read all config files
+  const configs = await store.lockFile.readConfigs()
+  if (!configs.length) {
+    logger.log(`  No configs...`)
+    return
+  }
+  const answers = await inquirer.prompt<{ config: string }>([
+    {
+      type: 'search-list',
+      name: 'config',
+      choices: configs.map((c) => ({
+        name: c.name,
+      })),
+    },
+  ])
+  const pref = configs.find((choice) => choice.name === answers.config)
+  if (!pref) {
+    return
+  }
+  const fileResponse = await store.pm.request({ alias: pref.preset, pref: pref.preset })
+  const files = await fileResponse?.files?.()
+  if (!files) {
+    return
+  }
+  // import to tempy dir
+  const dir = tempy.directory()
+  store.pm.import(dir, files)
+  // copy it
+  const filepath = path.join(dir, pref.pref!)
+  copy.writeSync(fs.readFileSync(filepath).toString())
+  // log message
+  console.log()
+  logger.success(`  🎉 config ${pref?.name} copied, Happy hacking!`)
+}

packages/core/src/interface/index.ts

@@ -1,15 +1,14 @@
 import type { ResolveResult } from '@pnpm/package-store'
-import type { PresetTemplate } from '@aiou/schema'
+import type { PresetTemplate, Preset } from '@aiou/schema'
+
+export type { Config } from '@aiou/schema'
 
 export type CommonOptions = {
   storeDir?: string
 }
 
-export interface PresetPackage extends PresetTemplate {
+export interface Package extends PresetTemplate {
   resolvedVia?: ResolveResult['resolvedVia']
-}
-
-export interface Package extends PresetPackage {
   version: string
   pref: string
   id: string
@@ -22,7 +21,7 @@ export interface Package extends PresetPackage {
 
 export type LockFile = {
   templates?: Record<string, Package>
-  presets?: Record<string, { templates: PresetPackage[] }>
+  presets?: Record<string, Preset>
 }
 
 export type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (

packages/core/src/neo.ts

@@ -20,7 +20,7 @@ const cli = program
 
 const commands = {
   create: async () => await import('./create').then((res) => res.create),
-  list: async () => await import('./list').then((res) => res.list),
+  list: async () => await import('./commands/list').then((res) => res.list),
   add: async () => await import('./add').then((res) => res.add),
   prepack: async () => await import('./prepack').then((res) => res.prepack),
   whoami: async () => await import('./whoami').then((res) => res.whoami),
@@ -51,7 +51,7 @@ cli
   .action(handler('create'))
 
 cli
-  .command('list')
+  .command('list [configs]')
   .description('List all templates')
   .alias('l')
   .option('--store-dir [storeDir]', 'Set store dir')

packages/core/src/store/lock-file.ts

@@ -4,7 +4,7 @@ import path from 'path'
 import fs from 'fs-extra'
 
 import { LOCK_FILE, STORE_PATH } from '../utils/constants'
-import { CommonOptions, LockFile, Package } from '../interface'
+import { CommonOptions, LockFile, Package, Config } from '../interface'
 import { debug } from '../utils/logger'
 import { isMatchPreset } from '../utils'
 
@@ -88,6 +88,18 @@ export const createLockFile = ({ lockFilePath }: { lockFilePath: string }) => {
       debug.lockfile('templates list %O', allTemplates)
       return allTemplates
     },
+    /**
+     * @description read `neo-lock` preset config files
+     */
+    async readConfigs() {
+      const lockFile = await this.read()
+      const presets: LockFile['presets'] = lockFile.presets || {}
+      return Object.keys(presets).reduce((acc, cur) => {
+        // inject original preset
+        const configs = presets[cur]?.configs || []
+        return acc.concat(configs.map((config) => ({ ...config, preset: cur })))
+      }, [] as Partial<Config & { preset: string }>[])
+    },
   }
 }
 

packages/core/src/utils/logger.ts

@@ -42,6 +42,7 @@ export const debug = {
   store: Debug('neo:store'),
   add: Debug('neo:cmd:add'),
   create: Debug('neo:cmd:create'),
+  list: Debug('neo:cmd:list'),
 }
 
 export default {

packages/core/test/cmd-list/list-config.test.ts

@@ -0,0 +1,12 @@
+import { execNeo, mockLockFile, storeDir } from '../helpers'
+
+beforeAll(async () => {
+  await mockLockFile()
+})
+
+describe('command list', () => {
+  it('should list configs', async () => {
+    const { stdout } = await execNeo(['list', 'configs', '--store-dir', storeDir])
+    expect(stdout).toMatchSnapshot()
+  })
+})

packages/presets/aiou/assets/workflows/ci.yaml

@@ -0,0 +1,33 @@
+name: Node.js CI
+
+on:
+  push:
+  pull_request:
+    branches: [master,release]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: test
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+
+    steps:
+      - name: checkout code repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install pnpm
+        run: npm i pnpm@latest -g
+      - name: Install 
+        run: |
+          pnpm install --frozen-lockfile=false
+      - name: Test
+        run: |
+          pnpm test

packages/presets/aiou/index.json

@@ -1,4 +1,10 @@
 {
+  "configs": [
+    {
+      "name": "Pnpm CI workflow",
+      "pref": "./assets/workflows/ci.yaml"
+    }
+  ],
   "templates": [
     {
       "name": "@aiou/ts-lib-template"

packages/presets/aiou/package.json

@@ -23,6 +23,10 @@
     "email": "jiangweixian1994@gmail.com",
     "url": "https://twitter.com/jiangweixian"
   },
+  "files": [
+    "assets",
+    "index.json"
+  ],
   "main": "index.json",
   "scripts": {
     "build": "echo build",

packages/schema/src/index.ts

@@ -3,6 +3,12 @@ export interface PresetTemplate {
   pref: string
 }
 
+export type Config = {
+  pref: string
+  name: string
+}
+
 export type Preset = {
   templates: PresetTemplate[]
+  configs: Config[]
 }