0.2.4 • Published 2 days ago

cdk-generate-synthetic-examples v0.2.4

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
2 days ago

CDK Generate Synthetic Examples

This tool will find all classes in the JSII assembly that don't yet have any example code associated with them, and will generate a synthetic example that shows how to instantiate the type. This is a method of last resort: we'd obviously prefer hand-written examples, but this will make sure all classes get something usable (which otherwise would not have any examples at all). It is designed to run during the build of a CDK Construct Library.

Install

This tool is published as an npm module, install locally:

npm install cdk-generate-synthetic-examples

Usage

Suppose you are in the base directory of your CDK construct, aws-construct. After a successful build, you have a .jsii file. cdk-generate-synthetic-examples will generate examples for types without doc examples and directly modify the assembly.

As part of the command, a _generated.ts-fixture file will be added to your project's rosetta directory. This fixture contains the necessary imports that will ensure compilation when rosetta:extract is run.

npx cdk-generate-synthetic-examples .jsii

With Rosetta:Extract

A common workflow is to run cdk-generate-synthetic-examples sandwiched between calls to rosetta:extract. The first rosetta:extract will extract any possible hand-written examples into your assembly. The second rosetta:extract will then compile and translate the new synthetic examples.

The --extract flag is simply a helper that does the second rosetta:extract call for you.

npx cdk-generate-synthetic-examples .jsii --extract

You can send common rosetta:extract options through cdk-generate-synthetic-examples as well.

npx cdk-generate-synthetic-examples \
  path/to/cdk/directory/.jsii \
  --extract \
  --extract-cache='rosetta-cache.tabl.json' \
  --extract-directory='path/to/cdk/directory'

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.

@jsii/specjsii-reflectyargs
@infinitebrahmanuniverse/nolb-cdk@everything-registry/sub-chunk-1303@zalastax/nolb-cdk
0.2.4

2 days ago

0.2.3

4 days ago

0.2.2

10 days ago

0.2.1

11 days ago

0.1.310

15 days ago

0.2.0

15 days ago

0.1.309

1 month ago

0.1.308

2 months ago

0.1.307

2 months ago

0.1.306

3 months ago

0.1.305

3 months ago

0.1.304

3 months ago

0.1.303

3 months ago

0.1.302

4 months ago

0.1.301

4 months ago

0.1.300

5 months ago

0.1.299

5 months ago

0.1.291

10 months ago

0.1.290

10 months ago

0.1.297

6 months ago

0.1.296

6 months ago

0.1.298

5 months ago

0.1.293

6 months ago

0.1.292

7 months ago

0.1.295

6 months ago

0.1.294

6 months ago

0.1.289

10 months ago

0.1.288

10 months ago

0.1.287

10 months ago

0.1.286

10 months ago

0.1.285

11 months ago

0.1.284

11 months ago

0.1.283

11 months ago

0.1.279

11 months ago

0.1.280

11 months ago

0.1.282

11 months ago

0.1.281

11 months ago

0.1.268

11 months ago

0.1.267

11 months ago

0.1.269

11 months ago

0.1.264

11 months ago

0.1.266

11 months ago

0.1.265

11 months ago

0.1.278

11 months ago

0.1.275

11 months ago

0.1.274

11 months ago

0.1.277

11 months ago

0.1.276

11 months ago

0.1.271

11 months ago

0.1.270

11 months ago

0.1.273

11 months ago

0.1.272

11 months ago

0.1.249

12 months ago

0.1.246

12 months ago

0.1.245

12 months ago

0.1.248

12 months ago

0.1.247

12 months ago

0.1.242

12 months ago

0.1.241

12 months ago

0.1.244

12 months ago

0.1.243

12 months ago

0.1.257

12 months ago

0.1.256

12 months ago

0.1.259

12 months ago

0.1.258

12 months ago

0.1.253

12 months ago

0.1.252

12 months ago

0.1.255

12 months ago

0.1.254

12 months ago

0.1.251

12 months ago

0.1.250

12 months ago

0.1.263

11 months ago

0.1.260

12 months ago

0.1.262

11 months ago

0.1.261

11 months ago

0.1.239

1 year ago

0.1.238

1 year ago

0.1.235

1 year ago

0.1.234

1 year ago

0.1.237

1 year ago

0.1.236

1 year ago

0.1.231

1 year ago

0.1.230

1 year ago

0.1.233

1 year ago

0.1.232

1 year ago

0.1.240

12 months ago

0.1.217

1 year ago

0.1.216

1 year ago

0.1.219

1 year ago

0.1.218

1 year ago

0.1.213

1 year ago

0.1.215

1 year ago

0.1.214

1 year ago

0.1.228

1 year ago

0.1.227

1 year ago

0.1.229

1 year ago

0.1.224

1 year ago

0.1.223

1 year ago

0.1.226

1 year ago

0.1.225

1 year ago

0.1.220

1 year ago

0.1.222

1 year ago

0.1.221

1 year ago

0.1.206

1 year ago

0.1.205

1 year ago

0.1.208

1 year ago

0.1.207

1 year ago

0.1.202

1 year ago

0.1.201

1 year ago

0.1.204

1 year ago

0.1.203

1 year ago

0.1.200

1 year ago

0.1.209

1 year ago

0.1.212

1 year ago

0.1.211

1 year ago

0.1.210

1 year ago

0.1.198

1 year ago

0.1.197

1 year ago

0.1.199

1 year ago

0.1.190

1 year ago

0.1.192

1 year ago

0.1.191

1 year ago

0.1.194

1 year ago

0.1.193

1 year ago

0.1.196

1 year ago

0.1.195

1 year ago

0.1.179

1 year ago

0.1.176

1 year ago

0.1.175

1 year ago

0.1.178

1 year ago

0.1.177

