https://github.com/theknarf/yarn-plugin-envinfo

Yarn plugin so that you can run `envinfo` in your project based on a local `.envinfo` project config file.
https://github.com/theknarf/yarn-plugin-envinfo

plugin yarn yarn-plugin yarn3

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/theknarf/yarn-plugin-envinfo
• Owner: TheKnarf
• License: mit
• Created: 2021-12-23T13:02:54.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-27T16:57:36.000Z (almost 3 years ago)
• Last Synced: 2024-04-14T04:43:32.568Z (7 months ago)
• Topics: plugin, yarn, yarn-plugin, yarn3
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/yarn-plugin-envinfo
• Size: 48.9 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Yarn Plugin Envinfo

![license](https://img.shields.io/github/license/theknarf/yarn-plugin-envinfo) ![GitHub branch checks state](https://img.shields.io/github/checks-status/theknarf/yarn-plugin-envinfo/main) ![npm](https://img.shields.io/npm/v/yarn-plugin-envinfo)

This is a yarn plugin so that you can run [envinfo](https://www.npmjs.com/package/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

```bash

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](https://github.com/tabrindle/envinfo/blob/main/src/presets.js).

## Development

```bash

yarn install # first time setup

yarn build # builds the plugin

yarn postbuild

# uncomment the line in `.yarnrc.yml` to test

yarn envinfo

```