Skip to content

Commit 6ad6faf

Browse files
kikuomaxkikuomax
authored
Include the scope in the package name (#6)
* chore: bump dependencies * chore: include scope in package name Replaces the package name: `cdk-ghost-string-parameter` → `@codemonger-io/cdk-ghost-string-parameter`. Also bumps the version to 0.2.0. * chore: make scripts package-manager-agnostic Installs `npm-run-all2` and replaces `npm run` with `run-s`. * chore: clean dist folder before build Installs `rimraf` and removes the `dist` folder before `build`. Also removes the `temp` folder before `build:doc`. * docs: update README Topics: - Includes the scope `@codemonger-io` in the package name - Bumps the version to 0.2.0 - Uses `pnpm` instead of `npm` for development * docs: update API documentation Replaces the package name.
1 parent 87fad88 commit 6ad6faf

14 files changed

+1259
-452
lines changed

‎README.ja.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
## インストール
1010

1111
```sh
12-
npm install https://github.com/codemonger-io/cdk-ghost-string-parameter.git#v0.1.1
12+
npm install https://github.com/codemonger-io/cdk-ghost-string-parameter.git#v0.2.0
1313
```
1414

1515
## サンプル
@@ -18,7 +18,7 @@ npm install https://github.com/codemonger-io/cdk-ghost-string-parameter.git#v0.1
1818
以下は使用例です。
1919

2020
```ts
21-
import { GhostStringParameter } from 'cdk-ghost-string-parameter';
21+
import { GhostStringParameter } from '@codemonger-io/cdk-ghost-string-parameter';
2222
import { aws_iam as iam } from 'aws-cdk-lib';
2323
import { Construct } from 'constructs';
2424

@@ -59,17 +59,17 @@ CDKスタックをデプロイした後にパラメータを作成したい場
5959
### 依存関係の解決
6060

6161
```sh
62-
npm ci
62+
pnpm install --frozen-lockfile
6363
```
6464

6565
### ビルド
6666

6767
```sh
68-
npm run build
68+
pnpm build
6969
```
7070

7171
### APIドキュメントの生成
7272

7373
```sh
74-
npm run build:doc
74+
pnpm build:doc
7575
```

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This library is supposed to be combined with the [AWS Cloud Development Kit (CDK
99
## Installation
1010

1111
```sh
12-
npm install https://github.com/codemonger-io/cdk-ghost-string-parameter.git#v0.1.1
12+
npm install https://github.com/codemonger-io/cdk-ghost-string-parameter.git#v0.2.0
1313
```
1414

1515
## Example
@@ -18,7 +18,7 @@ The only class this library provides is [`GhostStringParameter`](./api-docs/mark
1818
Here is an example to use it:
1919

2020
```ts
21-
import { GhostStringParameter } from 'cdk-ghost-string-parameter';
21+
import { GhostStringParameter } from '@codemonger-io/cdk-ghost-string-parameter';
2222
import { aws_iam as iam } from 'aws-cdk-lib';
2323
import { Construct } from 'constructs';
2424

@@ -59,17 +59,17 @@ If you want to control access to a parameter that does not exist at deployment w
5959
### Resolving dependencies
6060

6161
```sh
62-
npm ci
62+
pnpm install --frozen-lockfile
6363
```
6464

6565
### Building
6666

6767
```sh
68-
npm run build
68+
pnpm build
6969
```
7070

7171
### Generating the API documentation
7272

7373
```sh
74-
npm run build:doc
74+
pnpm build:doc
7575
```

‎api-docs/cdk-ghost-string-parameter.api.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## API Report File for "cdk-ghost-string-parameter"
1+
## API Report File for "@codemonger-io/cdk-ghost-string-parameter"
22

33
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
44

‎api-docs/markdown/cdk-ghost-string-parameter.ghoststringparameter._constructor_.md‎

Lines changed: 45 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [cdk-ghost-string-parameter](./cdk-ghost-string-parameter.md) &gt; [GhostStringParameter](./cdk-ghost-string-parameter.ghoststringparameter.md) &gt; [(constructor)](./cdk-ghost-string-parameter.ghoststringparameter._constructor_.md)
3+
[Home](./index.md) &gt; [@codemonger-io/cdk-ghost-string-parameter](./cdk-ghost-string-parameter.md) &gt; [GhostStringParameter](./cdk-ghost-string-parameter.ghoststringparameter.md) &gt; [(constructor)](./cdk-ghost-string-parameter.ghoststringparameter._constructor_.md)
44

55
## GhostStringParameter.(constructor)
66

@@ -17,8 +17,48 @@ constructor(scope: Construct, props: GhostStringParameterProps);
1717

1818
## Parameters
1919

20-
| Parameter | Type | Description |
21-
| --- | --- | --- |
22-
| scope | Construct | |
23-
| props | [GhostStringParameterProps](./cdk-ghost-string-parameter.ghoststringparameterprops.md) | |
20+
<table><thead><tr><th>
2421

22+
Parameter
23+
24+
25+
</th><th>
26+
27+
Type
28+
29+
30+
</th><th>
31+
32+
Description
33+
34+
35+
</th></tr></thead>
36+
<tbody><tr><td>
37+
38+
scope
39+
40+
41+
</td><td>
42+
43+
Construct
44+
45+
46+
</td><td>
47+
48+
49+
</td></tr>
50+
<tr><td>
51+
52+
props
53+
54+
55+
</td><td>
56+
57+
[GhostStringParameterProps](./cdk-ghost-string-parameter.ghoststringparameterprops.md)
58+
59+
60+
</td><td>
61+
62+
63+
</td></tr>
64+
</tbody></table>

‎api-docs/markdown/cdk-ghost-string-parameter.ghoststringparameter.grantread.md‎

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [cdk-ghost-string-parameter](./cdk-ghost-string-parameter.md) &gt; [GhostStringParameter](./cdk-ghost-string-parameter.ghoststringparameter.md) &gt; [grantRead](./cdk-ghost-string-parameter.ghoststringparameter.grantread.md)
3+
[Home](./index.md) &gt; [@codemonger-io/cdk-ghost-string-parameter](./cdk-ghost-string-parameter.md) &gt; [GhostStringParameter](./cdk-ghost-string-parameter.ghoststringparameter.md) &gt; [grantRead](./cdk-ghost-string-parameter.ghoststringparameter.grantread.md)
44

55
## GhostStringParameter.grantRead() method
66

@@ -17,10 +17,37 @@ grantRead(grantee: iam.IGrantable): iam.Grant;
1717

1818
## Parameters
1919

20-
| Parameter | Type | Description |
21-
| --- | --- | --- |
22-
| grantee | iam.IGrantable | |
20+
<table><thead><tr><th>
2321

22+
Parameter
23+
24+
25+
</th><th>
26+
27+
Type
28+
29+
30+
</th><th>
31+
32+
Description
33+
34+
35+
</th></tr></thead>
36+
<tbody><tr><td>
37+
38+
grantee
39+
40+
41+
</td><td>
42+
43+
iam.IGrantable
44+
45+
46+
</td><td>
47+
48+
49+
</td></tr>
50+
</tbody></table>
2451
**Returns:**
2552

2653
iam.Grant

‎api-docs/markdown/cdk-ghost-string-parameter.ghoststringparameter.md‎

Lines changed: 126 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [cdk-ghost-string-parameter](./cdk-ghost-string-parameter.md) &gt; [GhostStringParameter](./cdk-ghost-string-parameter.ghoststringparameter.md)
3+
[Home](./index.md) &gt; [@codemonger-io/cdk-ghost-string-parameter](./cdk-ghost-string-parameter.md) &gt; [GhostStringParameter](./cdk-ghost-string-parameter.ghoststringparameter.md)
44

55
## GhostStringParameter class
66

@@ -27,20 +27,135 @@ Note that this class is not a `Construct`<!-- -->.
2727

2828
## Constructors
2929

30-
| Constructor | Modifiers | Description |
31-
| --- | --- | --- |
32-
| [(constructor)(scope, props)](./cdk-ghost-string-parameter.ghoststringparameter._constructor_.md) | | **_(BETA)_** Constructs a new instance of the <code>GhostStringParameter</code> class |
30+
<table><thead><tr><th>
31+
32+
Constructor
33+
34+
35+
</th><th>
36+
37+
Modifiers
38+
39+
40+
</th><th>
41+
42+
Description
43+
44+
45+
</th></tr></thead>
46+
<tbody><tr><td>
47+
48+
[(constructor)(scope, props)](./cdk-ghost-string-parameter.ghoststringparameter._constructor_.md)
49+
50+
51+
</td><td>
52+
53+
54+
</td><td>
55+
56+
**_(BETA)_** Constructs a new instance of the `GhostStringParameter` class
57+
58+
59+
</td></tr>
60+
</tbody></table>
3361

3462
## Properties
3563

36-
| Property | Modifiers | Type | Description |
37-
| --- | --- | --- | --- |
38-
| [parameterName](./cdk-ghost-string-parameter.ghoststringparameter.parametername.md) | <code>readonly</code> | string | **_(BETA)_** Name of this parameter. |
39-
| [scope](./cdk-ghost-string-parameter.ghoststringparameter.scope.md) | <code>readonly</code> | Construct | **_(BETA)_** Scope of this parameter. |
64+
<table><thead><tr><th>
65+
66+
Property
67+
68+
69+
</th><th>
70+
71+
Modifiers
72+
73+
74+
</th><th>
75+
76+
Type
77+
78+
79+
</th><th>
80+
81+
Description
82+
83+
84+
</th></tr></thead>
85+
<tbody><tr><td>
86+
87+
[parameterName](./cdk-ghost-string-parameter.ghoststringparameter.parametername.md)
88+
89+
90+
</td><td>
91+
92+
`readonly`
93+
94+
95+
</td><td>
96+
97+
string
98+
99+
100+
</td><td>
101+
102+
**_(BETA)_** Name of this parameter.
103+
104+
105+
</td></tr>
106+
<tr><td>
107+
108+
[scope](./cdk-ghost-string-parameter.ghoststringparameter.scope.md)
109+
110+
111+
</td><td>
112+
113+
`readonly`
114+
115+
116+
</td><td>
117+
118+
Construct
119+
120+
121+
</td><td>
122+
123+
**_(BETA)_** Scope of this parameter.
124+
125+
126+
</td></tr>
127+
</tbody></table>
40128

41129
## Methods
42130

43-
| Method | Modifiers | Description |
44-
| --- | --- | --- |
45-
| [grantRead(grantee)](./cdk-ghost-string-parameter.ghoststringparameter.grantread.md) | | **_(BETA)_** Allows a given principal to read this parameter. |
131+
<table><thead><tr><th>
132+
133+
Method
134+
135+
136+
</th><th>
137+
138+
Modifiers
139+
140+
141+
</th><th>
142+
143+
Description
144+
145+
146+
</th></tr></thead>
147+
<tbody><tr><td>
148+
149+
[grantRead(grantee)](./cdk-ghost-string-parameter.ghoststringparameter.grantread.md)
150+
151+
152+
</td><td>
153+
154+
155+
</td><td>
156+
157+
**_(BETA)_** Allows a given principal to read this parameter.
158+
46159

160+
</td></tr>
161+
</tbody></table>

‎api-docs/markdown/cdk-ghost-string-parameter.ghoststringparameter.parametername.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [cdk-ghost-string-parameter](./cdk-ghost-string-parameter.md) &gt; [GhostStringParameter](./cdk-ghost-string-parameter.ghoststringparameter.md) &gt; [parameterName](./cdk-ghost-string-parameter.ghoststringparameter.parametername.md)
3+
[Home](./index.md) &gt; [@codemonger-io/cdk-ghost-string-parameter](./cdk-ghost-string-parameter.md) &gt; [GhostStringParameter](./cdk-ghost-string-parameter.ghoststringparameter.md) &gt; [parameterName](./cdk-ghost-string-parameter.ghoststringparameter.parametername.md)
44

55
## GhostStringParameter.parameterName property
66

‎api-docs/markdown/cdk-ghost-string-parameter.ghoststringparameter.scope.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [cdk-ghost-string-parameter](./cdk-ghost-string-parameter.md) &gt; [GhostStringParameter](./cdk-ghost-string-parameter.ghoststringparameter.md) &gt; [scope](./cdk-ghost-string-parameter.ghoststringparameter.scope.md)
3+
[Home](./index.md) &gt; [@codemonger-io/cdk-ghost-string-parameter](./cdk-ghost-string-parameter.md) &gt; [GhostStringParameter](./cdk-ghost-string-parameter.ghoststringparameter.md) &gt; [scope](./cdk-ghost-string-parameter.ghoststringparameter.scope.md)
44

55
## GhostStringParameter.scope property
66

0 commit comments

Comments
 (0)