@arethetypeswrong/cli
Advanced tools
Readme
A CLI for arethetypeswrong.github.io.
This project attempts to analyze npm package contents for issues with their TypeScript types, particularly ESM-related module resolution issues. The following kinds of problems can be detected in the node10, node16, and bundler module resolution modes:
export =npm i -g @arethetypeswrong/cli
The attw command acts very similarly to arethetypeswrong.github.io, with some additional features that are useful for command line usage.
The CLI can check an npm packed tarball:
npm pack
attw cool-package-1.0.0.tgz
# or
attw $(npm pack)
or pack one in-place by specifying --pack and a directory:
attw --pack .
or check a package from npm:
attw --from-npm @arethetypeswrong/cli
attw supports a JSON config file (by default named .attw.json) which allows you to pre-set the command line arguments. The options are a one-to-one mapping of the command line flags, changed to camelCase, and are all documented in their relevant Options section below.
Show help information and exit.
In the CLI: --help, -h
attw --help
Print the current version of attw and exit.
In the CLI: --version, -v
attw --version
Specify a directory to run npm pack in (instead of specifying a tarball filename), analyze the resulting tarball, and delete it afterwards.
attw --pack .
Specify the name (and, optionally, version or SemVer range) of a package from the NPM registry instead of a local tarball filename.
In the CLI: --from-npm, -p
attw --from-npm <package-name>
In the config file, fromNpm can be a boolean value.
When a package does not contain types, specifies the version or SemVer range of the DefinitelyTyped @types package to use. Defaults to inferring the best version match from the implementation package version.
In the CLI: --definitely-typed, --no-definitely-typed
attw -p <package-name> --definitely-typed <version>
attw -p <package-name> --no-definitely-typed
The format to print the output in. Defaults to auto.
The available values are:
table, where columns are entrypoints and rows are resolution kindstable-flipped, where columns are resolution kinds and rows are entrypointsascii, for large tables where the output is clunkyauto, which picks whichever of the above best fits the terminal widthjson outputs the raw JSON data (overriding all other rendering options)In the CLI: --format, -f
attw --format <format> <file-name>
In the config file, format can be a string value.
attw automatically discovers package entrypoints by looking at package.json exports and subdirectories with additional package.json files. In a package lacking exports, providing the --entrypoints-legacy option will include all published code files. This automatic discovery process can be overridden with the --entrypoints option, or altered with the --include-entrypoints and --exclude-entrypoints options:
attw --pack . --entrypoints . one two three # Just ".", "./one", "./two", "./three"
attw --pack . --include-entrypoints added # Auto-discovered entyrpoints plus "./added"
attw --pack . --exclude-entrypoints styles.css # Auto-discovered entrypoints except "./styles.css"
attw --pack . --entrypoints-legacy # All published code files
Specifies rules/problems to ignore (i.e. not raise an error for).
The available values are:
no-resolutionuntyped-resolutionfalse-cjsfalse-esmcjs-resolves-to-esmfallback-conditioncjs-only-exports-defaultfalse-export-defaultunexpected-module-syntaxmissing-export-equalsinternal-resolution-errorIn the CLI: --ignore-rules
attw <file-name> --ignore-rules <rules...>
In the config file, ignoreRules can be an array of strings.
Whether to display a summary of what the different errors/problems mean. Defaults to showing the summary (--summary).
In the CLI: --summary/--no-summary
attw --summary/--no-summary <file-name>
In the config file, summary can be a boolean value.
Whether to print the information with emojis. Defaults to printing with emojis (--emoji).
In the CLI: --emoji/--no-emoji
attw --emoji/--no-emoji <file-name>
In the config file, emoji can be a boolean value.
Whether to print with colors. Defaults to printing with colors (--color).
The FORCE_COLOR env variable is also available for use (set is to 0 or 1).
In the CLI: --color/--no-color
attw --color/--no-color <file-name>
In the config file, color can be a boolean value.
When set, nothing will be printed to STDOUT.
In the CLI: --quiet, -q
attw --quiet <file-name>
In the config file, quiet can be a boolean value.
The path to the config file. Defaults to ./.attw.json.
In the CLI: --config-path <path>
attw --config-path <path> <file-name>
Cannot be set from within the config file itself.
FAQs
A CLI tool for arethetypeswrong.github.io
We found that @arethetypeswrong/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer 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
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.