Component Hint is a linting tool for Component.io. The main goal is to detect nuisances prior to publication and alleviate debugging time (e.g. missing paths for local dependencies).
- Ensures a given components contains a
component.jsonfile - Checks each local dependency exists in exactly one of the given paths
- Detects any unused paths in the
component.jsonfile - Check each external dependency exists in exactly one of the given dependency paths (--dep-paths)
- Check dependencies are only required at a single version through the project
- Checks that a component doesn't have itself as a dependency
- Checks that any files listed in the
component.jsonfile (i.e. scripts, styles, etc.) actually exist
- In the event a local dependency isn't resolved, it will give you a hint as to where you can find
it (uses the given
--lookupPathsoption) - Skips folders with the same name as a dependency if it does not contain a
component.jsonfile - Recurses into dependencies and checks if there are any other dependency errors (this can be switched to warning level by using --warn-on-deps option)
- Parse scripts for usages of
require()and ensure those components exist in thecomponent.json - Check that the name inside the
component.jsonfile is the name used for the folder - Other issues
npm install component-hint
./node_modules/.bin/component-hint
OR if installed globally component-hint can be accessed like any other component command
npm install -g component-hint
component hint
Usage: component-hint [options] <component_path ...>
Options:
-h, --help output usage information
-V, --version output the version number
-v, --verbose Be verbose during tests. (cannot be used with --quiet
or --silent)
-q, --quiet Display only the final outcome.
-s, --silent Suppress all output.
-r, --recursive Recurse into local and external dependencies.
-d, --dep-paths <paths> Colon separated list of paths to external
dependencies. (default: "./components")
-w, --warn-on-deps Errors caused by external dependencies will only
result in a warning and not return a fail status
code.
-i, --ignore-paths <paths> Colon separated list of paths component-hint should
ignore. (supports minimatch globbing)
-l, --lookup-paths <paths> Colon separated list of paths to check for the
existence of missing local dependencies. This is used
to give the user a hint where they can find them.
--reporter <path> Path to reporter file to use for output formatting.
Examples:
Check multiple component entry points
$ component-hint /path/to/single/component /path/to/another/component
Check multiple component entry point which exist in the same folder
$ component-hint /path/to/multiple/component/folder/*/
Component Hint is distributed under the MIT License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent