@doikayt/typescript-build-config 0.1.23 → 0.1.25
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 +9 -9
- package/package.json +2 -2
- package/src/postinstall.js +2 -2
- /package/{image-assets → assets/image}/doikayt-logo.png +0 -0
- /package/{image-assets → assets/image}/doikayt-logo.svg +0 -0
- /package/{image-assets → assets/image}/jews-support-a-free-palestine-poster.pdf +0 -0
- /package/{image-assets → assets/image}/poster.png +0 -0
- /package/{image-assets → assets/image}/qrcode_www.doikayt.org.png +0 -0
package/README.md
CHANGED
|
@@ -53,7 +53,7 @@ links to the section that explains _what_ and _why_.
|
|
|
53
53
|
```bash
|
|
54
54
|
git clone git@github.com:doikayt/typescript-build-config.git
|
|
55
55
|
cd typescript-build-config
|
|
56
|
-
./
|
|
56
|
+
./assets/shell/install.sh # adds `source assets/shell/aliases.sh` to your rc (idempotent)
|
|
57
57
|
exec $SHELL # reload
|
|
58
58
|
```
|
|
59
59
|
|
|
@@ -115,8 +115,8 @@ is _why_.)
|
|
|
115
115
|
| **Convention checks** — postinstall warns on missing `ci` / `update-all-format` | An install-time nudge toward the shared command surface | Consistency |
|
|
116
116
|
| **`ci` gate** — `release.yml` runs `npm run ci` | Fail-closed enforcement: a repo that ignores the convention cannot release | Consistency (hard teeth) |
|
|
117
117
|
| **Policy doc** — `docs/RELEASE-PROCESS.md`, linked never copied | One canonical release policy, impossible to drift | Consistency |
|
|
118
|
-
| **Assets** — `image
|
|
119
|
-
| **Shell aliases** — `
|
|
118
|
+
| **Assets** — `assets/image/*` seeded into `docs/assets/` | Shared brand logos with no per-repo copies to maintain | Minimal setup |
|
|
119
|
+
| **Shell aliases** — `assets/shell/aliases.sh`, cloned + sourced (never shipped to npm) | One standard way for the team to create and scaffold repos (`mkrepo`, `dk-*`) | Consistency |
|
|
120
120
|
|
|
121
121
|
The two goals map onto two lifecycle phases — **[delivery](#delivery-model)**
|
|
122
122
|
(getting canonical artifacts into a consuming repo) and
|
|
@@ -277,7 +277,7 @@ versions of these tools may produce peer dependency conflicts.
|
|
|
277
277
|
});
|
|
278
278
|
```
|
|
279
279
|
|
|
280
|
-
- Brand assets (`
|
|
280
|
+
- Brand assets (`assets/image/doikayt-logo.png`, `assets/image/doikayt-logo.svg`) — shared logos for use
|
|
281
281
|
across all `@doikayt` project READMEs and documentation
|
|
282
282
|
|
|
283
283
|
## Delivery Model
|
|
@@ -305,7 +305,7 @@ components.
|
|
|
305
305
|
│ presets eslint prettier tsconfig playwright│
|
|
306
306
|
│ stubs src/top-level/* │
|
|
307
307
|
│ pipeline src/pipeline/* │
|
|
308
|
-
│ assets image
|
|
308
|
+
│ assets assets/image/* │
|
|
309
309
|
│ policy docs/RELEASE-PROCESS.md │
|
|
310
310
|
└─────────┬───────────────┬───────────────┬───────┘
|
|
311
311
|
│ │ │
|
|
@@ -361,8 +361,8 @@ components.
|
|
|
361
361
|
a _consuming repo_ through npm (channels 1–3). The team
|
|
362
362
|
[shell aliases](#team-shell-aliases) are the exception: they target the
|
|
363
363
|
_developer's machine_, not a repo, through a fourth channel — **cloned and
|
|
364
|
-
sourced** (`git clone` this repo + `source
|
|
365
|
-
`
|
|
364
|
+
sourced** (`git clone` this repo + `source assets/shell/aliases.sh`, via
|
|
365
|
+
`assets/shell/install.sh`). npm never touches them and they never land in a consumer's
|
|
366
366
|
`package.json` or tree. Same goal (a standard way to create repos), different
|
|
367
367
|
destination — which is why they sit outside the five-components / three-channels
|
|
368
368
|
model rather than as a sixth row in it.
|
|
@@ -543,7 +543,7 @@ release job until one is committed.
|
|
|
543
543
|
## Team shell aliases
|
|
544
544
|
|
|
545
545
|
Installed by [Quick start](#quick-start) step 1 (or manually: add
|
|
546
|
-
`source <clone-path>/
|
|
546
|
+
`source <clone-path>/assets/shell/aliases.sh` to your shell rc). They require `gh`
|
|
547
547
|
(authenticated) and `node`/`npm`.
|
|
548
548
|
|
|
549
549
|
| Alias | What it does |
|
|
@@ -551,7 +551,7 @@ Installed by [Quick start](#quick-start) step 1 (or manually: add
|
|
|
551
551
|
| `mkrepo <name>` | Create a public repo in the `doikayt` org (guards against duplicates). |
|
|
552
552
|
| `dk-new` | `npm init -y` + `@doikayt` scope. |
|
|
553
553
|
| `dk-init` | Scaffold the build config into the current project. |
|
|
554
|
-
| `dk-scaffold <name
|
|
554
|
+
| `dk-scaffold <name>\|. [lib\|app]` | Create the repo, scaffold, and push — one command (defaults to app). Pass `.` to scaffold in the current directory, using its leaf name as `@doikayt/<package-name>`. |
|
|
555
555
|
|
|
556
556
|
## For Maintainers
|
|
557
557
|
|
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.25",
|
|
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'.",
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
"files": [
|
|
22
22
|
"src/",
|
|
23
23
|
"src/top-level/.gitignore",
|
|
24
|
-
"
|
|
24
|
+
"assets/image/"
|
|
25
25
|
],
|
|
26
26
|
"scripts": {
|
|
27
27
|
"prepack": "echo no build step required",
|
package/src/postinstall.js
CHANGED
|
@@ -111,7 +111,7 @@ for (const { src, dest } of pipelineFiles) {
|
|
|
111
111
|
|
|
112
112
|
// --- Asset files: seeded into docs/assets/, same per-file copy/warn as pipeline ---
|
|
113
113
|
|
|
114
|
-
const assetDir = new URL("../image
|
|
114
|
+
const assetDir = new URL("../assets/image", import.meta.url).pathname;
|
|
115
115
|
|
|
116
116
|
const assetFiles = [
|
|
117
117
|
{ src: "doikayt-logo.png", dest: "docs/assets/doikayt-logo.png" },
|
|
@@ -135,7 +135,7 @@ for (const { src, dest } of assetFiles) {
|
|
|
135
135
|
|
|
136
136
|
console.warn(
|
|
137
137
|
`${PREFIX} WARNING: ${dest} differs from canonical version — skipping. ` +
|
|
138
|
-
`To resync: cp node_modules/@doikayt/typescript-build-config/image
|
|
138
|
+
`To resync: cp node_modules/@doikayt/typescript-build-config/assets/image/${src} ${dest}`,
|
|
139
139
|
);
|
|
140
140
|
}
|
|
141
141
|
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|