xebia-radar-lint v1.0.0-beta.1

Xebia Radar Lint

lint your package.json against Xebia Technology Radar

Installation

Install locally npm i xebia-radar-lint or globally npm i -g xebia-radar-lint

Usage via npx

xebia-radar-lint: npx xebia-radar-lint

xebia-radar-status: npx -p xebia-radar-lint -c xebia-radar-status

xebia-radar-lint

xebia-radar-lint - lint dependencies from your package.json against Xebia Technology Radar

Usage: xebia-radar-lint <directory>

Options:
	<directory>      - directory with package.json and .radarlintrc files - (optional) current directory is default
	-i, --init           - creates config file (.radarlintrc) in <directory> (interactive)
	-n, --no-config      - prompt user for config, doesn't require config file  and ignores it if it exists (interactive)
	-h, --help           - shows this help

Output formatting:
	                     - default format (dependencies in Hold status)
	-c, --cli            - dependencies in Hold status
	-s, --summary        - detailed summary format
	-j, --json           - print output in raw JSON


Visit  (https://radar.xebia.com) to see Xebia Technology Radar

Exit codes

xebia-radar-lint exit codes:

• 1 dependencies in Hold status found
• 2 an error occurred
• 0 success and any other scenario

With config file:

Config file needs to be created:

xebia-radar-lint --init - create config file (.radarlintrc) in current directory

xebia-radar-lint --init <directory> - create config file (.radarlintrc) in <directory>

When file exists run xebia-radar-lint with optional flags

Without config file:

xebia-radar-lint --no-config - run linter without config file, you will be asked each time which radars use to check you package.json

xebia-radar-status

xebia-radar-status prints status of provided npm packages list from all Xebia Technology radars

local testing

Use npm link for local testing. See docs here

For development use npm start, which will first links package locally and then watches for changes in code and rebuilds code.