0.2.23 • Published 4 months ago

cdk-generate-synthetic-examples v0.2.23

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
4 months 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.

0.2.23

4 months ago

0.2.22

4 months ago

0.2.21

5 months ago

0.2.20

6 months ago

0.2.19

6 months ago

0.2.18

8 months ago

0.2.17

9 months ago

0.2.16

9 months ago

0.2.15

9 months ago

0.2.14

10 months ago

0.2.13

10 months ago

0.2.12

11 months ago

0.2.11

12 months ago

0.2.10

12 months ago

0.2.9

1 year ago

0.2.8

1 year ago

0.2.7

1 year ago

0.2.6

1 year ago

0.2.5

1 year ago

0.2.4

1 year ago

0.2.3

1 year ago

0.2.2

1 year ago

0.2.1

1 year ago

0.1.310

1 year ago

0.2.0

1 year ago

0.1.309

1 year ago

0.1.308

1 year ago

0.1.307

1 year ago

0.1.306

1 year ago

0.1.305

1 year ago

0.1.304

1 year ago

0.1.303

1 year ago

0.1.302

1 year ago

0.1.301

1 year ago

0.1.300

2 years ago

0.1.299

2 years ago

0.1.291

2 years ago

0.1.290

2 years ago

0.1.297

2 years ago

0.1.296

2 years ago

0.1.298

2 years ago

0.1.293

2 years ago

0.1.292

2 years ago

0.1.295

2 years ago

0.1.294

2 years ago

0.1.289

2 years ago

0.1.288

2 years ago

0.1.287

2 years ago

0.1.286

2 years ago

0.1.285

2 years ago

0.1.284

2 years ago

0.1.283

2 years ago

0.1.279

2 years ago

0.1.280

2 years ago

0.1.282

2 years ago

0.1.281

2 years ago

0.1.268

2 years ago

0.1.267

2 years ago

0.1.269

2 years ago

0.1.264

2 years ago

0.1.266

2 years ago

0.1.265

2 years ago

0.1.278

2 years ago

0.1.275

2 years ago

0.1.274

2 years ago

0.1.277

2 years ago

0.1.276

2 years ago

0.1.271

2 years ago

0.1.270

2 years ago

0.1.273

2 years ago

0.1.272

2 years ago

0.1.249

2 years ago

0.1.246

2 years ago

0.1.245

2 years ago

0.1.248

2 years ago

0.1.247

2 years ago

0.1.242

2 years ago

0.1.241

2 years ago

0.1.244

2 years ago

0.1.243

2 years ago

0.1.257

2 years ago

0.1.256

2 years ago

0.1.259

2 years ago

0.1.258

2 years ago

0.1.253

2 years ago

0.1.252

2 years ago

0.1.255

2 years ago

0.1.254

2 years ago

0.1.251

2 years ago

0.1.250

2 years ago

0.1.263

2 years ago

0.1.260

2 years ago

0.1.262

2 years ago

0.1.261

2 years ago

0.1.239

2 years ago

0.1.238

2 years ago

0.1.235

2 years ago

0.1.234

2 years ago

0.1.237

2 years ago

0.1.236

2 years ago

0.1.231

2 years ago

0.1.230

2 years ago

0.1.233

2 years ago

0.1.232

2 years ago

0.1.240

2 years ago

0.1.217

2 years ago

0.1.216

2 years ago

0.1.219

2 years ago

0.1.218

2 years ago

0.1.213

2 years ago

0.1.215

2 years ago

0.1.214

2 years ago

0.1.228

2 years ago

0.1.227

2 years ago

0.1.229

2 years ago

0.1.224

2 years ago

0.1.223

2 years ago

0.1.226

2 years ago

0.1.225

2 years ago

0.1.220

2 years ago

0.1.222

2 years ago

0.1.221

2 years ago

0.1.206

2 years ago

0.1.205

2 years ago

0.1.208

2 years ago

0.1.207

2 years ago

0.1.202

2 years ago

0.1.201

2 years ago

0.1.204

2 years ago

0.1.203

2 years ago

0.1.200

2 years ago

0.1.209

2 years ago

0.1.212

2 years ago

0.1.211

2 years ago

0.1.210

2 years ago

0.1.198

2 years ago

0.1.197

2 years ago

0.1.199

2 years ago

0.1.190

2 years ago

0.1.192

2 years ago

0.1.191

2 years ago

0.1.194

2 years ago

0.1.193

2 years ago

0.1.196

2 years ago

0.1.195

2 years ago

0.1.179

2 years ago

0.1.176

2 years ago

0.1.175

2 years ago

0.1.178

2 years ago

0.1.177

2 years ago

0.1.172

2 years ago

0.1.174

2 years ago

0.1.173

2 years ago

0.1.181

2 years ago

0.1.180

2 years ago

0.1.187

2 years ago

0.1.186

2 years ago

0.1.189

2 years ago

0.1.188

2 years ago

0.1.183

2 years ago

0.1.182

2 years ago

0.1.185

2 years ago

0.1.184

2 years ago

0.1.171

2 years ago

0.1.169

2 years ago

0.1.168

2 years ago

0.1.167

2 years ago

0.1.166

2 years ago

0.1.170

2 years ago

0.1.165

2 years ago

