/yarn-plugin-envinfo

Yarn plugin so that you can run `envinfo` in your project based on a local `.envinfo` project config file.

Primary LanguageTypeScriptMIT LicenseMIT

Yarn Plugin Envinfo

license GitHub branch checks state npm

This is a yarn plugin so that you can run envinfo in your project. It'll read a project local configuration file so that different projects can ask for different info. Useful for helping new developers when onboarding them into your project.

Installation

yarn plugin import https://unpkg.com/yarn-plugin-envinfo

Then you can create a .envinfo file in your project:

{
	System: ['OS', 'CPU', 'Memory', 'Container', 'Shell'],
	Binaries: ['Node', 'Yarn', 'npm'],
	Browsers: [
		'Brave Browser',
		'Chrome',
		'Chrome Canary',
		'Chromium',
		'Edge',
		'Firefox',
		'Firefox Developer Edition',
		'Firefox Nightly',
		'Internet Explorer',
		'Safari',
		'Safari Technology Preview',
	],
	npmGlobalPackages: true,
}

And finally you can test it out by running:

yarn envinfo

For more information about what you can turn on and off in .envinfo check out the following full example.

Development

yarn install # first time setup
yarn build # builds the plugin
yarn postbuild
# uncomment the line in `.yarnrc.yml` to test
yarn envinfo