{"_id":"@alma-oss/textlint-rule-preset-alma","name":"@alma-oss/textlint-rule-preset-alma","dist-tags":{"latest":"3.0.0-alpha.0"},"versions":{"3.0.0-alpha.0":{"name":"@alma-oss/textlint-rule-preset-alma","version":"3.0.0-alpha.0","description":"Alma Career's config for Textlint","keywords":["textlint","textlintrule","alma","config","preset"],"author":{"name":"Tomáš Litera","email":"tomas.litera@almacareer.com"},"license":"MIT","type":"module","exports":{".":"./index.js","./package.json":"./package.json"},"publishConfig":{"access":"public"},"repository":{"type":"git","url":"git+https://github.com/lmc-eu/code-quality-tools.git","directory":"packages/textlint-rule-preset-alma"},"engines":{"node":">=20"},"scripts":{"test":"node --test"},"dependencies":{"textlint":"^15.0.0","textlint-filter-rule-comments":"^1.2.2","textlint-rule-apostrophe":"^3.0.0","textlint-rule-common-misspellings":"^1.0.1","textlint-rule-stop-words":"^5.0.0","textlint-rule-terminology":"^5.0.0","textlint-rule-title-case":"^3.0.0","textlint-rule-write-good":"^2.0.0"},"devDependencies":{"@textlint/kernel":"^15.0.0","@textlint/textlint-plugin-markdown":"^15.0.0","@textlint/textlint-plugin-text":"^15.0.0"},"peerDependencies":{"textlint":"^15.0.0"},"gitHead":"dd24962aed1ccc9a0dc14993cb3141f7e7fd3c99","_id":"@alma-oss/textlint-rule-preset-alma@3.0.0-alpha.0","bugs":{"url":"https://github.com/lmc-eu/code-quality-tools/issues"},"homepage":"https://github.com/lmc-eu/code-quality-tools#readme","_nodeVersion":"22.23.2","_npmVersion":"lerna/10.0.1/node@v22.23.2+arm64 (darwin)","dist":{"integrity":"sha512-BqnOO5clw6FEPL1SFy+c004Uat3817sLiZKi0Ysm6sp6lrJULslMAripSTSy7N4wS/M2Z5YxcO31N636UWPCVw==","shasum":"4644707b0be8425a17bf513fcfaec7fb52af5610","tarball":"https://registry.npmjs.org/@alma-oss/textlint-rule-preset-alma/-/textlint-rule-preset-alma-3.0.0-alpha.0.tgz","fileCount":8,"unpackedSize":21136,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDjbuZrplz6eqWovQOoK4DHgO5e6+7kG5MBFKo5tfEKfgIhAK7f5CHhGFrJ82ORuhM3SaIFNLdAon4Ry1s/bm5YFHKl"}]},"_npmUser":{"name":"literat","email":"tomaslitera@hotmail.com"},"directories":{},"maintainers":[{"name":"alma-design-system-bot","email":"team-design-system@almacareer.com"},{"name":"literat","email":"tomaslitera@hotmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/textlint-rule-preset-alma_3.0.0-alpha.0_1789128109420_0.5012982443095866"},"_hasShrinkwrap":false}},"time":{"created":"2026-09-11T12:01:49.124Z","3.0.0-alpha.0":"2026-09-11T12:01:49.559Z","modified":"2026-09-11T12:01:49.788Z"},"maintainers":[{"name":"alma-design-system-bot","email":"team-design-system@almacareer.com"},{"name":"literat","email":"tomaslitera@hotmail.com"}],"description":"Alma Career's config for Textlint","homepage":"https://github.com/lmc-eu/code-quality-tools#readme","keywords":["textlint","textlintrule","alma","config","preset"],"repository":{"type":"git","url":"git+https://github.com/lmc-eu/code-quality-tools.git","directory":"packages/textlint-rule-preset-alma"},"author":{"name":"Tomáš Litera","email":"tomas.litera@almacareer.com"},"bugs":{"url":"https://github.com/lmc-eu/code-quality-tools/issues"},"license":"MIT","readme":"# @alma-oss/textlint-rule-preset-alma\n\n> Alma Career’s config for [textlint][textlint-home]\n\nTextlint doesn’t support [\"extends\" convention][extends-convention], thus we created [rule-preset][rule-preset-docs], a collection of rules and rulesConfig.\n\n## Usage\n\n```sh\n#Yarn\nyarn add -D @alma-oss/textlint-rule-preset-alma\n\n# npm\nnpm i --save-dev @alma-oss/textlint-rule-preset-alma\n```\n\n## Recommended Textlint Config\n\n```js\n// .textlintrc.js\n\n'use strict';\n\nmodule.exports = {\n  rules: {\n    '@alma-oss/textlint-rule-preset-alma': true,\n  },\n};\n```\n\n<details>\n<summary><i>.textlintrc</i> or <i>.textlintrc.json</i></summary>\n\n```json\n{\n  \"rules\": {\n    \"@alma-oss/textlint-rule-preset-alma\": true\n  }\n}\n```\n\n</details>\n\n## Excluding Terminology Rule Terms\n\nThe preset’s `terminology` rule ships with its own curated term list (see [`rules/terminology.js`][terminology-terms]) and disables `textlint-rule-terminology`’s built-in defaults. If you only want to drop a few terms from that list, pass an `exclude` array — it’s merged with the preset’s own options, so you keep everything else, including `defaultTerms: false`:\n\n```js\n// .textlintrc.js\n\n'use strict';\n\nmodule.exports = {\n  rules: {\n    '@alma-oss/textlint-rule-preset-alma': {\n      terminology: {\n        exclude: ['ID', 'back[- ]end(\\\\w*)'],\n      },\n    },\n  },\n};\n```\n\nEach entry in `exclude` must match a term key exactly as written in the preset’s `terms` list — for a `[pattern, replacement]` pair, that’s the `pattern` string, for instance `'back[- ]end(\\\\w*)'`, not a paraphrase of it.\n\nAny other option you pass, including your own `terms`, is merged the same way: that specific key replaces the preset’s default for it, while every key you didn’t specify — such as `defaultTerms: false` — is kept from the preset.\n\nThis differs from textlint’s usual behavior for rule config, where a consumer-supplied options object replaces the rule’s config wholesale rather than merging with it. If you were previously relying on a partial override falling back to `textlint-rule-terminology`’s own defaults for anything you didn’t set, that fallback no longer happens — unset keys now come from this preset’s defaults instead.\n\n## Ignoring Parts of a File\n\nThe preset enables textlint’s [`comments` filter rule][comments-filter-rule], so you can silence any rule — including this preset’s own rules — for a specific range of a file with inline HTML comments, without resorting to a `.textlintignore` entry for the whole file:\n\n```md\nWe use the ID field here, which is fine.\n\n<!-- textlint-disable -->\n\nThis block is skipped entirely, so the id field here is not flagged.\n\n<!-- textlint-enable -->\n\nWe use the ID field here again, back to being checked.\n```\n\nA `<!-- textlint-disable -->` with no matching `<!-- textlint-enable -->` ignores everything for the rest of the file. See [textlint’s “Ignoring parts of files” docs][ignoring-parts-of-files] for the full comment syntax, including disabling only a specific rule.\n\n## License\n\nSee the [LICENSE][license] file for more information.\n\n[textlint-home]: https://github.com/textlint/textlint\n[extends-convention]: https://github.com/textlint/textlint/issues/210\n[rule-preset-docs]: https://textlint.github.io/docs/rule-preset.html\n[terminology-terms]: rules/terminology.js\n[comments-filter-rule]: https://github.com/textlint/textlint-filter-rule-comments\n[ignoring-parts-of-files]: https://textlint.github.io/docs/ignore.html#ignoring-parts-of-files\n[license]: LICENSE\n","readmeFilename":"README.md","_rev":"1-fc2b7d1d231da62cbd8a58cb116870c8"}