yage
a739d3b5a2
=====================================================================
Big day! V4 is finally live. This INCLUDES some BREAKING CHANGES to ZSH
TYPE scwrypts! Please refer to the readme for upgrade details
(more specifically docs/upgrade/v3-to-v4.md)
Upgrade is SUPER EASY, so please take the time to do so.
--- New Features ----------------------------------------------------
- zsh type scwrypts have an upgraded runstring to improve context setup
and simplicity to the scwrypt-writer
- scwrypts now publishes the package (scwrypts) to PyPi; this provides a
simple way to invoke scwrypts from python-based environments as well
as the entire scwrypts python library suite
pip install scwrypts
- scwrypts now publishes the package (scwrypts) to npm; this provides a
simple way to invoke scwrypts from nodesjs environments
npm install scwrypts
--- Bug Fixes -------------------------------------------------------
- scwrypts runner prompts which use the zshbuiltin "read" now
appropriately read input from tty, pipe, files, and user input
- virtualenv refresh now loads and prepares the scwrypts virtual
environments correctly
--- Changes ---------------------------------------------------------
- created the (-v, --log-level) scwrypts arguments as improvements of
and replacements to the --verbose and --no-log flags
- (-n) is now an alias for (--log-level 0)
- (--no-log) is the same as (-n) for compatibility, but will be removed in 4.2
- zsh/lib/utils/io print functions now *interact with log-level* various
log levels will now only display the appropriate console prints for
the specified log level
- zsh/lib/utils/io:INFO has been renamed to DEBUG to align with
log-level output; please use DEBUG for debug messages and REMINDER for
important user messages
- created zsh/lib/utils/io:FZF_USER_INPUT as a *drop-in replacement* for
the confusing FZF_HEAD and FZF_TAIL commands. Update by literally
changing any instances of FZF_HEAD or FZF_TAIL with FZF_USER_INPUT
- FZF_HEAD and FZF_TAIL will be removed in 4.2
- zsh/lib/utils/io:READ (and other zshbuiltin/read-based prompts) now
accept a --force-user-input flag in case important checks should
require an admin's approval. This flag will ensure that piped input
and the `scwrypts -y` flag are ignored for the single prompt.
- zsh/lib/utils/color has been updated to use color names which match
the ANSI color names
- zsh/hello-world has been reduced to a minimal example; this is to
emphasize ease-of-use with v4
- zsh/sanity-check is a scwrypts/run testing helper and detailed
starting reference (helpful since hello-world is now minimal)
- various refactor, updates, and improvements to the scwrypts runner
- migrated all zsh scwrypts and plugins to use v4 runner syntax
- zsh
- plugins/kubectl
- plugins/ci
- refactored py/lib into py/lib/scwrypts (PyPi)
50 lines
1.2 KiB
TypeScript
50 lines
1.2 KiB
TypeScript
import { parseCLIArgs } from './parse-cli-args.js';
|
|
|
|
import type { ScwryptsOptions } from './types.js';
|
|
|
|
export type ScwryptsLookupOptions =
|
|
| {
|
|
method: 'exact';
|
|
name: string;
|
|
group: string;
|
|
type: string;
|
|
}
|
|
| {
|
|
method: 'patterns';
|
|
patterns: string[];
|
|
};
|
|
|
|
export const Errors = {
|
|
NoScwryptsLookupError: {
|
|
name: 'NoScwryptsLookupError',
|
|
message: 'no scwrypts lookup parameters provided',
|
|
},
|
|
MissingScwryptsExactLookupParametersError: {
|
|
name: 'MissingScwryptsExactLookupParametersError',
|
|
message: '"name" option requires "group" and "type" options',
|
|
},
|
|
};
|
|
|
|
export const getScwryptsLookup = (options: ScwryptsOptions): ScwryptsLookupOptions => {
|
|
if (options.name === undefined) {
|
|
if (options.patterns === undefined || options.patterns.length === 0) {
|
|
throw Errors.NoScwryptsLookupError;
|
|
}
|
|
return {
|
|
method: 'patterns',
|
|
patterns: parseCLIArgs(options.patterns),
|
|
};
|
|
}
|
|
|
|
if (options.group === undefined || options.type === undefined) {
|
|
throw Errors.MissingScwryptsExactLookupParametersError;
|
|
}
|
|
|
|
return {
|
|
method: 'exact',
|
|
name: options.name,
|
|
group: options.group,
|
|
type: options.type,
|
|
};
|
|
};
|