@powerduck/openapi-codegen 0.4.1 → 0.4.2

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 (2) hide show
  1. package/README.md +1 -123
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -6,6 +6,7 @@ Generate runnable HTTP request examples from parsed OpenAPI documents for **21 l
6
6
 
7
7
  ## Features
8
8
 
9
+ - No need for Node environment support
9
10
  - Supports parsed OpenAPI documents, including OpenAPI 3.2
10
11
  - Generates readable HTTP request examples across 41 generators
11
12
  - Resolves path, query, header, and cookie parameters
@@ -415,129 +416,6 @@ Before committing snapshot changes, inspect the diff:
415
416
  git diff
416
417
  ```
417
418
 
418
- ## Releasing
419
-
420
- Before releasing, verify that:
421
-
422
- - The working tree is clean
423
- - You are on the intended branch
424
- - The full validation suite passes
425
- - You are authenticated with npm
426
- - The package is owned by your npm account or organization
427
- - The Git remote points to the intended repository
428
-
429
- Check the repository state:
430
-
431
- ```bash
432
- git status
433
- git remote -v
434
- ```
435
-
436
- Sign in to npm:
437
-
438
- ```bash
439
- npm login
440
- ```
441
-
442
- Inspect the package contents without publishing:
443
-
444
- ```bash
445
- npm pack --dry-run
446
- ```
447
-
448
- ### Patch Release
449
-
450
- Use a patch release for backward-compatible bug fixes:
451
-
452
- ```bash
453
- npm run release:patch
454
- ```
455
-
456
- Example:
457
-
458
- ```text
459
- 0.4.0 → 0.4.1
460
- ```
461
-
462
- ### Minor Release
463
-
464
- Use a minor release for backward-compatible features:
465
-
466
- ```bash
467
- npm run release:minor
468
- ```
469
-
470
- Example:
471
-
472
- ```text
473
- 0.4.0 → 0.5.0
474
- ```
475
-
476
- ### Major Release
477
-
478
- Use a major release for breaking changes:
479
-
480
- ```bash
481
- npm run release:major
482
- ```
483
-
484
- Example:
485
-
486
- ```text
487
- 0.4.0 → 1.0.0
488
- ```
489
-
490
- The release scripts run the configured checks, update the package version, create a Git commit and tag, and push the commit and tags.
491
-
492
- Publish the public scoped package:
493
-
494
- ```bash
495
- npm publish --access public
496
- ```
497
-
498
- ## Initial GitHub Setup
499
-
500
- Initialize the repository and push it to GitHub:
501
-
502
- ```bash
503
- git init
504
- git branch -M main
505
- git remote add origin https://github.com/PowerDuckie/-powerduck-openapi-codegen.git
506
- git add .
507
- git commit -m "feat: initialize OpenAPI code generator"
508
- git push -u origin main
509
- ```
510
-
511
- If `origin` already exists, update it:
512
-
513
- ```bash
514
- git remote set-url origin https://github.com/PowerDuckie/-powerduck-openapi-codegen.git
515
- git push -u origin main
516
- ```
517
-
518
- ## Project Structure
519
-
520
- A typical project layout is:
521
-
522
- ```text
523
- .
524
- ├── demo/
525
- ├── src/
526
- │ ├── core/
527
- │ ├── emitters/
528
- │ ├── generators/
529
- │ ├── common.ts
530
- │ ├── index.ts
531
- │ └── types.ts
532
- ├── tests/
533
- │ ├── fixtures/
534
- │ ├── fuzz.test.ts
535
- │ └── snapshot.test.ts
536
- ├── package.json
537
- ├── README.md
538
- └── tsconfig.json
539
- ```
540
-
541
419
  ## Security
542
420
 
543
421
  Generated source code can contain request URLs, headers, parameter values, and credentials supplied to the generator.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@powerduck/openapi-codegen",
3
- "version": "0.4.1",
3
+ "version": "0.4.2",
4
4
  "description": "Generate HTTP client examples from OpenAPI documents.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",