@magic/cli 0.0.47 → 0.0.49

package/README.md

@@ -558,6 +558,18 @@ update dependencies
 - add more tests
 - update dependencies
 
-##### 0.0.48 - unreleased
+##### 0.0.48
+
+- types changed to allow correct props when calling /src/index.js cli function
+
+##### 0.0.49
+
+- update dependencies
+
+##### 0.0.50
+
+- update dependencies
+
+##### 0.0.51 - unreleased
 
 - ...

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magic/cli",
-  "version": "0.0.47",
+  "version": "0.0.49",
   "homepage": "https://magic.github.io/cli",
   "description": "declarative command line interfaces with aliasing, commands and environment sanitization",
   "scripts": {
@@ -36,11 +36,11 @@
     "declarative"
   ],
   "dependencies": {
-    "@magic/cases": "0.0.10",
-    "@magic/deep": "0.1.18",
-    "@magic/error": "0.0.20",
-    "@magic/log": "0.1.20",
-    "@magic/types": "0.1.28"
+    "@magic/cases": "0.0.11",
+    "@magic/deep": "0.1.20",
+    "@magic/error": "0.0.21",
+    "@magic/log": "0.1.21",
+    "@magic/types": "0.1.30"
   },
   "devDependencies": {
     "@magic-modules/git-badges": "0.0.12",
@@ -50,7 +50,7 @@
     "@magic-themes/docs": "0.0.15",
     "@magic/core": "0.0.156",
     "@magic/format": "0.0.68",
-    "@magic/test": "0.2.20",
+    "@magic/test": "0.2.25",
     "typescript": "5.9.3"
   },
   "author": "Wizards & Witches",

package/src/index.js

@@ -8,11 +8,35 @@ import { execFile as executeFile } from './execFile.js'
 import { spawn as spawner } from './spawn.js'
 import { prompt as promptUser } from './prompt.js'
 
