Skip to content
This repository has been archived by the owner on Feb 5, 2023. It is now read-only.

Commit

Permalink
fix: Add logo, update texts
Browse files Browse the repository at this point in the history
  • Loading branch information
ffflorian committed Feb 14, 2021
1 parent abd6a8c commit 1c12811
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 33 deletions.
42 changes: 22 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
![electron-info](./electron-info-icon.png)

# electron-info [![Build Status](https://github.com/ffflorian/electron-info/workflows/Build/badge.svg)](https://github.com/ffflorian/electron-info/actions/) [![npm version](https://img.shields.io/npm/v/electron-info.svg?style=flat)](https://www.npmjs.com/package/electron-info)

Get informations about Electron releases. Uses [electron-releases](https://github.com/electron/releases).
Get useful data about Electron releases. Uses [electron-releases](https://github.com/electron/releases) in the background.

## Installation

Expand All @@ -13,37 +15,37 @@ If you'd like to install it permanently, run `yarn global add electron-info` or
```
Usage: electron-info [options] [command]
Get informations about Electron releases.
Get useful data about Electron releases.
Allowed version argument inputs:
- SemVer versions (e.g. "~7")
- npm dist tags (e.g. "5-0-x", only Electron)
- "all"
Options:
-d, --debug Enable debug logging
-f, --force Force downloading the latest release file
-L, --latest List only the latest release (alias for --limit 1,
-d, --debug enable debug logging
-f, --force force downloading the latest release file
-L, --latest list only the latest release (alias for --limit 1,
ignores limit)
-l, --limit <number> Limit output of releases
-r, --raw Output raw JSON
-s, --source <url> Use a custom releases source URL or path
-t, --timeout <number> Use a custom HTTP timeout
-l, --limit <number> limit output of releases
-r, --raw output raw JSON
-s, --source <url> use a custom releases source URL or path
-t, --timeout <number> use a custom HTTP timeout
-v, --version output the version number
--no-colors Don't use colors for displaying
--no-prereleases Don't include Electron prereleases
--no-colors don't use colors for displaying
--no-prereleases don't include Electron prereleases
-h, --help display help for command
Commands:
electron|e [version] Get informations about an Electron release
chrome|c [version] Get informations about Chrome releases
modules|m [version] Get informations about Modules (Node ABI) releases
node|n [version] Get informations about Node.js releases
openssl|o [version] Get informations about OpenSSL releases
uv|u [version] Get informations about uv releases
v8|v [version] Get informations about V8 releases
zlib|z [version] Get informations about zlib releases
all|a Get informations about all releases
electron|e [version] show data for Electron releases
chrome|c [version] show data for Chrome releases
modules|m [version] show data for Modules (Node ABI) releases
node|n [version] show data for Node.js releases
openssl|o [version] show data for OpenSSL releases
uv|u [version] show data for uv releases
v8|v [version] show data for V8 releases
zlib|z [version] show data for zlib releases
all|a show data for all kinds of releases
help [command] display help for command
```

Expand Down
Binary file added electron-info-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"semver": "7.3.4",
"table": "6.0.7"
},
"description": "Get informations about Electron releases.",
"description": "Get useful data about Electron releases.",
"devDependencies": {
"@ffflorian/eslint-config": "0.6.2",
"@ffflorian/prettier-config": "0.1.2",
Expand Down
24 changes: 12 additions & 12 deletions src/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,23 +26,23 @@ Allowed version argument inputs:
- npm dist tags (e.g. "5-0-x", only Electron)
- "all"`
)
.option('-d, --debug', 'Enable debug logging')
.option('-f, --force', 'Force downloading the latest release file')
.option('-L, --latest', 'List only the latest release (alias for --limit 1, ignores limit)')
.option('-l, --limit <number>', 'Limit output of releases')
.option('-r, --raw', 'Output raw JSON')
.option('-s, --source <url>', 'Use a custom releases source URL or path')
.option('-t, --timeout <number>', 'Use a custom HTTP timeout')
.option('-d, --debug', 'enable debug logging')
.option('-f, --force', 'force downloading the latest release file')
.option('-L, --latest', 'list only the latest release (alias for --limit 1, ignores limit)')
.option('-l, --limit <number>', 'limit output of releases')
.option('-r, --raw', 'output raw JSON')
.option('-s, --source <url>', 'use a custom releases source URL or path')
.option('-t, --timeout <number>', 'use a custom HTTP timeout')
.version(version, '-v, --version')
.option('--no-colors', `Don't use colors for displaying`)
.option('--no-prereleases', `Don't include Electron prereleases`);
.option('--no-colors', `don't use colors for displaying`)
.option('--no-prereleases', `don't include Electron prereleases`);

const commanderOptions = commander.opts();

commander
.command('electron')
.alias('e')
.description('Get informations about an Electron release')
.description('show data for Electron releases')
.arguments('[version]')
.action(async (input?: string) => {
matchedCommand = true;
Expand Down Expand Up @@ -76,7 +76,7 @@ for (const [dependencyShortName, dependencyFullName] of Object.entries(Supported
commander
.command(dependencyShortName)
.alias(dependencyShortName[0])
.description(`Get informations about ${dependencyFullName} releases`)
.description(`show data for ${dependencyFullName} releases`)
.arguments('[version]')
.action(async version => {
matchedCommand = true;
Expand Down Expand Up @@ -115,7 +115,7 @@ for (const [dependencyShortName, dependencyFullName] of Object.entries(Supported
commander
.command('all', {isDefault: true})
.alias('a')
.description('Get informations about all releases')
.description('show data for all kinds of releases')
.action(async () => {
matchedCommand = true;
try {
Expand Down

0 comments on commit 1c12811

Please sign in to comment.