@bemoje/cli 0.0.4 → 0.0.5

package/{src → dist/types}/util/types/TPlainObject.d.ts

@@ -1,2 +1,2 @@
-import { ObjectKey } from './ObjectKey';
+import type { ObjectKey } from './ObjectKey';
 export type TPlainObject<K extends ObjectKey = ObjectKey, V = any> = Record<K, V>;

package/dist/types/util/types/TValidator.d.ts

@@ -0,0 +1,2 @@
+import type { Any } from './Any';
+export type TValidator<T = Any> = (value: T) => boolean;

package/{src → dist/types}/util/validation/ensureThat.d.ts

@@ -1,5 +1,5 @@
-import { Any } from '../types/Any';
-import { TConstructor } from '../types/TConstructor';
+import type { Any } from '../types/Any';
+import type { TConstructor } from '../types/TConstructor';
 export declare function ensureThat<T>(value: T, validator: ((value: T, ...args: any[]) => boolean | string) | ((value: T, ...args: any[]) => boolean), options?: {
     Err?: TConstructor;
     args?: Any[];

package/{src → dist/types}/util/validation/isFunction.d.ts

@@ -1,4 +1,4 @@
-import { TFunction } from '../types/TFunction';
+import type { TFunction } from '../types/TFunction';
 /**
  * Checks if the given value is a function.
  *

package/{src → dist/types}/util/validation/isNamedFunction.d.ts

@@ -1,4 +1,4 @@
-import { TFunction } from '../types/TFunction';
+import type { TFunction } from '../types/TFunction';
 /**
  * Checks if the provided value is a named function.
  */

package/{src → dist/types}/util/validation/isPlainObject.d.ts

@@ -1,5 +1,5 @@
-import { ObjectKey } from '../types/ObjectKey';
-import { TPlainObject } from '../types/TPlainObject';
+import type { ObjectKey } from '../types/ObjectKey';
+import type { TPlainObject } from '../types/TPlainObject';
 /**
  * Checks if the provided value is a plain object, i.e. an object created by the native base `Object` constructor.
  */

package/{src → dist/types}/util/validation/isPrimitive.d.ts

@@ -1,4 +1,4 @@
-import { TPrimitive } from '../types/TPrimitive';
+import type { TPrimitive } from '../types/TPrimitive';
 /**
  * Checks if the provided value is a primitive type (null, undefined, bigint, boolean, number, string or symbol).
  * @param value The value to check.

package/jest.config.ts

@@ -0,0 +1,11 @@
+/* eslint-disable */
+export default {
+  displayName: 'cli',
+  preset: '../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/packages/cli',
+}

package/notes/tsc.md

@@ -0,0 +1 @@
+npx tsc packages\cli\src\index.ts --outDir packages\cli\dist --module commonjs --lib es2022 --moduleResolution node --downlevelIteration --esModuleInterop --target ES2022 --allowSyntheticDefaultImports --declaration --sourceMap

package/package.json

@@ -1,16 +1,22 @@
 {
   "name": "@bemoje/cli",
-  "version": "0.0.4",
+  "version": "0.0.5",
+  "scripts": {
+    "build:cjs": "rimraf dist/cjs && npx tsc src/index.ts --outDir dist/cjs --module commonjs --lib es2022 --moduleResolution node --downlevelIteration --esModuleInterop --target ES2022 --allowSyntheticDefaultImports --moduleResolution node --sourceMap",
+    "build:esm": "rimraf dist/esm && npx tsc src/index.ts --outDir dist/esm --module es2022 --lib es2022 --moduleResolution node --downlevelIteration --esModuleInterop --target ES2022 --allowSyntheticDefaultImports --moduleResolution node --sourceMap",
+    "build:types": "rimraf dist/types && npx tsc src/index.ts --outDir dist/types --module es2022 --lib es2022 --moduleResolution node --downlevelIteration --esModuleInterop --target ES2022 --allowSyntheticDefaultImports --moduleResolution node --declaration --emitDeclarationOnly",
+    "build": "npm run build:cjs && npm run build:esm && npm run build:types"
+  },
   "dependencies": {
+    "@commander-js/extra-typings": "^11.1.0",
     "ansi-colors": "^4.1.3",
     "cli-table": "^0.3.11",
-    "commander": "^11.1.0",
     "fs-extra": "^11.2.0",
     "is-async-function": "^2.0.0"
   },
-  "type": "commonjs",
-  "main": "./index.cjs.js",
-  "module": "./index.esm.js",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
   "author": {
     "name": "Benjamin Møller Jensen",
     "email": "bemoje@bemoje.net",
@@ -33,6 +39,7 @@
   "devDependencies": {
     "@types/cli-table": "^0.3.4",
     "@types/is-async-function": "^2.0.2",
-    "@types/prompts": "^2.4.9"
+    "@types/prompts": "^2.4.9",
+    "rimraf": "^5.0.5"
   }
 }

package/project.json

@@ -0,0 +1,43 @@
+{
+  "name": "cli",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/cli/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "nx:run-script",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/packages/cli",
+        "main": "packages/cli/src/index.ts",
+        "tsConfig": "packages/cli/tsconfig.lib.json",
+        "assets": [],
+        "project": "packages/cli/package.json",
+        "compiler": "tsc",
+        "format": ["cjs", "esm"]
+      }
+    },
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["packages/cli/**/*.ts", "packages/cli/package.json"]
+      }
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "packages/cli/jest.config.ts",
+        "passWithNoTests": true
+      },
+      "configurations": {
+        "ci": {
+          "ci": true,
+          "codeCoverage": true
+        }
+      }
+    }
+  },
+  "tags": []
+}

