{"_id":"@benasher44/danger-plugin-spellcheck","_rev":"1-22c5f91fab62c17a0a9f563a7b0ce59f","name":"@benasher44/danger-plugin-spellcheck","dist-tags":{"latest":"2.1.1"},"versions":{"2.1.0":{"name":"@benasher44/danger-plugin-spellcheck","description":"Spell checks any created or modified markdown files.","author":{"name":"Orta Therox + Yuki Nishijima","email":"orta.therox@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/benasher44/danger-plugin-spellcheck.git"},"bugs":{"url":"https://github.com/benasher44/danger-plugin-spellcheck/issues"},"homepage":"https://github.com/benasher44/danger-plugin-spellcheck#readme","keywords":["danger","danger-plugin","mdspell"],"version":"2.1.0","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"commit":"git-cz","build":"tsc","test":"jest","predocs":"rm -rf docs/","docs":"esdoc -c .esdoc.json","prepublish-only":"npm run build","semantic-release":"semantic-release pre && npm publish && semantic-release post","prettier":"prettier","prettier-write":"npm run prettier -- --parser typescript --no-semi --trailing-comma es5 --write --print-width 120","prettier-project":"npm run prettier-write -- 'src/**/*.{ts,tsx}'"},"license":"MIT","engines":{"node":">=10.0.0"},"devDependencies":{"@types/jest":"^24.0.18","@types/node":"^12.7.3","danger":"9.1.8","esdoc":"^1.1.0","husky":"^3.0.4","jest":"^24.9.0","lint-staged":"^9.2.5","prettier":"^1.18.2","ts-jest":"^24.0.2","tslint":"^5.19.0","typescript":"4.5.2"},"lint-staged":{"*.@(ts|tsx)":["tslint --fix","npm run prettier-write --","git add"]},"jest":{"moduleFileExtensions":["ts","tsx","js"],"transform":{".(ts|tsx)":"<rootDir>/node_modules/ts-jest/preprocessor.js"},"testRegex":"(.test)\\.(ts|tsx)$","testPathIgnorePatterns":["\\.snap$","<rootDir>/node_modules/"]},"dependencies":{"cspell":"^5.13.2","glob":"^7.1.4","markdown-spellcheck":"^1.3.1"},"husky":{"hooks":{"pre-commit":["lint-staged"]}},"_id":"@benasher44/danger-plugin-spellcheck@2.1.0","gitHead":"cbccc19ef3810de59b7bdf8d00dce1ea90c8f376","_nodeVersion":"20.9.0","_npmVersion":"10.1.0","dist":{"integrity":"sha512-ToISMWJ8M74kVOBaCUTq3SqUAlLXyKxmB0p1rvT0V2j0p3sj65ClltseEwsXbkkkw44OyosTAq2ZtNiaHtonPw==","shasum":"353f7bdd4e843b7e252609f736d28a03d93d2de8","tarball":"https://registry.npmjs.org/@benasher44/danger-plugin-spellcheck/-/danger-plugin-spellcheck-2.1.0.tgz","fileCount":7,"unpackedSize":10945,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCDWKFAulublmHRQQEH61p/0uAXu+UxM4bvOBtBC6IJoQIgWT+MJW5hVwaJgrvStjHR65APidcMfb6v4Z8AM7nsMOY="}]},"_npmUser":{"name":"benasher44","email":"hello@benasher.co"},"directories":{},"maintainers":[{"name":"benasher44","email":"hello@benasher.co"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/danger-plugin-spellcheck_2.1.0_1700370620125_0.9389858502280419"},"_hasShrinkwrap":false},"2.1.1":{"name":"@benasher44/danger-plugin-spellcheck","description":"Spell checks any created or modified markdown files.","author":{"name":"Orta Therox + Yuki Nishijima","email":"orta.therox@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/benasher44/danger-plugin-spellcheck.git"},"bugs":{"url":"https://github.com/benasher44/danger-plugin-spellcheck/issues"},"homepage":"https://github.com/benasher44/danger-plugin-spellcheck#readme","keywords":["danger","danger-plugin","mdspell"],"version":"2.1.1","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"commit":"git-cz","build":"tsc","test":"jest","predocs":"rm -rf docs/","docs":"esdoc -c .esdoc.json","prepublish-only":"npm run build","semantic-release":"semantic-release pre && npm publish && semantic-release post","prettier":"prettier","prettier-write":"npm run prettier -- --parser typescript --no-semi --trailing-comma es5 --write --print-width 120","prettier-project":"npm run prettier-write -- 'src/**/*.{ts,tsx}'"},"license":"MIT","engines":{"node":">=10.0.0"},"devDependencies":{"@types/jest":"^24.0.18","@types/node":"^12.7.3","danger":"9.1.8","esdoc":"^1.1.0","husky":"^3.0.4","jest":"^24.9.0","lint-staged":"^9.2.5","prettier":"^1.18.2","ts-jest":"^24.0.2","tslint":"^5.19.0","typescript":"4.5.2"},"lint-staged":{"*.@(ts|tsx)":["tslint --fix","npm run prettier-write --","git add"]},"jest":{"moduleFileExtensions":["ts","tsx","js"],"transform":{".(ts|tsx)":"<rootDir>/node_modules/ts-jest/preprocessor.js"},"testRegex":"(.test)\\.(ts|tsx)$","testPathIgnorePatterns":["\\.snap$","<rootDir>/node_modules/"]},"dependencies":{"cspell":"^5.13.2","glob":"^7.1.4","markdown-spellcheck":"^1.3.1"},"husky":{"hooks":{"pre-commit":["lint-staged"]}},"_id":"@benasher44/danger-plugin-spellcheck@2.1.1","gitHead":"679a6c98939ce83e4c5f7156e8e89c5a30ffaf46","_nodeVersion":"20.11.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-m39sprHlftHq7W2fSK0UOyULo0hsvs8Z7HkAYaX95t8uywKSAnL7mZNipxN33qI/gSxKHhmcKCk2nF/0N9TzwQ==","shasum":"993793f53996dcf5c82a55442ea6f970214be24c","tarball":"https://registry.npmjs.org/@benasher44/danger-plugin-spellcheck/-/danger-plugin-spellcheck-2.1.1.tgz","fileCount":12,"unpackedSize":34548,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGP77htV8hR94RDcy2eI5WGRHDg23sckx+HadDBpS88gAiEArSSHkf1DXT9PjeNIS671hTGViPFIo1IvPUJJs6/JR0Y="}]},"_npmUser":{"name":"benasher44","email":"hello@benasher.co"},"directories":{},"maintainers":[{"name":"benasher44","email":"hello@benasher.co"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/danger-plugin-spellcheck_2.1.1_1714879213862_0.5311904715348836"},"_hasShrinkwrap":false}},"time":{"created":"2023-11-19T05:10:20.030Z","2.1.0":"2023-11-19T05:10:20.310Z","modified":"2024-05-05T03:20:14.219Z","2.1.1":"2024-05-05T03:20:14.051Z"},"maintainers":[{"name":"benasher44","email":"hello@benasher.co"}],"description":"Spell checks any created or modified markdown files.","homepage":"https://github.com/benasher44/danger-plugin-spellcheck#readme","keywords":["danger","danger-plugin","mdspell"],"repository":{"type":"git","url":"git+https://github.com/benasher44/danger-plugin-spellcheck.git"},"author":{"name":"Orta Therox + Yuki Nishijima","email":"orta.therox@gmail.com"},"bugs":{"url":"https://github.com/benasher44/danger-plugin-spellcheck/issues"},"license":"MIT","readme":"# danger-plugin-spellcheck\n\n[![Build Status](https://travis-ci.org/orta/danger-plugin-spellcheck.svg?branch=master)](https://travis-ci.org/orta/danger-plugin-spellcheck)\n[![npm version](https://badge.fury.io/js/danger-plugin-spellcheck.svg)](https://badge.fury.io/js/danger-plugin-spellcheck)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n\n> Spell checks any created or modified files in a GitHub PR using :\n>\n> - [node-markdown-spellcheck](https://github.com/lukeapage/node-markdown-spellcheck) for Markdown.\n> - [cspell](https://github.com/streetsidesoftware/cspell) for code (opt-in).\n\n## Usage\n\nInstall:\n\n```sh\nyarn add danger-plugin-spellcheck --dev\n```\n\nAt a glance:\n\n```js\n// dangerfile.js\nimport spellcheck from 'danger-plugin-spellcheck'\n\nspellcheck()\n```\n\nYou can have a shared repo for the settings for your spell checking, or you can have a file called `spellcheck.json` in your repo's root.\n\n```js\n// dangerfile.js\nimport spellcheck from 'danger-plugin-spellcheck'\n\nspellcheck({ settings: \"artsy/artsy-danger@spellcheck.json\" })\n```\n\nThe JSON should look something like:\n\n```json\n{\n  \"ignore\": [\"orta\", \"artsy\", \"github\", \"/danger-*.\"],\n  \"ignoreFiles\": [\"README.md\"]\n}\n```\n\nThe `\"ignore\"` section is case in-sensitive for words, if a word has a prefix of `\"/\"` then it will be treated as a `RegExp`.\n\nThe `\"ignoreFiles\"` section is an array of files which will **NOT** be spellchecked.\n\n#### Dynamic Content\n\nThe spellcheck function also accepts `ignore` and `ignoreFiles` as properties of the options object.  If you already have a list of spell check exceptions (_e.g._ from your editor), you can build them in your dangerfile and pass them in to your spellcheck function call.\n\n```js\n// dangerfile.js\nimport spellcheck from 'danger-plugin-spellcheck'\n\nspellcheck({\n  ignore: ['Nachoz', 'Tacoz'],\n  ignoreFiles: ['README.md']\n})\n```\n\n#### Checking Code\n\nThe spellcheck also takes a set of globs to run cspell against:\n\n```js\n// dangerfile.js\nimport spellcheck from 'danger-plugin-spellcheck'\n\nspellcheck({\n  ignore: ['Nachoz', 'Tacoz'],\n  ignoreFiles: ['README.md'],\n  codeSpellCheck: [\"**/*.ts\", \"**/*.js\"]\n})\n```\n\n## Peril\n\nIf you're using Peril you can use both a global settings for org wide-spellchecking, and then have local additions to any\nof the settings. This can make it easier to handle specific one off cases that feel a bit too unique to a single project.\n\nHere is our Artsy setup where we do this:\n\n* [Dangerfile for every PR](https://github.com/artsy/artsy-danger/blob/997d4fb7f4680973ac016eb75474ad15bf18c183/org/all-prs.ts#L7-L9)\n* [Global Spellcheck for every repo](https://github.com/artsy/artsy-danger/blob/997d4fb7f4680973ac016eb75474ad15bf18c183/spellcheck.json)\n* [A per-repo override for a specific repo](https://github.com/artsy/bearden/blob/1979379bb56dacb13593fbc90981ed88e1b097b3/spellcheck.json)\n\n## Credits\n\nThis was created by [Orta Therox](https://twitter.com/orta) and [Yuki Nishijima](https://twitter.com/yuki24) in an amazing pairing session on cold thursday before an [Artsy Happy Hour](https://github.com/artsy/meta/blob/master/meta/happy_hour.md).\n\n## Contributing\n\nSee [CONTRIBUTING.md](contributing.md).\n","readmeFilename":"README.md"}