+/**
+ * @typedef {object} ParseProps
+ * @property {Array<string|string[]>} [options]
+ * @property {Record<string, any>|Array<any>} [prepend]
+ * @property {Record<string, any>|Array<any>} [append]
+ * @property {Record<string, any>} [default]
+ * @property {boolean} [pure]
+ * @property {boolean} [pureEnv]
+ * @property {boolean} [pureArgv]
+ * @property {boolean} [pureCommands]
+ * @property {Array<string|string[]>} [commands]
+ * @property {Array<[string[], string, string]>} [env]
+ * @property {Array<string|string[]>} [required]
+ * @property {object} [help]
+ */
+
+/**
+ * @typedef {object} ParsedCLI
+ * @property {Record<string, string>} env
+ * @property {Record<string, any>} argv
+ * @property {Record<string, any>} args
+ * @property {Record<string, boolean>} commands
+ * @property {Array<string|string[]>} errors
+ */
+
 /**
  * Main CLI entry point
- * @param {object} args - CLI configuration object.
- * @param {(string | string[])[]} [args.options=[]] - Command-line options array.
- * @returns {object} Parsed CLI data.
+ * @param {ParseProps} args - CLI configuration object.
+ * @returns {ParsedCLI}
  */
 export const cli = (args = {}) => {
   const { options = [] } = args

package/src/parse/clean.js

@@ -10,9 +10,9 @@ import cases from '@magic/cases'
 /**
  * Cleans CLI parsed arguments for single-value keys, applying defaults.
  *
- * @param {import('./index.js').ParsedCLI} cli
+ * @param {import('../index.js').ParsedCLI} cli
  * @param {CleanProps} [props={}]
- * @returns {import('./index.js').ParsedCLI}
+ * @returns {import('../index.js').ParsedCLI}
  */
 export const clean = (cli, props = {}) => {
   if (is.empty(props.single)) {

package/src/parse/index.js

@@ -4,36 +4,11 @@ import { parseCommands } from './commands.js'
 import { parseRequired } from './required.js'
 import { clean } from './clean.js'
 
-/**
- * @typedef {object} ParseProps
- * @property {Array<string|string[]>} [options]
- * @property {Record<string, any>|Array<any>} [prepend]
- * @property {Record<string, any>|Array<any>} [append]
- * @property {Record<string, any>} [default]
- * @property {boolean} [pure]
- * @property {boolean} [pureEnv]
- * @property {boolean} [pureArgv]
- * @property {boolean} [pureCommands]
- * @property {Array<string|string[]>} [commands]
- * @property {Array<[string[], string, string]>} [env]
- * @property {Array<string|string[]>} [required]
- * @property {object} [help]
- */
-
-/**
- * @typedef {object} ParsedCLI
- * @property {Record<string, string>} env
- * @property {Record<string, any>} argv
- * @property {Record<string, any>} args
- * @property {Record<string, boolean>} commands
- * @property {Array<string|string[]>} errors
- */
-
 /**
  * Parses CLI arguments, commands, environment variables, and required options.
  *
- * @param {ParseProps} props
- * @returns {ParsedCLI}
+ * @param {import('../index.js').ParseProps} props
+ * @returns {import('../index.js').ParsedCLI}
  */
 export const parse = props => {
   const { pure = false } = props

package/types/index.d.ts

@@ -1,4 +1,4 @@
-export function cli(args?: { options?: (string | string[])[] | undefined }): object
+export function cli(args?: ParseProps): ParsedCLI
 export namespace cli {
   export { spawner as spawn }
   export { execute as exec }
@@ -30,6 +30,27 @@ export const execFile: (
   opts?: import('child_process').ExecFileOptions,
 ) => Promise<string | Buffer>
 export default cli
+export type ParseProps = {
+  options?: (string | string[])[] | undefined
+  prepend?: any[] | Record<string, any> | undefined
+  append?: any[] | Record<string, any> | undefined
+  default?: Record<string, any> | undefined
+  pure?: boolean | undefined
+  pureEnv?: boolean | undefined
+  pureArgv?: boolean | undefined
+  pureCommands?: boolean | undefined
+  commands?: (string | string[])[] | undefined
+  env?: [string[], string, string][] | undefined
+  required?: (string | string[])[] | undefined
+  help?: object | undefined
+}
+export type ParsedCLI = {
+  env: Record<string, string>
+  argv: Record<string, any>
+  args: Record<string, any>
+  commands: Record<string, boolean>
+  errors: Array<string | string[]>
+}
 import { spawn as spawner } from './spawn.js'
 import { exec as execute } from './exec.js'
 import { prompt as promptUser } from './prompt.js'

package/types/parse/clean.d.ts

@@ -1,7 +1,7 @@
 export function clean(
-  cli: import('./index.js').ParsedCLI,
+  cli: import('../index.js').ParsedCLI,
   props?: CleanProps,
-): import('./index.js').ParsedCLI
+): import('../index.js').ParsedCLI
 export type CleanProps = {
   /**
    * - List of single-value argument keys to clean.

package/types/parse/index.d.ts

@@ -1,22 +1 @@
-export function parse(props: ParseProps): ParsedCLI
-export type ParseProps = {
-  options?: (string | string[])[] | undefined
-  prepend?: any[] | Record<string, any> | undefined
-  append?: any[] | Record<string, any> | undefined
-  default?: Record<string, any> | undefined
-  pure?: boolean | undefined
-  pureEnv?: boolean | undefined
-  pureArgv?: boolean | undefined
-  pureCommands?: boolean | undefined
-  commands?: (string | string[])[] | undefined
-  env?: [string[], string, string][] | undefined
-  required?: (string | string[])[] | undefined
-  help?: object | undefined
-}
-export type ParsedCLI = {
-  env: Record<string, string>
-  argv: Record<string, any>
-  args: Record<string, any>
-  commands: Record<string, boolean>
-  errors: Array<string | string[]>
-}
+export function parse(props: import('../index.js').ParseProps): import('../index.js').ParsedCLI