0.1.164

2 years ago

0.1.163

2 years ago

0.1.162

2 years ago

0.1.158

2 years ago

0.1.157

2 years ago

0.1.159

2 years ago

0.1.156

2 years ago

0.1.161

2 years ago

0.1.160

2 years ago

0.1.154

2 years ago

0.1.155

2 years ago

0.1.153

2 years ago

0.1.152

2 years ago

0.1.147

2 years ago

0.1.146

2 years ago

0.1.149

2 years ago

0.1.148

2 years ago

0.1.143

2 years ago

0.1.142

2 years ago

0.1.145

2 years ago

0.1.144

2 years ago

0.1.150

2 years ago

0.1.151

2 years ago

0.1.118

2 years ago

0.1.117

2 years ago

0.1.119

2 years ago

0.1.114

3 years ago

0.1.113

3 years ago

0.1.116

2 years ago

0.1.115

2 years ago

0.1.110

3 years ago

0.1.112

3 years ago

0.1.111

3 years ago

0.1.129

2 years ago

0.1.128

2 years ago

0.1.125

2 years ago

0.1.124

2 years ago

0.1.127

2 years ago

0.1.126

2 years ago

0.1.121

2 years ago

0.1.120

2 years ago

0.1.123

2 years ago

0.1.122

2 years ago

0.1.139

2 years ago

0.1.136

2 years ago

0.1.135

2 years ago

0.1.138

2 years ago

0.1.137

2 years ago

0.1.132

2 years ago

0.1.131

2 years ago

0.1.134

2 years ago

0.1.133

2 years ago

0.1.130

2 years ago

0.1.141

2 years ago

0.1.140

2 years ago

0.1.96

3 years ago

0.1.97

3 years ago

0.1.98

3 years ago

0.1.99

3 years ago

0.1.90

3 years ago

0.1.91

3 years ago

0.1.92

3 years ago

0.1.93

3 years ago

0.1.94

3 years ago

0.1.95

3 years ago

0.1.85

3 years ago

0.1.86

3 years ago

0.1.87

3 years ago

0.1.88

3 years ago

0.1.89

3 years ago

0.1.83

3 years ago

0.1.84

3 years ago

0.1.107

3 years ago

0.1.106

3 years ago

0.1.109

3 years ago

0.1.108

3 years ago

0.1.103

3 years ago

0.1.102

3 years ago

0.1.105

3 years ago

0.1.104

3 years ago

0.1.101

3 years ago

0.1.100

3 years ago

0.1.52

3 years ago

0.1.53

3 years ago

0.1.54

3 years ago

0.1.55

3 years ago

0.1.56

3 years ago

0.1.57

3 years ago

0.1.58

3 years ago

0.1.59

3 years ago

0.1.50

3 years ago

0.1.51

3 years ago

0.1.49

3 years ago

0.1.41

3 years ago

0.1.42

3 years ago

0.1.43

3 years ago

0.1.44

3 years ago

0.1.45

3 years ago

0.1.46

3 years ago

0.1.47

3 years ago

0.1.48

3 years ago

0.1.80

3 years ago

0.1.81

3 years ago

0.1.82

3 years ago

0.1.40

3 years ago

0.1.38

3 years ago

0.1.39

3 years ago

0.1.74

3 years ago

0.1.30

3 years ago

0.1.75

3 years ago

0.1.31

3 years ago

0.1.76

3 years ago

0.1.32

3 years ago

0.1.77

3 years ago

0.1.33

3 years ago

0.1.78

3 years ago

0.1.34

3 years ago

0.1.79

3 years ago

0.1.35

3 years ago

0.1.36

3 years ago

0.1.37

3 years ago

0.1.70

3 years ago

0.1.71

3 years ago

0.1.72

3 years ago

0.1.73

3 years ago

0.1.27

3 years ago

0.1.28

3 years ago

0.1.29

3 years ago

0.1.63

3 years ago

0.1.64

3 years ago

0.1.20

3 years ago

0.1.65

3 years ago

0.1.21

3 years ago

0.1.66

3 years ago

0.1.22

3 years ago

0.1.67

3 years ago

0.1.23

3 years ago

0.1.68

3 years ago

0.1.24

3 years ago

0.1.69

3 years ago

0.1.25

3 years ago

0.1.26

3 years ago

0.1.60

3 years ago

0.1.61

3 years ago

0.1.62

3 years ago

0.1.18

3 years ago

0.1.19

3 years ago

0.1.17

3 years ago

0.1.13

3 years ago

0.1.14

3 years ago

0.1.15

3 years ago

0.1.16

3 years ago

0.1.11

3 years ago

0.1.12

3 years ago

0.1.10

3 years ago

0.1.8

3 years ago

0.1.9

3 years ago

0.1.7

3 years ago

0.1.6

3 years ago

0.1.5

3 years ago

0.1.4

3 years ago

0.1.3

3 years ago

0.1.2

3 years ago

0.1.1

4 years ago

0.1.0

4 years ago

0.0.9

4 years ago

0.0.8

4 years ago

0.0.7

4 years ago

0.0.6

4 years ago

0.0.5

4 years ago

0.0.4

4 years ago

0.0.3

4 years ago

0.0.2

4 years ago

0.0.1

4 years ago