{"_id":"@18f/identity-normalize-yaml","_rev":"21-2abda4b8ef5f2398530ce8aac016ff32","name":"@18f/identity-normalize-yaml","dist-tags":{"latest":"2.0.0"},"versions":{"1.0.0":{"name":"@18f/identity-normalize-yaml","version":"1.0.0","license":"CC0-1.0","_id":"@18f/identity-normalize-yaml@1.0.0","maintainers":[{"name":"mneveunava","email":"micah.neveu@gsa.gov"},{"name":"nava-matt","email":"matt.gardner@gsa.gov"},{"name":"tts-tech-portfolio","email":"tts-tech-portfolio@gsa.gov"},{"name":"18f-devops","email":"devops@gsa.gov"},{"name":"mgwalker","email":"npm@darkcooger.net"},{"name":"stvnrlly","email":"stvnrlly@stvnrlly.com"},{"name":"rori123","email":"rochelle.ribeiro@gsa.gov"},{"name":"aduth","email":"andrew@andrewduthie.com"}],"homepage":"https://github.com/18f/identity-idp","bugs":{"url":"https://github.com/18f/identity-idp/issues"},"bin":{"normalize-yaml":"cli.js"},"dist":{"shasum":"c1ae60ca568bb0c4f403e7b7001d27ff66aaaa35","tarball":"https://registry.npmjs.org/@18f/identity-normalize-yaml/-/identity-normalize-yaml-1.0.0.tgz","fileCount":12,"integrity":"sha512-69kNtqKRhaLxvTTntQJPRva5ccbV6YJBMgZaThITOAqoq8ZrE0TrT+D9aahehcG1b51sGCm8iIkIcM4g5rIyzw==","signatures":[{"sig":"MEQCIDO67pHdbb9ppMkeWnc37zrh+YVIw9ks1EEnp+RRcXH1AiAlTsEs/r6+pCXx6xDDQNiCIVIk4B2Tyyn69z8PKbtHIw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":8502},"main":"./index.js","type":"module","types":"./types/index.d.ts","gitHead":"14400c9ccfac7e2db4100e3c05ce51bad9fe06be","private":false,"scripts":{"build:types":"tsc","prebuild:types":"rm -rf types","prepublishOnly":"npm run build:types"},"_npmUser":{"name":"aduth","email":"andrew@andrewduthie.com"},"repository":{"url":"git+https://github.com/18f/identity-idp.git","type":"git","directory":"app/javascript/packages/normalize-yaml"},"_npmVersion":"8.19.3","description":"Normalizes YAML files to ensure consistency and typographical quality","directories":{},"_nodeVersion":"16.19.1","dependencies":{"yaml":"^2.3.1","smartquotes":"^2.3.2"},"_hasShrinkwrap":false,"peerDependencies":{"prettier":"*"},"_npmOperationalInternal":{"tmp":"tmp/identity-normalize-yaml_1.0.0_1688129896911_0.8759290585436206","host":"s3://npm-registry-packages"}},"2.0.0":{"name":"@18f/identity-normalize-yaml","version":"2.0.0","license":"CC0-1.0","_id":"@18f/identity-normalize-yaml@2.0.0","maintainers":[{"name":"ginayam","email":"gina.yamada@gsa.gov"},{"name":"sb-nava","email":"sheldon@navapbc.com"},{"name":"cvfergus","email":"charles.ferguson@gsa.gov"},{"name":"mneveunava","email":"micah.neveu@gsa.gov"},{"name":"nava-matt","email":"matt.gardner@gsa.gov"},{"name":"tts-tech-portfolio","email":"tts-tech-portfolio@gsa.gov"},{"name":"18f-devops","email":"devops@gsa.gov"},{"name":"mgwalker","email":"npm@darkcooger.net"},{"name":"stvnrlly","email":"stvnrlly@stvnrlly.com"},{"name":"rori123","email":"rochelle.ribeiro@gsa.gov"},{"name":"aduth","email":"andrew@andrewduthie.com"}],"homepage":"https://github.com/18f/identity-idp","bugs":{"url":"https://github.com/18f/identity-idp/issues"},"bin":{"normalize-yaml":"cli.js"},"dist":{"shasum":"585fefd1eb15e7e218ed5dfd6b58029e0fba6b2b","tarball":"https://registry.npmjs.org/@18f/identity-normalize-yaml/-/identity-normalize-yaml-2.0.0.tgz","fileCount":12,"integrity":"sha512-TzTlVZlzxuxJzOytsobZcUE99tvFkqAJwfI7xROisxfkKyNeK5JhHKVAlNgqNHm/ARmJXw0zvMgRBVQgp5pteg==","signatures":[{"sig":"MEUCIQDsm8X/Dz3eeZmB0suA4GYKPBek1TXXE9p3Gl3EiDGFtwIgJasr70CnVFHQRp4eyNlh4Z2mFCtJlANrLIC/BajKs+A=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":8574},"main":"./index.js","type":"module","types":"./types/index.d.ts","gitHead":"f20de6b1ce4f65d6c8f7d34380a6c1492e0c4501","private":false,"scripts":{"build:types":"tsc","prebuild:types":"rm -rf types","prepublishOnly":"npm run build:types"},"_npmUser":{"name":"aduth","email":"andrew@andrewduthie.com"},"repository":{"url":"git+https://github.com/18f/identity-idp.git","type":"git","directory":"app/javascript/packages/normalize-yaml"},"_npmVersion":"10.2.4","description":"Normalizes YAML files to ensure consistency and typographical quality","directories":{},"_nodeVersion":"18.18.2","dependencies":{"yaml":"^2.3.4","smartquotes":"^2.3.2"},"_hasShrinkwrap":false,"peerDependencies":{"prettier":">=3"},"_npmOperationalInternal":{"tmp":"tmp/identity-normalize-yaml_2.0.0_1700495419007_0.2503241681160935","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-06-30T12:58:16.848Z","modified":"2026-07-30T16:17:32.774Z","1.0.0":"2023-06-30T12:58:17.056Z","2.0.0":"2023-11-20T15:50:19.200Z"},"bugs":{"url":"https://github.com/18f/identity-idp/issues"},"license":"CC0-1.0","homepage":"https://github.com/18f/identity-idp","repository":{"url":"git+https://github.com/18f/identity-idp.git","type":"git","directory":"app/javascript/packages/normalize-yaml"},"description":"Normalizes YAML files to ensure consistency and typographical quality","maintainers":[{"email":"devops@gsa.gov","name":"18f-devops"},{"email":"rochelle.ribeiro@gsa.gov","name":"rori123"},{"email":"sheldon@navapbc.com","name":"sb-nava"},{"email":"gina.yamada@gsa.gov","name":"ginayam"},{"email":"micah.neveu@gsa.gov","name":"mneveunava"},{"email":"tts-tech-portfolio@gsa.gov","name":"tts-tech-portfolio"},{"email":"michael.r.king@gsa.gov","name":"mkgsa"},{"email":"charles.ferguson@gsa.gov","name":"cvfergus"},{"email":"matt.gardner@gsa.gov","name":"nava-matt"},{"email":"keithwilliams@navapbc.com","name":"keithnava"},{"email":"tai@taigrr.com","name":"taigrr"},{"email":"luigi.ray-montanez@gsa.gov","name":"luigiraymontanez"},{"email":"john.jediny@gsa.gov","name":"jjediny"},{"email":"lakeisha.russell@gsa.gov","name":"lrussell01"},{"email":"gerardo.cruz-ortiz@gsa.gov","name":"gerardo.cruz-ortiz"},{"email":"aj.farkas@gsa.gov","name":"ajfarkas_gsa"}],"readme":"# @18f/identity-normalize-yaml\n\nNormalizes YAML files to ensure consistency and typographical quality:\n\n- Alphabetizes keys.\n- Applies improved punctuation.\n  - Converts straight quotes `\"` and `'` to smart quotes `“`, `”`, and `’`\n  - Converts three dots `...` to ellipsis `…`\n- Stylizes content using [Prettier](https://prettier.io/), respecting local project Prettier configuration.\n\n## Installation\n\nInstall using npm or Yarn. To reduce conflicts with a project's own Prettier dependency version, you must install Prettier as a separate dependency if not already installed.\n\nUsing npm:\n\n```\nnpm install @18f/identity-normalize-yaml prettier\n```\n\nUsing Yarn:\n\n```\nyarn add @18f/identity-normalize-yaml prettier\n```\n\n## Usage\n\n### CLI\n\nThe included `normalize-yaml` binary receives files as an argument, with optional flags:\n\n- `--disable-sort-keys`: Disable the default behavior to sort keys.\n- `--disable-smart-punctuation`: Disable the default behavior to apply smart punctuation.\n\n**Example:**\n\nUsing npm:\n\n```\nnpm exec normalize-yaml path/to/file.yml -- --disable-sort-keys\n```\n\nUsing Yarn:\n\n```\nyarn normalize-yaml path/to/file.yml --disable-sort-keys\n```\n\n### API\n\n#### `normalize(content: string, config?: Options): Promise<string>`\n\nGiven an input YAML string and optional options, resolves to a normalized YAML string.\n\n**Options:**\n\n- `prettierConfig` (`Record<string, any>`): Optional Prettier configuration object.\n- `exclude` (`Formatter[]`) Formatters to exclude.\n\n## License\n\nThis project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).\n\nAll contributions to this project will be released under the CC0 dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest.\n","readmeFilename":"README.md"}