@ttsc/banner 0.8.0-dev.20260505 → 0.8.0

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.
Files changed (3) hide show
  1. package/README.md +10 -10
  2. package/package.json +1 -1
  3. package/src/index.cjs +0 -4
package/README.md CHANGED
@@ -9,7 +9,7 @@
9
9
  [![Guide Documents](https://img.shields.io/badge/Guide-Documents-forestgreen)](https://github.com/samchon/ttsc/tree/master/docs)
10
10
  [![Discord Badge](https://img.shields.io/badge/discord-samchon-d91965?style=flat&labelColor=5866f2&logo=discord&logoColor=white&link=https://discord.gg/E94XhzrUCZ)](https://discord.gg/E94XhzrUCZ)
11
11
 
12
- `@ttsc/banner` adds a fixed `@packageDocumentation` JSDoc banner to JavaScript and declaration emit.
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 compiler-owned JSDoc block and adds `@packageDocumentation`. The banner follows TypeScript's normal comment emit policy, so `removeComments: true` removes it.
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 source/emit hook order.
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
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ttsc/banner",
3
- "version": "0.8.0-dev.20260505",
3
+ "version": "0.8.0",
4
4
  "description": "First-party ttsc plugin that adds package-documentation JSDoc banners during emit.",
5
5
  "main": "src/index.cjs",
6
6
  "exports": {
package/src/index.cjs CHANGED
@@ -8,9 +8,5 @@ module.exports = function createTtscBanner() {
8
8
  name: "@ttsc/banner",
9
9
  source: path.resolve(__dirname, "..", "plugin"),
10
10
  stage: "transform",
11
- hooks: {
12
- source: true,
13
- declaration: true,
14
- },
15
11
  };
16
12
  };