package/scripts/_example/CommandBuilder.example.ts

@@ -0,0 +1,96 @@
+import { CLI } from '../../src/cmd/CLI'
+import { isBoolean } from '../../src/util/validation/isBoolean'
+import { parseBoolean } from '../../src/util/string-parsers/parseBoolean'
+
+console.time('load')
+
+const init = CLI('demo', (c) => {
+  c.version('0.0.1')
+  c.description('A CLI example')
+  c.setRecommended()
+  // c.action(() => {})
+
+  c.command('hello', (h) => {
+    h.description('just prints hello')
+    h.argument('[name]')
+    h.action((name?: string) => {
+      console.log('hello ' + name)
+    })
+    h.preset('benja', {
+      description: 'Benjamin',
+      args: ['Benjamin'],
+    })
+    h.preset('thomas', {
+      description: 'Thomas',
+      args: ['Thomas'],
+    })
+  })
+
+  c.command('info', (i) => {
+    i.description('enter info about yourself')
+    i.argument('[name]', (a) => {
+      a.description('Your name')
+    })
+
+    i.argument('[friends]', (a) => {
+      a.description('Comma-delimited list of friends')
+      a.parser.delimitedStrings(',')
+      a.validator.isStringArray()
+    })
+
+    i.argument('[nums...]', (a) => {
+      a.description('Your favorite numbers between 0 and 4')
+      a.choices(['0', '1', '2', '3', '4'])
+      a.parser.integer()
+      a.validator.isIntegerArray()
+    })
+
+    i.option('--age [years]', (o) => {
+      o.description('Your age in years.')
+      o.parser.integer()
+      o.validator.isInteger()
+      o.validator.custom(function isAdult(age: unknown) {
+        return (age as number) >= 18
+      })
+    })
+
+    i.action((name, friends, nums, opts) => {
+      console.log({ name, friends, nums, ...opts })
+    })
+
+    i.config('inSchool', {
+      description: 'whether you are attending school',
+      defaultValue: true,
+      parse: parseBoolean,
+      validate: isBoolean,
+    })
+
+    i.preset('benjabob', {
+      description: 'Benjamin',
+      presets: ['old'],
+      args: ['Benjamin', ['Thomas', 'Lasse']],
+      options: { age: 35 },
+    })
+    i.preset('adult', {
+      description: 'Age is 18',
+      options: { age: 18 },
+    })
+    i.preset('old', {
+      description: 'Age is 35',
+      options: { age: 35 },
+    })
+  })
+
+  c.command('nothing', (n) => {
+    n
+  })
+})
+console.timeEnd('load')
+
+console.time('init')
+export const cli = init()
+console.timeEnd('init')
+
+console.time('exec')
+cli.parse()
+console.timeEnd('exec')

