@ttsc/banner 0.8.0-dev.20260505 → 0.8.0-dev.20260506
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 +10 -10
- package/package.json +1 -1
- package/src/index.cjs +0 -4
package/README.md
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
[](https://github.com/samchon/ttsc/tree/master/docs)
|
|
10
10
|
[](https://discord.gg/E94XhzrUCZ)
|
|
11
11
|
|
|
12
|
-
`@ttsc/banner` adds a fixed `@packageDocumentation` JSDoc banner
|
|
12
|
+
`@ttsc/banner` adds a fixed `@packageDocumentation` JSDoc banner by inserting a source preamble before TypeScript-Go parses the project.
|
|
13
13
|
|
|
14
14
|
## Setup
|
|
15
15
|
|
|
@@ -27,10 +27,10 @@ Open your project's `tsconfig.json`, then add this entry under `compilerOptions.
|
|
|
27
27
|
"plugins": [
|
|
28
28
|
{
|
|
29
29
|
"transform": "@ttsc/banner",
|
|
30
|
-
"banner": "License MIT (c) 2026 Acme"
|
|
31
|
-
}
|
|
32
|
-
]
|
|
33
|
-
}
|
|
30
|
+
"banner": "License MIT (c) 2026 Acme",
|
|
31
|
+
},
|
|
32
|
+
],
|
|
33
|
+
},
|
|
34
34
|
}
|
|
35
35
|
```
|
|
36
36
|
|
|
@@ -40,7 +40,7 @@ Run your normal `ttsc` command:
|
|
|
40
40
|
npx ttsc
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
The plugin formats every banner line inside a
|
|
43
|
+
The plugin formats every banner line inside a JSDoc block and adds `@packageDocumentation`. The banner follows TypeScript's normal comment emit policy, so `removeComments: true` removes it.
|
|
44
44
|
|
|
45
45
|
## Notes
|
|
46
46
|
|
|
@@ -53,11 +53,11 @@ The plugin formats every banner line inside a compiler-owned JSDoc block and add
|
|
|
53
53
|
// Keep lint first.
|
|
54
54
|
{ "transform": "@ttsc/lint", "config": { "no-var": "error" } },
|
|
55
55
|
|
|
56
|
-
// First-party utilities use their documented
|
|
56
|
+
// First-party utilities use their documented transform order.
|
|
57
57
|
{ "transform": "@ttsc/banner", "banner": "License MIT" },
|
|
58
58
|
{ "transform": "@ttsc/paths" },
|
|
59
|
-
{ "transform": "@ttsc/strip", "calls": ["console.log"] }
|
|
60
|
-
]
|
|
61
|
-
}
|
|
59
|
+
{ "transform": "@ttsc/strip", "calls": ["console.log"] },
|
|
60
|
+
],
|
|
61
|
+
},
|
|
62
62
|
}
|
|
63
63
|
```
|
package/package.json
CHANGED