Skip to content

Commit f22d4ea

Browse files
OaphiOaphi
committed
1.1.0
1 parent 091b1d3 commit f22d4ea

File tree

4 files changed

+37
-29
lines changed

4 files changed

+37
-29
lines changed

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33

44
| Author | Oleg Valter<br>[[email protected]](mailto:[email protected])<br>[https://stackoverflow.com/users/11407695](https://stackoverflow.com/users/11407695) |
55
| :----------- | :----------------------- |
6+
| Contributors | double beep<br>[https://github.com/double-beep](https://github.com/double-beep) |
67
| Name | @userscripters/generate-stackapps |
78
| Description | StackApps post generator for userscripts |
89
| License | [GPL-3.0-or-later](https://spdx.org/licenses/GPL-3.0-or-later) |
9-
| Version | 1.0.3 |
10+
| Version | 1.1.0 |
1011

1112
Creates StackApps post Markdown from project metadata.
1213

‎STACKAPPS.md‎

Lines changed: 32 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Generate Stackapps - StackApps post generator for userscripts
33
library typescript
44

55
<!-- thumbnail: https://i.stack.imgur.com/Cbt4Z.png -->
6-
<!-- version: 1.0.3 -->
6+
<!-- version: 1.1.0 -->
77
<!-- tag: library -->
88
<!-- excerpt: Tired of writing Stack Apps posts by hand? With Generate StackApps you can focus on what's really important — userscripts and delegate the busywork to automation. -->
99

@@ -54,7 +54,7 @@ The script is licensed under the [GPL-3.0-or-later](https://spdx.org/licenses/GP
5454

5555
### Download
5656

57-
Latest version: 1.0.3
57+
Latest version: 1.1.0
5858

5959
The package is published as both an [NPM package](https://www.npmjs.com/package/@userscripters/generate-stackapps) and a [GitHub package](https://github.com/userscripters/generate-stackapps/packages/1408794). Can be installed via a package manager like NPM as usual:
6060

@@ -84,29 +84,36 @@ generate-stackapps [options]
8484

8585
There are various options one can provide to customize the output:
8686

87-
| Long | Short | Required | Default | Value | Description |
88-
| ---------------- | ----- | -------- | ---------------------------- | ---------- | ------------------------------------------ |
89-
| `about` | `a` | no | `<pkg.description>` | string | Long project description |
90-
| `chrome` | `cr` | no | - | string | Last tested Chrome version |
91-
| `direct` | `d` | no | `false` | boolean | Send output to `process.stdout` (CLI-only) |
92-
| `excerpt` | `e` | no | `<pkg.description>` | string | Short project description |
93-
| `edge` | `ed` | no | - | string | Last tested Edge version |
94-
| `explorer` | `ie` | no | - | string | Last tested Internet Explorer version |
95-
| `firefox` | `ff` | no | - | string | Last tested Firefox version |
96-
| `install` | `iu` | yes | - | valid URL | Project installation URL |
97-
| `language` | `l` | no | - | `string[]` | Programming languages used (repeatable) |
98-
| `minified` | `mu` | no | - | valid URL | Minified version installation URL |
99-
| `opera` | `op` | no | - | string | Last tested Opera version |
100-
| `org-name` | `on` | no | - | string | GitHub organization name |
101-
| `org-url` | `ou` | no | - | valid URL | GitHub organization URL |
102-
| `output` | `o` | no | `./STACKAPPS.md` | filepath | Output file path (CLI-only) |
103-
| `package` | `p` | no | `./package.json` | filepath | Path to project's package.json |
104-
| `room` | `r` | no | - | valid URL | Chat room URL |
105-
| `screenshot-alt` | `sa` | no | - | string | Project screenshot alt text |
106-
| `screenshot-url` | `su` | no | - | valid URL | Project screenshot URL |
107-
| `tag` | `tg` | no | `["script"]` | `string[]` | StackApps post tag (repeatable) |
108-
| `thumbnail` | `th` | no | - | valid URL | StackApps post thumbnail |
109-
| `title` | `tl` | no | `<pkg.name> - <description>` | string | StackApps post title |
87+
```
88+
Options:
89+
--version Show version number [boolean]
90+
--help Show help [boolean]
91+
-a, --about Long project description [string]
92+
--cr, --chrome Last tested Chrome version [string]
93+
-d, --direct Send output to process.stdout (CLI-only)
94+
[boolean] [default: false]
95+
-e, --excerpt Short project description [string]
96+
--ed, --edge Last tested Edge version [string]
97+
--ie, --explorer Last tested Internet Explorer version [string]
98+
--ff, --firefox Last tested Firefox version [string]
99+
--iu, --install Project installation URL [string] [required]
100+
-l, --language Programming languages used (repeatable) [array]
101+
--mu, --minified Minified version installation URL [string]
102+
-o, --output Output file path (CLI-only)
103+
[string] [default: "./STACKAPPS.md"]
104+
--on, --org-name GitHub organization name [string]
105+
--op, --opera Last tested Opera version [string]
106+
--ou, --org-url GitHub organization URL [string]
107+
-p, --package Path to project's package.json
108+
[string] [default: "./package.json"]
109+
-r, --room Chat room URL [string]
110+
--sa, --screenshot-alt Project screenshot alt text [string]
111+
--su, --screenshot-url Project screenshot URL [string]
112+
--tg, --tag StackApps post tag (repeatable)
113+
[array] [default: ["script"]]
114+
--tl, --title StackApps post title [string]
115+
--th, --thumbnail StackApps post thumbnail [string]
116+
```
110117

111118
### Platform
112119

‎package-lock.json‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@userscripters/generate-stackapps",
33
"description": "StackApps post generator for userscripts",
4-
"version": "1.0.3",
4+
"version": "1.1.0",
55
"main": "dist/index.js",
66
"type": "module",
77
"keywords": [

0 commit comments

Comments
 (0)