{"_id":"heading-case","_rev":"28-04961c40ca554fa84ce97372a2c7f180","name":"heading-case","dist-tags":{"latest":"2.0.2"},"versions":{"0.0.0":{"name":"heading-case","version":"0.0.0","license":"MIT","_id":"heading-case@0.0.0","maintainers":[{"name":"chenjiahan","email":"416417567@163.com"}],"homepage":"https://github.com/rspack-contrib/heading-case#readme","bugs":{"url":"https://github.com/rspack-contrib/heading-case/issues"},"dist":{"shasum":"e4bbb4a6776b7ed790a0cd80e6a92ed33356c0aa","tarball":"https://registry.npmjs.org/heading-case/-/heading-case-0.0.0.tgz","fileCount":6,"integrity":"sha512-KHHkuS9i2+r5/vW+nrQtfoTbNYlQn2Zw8WD5OQlDHogfVqP1uKlWYi8CQG6uzGBBEXlqqMR3TuZaAYO/PWeFCQ==","signatures":[{"sig":"MEQCIApgIv4B3IImMd8t1ncU6L5SzvOkDIV/mcihDFew0wZxAiAT2cvAf/HE2cKSmxZBdy3AiahXdPFh1GQ9NCP56szDWw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":3007},"main":"./dist/index.js","type":"module","_from":"file:heading-case-0.0.0.tgz","types":"./dist/index.d.ts","module":"./dist/index.mjs","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"}},"scripts":{"dev":"rslib build --watch","bump":"npx bumpp","lint":"biome check .","test":"playwright test","build":"rslib build","lint:write":"biome check . --write"},"_npmUser":{"name":"chenjiahan","email":"416417567@163.com"},"_resolved":"/private/var/folders/lm/jz6s6y4s7ndg718_hskp0j600000gn/T/a98980bc9986d3ae8afdc8aa9f67c765/heading-case-0.0.0.tgz","_integrity":"sha512-KHHkuS9i2+r5/vW+nrQtfoTbNYlQn2Zw8WD5OQlDHogfVqP1uKlWYi8CQG6uzGBBEXlqqMR3TuZaAYO/PWeFCQ==","repository":{"url":"git+https://github.com/rspack-contrib/heading-case.git","type":"git"},"_npmVersion":"10.9.0","description":"

\"npm \n \n \"npm\n \n \"license\"\n \"downloads\"\n

\n\n## Example\n\n- Input:\n\n```md\n# A New Method for Creating JavaScript Rollovers\n```\n\n- Output:\n\n```md\n# A new method for creating JavaScript rollovers\n```\n\n## Usage\n\nInstall:\n\n```bash\nnpm add heading-case -D\n```\n\n### Rstack CLI\n\nAdd `heading-case` to the [`rs fmt` Prettier plugins](https://rstack.rs/guide/formatting#prettier-plugins):\n\n```ts\nimport { define } from 'rstack';\n\ndefine.fmt({\n plugins: ['heading-case'],\n});\n```\n\nCheck or write formatted files:\n\n```bash\nrs fmt --check\nrs fmt\n```\n\n### Prettier\n\nAdd the plugin to your Prettier configuration:\n\n```js\n/** @type {import('prettier').Config} */\nconst config = {\n plugins: ['heading-case'],\n};\n\nexport default config;\n```\n\nThen run Prettier normally:\n\n```bash\nprettier . --check\nprettier . --write\n```\n\n### Standalone CLI\n\nThe existing CLI remains available. Check all Markdown and MDX files in the current directory:\n\n```bash\nnpx heading-case\n```\n\nBy default, files ignored by Git are skipped as well, including rules from `.gitignore`, `.git/info/exclude`, and global Git ignore files.\n\nCheck and write the formatted content to the file:\n\n```bash\nnpx heading-case --write\n```\n\nThe programmatic CLI and core formatting utilities are available from subpath exports:\n\n```js\nimport { headingCase } from 'heading-case/cli';\nimport { formatLine } from 'heading-case/core';\n```\n\n## Limitations\n\nThis package is designed for Rstack's documentation. It follows the writing style of Rstack documentation and may not work well for other projects.\n\nThere are some edge cases that can not be correctly handled, so the execution result is not completely reliable.\n\n## License\n\n[MIT](./LICENSE).\n","readmeFilename":""}