@doikayt/typescript-build-config 0.1.28 → 0.1.30
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -99,7 +99,7 @@ npm install # fetch declared devDe
|
|
|
99
99
|
### Trying it out
|
|
100
100
|
|
|
101
101
|
`dk-scaffold` does a lot under the hood, so the best way to get familiar with it
|
|
102
|
-
is to run it at the
|
|
102
|
+
is to run it at the two levels it supports — each requiring a little more setup
|
|
103
103
|
than the last, and revealing a little more of the process. Each level scaffolds a
|
|
104
104
|
throwaway **app** (nothing publishes) unless noted. Do the one-time
|
|
105
105
|
[machine setup](#1-one-time-machine-setup-once-per-machine) first so `dk-scaffold`
|
|
@@ -123,7 +123,7 @@ Sign in, point the wrapper at your account, and drop `--local`:
|
|
|
123
123
|
|
|
124
124
|
```bash
|
|
125
125
|
gh auth login # one-time: sign in to GitHub
|
|
126
|
-
export
|
|
126
|
+
export REPO_OWNER=<your-github-username> # target owner for the repo
|
|
127
127
|
dk-scaffold my-demo # app (private) — no npm creds
|
|
128
128
|
```
|
|
129
129
|
|
|
@@ -136,12 +136,30 @@ Push a follow-up **`feat:`** commit and the **release job** version-bumps + tags
|
|
|
136
136
|
nothing published (app). (The initial `chore: scaffold` push releases nothing;
|
|
137
137
|
`feat:` / `fix:` triggers it.)
|
|
138
138
|
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
139
|
+
|
|
140
|
+
The screen cast below shows the process for Level 1. Note:
|
|
141
|
+
|
|
142
|
+
- When we log in to our test account (associated with a dummy GitHub account,
|
|
143
|
+
not doikayt) we see:
|
|
144
|
+
- no repos initially
|
|
145
|
+
- no doikayt aliases registered in `.bashrc`
|
|
146
|
+
- After we run `dk-scaffold demo`, we will see:
|
|
147
|
+
- lots of output showing the project being configured and built
|
|
148
|
+
- a push to GitHub
|
|
149
|
+
- a build and release triggered on GitHub
|
|
150
|
+
- since we did not select `lib`, we got an app build profile, for which
|
|
151
|
+
there is no publish to npm
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
<p align="center">
|
|
155
|
+
<img
|
|
156
|
+
src="docs/demo.gif"
|
|
157
|
+
width="720"
|
|
158
|
+
alt="update-markdown-toc demo">
|
|
159
|
+
</p>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
145
163
|
|
|
146
164
|
## Design Goals
|
|
147
165
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@doikayt/typescript-build-config",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.30",
|
|
4
4
|
"description": "Shared build configuration for TypeScript projects — ESLint, Prettier, tsconfig, and Playwright presets",
|
|
5
5
|
"_comments": {
|
|
6
6
|
"exports": "This block lists the config files that will be extended by files in in src/toplevel - which are copied to consuming project root folder. An example: eslint.config.js imports from '@doikayt/typescript-build-config/eslint'.",
|