1 year ago

0.1.172

1 year ago

0.1.174

1 year ago

0.1.173

1 year ago

0.1.181

1 year ago

0.1.180

1 year ago

0.1.187

1 year ago

0.1.186

1 year ago

0.1.189

1 year ago

0.1.188

1 year ago

0.1.183

1 year ago

0.1.182

1 year ago

0.1.185

1 year ago

0.1.184

1 year ago

0.1.171

1 year ago

0.1.169

1 year ago

0.1.168

1 year ago

0.1.167

1 year ago

0.1.166

1 year ago

0.1.170

1 year ago

0.1.165

1 year ago

0.1.164

1 year ago

0.1.163

1 year ago

0.1.162

1 year ago

0.1.158

1 year ago

0.1.157

1 year ago

0.1.159

1 year ago

0.1.156

1 year ago

0.1.161

1 year ago

0.1.160

1 year ago

0.1.154

1 year ago

0.1.155

1 year ago

0.1.153

1 year ago

0.1.152

1 year ago

0.1.147

1 year ago

0.1.146

1 year ago

0.1.149

1 year ago

0.1.148

1 year ago

0.1.143

1 year ago

0.1.142

1 year ago

0.1.145

1 year ago

0.1.144

1 year ago

0.1.150

1 year ago

0.1.151

1 year ago

0.1.118

1 year ago

0.1.117

1 year ago

0.1.119

1 year ago

0.1.114

1 year ago

0.1.113

1 year ago

0.1.116

1 year ago

0.1.115

1 year ago

0.1.110

1 year ago

0.1.112

1 year ago

0.1.111

1 year ago

0.1.129

1 year ago

0.1.128

1 year ago

0.1.125

1 year ago

0.1.124

1 year ago

0.1.127

1 year ago

0.1.126

1 year ago

0.1.121

1 year ago

0.1.120

1 year ago

0.1.123

1 year ago

0.1.122

1 year ago

0.1.139

1 year ago

0.1.136

1 year ago

0.1.135

1 year ago

0.1.138

1 year ago

0.1.137

1 year ago

0.1.132

1 year ago

0.1.131

1 year ago

0.1.134

1 year ago

0.1.133

1 year ago

0.1.130

1 year ago

0.1.141

1 year ago

0.1.140

1 year ago

0.1.96

1 year ago

0.1.97

1 year ago

0.1.98

1 year ago

0.1.99

1 year ago

0.1.90

1 year ago

0.1.91

1 year ago

0.1.92

1 year ago

0.1.93

1 year ago

0.1.94

1 year ago

0.1.95

1 year ago

0.1.85

1 year ago

0.1.86

1 year ago

0.1.87

1 year ago

0.1.88

1 year ago

0.1.89

1 year ago

0.1.83

1 year ago

0.1.84

1 year ago

0.1.107

1 year ago

0.1.106

1 year ago

0.1.109

1 year ago

0.1.108

1 year ago

0.1.103

1 year ago

0.1.102

1 year ago

0.1.105

1 year ago

0.1.104

1 year ago

0.1.101

1 year ago

0.1.100

1 year ago

0.1.52

2 years ago

0.1.53

2 years ago

0.1.54

2 years ago

0.1.55

2 years ago

0.1.56

2 years ago

0.1.57

2 years ago

0.1.58

2 years ago

0.1.59

2 years ago

0.1.50

2 years ago

0.1.51

2 years ago

0.1.49

2 years ago

0.1.41

2 years ago

0.1.42

2 years ago

0.1.43

2 years ago

0.1.44

2 years ago

0.1.45

2 years ago

0.1.46

2 years ago

0.1.47

2 years ago

0.1.48

2 years ago

0.1.80

1 year ago

0.1.81

1 year ago

0.1.82

1 year ago

0.1.40

2 years ago

0.1.38

2 years ago

0.1.39

2 years ago

0.1.74

1 year ago

0.1.30

2 years ago

0.1.75

1 year ago

0.1.31

2 years ago

0.1.76

1 year ago

0.1.32

2 years ago

0.1.77

1 year ago

0.1.33

2 years ago

0.1.78

1 year ago

0.1.34

2 years ago

0.1.79

1 year ago

0.1.35

2 years ago

0.1.36

2 years ago

0.1.37

2 years ago

0.1.70

1 year ago

0.1.71

1 year ago

0.1.72

1 year ago

0.1.73

1 year ago

0.1.27

2 years ago

0.1.28

2 years ago

0.1.29

2 years ago

0.1.63

1 year ago

0.1.64

1 year ago

0.1.20

2 years ago

0.1.65

1 year ago

0.1.21

2 years ago

0.1.66

1 year ago

0.1.22

2 years ago

0.1.67

1 year ago

0.1.23

2 years ago

0.1.68

1 year ago

0.1.24

2 years ago

0.1.69

1 year ago

0.1.25

2 years ago

0.1.26

2 years ago

0.1.60

1 year ago

0.1.61

1 year ago

0.1.62

1 year ago

0.1.18

2 years ago

0.1.19

2 years ago

0.1.17

2 years ago

0.1.13

2 years ago

0.1.14

2 years ago

0.1.15

2 years ago

0.1.16

2 years ago

0.1.11

2 years ago

0.1.12

2 years ago

0.1.10

2 years ago

0.1.8

2 years ago

0.1.9

2 years ago

0.1.7

2 years ago

0.1.6

2 years ago

0.1.5

2 years ago

0.1.4

2 years ago

0.1.3

2 years ago

0.1.2

2 years ago

0.1.1

2 years ago

0.1.0

2 years ago

0.0.9

2 years ago

0.0.8

2 years ago

0.0.7

2 years ago

0.0.6

2 years ago

0.0.5

2 years ago

0.0.4

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago