Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
@architect/utils
Advanced tools
Changelog
[4.0.5 - 4.0.6] 2024-04-29
package.json
engines.node
property to reflect changes from v4Readme
@architect/utils
@architect/utils are common utilities for the @architect suite of projects.
npm i @architect/utils
utils.banner(params)
Responsible for printing the standard banner, and loading the basic environment variables and necessary AWS credentials necessary to run Architect.
params
are required with the following available properties:
inventory
(required): Inventory object from @architect/inventory
disableBanner
(boolean): skip printing the banner and Architect's AWS environment bootstrapping routinesdisableRegion
(boolean): don't print the AWS region (useful in public CI scenarios, for example)disableProfile
(boolean): don't print the AWS profile (also useful in public CI scenarios)version
(string): the package version string to print out (e.g. Architect 1.2.3
)quiet
(boolean): disable banner printingutils.getLambdaName(fn)
Returns a valid AWS Lambda function name based on its URL (route).
utils.pathToUnix(pathString)
Converts any path to a Unix style path, with /
as the seperator. This works around Windows issues where /
is assumed across other parts of Architect.
utils.toLogicalID(str)
Converts str
into PascalCase for CloudFormation use.
utils.updater(name, params)
name
(a string) is required; params
may include the boolean option quiet
to manually override Architect's global printing status.
Returns a function to be reused for standardized logging updates with the following methods:
status
- prints an affirmative status update
start
- starts an animated progress indicator
update
done
- ends current progress indicator with an update
stop
cancel
- cancels current progress indicator without an updateerr
- pretty prints an error
error
and fail
warn
- cancels current progress indicator and prints a warning
warn
raw
- just logs a message as-is (while respecting quiet)Automatically respects Architect's global printing status, and also respects the following env vars:
ARC_QUIET
- if truthy, disables printingCI
- if truthy, disables certain terminal progress animationsFAQs
Common utility functions
The npm package @architect/utils receives a total of 10,230 weekly downloads. As such, @architect/utils popularity was classified as popular.
We found that @architect/utils demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.