{"id":13784089,"url":"https://github.com/mapbox/retext-mapbox-standard","last_synced_at":"2025-05-11T19:32:15.544Z","repository":{"id":65489733,"uuid":"49605509","full_name":"mapbox/retext-mapbox-standard","owner":"mapbox","description":"Enforce Mapbox rules about language.","archived":true,"fork":false,"pushed_at":"2020-06-15T19:37:08.000Z","size":60,"stargazers_count":139,"open_issues_count":1,"forks_count":17,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-21T08:56:56.020Z","etag":null,"topics":["docs-tests"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mapbox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-01-13T22:13:13.000Z","updated_at":"2023-09-16T01:36:16.000Z","dependencies_parsed_at":"2023-01-25T17:25:13.152Z","dependency_job_id":null,"html_url":"https://github.com/mapbox/retext-mapbox-standard","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mapbox%2Fretext-mapbox-standard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mapbox%2Fretext-mapbox-standard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mapbox%2Fretext-mapbox-standard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mapbox%2Fretext-mapbox-standard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mapbox","download_url":"https://codeload.github.com/mapbox/retext-mapbox-standard/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253621188,"owners_count":21937490,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs-tests"],"created_at":"2024-08-03T19:00:35.254Z","updated_at":"2025-05-11T19:32:15.226Z","avatar_url":"https://github.com/mapbox.png","language":"JavaScript","readme":"# retext-mapbox-standard\n\n[![Circle CI](https://circleci.com/gh/mapbox/retext-mapbox-standard.svg?style=svg)](https://circleci.com/gh/mapbox/retext-mapbox-standard)\n\nEnforce Mapbox rules about language: this is a testing tool that automatically\nruns on English-language content produced by the Mapbox team to guard against\ncommon grammar, sensitivity, and simplicity errors.\n\n## Enforcement\n\n\u003c!--mapbox ignore geojson OpenStreetMap--\u003e\n* Acronym \u0026 term styling, like GeoJSON rather than geoJSON\n* Brand styling, like Mapbox instead of MapBox\n* Simple language - includes [retext-simplify](https://github.com/wooorm/retext-simplify) to recommend\n  plain language words\n* Sensitive language - includes [retext-equality](https://github.com/wooorm/retext-equality)\n\n## Installation\n\nInstall globally:\n\n    npm install -g @mapbox/retext-mapbox-standard\n\nMore typically, this will be included as a devDependency and invoked through\nthe `test` script.\n\n## Configuration\n\nPer-file exceptions can be enabled with [comments, using syntax from\nremark-message-control](https://github.com/wooorm/remark-message-control/).\n\nFor instance, in the list above where we needed to mention the word\n`geoJSON`, the list is preceded by the following comment so that it doesn't\ntrigger a validation error in CI:\n\n```html\n\u003c!--mapbox ignore geojson OpenStreetMap--\u003e\n```\n\n## Example\n\n```sh\n$ retext-mapbox-standard bad.md\nbad.md\n  1:19-1:22  warning  OSM is jargon, use OpenStreetMap instead\n  1:40-1:46  warning  MapBox is styled Mapbox\n  2:40-2:47  warning  geoJSON should be styled GeoJSON\n  4:50-4:55  warning  `crazy` may be insensitive, use `rude`, `mean`, `disgusting`, `vile`, `person with symptoms of mental illness`, `person with mental illness`, `person with symptoms of a mental disorder`, `person with a mental disorder` instead\nSource: http://ncdj.org/style-guide/\n\n⚠ 4 warnings\n```\n\n## Architecture\n\n_Implementation details for the interested, optional reading_\n\nThis code is built on [wooorm/remark](https://github.com/wooorm/remark) the Markdown parser and [wooorm/retext](https://github.com/wooorm/retext) the natural language toolkit. These libraries avoid false-positives related to **code syntax**: we should never flag a spelling error in a URL, for instance. Since Mapbox's documentation also uses [Liquid templating](http://liquidmarkup.org/) tags, this tool also includes a step that removes them before validation.\n\n[retext-simplify](https://github.com/wooorm/retext-simplify) and [retext-equality](https://github.com/wooorm/retext-equality) (the core of [wooorm/alex](https://github.com/wooorm/alex)) are used unmodified but with a bunch of loosened restrictions. `lib/standard` adds Mapbox-specific rules about styling and casing brands and technical jargon.\n\n### [See Also \u0026 FAQ](https://github.com/mapbox/retext-mapbox-standard/wiki)\n","funding_links":[],"categories":["Built on retext"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmapbox%2Fretext-mapbox-standard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmapbox%2Fretext-mapbox-standard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmapbox%2Fretext-mapbox-standard/lists"}