Security News
The Dark Side of Open Source
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
@cnamts/cli-helpers
Advanced tools
Readme
Helper functions to build CLI tools.
This package is built with TypeScript and is meant to be used in TypeScript projects, but a JavaScript version is built so you can use it in node.js environment.
To install it, you need to use yarn or npm:
yarn add @cnamts/cli-helpers
# OR
npm install @cnamts/cli-helpers
You can import the different helpers from the main file:
import { log, done, getPath } from '@cnamts/cli-helpers';
Or you can import them using their files, like so:
import { log, done } from '@cnamts/cli-helpers/src/logger';
import { getPath } from '@cnamts/cli-helpers/src/getPath';
Get an object with standardized colors.
import { colors } from '@cnamts/cli-helpers';
console.log(colors.primary); // Use 'primary' color
Get path relative to current working directory.
import { getPath } from '@cnamts/cli-helpers';
const myPath = getPath('./file'); // Equivalent to path.join(process.cwd(), './file)
Trace a straight line across the terminal using box-drawing character ─
, by default it uses the primary
color from colors, but you can change it.
import { traceLine } from '@cnamts/cli-helpers';
traceLine(); // Example: ───────────────────────
traceLine('#eee') // With custom color
Log informations to the user such as errors, warnings, events and others.
import { log, cmd, info, done, warn, error, verbose, event } from '@cnamts/cli-helpers';
log('Default log');
cmd('yarn lint');
info('Info log');
done('Success log');
warn('Warning log');
error('Error log');
verbose('Verbose log');
event('Event log');
Display header with Georgia11 font and optionally author and/or version.
import { renderHeader } from '@cnamts/cli-helpers';
renderHeader('Package', 'Someone', '1.0.0');
Feel free to open an issue or a pull request to improve this package!
Just make sure to respect the code style by running yarn lint
and to update the tests and check the coverage with yarn test
.
FAQs
Helper functions to build CLI tools
The npm package @cnamts/cli-helpers receives a total of 32 weekly downloads. As such, @cnamts/cli-helpers popularity was classified as not popular.
We found that @cnamts/cli-helpers demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 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.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.