costrix 1.0.0 → 1.0.11
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 +64 -0
- package/package.json +2 -2
- package/templates/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# Costrix
|
|
2
|
+
|
|
3
|
+
`costrix` scaffolds a TypeScript + Webpack starter with strict guardrails (lint, typecheck, tests, coverage).
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# direct
|
|
9
|
+
node ./bin/costrix.js my-app
|
|
10
|
+
|
|
11
|
+
# with prompts
|
|
12
|
+
node ./bin/costrix.js
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
If published, usage is:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npx costrix my-app
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Flags
|
|
22
|
+
|
|
23
|
+
- `--no-install`: scaffold only, skip `npm install`
|
|
24
|
+
- `--no-dev`: scaffold (and optional install), skip auto `npm run dev`
|
|
25
|
+
- `-h, --help`: print help
|
|
26
|
+
|
|
27
|
+
## What It Generates
|
|
28
|
+
|
|
29
|
+
```text
|
|
30
|
+
public/
|
|
31
|
+
favicon.ico
|
|
32
|
+
ogimage.jpg
|
|
33
|
+
index.html
|
|
34
|
+
scripts/
|
|
35
|
+
banner.cjs
|
|
36
|
+
src/
|
|
37
|
+
index.ts
|
|
38
|
+
App.module.css
|
|
39
|
+
global.d.ts
|
|
40
|
+
tests/
|
|
41
|
+
index.test.ts
|
|
42
|
+
styleMock.ts
|
|
43
|
+
eslint.config.cjs
|
|
44
|
+
jest.config.cjs
|
|
45
|
+
tsconfig.json
|
|
46
|
+
tsconfig.eslint.json
|
|
47
|
+
webpack.config.js
|
|
48
|
+
package.json
|
|
49
|
+
.gitignore
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Generated Project Scripts
|
|
53
|
+
|
|
54
|
+
- `npm run dev`: webpack dev server
|
|
55
|
+
- `npm run test`: jest
|
|
56
|
+
- `npm run prod`: lint + typecheck + coverage tests + production build
|
|
57
|
+
- `npm run build`: alias to `npm run prod`
|
|
58
|
+
|
|
59
|
+
## Notes
|
|
60
|
+
|
|
61
|
+
- Public assets are copied as binary files (no text conversion), so `favicon.ico` and `ogimage.jpg` remain valid.
|
|
62
|
+
- Dev/build banners are shown via `scripts/banner.cjs`.
|
|
63
|
+
- Starter UI includes a docs button linking to: `https://costrix.kaustubhvats.in`
|
|
64
|
+
|
package/package.json
CHANGED
package/templates/package.json
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"prod": "npm run lint && npm run typecheck && npm run test:ci && webpack --mode production",
|
|
12
12
|
"test": "jest",
|
|
13
13
|
"test:ci": "jest --coverage",
|
|
14
|
-
"lint": "eslint . --ext .ts,.js,.cjs",
|
|
14
|
+
"lint": "eslint . --ext .ts,.js,.cjs --max-warnings=0",
|
|
15
15
|
"typecheck": "tsc --noEmit"
|
|
16
16
|
},
|
|
17
17
|
"devDependencies": {
|