{"_id":"@ariiera/remark-lint-styleguide","_rev":"1-7b899354eacd7fea67f7b922a1abd701","name":"@ariiera/remark-lint-styleguide","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@ariiera/remark-lint-styleguide","version":"1.0.0","description":"remark-lint preset made by ariiera","type":"module","main":"index.js","scripts":{"test":"jest","lint":"eslint .","lint:fix":"eslint . --fix"},"repository":{"type":"git","url":"git+https://github.com/ariiiera/ari-remark-lint-preset.git"},"keywords":["remark","linting","remark-lint","proofreading","writing"],"author":{"name":"ariiera","url":"Noah Vazquez"},"license":"MIT","publishConfig":{"access":"public"},"bugs":{"url":"https://github.com/ariiiera/ari-remark-lint-preset/issues"},"homepage":"https://github.com/ariiiera/ari-remark-lint-preset#readme","dependencies":{"remark-frontmatter":"^5.0.0","remark-gfm":"^4.0.0","remark-lint":"^9.1.2","remark-lint-blockquote-indentation":"^3.1.2","remark-lint-checkbox-character-style":"^4.1.2"},"devDependencies":{"eslint":"^8.57.0","eslint-config-airbnb-base":"^15.0.0","eslint-plugin-import":"^2.29.1"},"_id":"@ariiera/remark-lint-styleguide@1.0.0","gitHead":"e632de9a81dc6f42c925c10d96b729424145fda9","_nodeVersion":"21.1.0","_npmVersion":"10.2.0","dist":{"integrity":"sha512-zflzzbJFyttzEa6opWtYw9t3djkrG5D/Nay0CedobpwcFW0MnI+BLx/p/DHlkgHsX1nARoF4ygX+kR+JWM/AFQ==","shasum":"5fa500dc92f0b9afabb06a975f8ba94dc3c5c6a2","tarball":"https://registry.npmjs.org/@ariiera/remark-lint-styleguide/-/remark-lint-styleguide-1.0.0.tgz","fileCount":7,"unpackedSize":6334,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD5qnuPOvW9iO6PPRZUo3ftEpXP4nlzXzjVdZcz+IxexwIhAL/UbaVD9vRDUIy9rykdi035WY5KFARx7r1PUXYHPAqA"}]},"_npmUser":{"name":"ariiera","email":"imnoahvazquez@gmail.com"},"directories":{},"maintainers":[{"name":"ariiera","email":"imnoahvazquez@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-lint-styleguide_1.0.0_1714859018606_0.6718851518740123"},"_hasShrinkwrap":false},"1.0.1":{"name":"@ariiera/remark-lint-styleguide","version":"1.0.1","description":"remark-lint styleguide preset","type":"module","main":"index.js","scripts":{"test":"jest","lint":"eslint .","lint:fix":"eslint . --fix"},"repository":{"type":"git","url":"git+https://github.com/ariiiera/remark-lint-styleguide.git"},"keywords":["remark","linting","remark-lint","proofreading","writing"],"author":{"name":"ariiera","url":"Noah Vazquez"},"license":"MIT","publishConfig":{"access":"public"},"bugs":{"url":"https://github.com/ariiiera/remark-lint-styleguide/issues"},"homepage":"https://github.com/ariiiera/remark-lint-styleguide#readme","dependencies":{"remark-frontmatter":"^5.0.0","remark-gfm":"^4.0.0","remark-lint":"^9.1.2","remark-lint-blockquote-indentation":"^3.1.2","remark-lint-checkbox-character-style":"^4.1.2"},"devDependencies":{"eslint":"^8.57.0","eslint-config-airbnb-base":"^15.0.0","eslint-plugin-import":"^2.29.1"},"_id":"@ariiera/remark-lint-styleguide@1.0.1","gitHead":"fc006a763a4e724217288c2e048329d18bba4dad","_nodeVersion":"21.1.0","_npmVersion":"10.2.0","dist":{"integrity":"sha512-4bYgKG3ty87fKvgoAgbqBbGhktl3XuyGLHC+ZMaaqu4Wblb5rcBcOtCW0KKdxCwFXv0GfJz0zDJn2Da56nG53g==","shasum":"4cb7bbee4e77d81f69c336734d2a20442e529177","tarball":"https://registry.npmjs.org/@ariiera/remark-lint-styleguide/-/remark-lint-styleguide-1.0.1.tgz","fileCount":7,"unpackedSize":13637,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIE1SeT+Qf3JXLurQj+zxvtn5gkR1arBY5HnyeZT+Tmn4AiEA5YxSBRUfefEFnpJYu+5W7bKIFiHRgQdXP4b9y9geppY="}]},"_npmUser":{"name":"ariiera","email":"imnoahvazquez@gmail.com"},"directories":{},"maintainers":[{"name":"ariiera","email":"imnoahvazquez@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-lint-styleguide_1.0.1_1714862889732_0.7941742632081115"},"_hasShrinkwrap":false}},"time":{"created":"2024-05-04T21:43:38.484Z","1.0.0":"2024-05-04T21:43:38.774Z","modified":"2024-05-04T22:48:10.094Z","1.0.1":"2024-05-04T22:48:09.909Z"},"maintainers":[{"name":"ariiera","email":"imnoahvazquez@gmail.com"}],"description":"remark-lint styleguide preset","homepage":"https://github.com/ariiiera/remark-lint-styleguide#readme","keywords":["remark","linting","remark-lint","proofreading","writing"],"repository":{"type":"git","url":"git+https://github.com/ariiiera/remark-lint-styleguide.git"},"author":{"name":"ariiera","url":"Noah Vazquez"},"bugs":{"url":"https://github.com/ariiiera/remark-lint-styleguide/issues"},"license":"MIT","readme":"# @ariiera/remark-lint-styleguide\n\nPersonalized [remark-lint][] styleguide preset.\n\n## Installation and Usage\n\n### Local installation\n\nIf you want to lint the Markdown files from a project, the recommended way is to [install][npm install] this package as a [development dependency][] via [npm][]. Requires [`remark-cli`][remark-cli package].\n\n```bash\nnpm install --save-dev remark-cli @ariiera/remark-lint-styleguide\n```\n\nThen, add the [`remarkConfig`][unified-engine configure] field in your [`package.json`][package.json] file.\n\n```json\n\"remarkConfig\": {\n \"plugins\": [\n \"@ariiera/remark-lint-styleguide\"\n ]\n}\n```\n\nAlternatively, you can create a [`.remarkrc`][unified-engine configure] file in the root of your project and put the configuration there.\n\n```json\n{\n \"plugins\": [\n \"@ariiera/remark-lint-styleguide\"\n ]\n}\n```\n\nNext, you need to setup a [npm script][npm run-script] to lint Markdown files. See the [remark-cli package][] for more information on all available options.\n\n```json\n\"scripts\": {\n \"lint-md\": \"remark .\"\n}\n```\n\nRun the script from the command-line.\n\n```bash\nnpm run lint-md\n```\n\n----------\n\nYou can tell **remark** to ignore certain files or folders by creating a [`.remarkignore`][unified-engine ignore] file in the root of your project. The format is the same as for [`.gitignore`][gitignore] files.\n\nAlternatively, you can use any file that follows the standard ignore file format. You can even use your `.gitignore` file.\n\n```json\n\"scripts\": {\n \"lint-md\": \"remark --ignore-path .gitignore .\"\n}\n```\n\n### Programmatic usage\n\nIf you want to lint Markdown inside a [Node.js module][], you need to [install][npm install] this package as a project [dependency][] via [npm][]. Requires [`remark`][remark package].\n\n```bash\nnpm install --save remark @ariiera/remark-lint-styleguide vfile-reporter\n```\n\nIf you want to use it inside your project's custom build script, you should [install][npm install] this package as a [development dependency][] via [npm][]. Requires [`remark`][remark package].\n\n```bash\nnpm install --save-dev remark @ariiera/remark-lint-styleguide vfile-reporter\n```\n\nQuick example:\n\n```javascript\nconst fs = require('fs');\nconst remark = require('remark');\nconst styleguide = require('@ariiera/remark-lint-styleguide');\nconst report = require('vfile-reporter');\n\nconst myFile = fs.readFileSync('my-awesome-article.md', 'utf8');\n\nlet output = remark().use(styleguide).processSync(myFile);\n\nconsole.log(report(output));\n```\n\nThe [remark package][] interface is provided by the [unified package][]. See the documentation of both projects in order to get a better understanding of the API.\n\n## Configuration\n\nEach rule can be configured with a severity level:\n\n- `off`: turn the rule off\n- `warn`: show a warning for problems (exit code is 0, lint passes). Used by optional rules that might have a valid edge case.\n- `error`: trigger an error for problems (exit code is 1, lint fails). Used by rules that enforce correct syntax, best practices or portability.\n\n### Override rules\n\nStart your configuration with one of the presets and then modify certain rules to better suit your needs.\n\n\n```json\n\"remarkConfig\": {\n \"plugins\": [\n \"@ariiera/remark-lint-styleguide\",\n [\"remark-lint-no-html\", false]\n ]\n}\n```\n\n### Configuration comments\n\nYou can use configuration comments to turn all or certain rules on or off inside a file. Note that you cannot change their setting, only whether messages for that rule are shown or hidden. See the [remark-message-control][] package for more information.\n\nTo disable all **remark-lint** rules for an entire file, put the comment at the top of the file.\n\n```markdown\n\n\n# Heading\n\nParagraph.\n\n* list item 1\n* list item 2\n* list item 3\n```\n\nDisable certain rules for an entire file.\n\n```markdown\n\n\n# Heading\n\n\n\nParagraph.\n\n* list item 1\n* list item 2\n* list item 3\n```\n\nDisable certain rules only for a section of text.\n\n```markdown\n# Heading\n\n\n\n\n\n* list item 1\n* list item 2\n* list item 3\n\n\n\nParagraph.\n\n- list item 1\n- list item 2\n- list item 3\n```\n\nDisable certain rules only for the next node.\n\n```markdown\n# Heading\n\n\n\n\n\nParagraph.\n\n- list item 1\n- list item 2\n- list item 3\n```\n\n> **Note**: You'll need the blank lines between comments and other nodes!\n\n### External rules\n\nIn order to use the \"[external rules][]\" you will first have to install their respective package and then add them to your configuration. Example: `remark-lint-no-url-trailing-slash`.\n\nFirst, install the rule as a [development dependency][].\n\n```bash\nnpm install --save-dev remark-lint-no-url-trailing-slash\n```\n\nThen, add the rule to your existing configuration and provide a severity level for it.\n\n```json\n\"remarkConfig\": {\n \"plugins\": [\n \"@ariiera/remark-lint-styleguide\",\n [\"remark-lint-no-url-trailing-slash\", [\"warn\"]]\n ]\n}\n```\n\n## Help\n\nIf you have questions that this document or the [remark][] and [remark-lint][] documentations do not answer, please use the official [Gitter chat room][gitter remark] for **remark**.\n\n## Issues\n\nUse this project's [issue tracker][] for any of these situations:\n\n- report a preset that does not correctly implement the style guide it is based on\n- request a new preset\n- other aspects directly related to the current package\n\nFor problems related to the [remark][] and [remark-lint][] packages, please use their respective issue trackers.\n\n## Authors\n\n* **Noah Vazquez** - *Initial work* - [ariiiera][]\n\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details\n\n## Acknowledgments\n\n* Thank you to [raduserbanescu][] for the bulk of information in this readme\n\n\n\n[remark]: https://github.com/wooorm/remark\n[remark-lint]: https://github.com/wooorm/remark-lint\n[external rules]: https://github.com/wooorm/remark-lint#list-of-external-rules\n[gitter remark]: https://gitter.im/wooorm/remark\n\n[remark-cli package]: https://github.com/wooorm/remark/tree/master/packages/remark-cli\n[remark package]: https://github.com/wooorm/remark/tree/master/packages/remark\n[unified-engine configure]: https://github.com/unifiedjs/unified-engine/blob/master/doc/configure.md\n[unified-engine ignore]: https://github.com/unifiedjs/unified-engine/blob/master/doc/ignore.md\n[unified package]: https://github.com/unifiedjs/unified\n[remark-message-control]: https://github.com/wooorm/remark-message-control#markers\n\n[npm]: https://www.npmjs.com/ \"npm is the package manager for Node.js\"\n[npm install]: https://docs.npmjs.com/cli/install\n[npm run-script]: https://docs.npmjs.com/cli/run-script\n[package.json]: https://docs.npmjs.com/files/package.json\n[development dependency]: https://docs.npmjs.com/files/package.json#devdependencies\n[dependency]: https://docs.npmjs.com/files/package.json#dependencies\n\n[node.js module]: https://nodejs.org/api/modules.html\n\n[gitignore]: https://git-scm.com/docs/gitignore\n\n[issue tracker]: https://github.com/ariiiera/remark-lint-styleguide/issues\n[ariiiera]: https://github.com/ariiiera\n[raduserbanescu]: https://github.com/raduserbanescu\n","readmeFilename":"README.md"}