inquirer-plugins 1.0.0-alpha.7 → 1.0.1

package/src/_internal/plugins/table/README.md

@@ -1,117 +0,0 @@
-<!-- MD_HOPPER: ID: src-_internal-plugins-table-rmd -->
-<!-- MD_HOPPER: TITLE: TABLE PLUGIN -->
-<!-- MD_HOPPER: OUTPUT: README.md -->
-
-`Table Plugin` is based on the original [inquirer-table-input](https://github.com/edelciomolina/inquirer-table-input).
-This plugin has been customized to support TypeScript and symbol input.
-
-```ts
-import chalk from 'chalk'
-import inquirer from 'inquirer'
-import { TablePlugin, TableQuestion } from 'inquirer-plugins/table'
-
-inquirer.registerPrompt('table', TablePlugin)
-
-const question: TableQuestion = {
-  type: 'table',
-  name: 'settings',
-  message: 'SETTINGS',
-  description: `You can edit data.`,
-  disableColumnIndexes: [0],
-  colors: {
-    selected: chalk.hex('#FFA500'),
-    editable: chalk.green,
-    editing: chalk.hex('#F577F5'),
-  },
-  columns: [
-    { name: cyan.bold('ID'), value: 'id', type: 'input' },
-    {
-      name: cyan.bold('filename'),
-      value: 'filename',
-      type: 'input',
-      parser: (input: string, _inputs, _answers) => (/\.md$/.test(input) ? input : `${input}.md`),
-    },
-    {
-      name: cyan.bold('count'),
-      value: 'cnt',
-      type: 'number',
-      validate: (input: string, _inputs, _answers) => {
-        const isValid = Number(input) > 0
-        return {
-          isValid,
-          message: isValid ? '' : error('should be more than 0'),
-        }
-      },
-    },
-    { name: cyan.bold('IS LOCK'), value: 'lock', type: 'confirm' },
-  ],
-  rows: [
-    [chalk.bold('ABCD'), 'hoge', 0, true],
-    [chalk.bold('EFG'), 'foo', 1, false],
-  ],
-  validate: (inputs, _answers) => {
-    const isValid = inputs.every((i: any) => Object.values(i).every(v => `${v}`.length))
-    return {
-      isValid,
-      message: isValid ? '' : 'not allow empty input',
-    }
-  },
-}
-inquirer.prompt([question])
-```
-
-> In the [inquirer-table-input](https://github.com/edelciomolina/inquirer-table-input#usage), it was necessary to set validation to false, but this plugin makes it configurable by separating the validation and processing within Inquirer. Instead of using a boolean, changes have been made to pass isValid and message.
-
-```json
-{
-  "settings": {
-    "state": true,
-    "result": [
-      {
-        "id": "ABCD",
-        "filename": "hoge.md",
-        "cnt": 0,
-        "lock": true
-      },
-      {
-        "id": "EFG",
-        "filename": "foo.md",
-        "cnt": 1,
-        "lock": false
-      }
-    ]
-  }
-}
-```
-
-## Params
-
-- **type** [*required*]
-- **name** [*required*]
-- **message** [*optional*] (String | ChalkInstance)
-- **description** [*optional*] (String | ChalkInstance)
-- **escapeMessage** [*optional*] (String | ChalkInstance)
-- **confirmMessage** [*optional*] (String | ChalkInstance)
-- **disableColumnIndexes** [*optional*] (number[])
-- **colors** [*optional*]
-  - _selected_ [*optional*] (ChalkInstance)
-  - _editable_ [*optional*] (ChalkInstance)
-  - _editing_ [*optional*] (ChalkInstance)
-- **columns** [*required*]
-- **rows** [*required*]
-- **validate** [*optional*] (() => { isValid: boolean, message: string })
-- **pageSize** [*optional*] number
-
-## Column Params
-
-- **name**: [*required*] (String | ChalkInstance) To show table header colum name.
-- **value**: [*required*] (String) result param property name.
-- **type**: [*required*] (String) `input`, `number`, `confirm`
-- **parser**: [*optional*] (() => any) table view & result parser
-- **validate**: [*optional*] (() => { isValid: boolean, message: string }) validate cell
-
-## Raws (number | string | boolean)
-
-<!-- MD_HOPPER: BEGIN_DEFINE_LINKS: -->
-
-<!-- MD_HOPPER: END_DEFINE_LINKS: -->

package/src/_internal/plugins/table/table.ts

@@ -1,93 +0,0 @@
-import { Answers } from 'inquirer'
-
-import { PARSE_TYPES } from '~types/parse-types.js'
-import { trim, error } from '~utils/chalk.js'
-import { parse } from '~utils/parse-types.js'
-
-import { Column, Cell, RawInputs } from './types.js'
-
-export class TableClass {
-  columns: Column[] = []
-  rows: string[][] = []
-
-  constructor(columns: Column[], rows: Cell[][]) {
-    this.columns = columns
-    this.rows = rows.map(columns => columns.map(value => `${value}`))
-  }
-
-  get header() {
-    return this.columns.map(({ name }) => `${name}`)
-  }
-
-  getColumnType(columnIndex: number) {
-    if (!(columnIndex in this.columns)) {
-      return PARSE_TYPES.input
-    }
-    return this.columns[columnIndex].type
-  }
-
-  getParser(columnIndex: number): Exclude<Column['parser'], undefined> {
-    return this.columns[columnIndex].parser || ((txt: string, _inputs: RawInputs, _answers: Answers) => txt)
-  }
-
-  getValidator(columnIndex: number): Exclude<Column['validate'], undefined> {
-    return (
-      this.columns[columnIndex].validate ||
-      ((_txt: string, _inputs: RawInputs, _answers: Answers) => ({ isValid: true, message: '' }))
-    )
-  }
-
-  updateRow(rowIndex: number, columnIndex: number, value: string, answers: Answers) {
-    if (!(rowIndex in this.rows)) {
-      return error(`row index (${rowIndex}) not found`)
-    }
-    const columns = this.rows[rowIndex]
-    if (!(columnIndex in columns)) {
-      return error(`column index (${columnIndex}) not found`)
-    }
-    const validateResult = this.getValidator(columnIndex)(value, this.getRaw(), answers)
-    if (!validateResult.isValid) {
-      return validateResult.message
-    }
-    const parser = this.getParser(columnIndex)
-    const parsed = parser(value, this.getRaw(), answers)
-    columns[columnIndex] = `${parsed}`
-    return ''
-  }
-
-  getValue(rowIndex: number, columnIndex: number) {
-    if (!(rowIndex in this.rows)) {
-      return ''
-    }
-    const columns = this.rows[rowIndex]
-    if (!(columnIndex in columns)) {
-      return ''
-    }
-    return columns[columnIndex]
-  }
-
-  getRaw(): RawInputs {
-    const result: RawInputs = []
-    for (let i = 0; i < this.rows.length; i++) {
-      result.push({})
-      for (let ii = 0; ii < (this.rows[i] || []).length; ii++) {
-        const { value: key } = this.columns[ii]
-        result[i][key] = trim(this.rows[i][ii])
-      }
-    }
-    return result
-  }
-
-  getResult(answers: Answers) {
-    const result: Record<string, Cell>[] = []
-    for (let i = 0; i < this.rows.length; i++) {
-      result.push({})
-      for (let ii = 0; ii < (this.rows[i] || []).length; ii++) {
-        const { value: key, type, parser } = this.columns[ii]
-        const value = trim(this.rows[i][ii])
-        result[i][key] = parser ? parser(value, this.getRaw(), answers) : parse(value, type)
-      }
-    }
-    return result
-  }
-}

package/src/_internal/plugins/table/types.ts

@@ -1,74 +0,0 @@
-import chalk, { ChalkInstance } from 'chalk'
-import { Answers } from 'inquirer'
-
-import { ParseType } from '~types/parse-types.js'
-import { hop, success, warn } from '~utils/chalk.js'
-
-export const DEFAULT_PAGE_SIZE = 5
-export const INDEX_ERRORS = Object.freeze({
-  excess: 'excess',
-  disabled: 'disabled',
-} as const)
-
-export interface DefaultOptions extends Required<Omit<TableQuestion, 'type' | 'name' | 'colors'>> {
-  colors: Colors
-}
-
-export const DEFAULT_OPTIONS: DefaultOptions = {
-  message: '',
-  description: '',
-  escapeMessage: chalk.red('Press ESC again to exit!'),
-  confirmMessage: chalk.red('Press ENTER again to confirm!'),
-  disableColumnIndexes: [],
-  colors: {
-    selected: warn,
-    editable: success,
-    editing: hop,
-  },
-  columns: [],
-  rows: [],
-  pageSize: DEFAULT_PAGE_SIZE,
-  validate: () => ({ isValid: true, message: '' }),
-}
-
-export interface RequiredOptions extends Required<Omit<TableQuestion, 'colors'>> {
-  colors: Colors
-}
-
-export interface Colors {
-  selected: ChalkInstance
-  editable: ChalkInstance
-  editing: ChalkInstance
-}
-
-export interface ValidateResult {
-  isValid: boolean
-  message: string
-}
-
-export interface TableQuestion {
-  type: string
-  name: string
-  message?: string | ChalkInstance
-  description?: string | ChalkInstance
-  escapeMessage?: string | ChalkInstance
-  confirmMessage?: string | ChalkInstance
-  disableColumnIndexes?: number[]
-  colors?: Partial<Colors>
-  columns: Column[]
-  rows: Cell[][]
-  validate?: (...args: any[]) => ValidateResult
-  pageSize?: number
-}
-
-export interface Column {
-  name: string | ChalkInstance
-  value: string
-  type: ParseType
-  validate?: (input: string, raws: RawInputs, answers: Answers) => ValidateResult
-  parser?: (input: any, raws: RawInputs, answers: Answers) => any
-}
-
-export type Cell = number | string | boolean
-
-export type RawInputs = Record<string, string>[]

package/src/_internal/plugins/table/utils.ts

@@ -1,25 +0,0 @@
-import { INDEX_ERRORS } from '~internal/plugins/table/types.js'
-
-export const isNoChoiceOfIndex = (maxIndex: number, disableIndexes: number[]) => {
-  return disableIndexes.length > maxIndex && [...Array(maxIndex).keys()].every(index => disableIndexes.includes(index))
-}
-
-export const gateValidateColumnIndexError = (index: number, maxIndex: number, disableIndexes: number[]) => {
-  if (index > maxIndex || index < 0) {
-    return INDEX_ERRORS.excess
-  }
-  if (disableIndexes.includes(index)) {
-    return INDEX_ERRORS.disabled
-  }
-  return false
-}
-
-export const getNextIndex = (index: number, maxIndex: number, num: number) => {
-  if (index > maxIndex) {
-    return 0
-  }
-  if (index < 0) {
-    return maxIndex
-  }
-  return index > maxIndex ? 0 : index + num
-}

package/src/_internal/plugins/table.ts

@@ -1,305 +0,0 @@
-import { Interface as ReadLineInterface, Key } from 'readline'
-
-import { ChalkInstance } from 'chalk'
-import cliCursor from 'cli-cursor'
-import Table from 'cli-table3'
-import { Question, Answers } from 'inquirer'
-import Base from 'inquirer/lib/prompts/base.js'
-import observe from 'inquirer/lib/utils/events.js'
-import { map } from 'rxjs/operators'
-
-import { Done } from '~types/inquirer.js'
-import { dim, error } from '~utils/chalk.js'
-import { getKeypressValue, getBackspaceText } from '~utils/keypress.js'
-
-import { TableClass } from './table/table.js'
-import { DEFAULT_OPTIONS, RequiredOptions, TableQuestion } from './table/types.js'
-import { isNoChoiceOfIndex, gateValidateColumnIndexError, getNextIndex } from './table/utils.js'
-
-export class TablePlugin extends Base {
-  table = new TableClass([], [])
-  options!: RequiredOptions
-
-  done!: Done
-
-  pointerIndexes = {
-    row: 0,
-    column: 0,
-  }
-  isNextCloses = {
-    escape: false,
-  }
-  editing = false
-  temporaryBackup: string | null = null
-  purTyping = ''
-  answers: Answers = []
-
-  constructor(question: Question<TableQuestion>, readLine: ReadLineInterface, answers: Answers) {
-    super({ ...question, validate: () => false } as Question, readLine, answers)
-    this.options = {
-      ...DEFAULT_OPTIONS,
-      ...(this.opt as any),
-      validate: question.validate || DEFAULT_OPTIONS.validate,
-    }
-    this.answers = answers
-    this.table = new TableClass(this.options.columns, this.options.rows)
-
-    if (isNoChoiceOfIndex(this.maxColumnIndex, this.options.disableColumnIndexes)) {
-      throw new Error('disableColumnIndexes contains all of index.')
-    }
-    this.pointerIndexes.row = 0
-    this.updateColumnIndex(1)
-  }
-
-  getCurrentValues() {
-    return this.table.getResult(this.answers)
-  }
-
-  isEditable(index: number) {
-    return !this.options.disableColumnIndexes.includes(index)
-  }
-
-  _run(callback: Done) {
-    this.done = callback
-
-    const events = observe(this.rl)
-    const validation = this.handleSubmitEvents(events.line.pipe(map(this.getCurrentValues.bind(this))))
-    validation.success.forEach(this.onEnd.bind(this))
-    validation.error.forEach(this.onError.bind(this))
-
-    events.keypress.forEach(({ key }) => {
-      if (key.name !== 'escape') {
-        this.isNextCloses.escape = false
-      }
-
-      if (!this.editing) {
-        switch (key.name) {
-          case 'down':
-            return this.onDownKey()
-
-          case 'up':
-            return this.onUpKey()
-
-          case 'left':
-            return this.onLeftKey()
-
-          case 'right':
-            return this.onRightKey()
-
-          case 'escape':
-            if (!this.isNextCloses.escape) {
-              this.isNextCloses.escape = true
-              return this.render()
-            } else {
-              this.render()
-              return this.onEnd(false)
-            }
-
-          default:
-            if (this.isEditable(this.pointerIndexes.column)) {
-              this.editing = true
-              this.clear()
-              this.onEditPress(key)
-            }
-        }
-      } else {
-        return this.onEditPress(key)
-      }
-    })
-
-    cliCursor.hide()
-    this.render()
-
-    return this
-  }
-
-  get maxPageIndex() {
-    return this.options.pageSize - 1
-  }
-  get maxRowIndex() {
-    return this.table.rows.length - 1
-  }
-
-  get maxColumnIndex() {
-    return this.table.columns.length - 1
-  }
-
-  onDownKey() {
-    if (this.pointerIndexes.row < this.maxRowIndex) {
-      ++this.pointerIndexes.row
-    }
-    this.render()
-  }
-  onUpKey() {
-    if (this.pointerIndexes.row > 0) {
-      --this.pointerIndexes.row
-    }
-    this.render()
-  }
-
-  updateColumnIndex(num: number) {
-    let index = this.pointerIndexes.column
-    for (let c = 0; c <= this.maxColumnIndex; c++) {
-      index = getNextIndex(index, this.maxColumnIndex, num)
-      const error = gateValidateColumnIndexError(index, this.maxColumnIndex, this.options.disableColumnIndexes)
-      if (!error) {
-        break
-      }
-    }
-    this.pointerIndexes.column = index
-  }
-
-  onLeftKey() {
-    this.updateColumnIndex(-1)
-    this.render()
-  }
-
-  onRightKey() {
-    this.updateColumnIndex(1)
-    this.render()
-  }
-
-  clear() {
-    this.temporaryBackup = null
-    this.purTyping = ''
-  }
-
-  onEnd(state: any) {
-    this.render(true)
-    this.status = 'answered'
-    this.screen.done()
-    cliCursor.show()
-    if (state) {
-      return this.done({
-        state,
-        result: this.getCurrentValues(),
-      })
-    } else {
-      return this.done({
-        state,
-      })
-    }
-  }
-
-  validate() {
-    return this.options.validate(this.getCurrentValues(), this.answers)
-  }
-
-  onError(_state: any) {
-    if (this.editing) {
-      this.editing = false
-      this.render()
-    } else {
-      if (this.validate().isValid) {
-        return this.onEnd(true)
-      } else {
-        return this.render()
-      }
-    }
-  }
-
-  updateChoice(value: string) {
-    return this.table.updateRow(this.pointerIndexes.row, this.pointerIndexes.column, value, this.answers)
-  }
-
-  get currentValue() {
-    return this.table.getValue(this.pointerIndexes.row, this.pointerIndexes.column)
-  }
-
-  onEditPress(key: Key) {
-    if (this.temporaryBackup === null) {
-      this.temporaryBackup = this.currentValue
-    }
-    let value = this.purTyping
-    switch (key.name) {
-      case 'escape':
-        this.purTyping = ''
-        value = this.temporaryBackup
-        this.editing = false
-        break
-      case 'delete':
-        this.purTyping = ''
-        value = this.purTyping
-        break
-      case 'backspace': {
-        this.purTyping = getBackspaceText(this.purTyping)
-        value = this.purTyping
-        break
-      }
-      default:
-        this.purTyping = `${this.purTyping}${getKeypressValue(key)}`
-        value = this.purTyping
-        break
-    }
-    const message = this.updateChoice(value)
-    this.render(false, message)
-  }
-
-  getShowRowIndex() {
-    const middleOfPage = Math.floor(this.options.pageSize / 2)
-    let rowIndexFrom = Math.max(0, this.pointerIndexes.row - middleOfPage)
-    const rowIndexTo = Math.min(this.maxRowIndex, rowIndexFrom + this.maxPageIndex)
-    rowIndexFrom = Math.min(rowIndexFrom, rowIndexTo - (this.options.pageSize - 1))
-    return { rowIndexFrom, rowIndexTo }
-  }
-
-  isSelected(rowIndex: number, columnIndex: number) {
-    return this.pointerIndexes.row === rowIndex && this.pointerIndexes.column === columnIndex
-  }
-  getColor(_value: string, isSelected: boolean, isEditable: boolean) {
-    const value = isEditable ? _value : dim(_value)
-    if (!isSelected) {
-      return value
-    }
-    if (this.editing) {
-      return isEditable ? this.options.colors.editing(value) : this.options.colors.selected(value)
-    }
-    return isEditable ? this.options.colors.editable(value) : this.options.colors.selected(value)
-  }
-
-  render(isDisconnect = false, message = '') {
-    let content = this.getQuestion()
-    let bottomContent: string | ChalkInstance = ''
-
-    content += this.options.description ? `\n${this.options.description}` : ''
-
-    const { rowIndexFrom, rowIndexTo } = this.getShowRowIndex()
-    const table = new Table({
-      head: this.table.header,
-    })
-    for (let i = 0; i < this.table.rows.length; i++) {
-      if (i < rowIndexFrom || i > rowIndexTo) {
-        continue
-      }
-      const columnValues: string[] = []
-      for (let ii = 0; ii < (this.table.rows[i] || []).length; ii++) {
-        const isEditable = this.isEditable(ii)
-        const value = this.table.rows[i][ii]
-        const parser = this.table.getParser(ii)
-        columnValues.push(
-          this.getColor(parser(value, this.table.getRaw(), this.answers), this.isSelected(i, ii), isEditable)
-        )
-      }
-      table.push(columnValues)
-    }
-
-    content += '\n\n' + table.toString()
-
-    if (!isDisconnect) {
-      const validateResult = this.validate()
-      if (!this.editing && validateResult.isValid) {
-        bottomContent = this.options.confirmMessage
-      }
-      if (!validateResult.isValid) {
-        bottomContent = validateResult.message || error('Something went wrong.')
-      }
-    }
-    if (this.isNextCloses.escape) {
-      bottomContent = this.options.escapeMessage
-    }
-    if (message) {
-      bottomContent = message
-    }
-    this.screen.render(content, bottomContent as string)
-  }
-}

package/src/_internal/plugins/test.ts

@@ -1,76 +0,0 @@
-import chalk from 'chalk'
-import inquirer from 'inquirer'
-
-import { success, warn, hop, cyan, error } from '../utils/chalk.js'
-
-import { TableQuestion } from './table/types.js'
-import { TablePlugin } from './table.js'
-
-const run = async () => {
-  inquirer.registerPrompt('table-input', TablePlugin)
-  // const rows = [...Array(33).keys()].map(i => [cyan(`--path ${i}--`), '--id--', true, i + 100, '--lock--'])
-  const question: TableQuestion = {
-    type: 'table-input',
-    name: 'settings',
-    message: 'SETTINGS',
-    description: `You can edit data.`,
-    disableColumnIndexes: [0],
-    colors: {
-      selected: warn,
-      editable: success,
-      editing: hop,
-    },
-    // columns: [
-    //   { name: cyan.bold('filepath'), value: 'path', type: 'input' },
-    //   { name: cyan.bold('id'), value: 'id', type: 'input', parser: () => 'aaa' },
-    //   { name: cyan.bold('title'), value: 'title', type: 'confirm' },
-    //   {
-    //     name: cyan.bold('num'),
-    //     value: 'output',
-    //     type: 'number',
-    //     validate: (value: string) => /^\d*$/.test(value) || value === '0' || !value,
-    //   },
-    //   { name: cyan.bold('lock'), value: 'lock', type: 'input' },
-    // ],
-    // rows: rows,
-    columns: [
-      { name: cyan.bold('ID'), value: 'id', type: 'input' },
-      // { name: cyan.bold('title'), value: 'title', type: 'input', parser: (input: string) => `${input}.md` },
-      { name: cyan.bold('title'), value: 'title', type: 'input', parser: (input: string) => /\.md$/.test(input) ? input : `${input}.md` },
-      { name: cyan.bold('count'), value: 'cnt', type: 'number', validate: (input) => {
-        const isValid = input !== '0'
-          return {
-            isValid,
-            message: isValid ? '' : error('should be more than 0')
-          }
-        }
-      },
-      { name: cyan.bold('IS LOCK'), value: 'lock', type: 'confirm' },
-    ],
-    rows: [
-      [chalk.bold('ABCD'), 'hoge', 0, true],
-      [chalk.bold('EFG'), 'foo', 1, false]
-    ],
-    validate: (inputs, _answers) => {
-      const isValid = inputs.every((i: any) => Object.values(i).every(v => `${v}`.length))
-      return {
-        isValid,
-        message: isValid ? '' : 'not allow empty input',
-      }
-    },
-  }
-  const answers = await inquirer.prompt([
-    // {
-    //   type: 'confirm',
-    //   name: 'id',
-    //   message: 'type id',
-    //   choices: ['aa', 'bb']
-    // },
-    question,
-  ])
-  console.log('answers', JSON.stringify(answers, null, 2))
-}
-
-run().then(() => {
-  console.log('--- end ---')
-})

package/src/_internal/types/inquirer.ts

@@ -1 +0,0 @@
-export type Done = (value: any) => void

package/src/_internal/utils/chalk.ts

@@ -1,13 +0,0 @@
-import chalk from 'chalk'
-
-// eslint-disable-next-line no-control-regex
-export const trim = (txt: string) => txt.replace(/\u001b\[[0-9;]*m/g, '')
-
-export const success = chalk.green
-export const warn = chalk.hex('#FFA500')
-export const info = chalk.hex('#77CFF5')
-export const error = chalk.red
-export const hop = chalk.hex('#F577F5')
-export const cyan = chalk.cyan
-export const bold = chalk.bold
-export const dim = chalk.dim