package/scripts/_example/CommandBuilder.example2.ts

@@ -0,0 +1,31 @@
+import { CLI, CommandBuilder } from '../../src'
+
+console.time('load')
+
+const init = CLI('demo', (c) => {
+  c.version('0.0.1')
+  c.description('A CLI example')
+  c.setRecommended()
+  c.command('nothing', function (this: CommandBuilder) {
+    this.features
+  })
+  c.option('--opt1', 'opt1')
+  c.option('--opt2', 'opt2')
+  c.action((opts, cmd) => {
+    cmd.db.appData.update('count1', (c: number) => c + 1)
+    console.log(cmd.db.appData.get())
+  })
+
+  c.appData('count1', { defaultValue: 0 })
+  c.appData('count2', { defaultValue: 0 })
+  console.log(c.dataFilepath)
+})
+console.timeEnd('load')
+
+console.time('init')
+const cli = init()
+console.timeEnd('init')
+
+console.time('exec')
+cli.parse()
+console.timeEnd('exec')

package/scripts/_example/CommandBuilder.example3.ts

@@ -0,0 +1,20 @@
+import { CLI } from '../../src/cmd/CLI'
+
+console.time('load')
+
+const init = CLI('demo', (c) => {
+  c.argument('[arg1...]', (a) => a.default('lol'))
+  c.argument('[arg2]')
+  c.action((arg1, arg2, arg3) => {
+    console.log({ arg1, arg2, arg3 })
+  })
+})
+console.timeEnd('load')
+
+console.time('init')
+const cli = init()
+console.timeEnd('init')
+
+console.time('exec')
+cli.parse()
+console.timeEnd('exec')

package/scripts/_example/bFindIn.ts

