{"_id":"remark-lint-definition-sort","_rev":"1-7b5f3710213afc0c40f76afcbf086e2b","name":"remark-lint-definition-sort","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"remark-lint-definition-sort","version":"1.0.0","keywords":["compare","definition","footnote","lint","order","remark","remark-lint","remark-lint-rule","rule","sort"],"author":{"url":"https://wooorm.com","name":"Titus Wormer","email":"tituswormer@gmail.com"},"license":"MIT","_id":"remark-lint-definition-sort@1.0.0","maintainers":[{"name":"wooorm","email":"tituswormer@gmail.com"}],"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com"}],"homepage":"https://github.com/remarkjs/remark-lint/tree/main#readme","bugs":{"url":"https://github.com/remarkjs/remark-lint/issues"},"xo":{"rules":{"capitalized-comments":"off"},"prettier":true},"dist":{"shasum":"5ef73c41feab62d27d0d5d63a87e150a658c4f7e","tarball":"https://registry.npmjs.org/remark-lint-definition-sort/-/remark-lint-definition-sort-1.0.0.tgz","fileCount":5,"integrity":"sha512-83DYZRvhrwAGWCpyeWRCifxIYTS6lI30KJC5mGtwHedDktxnI4W1UL4lFVMtqy8SkYkL3vvVTh/xDlTyShfQAg==","signatures":[{"sig":"MEUCIFemUsJ+K39FnYNWD6gGXBOoDBfLYixsWgguJhyG4bK1AiEAmD04OO/TDty7558Sy22fWZPtZnaj12wcZOYaCOd4yIQ=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":17357},"type":"module","types":"./index.d.ts","exports":"./index.js","funding":{"url":"https://opencollective.com/unified","type":"opencollective"},"gitHead":"68068118ad3ed4fcf35e168fdb9f4119fe93a153","scripts":{},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"repository":{"url":"git+https://github.com/remarkjs/remark-lint.git#main","type":"git"},"_npmVersion":"11.0.0","description":"remark-lint rule to check definition order","directories":{},"sideEffects":false,"_nodeVersion":"23.1.0","dependencies":{"devlop":"^1.0.0","@types/mdast":"^4.0.0","unified-lint-rule":"^3.0.0","mdast-util-phrasing":"^4.0.0","unist-util-visit-parents":"^6.0.0"},"typeCoverage":{"strict":true,"atLeast":100},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/remark-lint-definition-sort_1.0.0_1737979402921_0.9151085572361479","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"bugs":{"url":"https://github.com/remarkjs/remark-lint/issues"},"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com"}],"dependencies":{"@types/mdast":"^4.0.0","devlop":"^1.0.0","mdast-util-phrasing":"^4.0.0","unified-lint-rule":"^3.0.0","unist-util-visit-parents":"^6.0.0"},"description":"remark-lint rule to check definition order","exports":"./index.js","funding":{"type":"opencollective","url":"https://opencollective.com/unified"},"keywords":["compare","definition","footnote","lint","order","remark","remark-lint","remark-lint-rule","rule","sort"],"license":"MIT","name":"remark-lint-definition-sort","repository":{"type":"git","url":"git+https://github.com/remarkjs/remark-lint.git#main"},"scripts":{},"sideEffects":false,"typeCoverage":{"atLeast":100,"strict":true},"type":"module","version":"1.0.1","xo":{"prettier":true,"rules":{"capitalized-comments":"off"}},"_id":"remark-lint-definition-sort@1.0.1","gitHead":"46ccbcd49deaada0172ad10425a2cd6b5f21a2c2","types":"./index.d.ts","homepage":"https://github.com/remarkjs/remark-lint/tree/main#readme","_nodeVersion":"23.1.0","_npmVersion":"11.0.0","dist":{"integrity":"sha512-IrE3UftngIf+byqkzYrfBCiNj2dPh1qDeuO3pqU0bnm4bGJ6FNP8IwvBWsiIRmXI+Q9HTdihb/zZqOmTv5dnIw==","shasum":"fdc3006fcd9d821ee12e275be3a35770a1328067","tarball":"https://registry.npmjs.org/remark-lint-definition-sort/-/remark-lint-definition-sort-1.0.1.tgz","fileCount":5,"unpackedSize":17357,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQC2OwAVuzl68b//cZ/bCZgcWHTnk6+pZQ8HTfRDKv8KRgIhAOz/2K6lSV9vEyaVRgJA71eqA/ELN/jwRn5S2Ag91prS"}]},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"directories":{},"maintainers":[{"name":"wooorm","email":"tituswormer@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/remark-lint-definition-sort_1.0.1_1737981029021_0.47685451816830304"},"_hasShrinkwrap":false}},"time":{"created":"2025-01-27T12:03:22.920Z","modified":"2025-01-27T12:30:29.366Z","1.0.0":"2025-01-27T12:03:23.146Z","1.0.1":"2025-01-27T12:30:29.188Z"},"bugs":{"url":"https://github.com/remarkjs/remark-lint/issues"},"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"license":"MIT","homepage":"https://github.com/remarkjs/remark-lint/tree/main#readme","keywords":["compare","definition","footnote","lint","order","remark","remark-lint","remark-lint-rule","rule","sort"],"repository":{"type":"git","url":"git+https://github.com/remarkjs/remark-lint.git#main"},"description":"remark-lint rule to check definition order","contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com"}],"maintainers":[{"name":"wooorm","email":"tituswormer@gmail.com"}],"readme":"<!--This file is generated-->\n\n# remark-lint-definition-sort\n\n[![Build][badge-build-image]][badge-build-url]\n[![Coverage][badge-coverage-image]][badge-coverage-url]\n[![Downloads][badge-downloads-image]][badge-downloads-url]\n[![Size][badge-size-image]][badge-size-url]\n[![Sponsors][badge-funding-sponsors-image]][badge-funding-url]\n[![Backers][badge-funding-backers-image]][badge-funding-url]\n[![Chat][badge-chat-image]][badge-chat-url]\n\n[`remark-lint`][github-remark-lint] rule to warn when definitions are not sorted.\n\n## Contents\n\n* [What is this?](#what-is-this)\n* [When should I use this?](#when-should-i-use-this)\n* [Presets](#presets)\n* [Install](#install)\n* [Use](#use)\n* [API](#api)\n  * [`unified().use(remarkLintDefinitionSort)`](#unifieduseremarklintdefinitionsort)\n* [Examples](#examples)\n* [Compatibility](#compatibility)\n* [Contribute](#contribute)\n* [License](#license)\n\n## What is this?\n\nThis package checks definition order.\n\n## When should I use this?\n\nYou can use this package to check definition order.\n\n## Presets\n\nThis plugin is not included in presets maintained here.\n\n## Install\n\nThis package is [ESM only][github-gist-esm].\nIn Node.js (version 16+),\ninstall with [npm][npm-install]:\n\n```sh\nnpm install remark-lint-definition-sort\n```\n\nIn Deno with [`esm.sh`][esm-sh]:\n\n```js\nimport remarkLintDefinitionSort from 'https://esm.sh/remark-lint-definition-sort@1'\n```\n\nIn browsers with [`esm.sh`][esm-sh]:\n\n```html\n<script type=\"module\">\n  import remarkLintDefinitionSort from 'https://esm.sh/remark-lint-definition-sort@1?bundle'\n</script>\n```\n\n## Use\n\nOn the API:\n\n```js\nimport remarkLint from 'remark-lint'\nimport remarkLintDefinitionSort from 'remark-lint-definition-sort'\nimport remarkParse from 'remark-parse'\nimport remarkStringify from 'remark-stringify'\nimport {read} from 'to-vfile'\nimport {unified} from 'unified'\nimport {reporter} from 'vfile-reporter'\n\nconst file = await read('example.md')\n\nawait unified()\n  .use(remarkParse)\n  .use(remarkLint)\n  .use(remarkLintDefinitionSort)\n  .use(remarkStringify)\n  .process(file)\n\nconsole.error(reporter(file))\n```\n\nOn the CLI:\n\n```sh\nremark --frail --use remark-lint --use remark-lint-definition-sort .\n```\n\nOn the CLI in a config file (here a `package.json`):\n\n```diff\n …\n \"remarkConfig\": {\n   \"plugins\": [\n     …\n     \"remark-lint\",\n+    \"remark-lint-definition-sort\",\n     …\n   ]\n }\n …\n```\n\n## API\n\nThis package exports no identifiers.\nIt exports no additional [TypeScript][typescript] types.\nThe default export is\n[`remarkLintDefinitionSort`][api-remark-lint-definition-sort].\n\n### `unified().use(remarkLintDefinitionSort)`\n\nWarn when when definitions are not sorted.\n\n###### Parameters\n\nThere are no parameters.\n\n###### Returns\n\nTransform ([`Transformer` from `unified`][github-unified-transformer]).\n\n## Examples\n\n##### `ok.md`\n\n###### In\n\n```markdown\n[mercury]: https://example.com/mercury/\n\n[venus]: https://example.com/venus/\n```\n\n###### Out\n\nNo messages.\n\n##### `gfm-ok.md`\n\n###### In\n\n> 👉 **Note**: this example uses\n> GFM ([`remark-gfm`][github-remark-gfm]).\n\n```markdown\n[^mercury]:\n    **Mercury** is the first planet from the Sun and the smallest\n    in the Solar System.\n\n[^venus]:\n    **Venus** is the second planet from\n    the Sun.\n```\n\n###### Out\n\nNo messages.\n\n##### `together.md`\n\n###### In\n\n> 👉 **Note**: this example uses\n> GFM ([`remark-gfm`][github-remark-gfm]).\n\n```markdown\nDefinitions and footnote definitions are sorted separately.\n\n[mercury]: https://example.com/mercury/\n[venus]: https://example.com/venus/\n\n[^mercury]:\n    **Mercury** is the first planet from the Sun and the smallest\n    in the Solar System.\n\n[^venus]:\n    **Venus** is the second planet from\n    the Sun.\n```\n\n###### Out\n\nNo messages.\n\n##### `together.md`\n\n###### In\n\n> 👉 **Note**: this example uses\n> GFM ([`remark-gfm`][github-remark-gfm]).\n\n```markdown\nDefinitions are sorted per “group”.\n\n[mercury]: https://example.com/mercury/\n[venus]: https://example.com/venus/\n\nThis paragraph introduces another group.\n\n[earth]: https://example.com/earth/\n[mars]: https://example.com/mars/\n```\n\n###### Out\n\nNo messages.\n\n##### `comment.md`\n\n###### In\n\n```markdown\n[earth]: https://example.com/earth/\n\n<!-- HTML comments are ignored. -->\n\n[mars]: https://example.com/mars/\n```\n\n###### Out\n\nNo messages.\n\n##### `comment.mdx`\n\n###### In\n\n> 👉 **Note**: this example uses\n> MDX ([`remark-mdx`][github-remark-mdx]).\n\n```mdx\n[earth]: https://example.com/earth/\n\n{/* Comments in expressions in MDX are ignored. */}\n\n[mars]: https://example.com/mars/\n```\n\n###### Out\n\nNo messages.\n\n##### `not-ok.md`\n\n###### In\n\n```markdown\n[venus]: https://example.com/venus/\n\n[mercury]: https://example.com/mercury/\n\n[earth]: https://example.com/earth/\n\n[mars]: https://example.com/mars/\n```\n\n###### Out\n\n```text\n1:1-1:36: Unexpected definition `venus` in 1st place, expected alphabetically sorted definitions, move it to 4th place\n3:1-3:40: Unexpected definition `mercury` in 2nd place, expected alphabetically sorted definitions, move it to 3rd place\n5:1-5:36: Unexpected definition `earth` in 3rd place, expected alphabetically sorted definitions, move it to 1st place\n7:1-7:34: Unexpected definition `mars` in 4th place, expected alphabetically sorted definitions, move it to 2nd place\n```\n\n##### `not-ok-gfm.md`\n\n###### In\n\n> 👉 **Note**: this example uses\n> GFM ([`remark-gfm`][github-remark-gfm]).\n\n```markdown\n[^venus]:\n    **Venus** is the second planet from\n    the Sun.\n\n[^mercury]:\n    **Mercury** is the first planet from the Sun and the smallest\n    in the Solar System.\n```\n\n###### Out\n\n```text\n1:1-3:13: Unexpected footnote definition `venus` in 1st place, expected alphabetically sorted definitions, move it to 2nd place\n5:1-7:25: Unexpected footnote definition `mercury` in 2nd place, expected alphabetically sorted definitions, move it to 1st place\n```\n\n## Compatibility\n\nProjects maintained by the unified collective are compatible with maintained\nversions of Node.js.\n\nWhen we cut a new major release, we drop support for unmaintained versions of\nNode.\nThis means we try to keep the current release line,\n`remark-lint-definition-sort@1`,\ncompatible with Node.js 16.\n\n## Contribute\n\nSee [`contributing.md`][github-dotfiles-contributing] in [`remarkjs/.github`][github-dotfiles-health] for ways\nto get started.\nSee [`support.md`][github-dotfiles-support] for ways to get help.\n\nThis project has a [code of conduct][github-dotfiles-coc].\nBy interacting with this repository, organization, or community you agree to\nabide by its terms.\n\n## License\n\n[MIT][file-license] © [Titus Wormer][author]\n\n[api-remark-lint-definition-sort]: #unifieduseremarklintdefinitionsort\n\n[author]: https://wooorm.com\n\n[badge-build-image]: https://github.com/remarkjs/remark-lint/workflows/main/badge.svg\n\n[badge-build-url]: https://github.com/remarkjs/remark-lint/actions\n\n[badge-chat-image]: https://img.shields.io/badge/chat-discussions-success.svg\n\n[badge-chat-url]: https://github.com/remarkjs/remark/discussions\n\n[badge-coverage-image]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg\n\n[badge-coverage-url]: https://codecov.io/github/remarkjs/remark-lint\n\n[badge-downloads-image]: https://img.shields.io/npm/dm/remark-lint-definition-sort.svg\n\n[badge-downloads-url]: https://www.npmjs.com/package/remark-lint-definition-sort\n\n[badge-funding-backers-image]: https://opencollective.com/unified/backers/badge.svg\n\n[badge-funding-sponsors-image]: https://opencollective.com/unified/sponsors/badge.svg\n\n[badge-funding-url]: https://opencollective.com/unified\n\n[badge-size-image]: https://img.shields.io/bundlejs/size/remark-lint-definition-sort\n\n[badge-size-url]: https://bundlejs.com/?q=remark-lint-definition-sort\n\n[esm-sh]: https://esm.sh\n\n[file-license]: https://github.com/remarkjs/remark-lint/blob/main/license\n\n[github-dotfiles-coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md\n\n[github-dotfiles-contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md\n\n[github-dotfiles-health]: https://github.com/remarkjs/.github\n\n[github-dotfiles-support]: https://github.com/remarkjs/.github/blob/main/support.md\n\n[github-gist-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c\n\n[github-remark-gfm]: https://github.com/remarkjs/remark-gfm\n\n[github-remark-lint]: https://github.com/remarkjs/remark-lint\n\n[github-remark-mdx]: https://mdxjs.com/packages/remark-mdx/\n\n[github-unified-transformer]: https://github.com/unifiedjs/unified#transformer\n\n[npm-install]: https://docs.npmjs.com/cli/install\n\n[typescript]: https://www.typescriptlang.org\n","readmeFilename":"readme.md"}