Skip to content

Commit 1bbe910

Browse files
authored
docs: Add script to generate README.md (#2)
1 parent 6ba8c22 commit 1bbe910

File tree

7 files changed

+908
-5
lines changed

7 files changed

+908
-5
lines changed

README.md

Lines changed: 55 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,61 @@ This is a simple command line tool that lists files matching the provided globs.
66

77
## Getting Started
88

9-
1. Install [`pnpm`](https://pnppm.io)
10-
2. `pnpm i`
11-
3. `pnpm test`
12-
4. `pnpm run app --help`
9+
1. Install [`pnpm`](https://pnppm.io)
10+
11+
1. `pnpm i`
12+
13+
1. `pnpm test`
14+
15+
1. `pnpm run app --help`
16+
17+
<!--- @@inject: static/help.txt --->
18+
19+
```
20+
Usage: list-files [options] <files...>
21+
22+
List Files
23+
24+
Arguments:
25+
files Files to scan for injected content.
26+
27+
Options:
28+
--no-must-find-files No error if files are not found.
29+
--cwd <dir> Current Directory
30+
--color Force color.
31+
--no-color Do not use color.
32+
-V, --version output the version number
33+
-h, --help display help for command
34+
```
35+
36+
<!--- @@inject-end: static/help.txt --->
37+
38+
1. `pnpm run app "*"`
39+
40+
<!--- @@inject: static/example.md --->
41+
42+
**Example:**
43+
44+
<pre>
45+
<span style="color:#A50">Find Files:<span style="color:#FFF">
46+
<span style="color:#555"> - <span style="color:#FFF"><span style="color:#AAA">LICENSE<span style="color:#FFF">
47+
<span style="color:#555"> - <span style="color:#FFF"><span style="color:#AAA">README.md<span style="color:#FFF">
48+
<span style="color:#555"> - <span style="color:#FFF"><span style="color:#AAA">bin.mjs<span style="color:#FFF">
49+
<span style="color:#555"> - <span style="color:#FFF"><span style="color:#AAA">coverage<span style="color:#FFF">
50+
<span style="color:#555"> - <span style="color:#FFF"><span style="color:#AAA">cspell.config.yaml<span style="color:#FFF">
51+
<span style="color:#555"> - <span style="color:#FFF"><span style="color:#AAA">dist<span style="color:#FFF">
52+
<span style="color:#555"> - <span style="color:#FFF"><span style="color:#AAA">package.json<span style="color:#FFF">
53+
<span style="color:#555"> - <span style="color:#FFF"><span style="color:#AAA">pnpm-lock.yaml<span style="color:#FFF">
54+
<span style="color:#555"> - <span style="color:#FFF"><span style="color:#AAA">release-please-config.json<span style="color:#FFF">
55+
<span style="color:#555"> - <span style="color:#FFF"><span style="color:#AAA">scripts<span style="color:#FFF">
56+
<span style="color:#555"> - <span style="color:#FFF"><span style="color:#AAA">src<span style="color:#FFF">
57+
<span style="color:#555"> - <span style="color:#FFF"><span style="color:#AAA">static<span style="color:#FFF">
58+
<span style="color:#555"> - <span style="color:#FFF"><span style="color:#AAA">tsconfig.json<span style="color:#FFF">
59+
<span style="color:#555"> - <span style="color:#FFF"><span style="color:#AAA">vitest.config.ts<span style="color:#FFF">
60+
<span style="color:#0A0">done.<span style="color:#FFF">
61+
</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></pre>
62+
63+
<!--- @@inject-end: static/example.md --->
1364
1465
## `pnpm` - this template uses pnpm.
1566

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
},
1010
"scripts": {
1111
"build": "tsc -p .",
12+
"build:readme": "bash ./scripts/build-readme.sh",
1213
"watch": "tsc -p . --watch",
1314
"coverage": "vitest run --coverage",
1415
"lint": "pnpm eslint && pnpm prettier",
@@ -42,6 +43,7 @@
4243
"@typescript-eslint/eslint-plugin": "^5.47.1",
4344
"@typescript-eslint/parser": "^5.47.1",
4445
"@vitest/coverage-c8": "^0.26.2",
46+
"ansi-to-html": "^0.7.2",
4547
"cspell": "^6.18.1",
4648
"eslint": "^8.30.0",
4749
"eslint-config-prettier": "^8.5.0",
@@ -50,6 +52,7 @@
5052
"eslint-plugin-node": "^11.1.0",
5153
"eslint-plugin-prettier": "^4.2.1",
5254
"eslint-plugin-promise": "^6.1.1",
55+
"inject-markdown": "^1.3.0",
5356
"prettier": "^2.8.1",
5457
"typescript": "^4.9.4",
5558
"vite": "^4.0.3",

0 commit comments

Comments
 (0)