@@ -0,0 +1,207 @@
+import { CLI } from '../../src/cmd/CLI'
+import { execInherit } from '../../src/util/node/execInherit'
+import { printCounts } from '../../src/core/counter'
+import { strSplitCamelCase } from '../../src/util/string/strSplitCamelCase'
+
+console.time('load')
+
+const init = CLI('bFindIn', (b) => {
+  b.setRecommended()
+  b.version('0.0.1')
+  b.description(
+    [
+      "Search for 'PATTERN' inside files in 'DIRPATH'.",
+      '  Can search inside zip and binary files - and more.',
+      '',
+      "This is a wrapper for 'ag' which needs to be installed.",
+      '  https://github.com/JFLarvoire/the_silver_searcher',
+      '',
+      'Example Usage:',
+      `  ${b.name} matches keyword ./src`,
+      `  ${b.name} paths keyword --depth=1`,
+      `  ${b.name} file keyword readme.md --ignore-case`,
+    ].join('\n')
+  )
+
+  b.argument('<pattern>', 'search pattern')
+  b.argument('[dirpath]', 'dirpath to search')
+  // pattern settings
+  b.option('-i, --ignore-case', 'Case-insensitive')
+  b.option('-s, --case-sensitive', 'Case-sensitive.')
+  b.option('-Q, --literal', 'Do not parse PATTERN as a regular expression')
+  b.option('-m, --max-count <NUM>', (o) => {
+    o.description('Skip the rest of a file after NUM matches.')
+    o.parser.integer()
+    o.default(10000)
+  })
+  b.option('-w, --word-regexp', 'Only match whole words')
+  b.option('--invert-match', 'Match anything except PATTERN')
+  // navigation patterns
+  b.option('--ignore <names>', (o) => {
+    o.description('Comma-delimited list of dirnames to ignore')
+    o.parser.delimitedStrings(',')
+  })
+  b.option('-U, --skip-vcs-ignores', 'Ignore VCS ignore files (.gitignore, .hgignore; still obey .ignore)')
+  // directory selection
+  b.option('--depth <n>', (o) => {
+    o.description('Max directory depth.')
+    o.parser.integer()
+    o.default(25)
+  })
+  b.option('-f, --follow', 'Follow symlinks')
+  b.option('--one-device', 'Do not follow links to other devices.')
+  b.option('--path-to-ignore <PATH>', 'Filepath to file with paths to ignore.')
+  // file selection
+  b.option(
+    '-u, --unrestricted',
+    'Search all files (ignore .ignore, .gitignore, etc.; searches binary and hidden files as well).'
+  )
+  b.option(
+    '-z, --search-zip',
+    'Search contents of compressed (e.g., gzip) files. Note that Windows zip files are not supported.'
+  )
+  b.option('-a, --all-types', 'Search all files (does not include hidden files or patterns from ignore files)')
+  b.option('-t, --all-text', 'Search all text files (does not include hidden files)')
+  b.option('--ext <file-extensions>', (o) => {
+    o.description('Comma-delimited list of file extensions to include.')
+    o.parser.custom((string: string) => {
+      const arr = string
+        .split(',')
+        .map((s) => s.trim())
+        .filter(Boolean)
+      if (arr.length === 1) return '"\\.' + arr[0] + '$"'
+      return '"\\.(' + arr.join('|') + ')$"'
+    })
+  })
+  // output modes
+  b.option('--files-with-matches', 'Only print filenames that contain matches (do not print the matching lines)')
+  b.option('--silent', 'Suppress all log messages, including errors')
+  b.option('--stats', 'Print stats (files scanned, time taken, etc.)')
+  b.option('--stats-only', 'Print stats and nothing else.')
+  // context
+  b.option('-B, --before <lines>', (o) => {
+    o.description('Print lines before match')
+    o.default(0)
+    o.parser.integer()
+  })
+  b.option('-A, --after <lines>', (o) => {
+    o.description('Print lines after match')
+    o.default(0)
+    o.parser.integer()
+  })
+  b.option('--nobreak', 'Disable printing newlines between matches in different files')
+  b.option('-W, --width <n>', (o) => {
+    o.description('Truncate match lines after n characters.')
+    o.parser.integer()
+  })
+  b.option('--column', 'Print column numbers in results')
+  b.option('--nonumbers', 'Print line numbers. Default is to omit line numbers when searching streams')
+  b.option('--filename', 'Print file names (Enabled unless searching a single file)')
+  b.option('--print-all-files', 'Print headings for all files searched, even those that do not contain matches')
+  b.option('-o, --only-matching', 'Prints only the matching part of the lines')
+  b.option('--print-long-lines', 'Print matches on very long lines (Default: >2k characters)')
+  b.option('-C, --context <lines>', (o) => {
+    o.description('Print lines before and after matches')
+    o.default(0)
+    o.parser.integer()
+  })
+  b.option('-H, --noheading', "Disable printing file names before each file's matches")
+  b.option('-c, --count', 'Only print file match counts. (Not always equal to matching lines count)')
+  // misc
+  b.option('-g, --filename-pattern <pattern>', 'Print filenames matching PATTERN')
+  b.option('-L, --files-without-matches', 'Only print filenames that do not contain matches')
+  b.option('--passthrough', 'When searching a stream, print all lines even if they do not match')
+  b.option('-0, --print0', "Separate filenames with null (for 'xargs -0')")
+  b.option('--ackmate', 'Print results in AckMate-parseable format')
+  b.option('--vimgrep', 'Print results like :vimgrep /pattern/g would in vim (reports every line match)')
+  // teminal colors
+  b.option('--nocolor', 'Disable printing color codes in results')
+  b.option('--color-line-number <cc>', (o) => {
+    o.description('Color codes for line numbers')
+    o.default('1;33')
+  })
+  b.option('--color-match <cc>', (o) => {
+    o.description('Color codes for result match numbers')
+    o.default('30;43')
+  })
+  b.option('--color-path <cc>', (o) => {
+    o.description('Color codes for path names')
+    o.default('1;32')
+  })
+  b.option('--color-win-ansi', 'Always use ANSI colors in Windows (except pager/pipe remain ANSI)')
+
+  ////////////////
+
+  b.action(async (pattern, dirpath, opts) => {
+    const args: string[] = []
+    for (const [k, value] of Object.entries(opts)) {
+      if (k === 'debug') continue
+      let key = strSplitCamelCase(k)
+        .map((s) => s.trim())
+        .join('-')
+        .toLowerCase()
+      if (key === 'ext') key = 'file-search-regex'
+
+      if (value == null || value === false) {
+        continue
+      }
+      if (b.options.find((o) => o.attributeName() === k)?.defaultValue === value) {
+        continue
+      }
+      if (value === true) {
+        args.push(`--${key}`)
+        continue
+      }
+      args.push(`--${key} "${value}"`)
+    }
+    const cmd = `ag ${args.join(' ')} ${pattern} ${dirpath || ''}`.trim()
+    console.log({ pattern, dirpath, opts, cmd })
+    await execInherit(cmd)
+  })
+
+  b.preset('#matches', {
+    description: 'Print matches found in each file',
+    options: { count: false, numbers: true, column: true, printLongLines: false, onlyMatching: true, width: 100 },
+  })
+  b.preset('#paths', {
+    description: 'Print only paths to files with matches',
+    options: { paths: true, maxCount: 1, silent: true },
+  })
+  b.preset('#bin', {
+    description: 'Search everything, including zipped, binary, and hidden files.',
+    options: {
+      unrestricted: true,
+      searchBinary: true,
+      searchZip: true,
+      hidden: true,
+      printLongLines: true,
+    },
+  })
+  b.preset('#text', {
+    description: 'Search all text files.',
+    options: {
+      allText: true,
+    },
+  })
+  b.preset('#ts', {
+    description: 'Search source code in a js/ts repository.',
+    args: [null, 'C:/Users/bemoj/repos'],
+    options: {
+      ext: '\\.(ts|tsx|json|js|jsx|md|css|html|txt)$',
+      ignore: 'node_modules',
+    },
+  })
+
+  ////////////////
+})
+console.timeEnd('load')
+
+console.time('init')
+const cli = init()
+console.timeEnd('init')
+
+console.time('exec')
+cli.parse()
+console.timeEnd('exec')
+
+printCounts()

package/scripts/currentBemojeUtils.txt

@@ -0,0 +1,41 @@
+'realizeLazyProperty',
+'JsonValue',
+'TStringParser',
+'arrLast',
+'TValidator',
+'colors',
+'Any',
+'arrAssign',
+'arrSome',
+'assertThat',
+'ensureThat',
+'formatTableForTerminal',
+'isArray',
+'isObject',
+'isString',
+'isStringArray',
+'isStringWithNoSpacesOrDashes',
+'objAssign',
+'removeFile',
+'setNonEnumerable',
+'ErrorParser',
+'TConstructor',
+'MethodDisabler',
+'createTypedListParser',
+'parseInteger',
+'parseNumber',
+'parseString',
+'createTypedArrayValidator',
+'isInteger',
+'isValidNumber',
+'promptUserEditJsonInTextEditorSync',
+'defaultOpenInEditorCommand',
+'JsonDB',
+'strEnsureStartsWith',
+'ObjectKey',
+'execInherit',
+'strSplitCamelCase',
+'isBoolean',
+'parseBoolean',
+'readFileSafeSync',
+'writeFileSafeSync'