From acec739a4b52cc5d89f344dc6fd8d77aaafbdc87 Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Tue, 24 Mar 2020 11:35:17 +0100 Subject: [PATCH] Refactor prose MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit …and improve some error messages --- .remarkrc.js | 2 +- doc/rules.md | 32 ++++++------- .../index.js | 18 +++---- .../package.json | 2 +- .../readme.md | 36 +++++++------- .../index.js | 24 +++++----- .../readme.md | 44 ++++++++--------- .../index.js | 6 +-- .../readme.md | 26 +++++----- .../remark-lint-code-block-style/index.js | 24 +++++----- .../remark-lint-code-block-style/package.json | 2 +- .../remark-lint-code-block-style/readme.md | 40 ++++++++-------- packages/remark-lint-definition-case/index.js | 15 +++--- .../remark-lint-definition-case/readme.md | 28 +++++------ .../remark-lint-definition-spacing/index.js | 14 +++--- .../remark-lint-definition-spacing/readme.md | 28 +++++------ packages/remark-lint-emphasis-marker/index.js | 22 ++++----- .../remark-lint-emphasis-marker/readme.md | 38 +++++++-------- .../remark-lint-fenced-code-flag/index.js | 38 +++++++-------- .../remark-lint-fenced-code-flag/readme.md | 48 +++++++++---------- .../remark-lint-fenced-code-marker/index.js | 38 ++++++++------- .../remark-lint-fenced-code-marker/readme.md | 38 +++++++-------- packages/remark-lint-file-extension/index.js | 4 +- packages/remark-lint-file-extension/readme.md | 24 +++++----- .../remark-lint-final-definition/index.js | 6 +-- .../remark-lint-final-definition/readme.md | 26 +++++----- packages/remark-lint-final-newline/index.js | 4 +- packages/remark-lint-final-newline/readme.md | 26 +++++----- .../remark-lint-first-heading-level/index.js | 26 +++++----- .../remark-lint-first-heading-level/readme.md | 40 ++++++++-------- .../remark-lint-hard-break-spaces/index.js | 6 +-- .../remark-lint-hard-break-spaces/readme.md | 26 +++++----- .../remark-lint-heading-increment/index.js | 6 +-- .../remark-lint-heading-increment/readme.md | 26 +++++----- packages/remark-lint-heading-style/index.js | 10 ++-- packages/remark-lint-heading-style/readme.md | 30 ++++++------ packages/remark-lint-linebreak-style/index.js | 14 +++--- .../remark-lint-linebreak-style/readme.md | 32 ++++++------- .../remark-lint-link-title-style/index.js | 32 ++++++------- .../remark-lint-link-title-style/readme.md | 42 ++++++++-------- .../index.js | 6 +-- .../readme.md | 26 +++++----- .../index.js | 6 +-- .../readme.md | 26 +++++----- .../remark-lint-list-item-indent/index.js | 24 +++++----- .../remark-lint-list-item-indent/readme.md | 40 ++++++++-------- .../remark-lint-list-item-spacing/index.js | 22 ++++----- .../remark-lint-list-item-spacing/readme.md | 40 ++++++++-------- .../index.js | 6 +-- .../readme.md | 26 +++++----- .../remark-lint-maximum-line-length/index.js | 26 +++++----- .../remark-lint-maximum-line-length/readme.md | 44 ++++++++--------- .../index.js | 8 ++-- .../package.json | 2 +- .../readme.md | 28 +++++------ .../index.js | 16 +++---- .../package.json | 2 +- .../readme.md | 34 ++++++------- .../index.js | 18 +++---- .../readme.md | 38 +++++++-------- .../index.js | 10 ++-- .../readme.md | 26 +++++----- .../index.js | 6 +-- .../readme.md | 26 +++++----- .../index.js | 6 +-- .../readme.md | 26 +++++----- .../index.js | 6 +-- .../readme.md | 26 +++++----- packages/remark-lint-no-empty-url/index.js | 6 +-- packages/remark-lint-no-empty-url/readme.md | 26 +++++----- .../readme.md | 22 ++++----- .../readme.md | 22 ++++----- .../readme.md | 22 ++++----- .../readme.md | 22 ++++----- .../readme.md | 22 ++++----- .../index.js | 10 ++-- .../readme.md | 26 +++++----- .../remark-lint-no-heading-indent/index.js | 6 +-- .../remark-lint-no-heading-indent/readme.md | 26 +++++----- .../index.js | 6 +-- .../readme.md | 26 +++++----- .../index.js | 10 ++-- .../readme.md | 30 ++++++------ packages/remark-lint-no-html/index.js | 6 +-- packages/remark-lint-no-html/readme.md | 26 +++++----- .../remark-lint-no-inline-padding/index.js | 6 +-- .../remark-lint-no-inline-padding/readme.md | 26 +++++----- packages/remark-lint-no-literal-urls/index.js | 14 +++--- .../remark-lint-no-literal-urls/package.json | 2 +- .../remark-lint-no-literal-urls/readme.md | 34 ++++++------- .../index.js | 6 +-- .../readme.md | 26 +++++----- .../index.js | 6 +-- .../package.json | 2 +- .../readme.md | 26 +++++----- .../index.js | 6 +-- .../readme.md | 26 +++++----- .../index.js | 6 +-- .../readme.md | 26 +++++----- .../remark-lint-no-shell-dollars/index.js | 10 ++-- .../remark-lint-no-shell-dollars/readme.md | 28 +++++------ .../index.js | 6 +-- .../readme.md | 26 +++++----- .../index.js | 10 ++-- .../readme.md | 28 +++++------ .../remark-lint-no-table-indentation/index.js | 6 +-- .../readme.md | 26 +++++----- packages/remark-lint-no-tabs/index.js | 30 ++++++------ packages/remark-lint-no-tabs/readme.md | 46 +++++++++--------- .../index.js | 25 +++++----- .../readme.md | 36 +++++++------- .../index.js | 6 +-- .../readme.md | 26 +++++----- .../index.js | 6 +-- .../readme.md | 26 +++++----- .../index.js | 6 +-- .../readme.md | 26 +++++----- .../index.js | 16 +++---- .../readme.md | 36 +++++++------- .../index.js | 26 +++++----- .../readme.md | 42 ++++++++-------- packages/remark-lint-rule-style/index.js | 18 +++---- packages/remark-lint-rule-style/readme.md | 38 +++++++-------- packages/remark-lint-strong-marker/index.js | 18 +++---- packages/remark-lint-strong-marker/readme.md | 38 +++++++-------- .../remark-lint-table-cell-padding/index.js | 34 +++++++------ .../remark-lint-table-cell-padding/readme.md | 44 ++++++++--------- .../remark-lint-table-pipe-alignment/index.js | 6 +-- .../readme.md | 26 +++++----- packages/remark-lint-table-pipes/index.js | 6 +-- packages/remark-lint-table-pipes/readme.md | 26 +++++----- .../index.js | 18 +++---- .../readme.md | 38 +++++++-------- packages/remark-lint/readme.md | 20 ++++---- .../remark-preset-lint-consistent/readme.md | 18 +++---- .../index.js | 20 ++++---- .../readme.md | 38 +++++++-------- .../remark-preset-lint-recommended/readme.md | 18 +++---- packages/unified-lint-rule/index.js | 2 +- packages/unified-lint-rule/readme.md | 15 +++--- readme.md | 48 +++++++++---------- script/build-presets.js | 19 ++++---- script/build-rules.js | 23 +++++---- script/util/rule.js | 2 +- test.js | 6 +-- 145 files changed, 1537 insertions(+), 1534 deletions(-) diff --git a/.remarkrc.js b/.remarkrc.js index b65e70c2..3817684f 100644 --- a/.remarkrc.js +++ b/.remarkrc.js @@ -3,7 +3,7 @@ exports.settings = {bullet: '*', paddedTable: false} exports.plugins = [ require('./packages/remark-preset-lint-recommended'), require('./packages/remark-preset-lint-consistent'), - [require('remark-toc'), {tight: true, maxDepth: 2}], + [require('remark-toc'), {tight: true, maxDepth: 2, heading: 'contents'}], require('remark-comment-config'), require('remark-github'), require('remark-validate-links'), diff --git a/doc/rules.md b/doc/rules.md index 839d3482..9978de82 100644 --- a/doc/rules.md +++ b/doc/rules.md @@ -4,10 +4,10 @@ This document describes how to configure rules and lists all available official rules. Each rule is a separate package. See their readme’s for more information. -## Table of Contents +## Contents * [Configuration](#configuration) -* [List of Rules](#list-of-rules) +* [List of rules](#list-of-rules) ## Configuration @@ -16,7 +16,7 @@ information. ```js remark() .use(require('remark-lint-final-newline'), false) - // ... + // … ``` `true` turns a rule on again: @@ -24,7 +24,7 @@ remark() ```js remark() .use(require('remark-lint-final-newline'), true) - // ... + // … ``` Rules can be configured with a severity too. The following ignores all @@ -33,16 +33,16 @@ messages from the plugin: ```js remark() .use(require('remark-lint-final-newline'), [0]) - // ... + // … ``` -...and passing `[1]` explicitly sets the normal behaviour (warn for problems). +…and passing `[1]` explicitly sets the normal behavior (warn for problems). To trigger an error instead of a warning, pass `2`: ```js remark() .use(require('remark-lint-final-newline'), [2]) - // ... + // … ``` It’s also possible to pass both a severity and configuration: @@ -50,7 +50,7 @@ It’s also possible to pass both a severity and configuration: ```js remark() .use(require('remark-lint-maximum-line-length'), [2, 70]) - // ... + // … ``` Lastly, strings can also be passed, instead of numbers: @@ -60,10 +60,10 @@ Lastly, strings can also be passed, instead of numbers: ```js remark() .use(require('remark-lint-maximum-line-length'), ['error', 70]) - // ... + // … ``` -## List of Rules +## List of rules This lists contains all “official” rules, developed in this repository. For rules developed outside of this repo, view the [List of External @@ -71,10 +71,10 @@ Rules][external]. -* [`blockquote-indentation`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-blockquote-indentation) — warn when blockquotes are either indented too much or too little +* [`blockquote-indentation`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-blockquote-indentation) — warn when block quotes are either indented too much or too little * [`checkbox-character-style`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-checkbox-character-style) — warn when list item checkboxes violate a given style * [`checkbox-content-indent`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-checkbox-content-indent) — warn when list item checkboxes are followed by too much whitespace -* [`code-block-style`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-code-block-style) — warn when code-blocks do not adhere to a given style +* [`code-block-style`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-code-block-style) — warn when code blocks do not adhere to a given style * [`definition-case`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-definition-case) — warn when definition labels are not lowercase * [`definition-spacing`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-definition-spacing) — warn when consecutive whitespace is used in a definition * [`emphasis-marker`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-emphasis-marker) — warn when emphasis markers violate the given style @@ -95,8 +95,8 @@ Rules][external]. * [`list-item-spacing`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-list-item-spacing) — warn when list looseness is incorrect * [`maximum-heading-length`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-maximum-heading-length) — warn when headings are too long * [`maximum-line-length`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-maximum-line-length) — warn when lines are too long -* [`no-auto-link-without-protocol`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-auto-link-without-protocol) — warn for angle-bracketed links without protocol -* [`no-blockquote-without-marker`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-blockquote-without-marker) — warn when blank lines without markers (\`>\`) are found in a blockquote +* [`no-auto-link-without-protocol`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-auto-link-without-protocol) — warn for angle bracketed links without protocol +* [`no-blockquote-without-marker`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-blockquote-without-marker) — warn when blank lines without markers (\`>\`) are found in a block quote * [`no-consecutive-blank-lines`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-consecutive-blank-lines) — warn for too many consecutive blank lines * [`no-duplicate-definitions`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-duplicate-definitions) — warn on duplicate definitions * [`no-duplicate-headings`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-duplicate-headings) — warn on duplicate headings @@ -114,9 +114,9 @@ Rules][external]. * [`no-heading-punctuation`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-heading-punctuation) — warn when headings end in illegal characters * [`no-html`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-html) — warn when HTML nodes are used * [`no-inline-padding`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-inline-padding) — warn when inline nodes are padded with spaces -* [`no-literal-urls`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-literal-urls) — warn when URLs without angle-brackets are used +* [`no-literal-urls`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-literal-urls) — warn when URLs without angle brackets are used * [`no-missing-blank-lines`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-missing-blank-lines) — warn when missing blank lines -* [`no-multiple-toplevel-headings`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-multiple-toplevel-headings) — warn when multiple top-level headings are used +* [`no-multiple-toplevel-headings`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-multiple-toplevel-headings) — warn when multiple top level headings are used * [`no-paragraph-content-indent`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-paragraph-content-indent) — warn when the content in paragraphs are indented * [`no-reference-like-url`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-reference-like-url) — warn when URLs are also defined identifiers * [`no-shell-dollars`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-shell-dollars) — warn when shell code is prefixed by dollars diff --git a/packages/remark-lint-blockquote-indentation/index.js b/packages/remark-lint-blockquote-indentation/index.js index a082f867..194e7e2f 100644 --- a/packages/remark-lint-blockquote-indentation/index.js +++ b/packages/remark-lint-blockquote-indentation/index.js @@ -4,14 +4,14 @@ * @license MIT * @module blockquote-indentation * @fileoverview - * Warn when blockquotes are indented too much or too little. + * Warn when block quotes are indented too much or too little. * * Options: `number` or `'consistent'`, default: `'consistent'`. * * `'consistent'` detects the first used indentation and will warn when - * other blockquotes use a different indentation. + * other block quotes use a different indentation. * - * @example {"name": "valid.md", "setting": 4} + * @example {"name": "ok.md", "setting": 4} * * > Hello * @@ -19,7 +19,7 @@ * * > World * - * @example {"name": "valid.md", "setting": 2} + * @example {"name": "ok.md", "setting": 2} * * > Hello * @@ -27,7 +27,7 @@ * * > World * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * > Hello * @@ -39,10 +39,10 @@ * * > World * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * - * 5:3: Remove 1 space between blockquote and content - * 9:3: Add 1 space between blockquote and content + * 5:3: Remove 1 space between block quote and content + * 9:3: Add 1 space between block quote and content */ 'use strict' @@ -82,7 +82,7 @@ function blockquoteIndentation(tree, file, pref) { Math.abs(diff) + ' ' + plural('space', diff) + - ' between blockquote and content' + ' between block quote and content' file.message(reason, position.start(node.children[0])) } diff --git a/packages/remark-lint-blockquote-indentation/package.json b/packages/remark-lint-blockquote-indentation/package.json index 2b61e2cb..3de4cd27 100644 --- a/packages/remark-lint-blockquote-indentation/package.json +++ b/packages/remark-lint-blockquote-indentation/package.json @@ -1,7 +1,7 @@ { "name": "remark-lint-blockquote-indentation", "version": "1.0.3", - "description": "remark-lint rule to warn when blockquotes are either indented too much or too little", + "description": "remark-lint rule to warn when block quotes are either indented too much or too little", "license": "MIT", "keywords": [ "remark", diff --git a/packages/remark-lint-blockquote-indentation/readme.md b/packages/remark-lint-blockquote-indentation/readme.md index f80982ba..7dcfcf5f 100644 --- a/packages/remark-lint-blockquote-indentation/readme.md +++ b/packages/remark-lint-blockquote-indentation/readme.md @@ -10,12 +10,12 @@ [![Backers][backers-badge]][collective] [![Chat][chat-badge]][chat] -Warn when blockquotes are indented too much or too little. +Warn when block quotes are indented too much or too little. Options: `number` or `'consistent'`, default: `'consistent'`. `'consistent'` detects the first used indentation and will warn when -other blockquotes use a different indentation. +other block quotes use a different indentation. ## Presets @@ -28,7 +28,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` When configured with `2`. @@ -46,7 +46,7 @@ Paragraph. No messages. -##### `valid.md` +##### `ok.md` When configured with `4`. @@ -64,7 +64,7 @@ Paragraph. No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -83,8 +83,8 @@ Paragraph. ###### Out ```text -5:3: Remove 1 space between blockquote and content -9:3: Add 1 space between blockquote and content +5:3: Remove 1 space between block quote and content +9:3: Add 1 space between block quote and content ``` ## Install @@ -100,16 +100,16 @@ npm install remark-lint-blockquote-indentation You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-blockquote-indentation", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -121,15 +121,15 @@ remark -u lint -u lint-blockquote-indentation readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-blockquote-indentation')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -138,8 +138,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -168,7 +168,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-checkbox-character-style/index.js b/packages/remark-lint-checkbox-character-style/index.js index 6960ad44..94bb8a12 100644 --- a/packages/remark-lint-checkbox-character-style/index.js +++ b/packages/remark-lint-checkbox-character-style/index.js @@ -26,47 +26,47 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md", "setting": {"checked": "x"}} + * @example {"name": "ok.md", "setting": {"checked": "x"}} * * - [x] List item * - [x] List item * - * @example {"name": "valid.md", "setting": {"checked": "X"}} + * @example {"name": "ok.md", "setting": {"checked": "X"}} * * - [X] List item * - [X] List item * - * @example {"name": "valid.md", "setting": {"unchecked": " "}} + * @example {"name": "ok.md", "setting": {"unchecked": " "}} * * - [ ] List item * - [ ] List item * - [ ]·· * - [ ] * - * @example {"name": "valid.md", "setting": {"unchecked": "\t"}} + * @example {"name": "ok.md", "setting": {"unchecked": "\t"}} * * - [»] List item * - [»] List item * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * - [x] List item * - [X] List item * - [ ] List item * - [»] List item * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 2:4-2:5: Checked checkboxes should use `x` as a marker * 4:4-4:5: Unchecked checkboxes should use ` ` as a marker * - * @example {"setting": {"unchecked": "!"}, "name": "invalid.md", "label": "output", "config": {"positionless": true}} + * @example {"setting": {"unchecked": "💩"}, "name": "not-ok.md", "label": "output", "config": {"positionless": true}} * - * 1:1: Invalid unchecked checkbox marker `!`: use either `'\t'`, or `' '` + * 1:1: Incorrect unchecked checkbox marker `💩`: use either `'\t'`, or `' '` * - * @example {"setting": {"checked": "!"}, "name": "invalid.md", "label": "output", "config": {"positionless": true}} + * @example {"setting": {"checked": "💩"}, "name": "not-ok.md", "label": "output", "config": {"positionless": true}} * - * 1:1: Invalid checked checkbox marker `!`: use either `'x'`, or `'X'` + * 1:1: Incorrect checked checkbox marker `💩`: use either `'x'`, or `'X'` */ 'use strict' @@ -97,7 +97,7 @@ function checkboxCharacterStyle(tree, file, pref) { if (pref.unchecked && unchecked[pref.unchecked] !== true) { file.fail( - 'Invalid unchecked checkbox marker `' + + 'Incorrect unchecked checkbox marker `' + pref.unchecked + "`: use either `'\\t'`, or `' '`" ) @@ -105,7 +105,7 @@ function checkboxCharacterStyle(tree, file, pref) { if (pref.checked && checked[pref.checked] !== true) { file.fail( - 'Invalid checked checkbox marker `' + + 'Incorrect checked checkbox marker `' + pref.checked + "`: use either `'x'`, or `'X'`" ) diff --git a/packages/remark-lint-checkbox-character-style/readme.md b/packages/remark-lint-checkbox-character-style/readme.md index d7c201a3..68001f84 100644 --- a/packages/remark-lint-checkbox-character-style/readme.md +++ b/packages/remark-lint-checkbox-character-style/readme.md @@ -42,7 +42,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` When configured with `{ checked: 'x' }`. @@ -57,7 +57,7 @@ When configured with `{ checked: 'x' }`. No messages. -##### `valid.md` +##### `ok.md` When configured with `{ checked: 'X' }`. @@ -72,7 +72,7 @@ When configured with `{ checked: 'X' }`. No messages. -##### `valid.md` +##### `ok.md` When configured with `{ unchecked: ' ' }`. @@ -91,7 +91,7 @@ Note: `·` represents a space. No messages. -##### `valid.md` +##### `ok.md` When configured with `{ unchecked: '\t' }`. @@ -108,7 +108,7 @@ Note: `»` represents a tab. No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -128,24 +128,24 @@ Note: `»` represents a tab. 4:4-4:5: Unchecked checkboxes should use ` ` as a marker ``` -##### `invalid.md` +##### `not-ok.md` -When configured with `{ unchecked: '!' }`. +When configured with `{ unchecked: '💩' }`. ###### Out ```text -1:1: Invalid unchecked checkbox marker `!`: use either `'\t'`, or `' '` +1:1: Incorrect unchecked checkbox marker `💩`: use either `'\t'`, or `' '` ``` -##### `invalid.md` +##### `not-ok.md` -When configured with `{ checked: '!' }`. +When configured with `{ checked: '💩' }`. ###### Out ```text -1:1: Invalid checked checkbox marker `!`: use either `'x'`, or `'X'` +1:1: Incorrect checked checkbox marker `💩`: use either `'x'`, or `'X'` ``` ## Install @@ -161,16 +161,16 @@ npm install remark-lint-checkbox-character-style You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-checkbox-character-style", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -182,15 +182,15 @@ remark -u lint -u lint-checkbox-character-style readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-checkbox-character-style')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -199,8 +199,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -229,7 +229,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-checkbox-content-indent/index.js b/packages/remark-lint-checkbox-content-indent/index.js index 54f533bc..2b17538a 100644 --- a/packages/remark-lint-checkbox-content-indent/index.js +++ b/packages/remark-lint-checkbox-content-indent/index.js @@ -6,21 +6,21 @@ * @fileoverview * Warn when list item checkboxes are followed by too much whitespace. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * - [ ] List item * + [x] List Item * * [X] List item * - [ ] List item * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * - [ ] List item * + [x] List item * * [X] List item * - [ ] List item * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 2:7-2:8: Checkboxes should be followed by a single character * 3:7-3:9: Checkboxes should be followed by a single character diff --git a/packages/remark-lint-checkbox-content-indent/readme.md b/packages/remark-lint-checkbox-content-indent/readme.md index cac154a5..0c2b6db1 100644 --- a/packages/remark-lint-checkbox-content-indent/readme.md +++ b/packages/remark-lint-checkbox-content-indent/readme.md @@ -18,7 +18,7 @@ This rule is not included in any default preset ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -33,7 +33,7 @@ This rule is not included in any default preset No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -65,16 +65,16 @@ npm install remark-lint-checkbox-content-indent You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-checkbox-content-indent", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -86,15 +86,15 @@ remark -u lint -u lint-checkbox-content-indent readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-checkbox-content-indent')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -103,8 +103,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -133,7 +133,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-code-block-style/index.js b/packages/remark-lint-code-block-style/index.js index 98a1ba89..3bdf113d 100644 --- a/packages/remark-lint-code-block-style/index.js +++ b/packages/remark-lint-code-block-style/index.js @@ -9,7 +9,7 @@ * Options: `'consistent'`, `'fenced'`, or `'indented'`, default: `'consistent'`. * * `'consistent'` detects the first used code block style and warns when - * subsequent code-blocks uses different styles. + * subsequent code blocks uses different styles. * * ## Fix * @@ -23,7 +23,7 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"setting": "indented", "name": "valid.md"} + * @example {"setting": "indented", "name": "ok.md"} * * alpha(); * @@ -31,7 +31,7 @@ * * bravo(); * - * @example {"setting": "indented", "name": "invalid.md", "label": "input"} + * @example {"setting": "indented", "name": "not-ok.md", "label": "input"} * * ``` * alpha(); @@ -43,12 +43,12 @@ * bravo(); * ``` * - * @example {"setting": "indented", "name": "invalid.md", "label": "output"} + * @example {"setting": "indented", "name": "not-ok.md", "label": "output"} * * 1:1-3:4: Code blocks should be indented * 7:1-9:4: Code blocks should be indented * - * @example {"setting": "fenced", "name": "valid.md"} + * @example {"setting": "fenced", "name": "ok.md"} * * ``` * alpha(); @@ -60,7 +60,7 @@ * bravo(); * ``` * - * @example {"setting": "fenced", "name": "invalid.md", "label": "input"} + * @example {"setting": "fenced", "name": "not-ok.md", "label": "input"} * * alpha(); * @@ -68,12 +68,12 @@ * * bravo(); * - * @example {"setting": "fenced", "name": "invalid.md", "label": "output"} + * @example {"setting": "fenced", "name": "not-ok.md", "label": "output"} * * 1:1-1:13: Code blocks should be fenced * 5:1-5:13: Code blocks should be fenced * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * alpha(); * @@ -83,13 +83,13 @@ * bravo(); * ``` * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 5:1-7:4: Code blocks should be indented * - * @example {"setting": "invalid", "name": "invalid.md", "label": "output", "config": {"positionless": true}} + * @example {"setting": "💩", "name": "not-ok.md", "label": "output", "config": {"positionless": true}} * - * 1:1: Invalid code block style `invalid`: use either `'consistent'`, `'fenced'`, or `'indented'` + * 1:1: Incorrect code block style `💩`: use either `'consistent'`, `'fenced'`, or `'indented'` */ 'use strict' @@ -113,7 +113,7 @@ function codeBlockStyle(tree, file, pref) { if (styles[pref] !== true) { file.fail( - 'Invalid code block style `' + + 'Incorrect code block style `' + pref + "`: use either `'consistent'`, `'fenced'`, or `'indented'`" ) diff --git a/packages/remark-lint-code-block-style/package.json b/packages/remark-lint-code-block-style/package.json index 96cffaa8..8433a970 100644 --- a/packages/remark-lint-code-block-style/package.json +++ b/packages/remark-lint-code-block-style/package.json @@ -1,7 +1,7 @@ { "name": "remark-lint-code-block-style", "version": "1.0.3", - "description": "remark-lint rule to warn when code-blocks do not adhere to a given style", + "description": "remark-lint rule to warn when code blocks do not adhere to a given style", "license": "MIT", "keywords": [ "remark", diff --git a/packages/remark-lint-code-block-style/readme.md b/packages/remark-lint-code-block-style/readme.md index 72bdf71b..6c623485 100644 --- a/packages/remark-lint-code-block-style/readme.md +++ b/packages/remark-lint-code-block-style/readme.md @@ -15,7 +15,7 @@ Warn when code blocks do not adhere to a given style. Options: `'consistent'`, `'fenced'`, or `'indented'`, default: `'consistent'`. `'consistent'` detects the first used code block style and warns when -subsequent code-blocks uses different styles. +subsequent code blocks uses different styles. ## Fix @@ -40,7 +40,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` When configured with `'indented'`. @@ -58,7 +58,7 @@ Paragraph. No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `'indented'`. @@ -83,7 +83,7 @@ bravo(); 7:1-9:4: Code blocks should be indented ``` -##### `valid.md` +##### `ok.md` When configured with `'fenced'`. @@ -105,7 +105,7 @@ bravo(); No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `'fenced'`. @@ -126,7 +126,7 @@ Paragraph. 5:1-5:13: Code blocks should be fenced ``` -##### `invalid.md` +##### `not-ok.md` ###### In @@ -146,14 +146,14 @@ bravo(); 5:1-7:4: Code blocks should be indented ``` -##### `invalid.md` +##### `not-ok.md` -When configured with `'invalid'`. +When configured with `'💩'`. ###### Out ```text -1:1: Invalid code block style `invalid`: use either `'consistent'`, `'fenced'`, or `'indented'` +1:1: Incorrect code block style `💩`: use either `'consistent'`, `'fenced'`, or `'indented'` ``` ## Install @@ -169,16 +169,16 @@ npm install remark-lint-code-block-style You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-code-block-style", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -190,15 +190,15 @@ remark -u lint -u lint-code-block-style readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-code-block-style')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -207,8 +207,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -237,7 +237,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-definition-case/index.js b/packages/remark-lint-definition-case/index.js index 8141a8f8..13693125 100644 --- a/packages/remark-lint-definition-case/index.js +++ b/packages/remark-lint-definition-case/index.js @@ -6,17 +6,17 @@ * @fileoverview * Warn when definition labels are not lowercase. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * [example]: http://example.com "Example Domain" * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * [Example]: http://example.com "Example Domain" * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * - * 1:1-1:47: Do not use upper-case characters in definition labels + * 1:1-1:47: Do not use uppercase characters in definition labels */ 'use strict' @@ -29,15 +29,14 @@ var generated = require('unist-util-generated') module.exports = rule('remark-lint:definition-case', definitionCase) var label = /^\s*\[((?:\\[\s\S]|[^[\]])+)]/ -var reason = 'Do not use upper-case characters in definition labels' +var reason = 'Do not use uppercase characters in definition labels' function definitionCase(tree, file) { var contents = String(file) - visit(tree, ['definition', 'footnoteDefinition'], validate) + visit(tree, ['definition', 'footnoteDefinition'], check) - // Validate a node, either a normal definition or a footnote definition. - function validate(node) { + function check(node) { var start = position.start(node).offset var end = position.end(node).offset var value diff --git a/packages/remark-lint-definition-case/readme.md b/packages/remark-lint-definition-case/readme.md index 64596b1c..494f1dd2 100644 --- a/packages/remark-lint-definition-case/readme.md +++ b/packages/remark-lint-definition-case/readme.md @@ -22,7 +22,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -34,7 +34,7 @@ This rule is included in the following presets: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -45,7 +45,7 @@ No messages. ###### Out ```text -1:1-1:47: Do not use upper-case characters in definition labels +1:1-1:47: Do not use uppercase characters in definition labels ``` ## Install @@ -61,16 +61,16 @@ npm install remark-lint-definition-case You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-definition-case", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -82,15 +82,15 @@ remark -u lint -u lint-definition-case readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-definition-case')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -99,8 +99,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -129,7 +129,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-definition-spacing/index.js b/packages/remark-lint-definition-spacing/index.js index 1a0f98a2..3a6eb365 100644 --- a/packages/remark-lint-definition-spacing/index.js +++ b/packages/remark-lint-definition-spacing/index.js @@ -6,17 +6,17 @@ * @fileoverview * Warn when consecutive whitespace is used in a definition. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * [example domain]: http://example.com "Example Domain" * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * [example····domain]: http://example.com "Example Domain" * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * - * 1:1-1:57: Do not use consecutive white-space in definition labels + * 1:1-1:57: Do not use consecutive whitespace in definition labels */ 'use strict' @@ -29,14 +29,14 @@ var generated = require('unist-util-generated') module.exports = rule('remark-lint:definition-spacing', definitionSpacing) var label = /^\s*\[((?:\\[\s\S]|[^[\]])+)]/ -var reason = 'Do not use consecutive white-space in definition labels' +var reason = 'Do not use consecutive whitespace in definition labels' function definitionSpacing(tree, file) { var contents = String(file) - visit(tree, ['definition', 'footnoteDefinition'], validate) + visit(tree, ['definition', 'footnoteDefinition'], check) - function validate(node) { + function check(node) { var start = position.start(node).offset var end = position.end(node).offset diff --git a/packages/remark-lint-definition-spacing/readme.md b/packages/remark-lint-definition-spacing/readme.md index 69ec46d7..0ca9ef50 100644 --- a/packages/remark-lint-definition-spacing/readme.md +++ b/packages/remark-lint-definition-spacing/readme.md @@ -22,7 +22,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -34,7 +34,7 @@ This rule is included in the following presets: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -47,7 +47,7 @@ Note: `·` represents a space. ###### Out ```text -1:1-1:57: Do not use consecutive white-space in definition labels +1:1-1:57: Do not use consecutive whitespace in definition labels ``` ## Install @@ -63,16 +63,16 @@ npm install remark-lint-definition-spacing You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-definition-spacing", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -84,15 +84,15 @@ remark -u lint -u lint-definition-spacing readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-definition-spacing')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -101,8 +101,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -131,7 +131,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-emphasis-marker/index.js b/packages/remark-lint-emphasis-marker/index.js index be4dbd8f..c2f0788a 100644 --- a/packages/remark-lint-emphasis-marker/index.js +++ b/packages/remark-lint-emphasis-marker/index.js @@ -22,42 +22,42 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"setting": "*", "name": "valid.md"} + * @example {"setting": "*", "name": "ok.md"} * * *foo* * - * @example {"setting": "*", "name": "invalid.md", "label": "input"} + * @example {"setting": "*", "name": "not-ok.md", "label": "input"} * * _foo_ * - * @example {"setting": "*", "name": "invalid.md", "label": "output"} + * @example {"setting": "*", "name": "not-ok.md", "label": "output"} * * 1:1-1:6: Emphasis should use `*` as a marker * - * @example {"setting": "_", "name": "valid.md"} + * @example {"setting": "_", "name": "ok.md"} * * _foo_ * - * @example {"setting": "_", "name": "invalid.md", "label": "input"} + * @example {"setting": "_", "name": "not-ok.md", "label": "input"} * * *foo* * - * @example {"setting": "_", "name": "invalid.md", "label": "output"} + * @example {"setting": "_", "name": "not-ok.md", "label": "output"} * * 1:1-1:6: Emphasis should use `_` as a marker * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * *foo* * _bar_ * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 2:1-2:6: Emphasis should use `*` as a marker * - * @example {"setting": "invalid", "name": "invalid.md", "label": "output", "config": {"positionless": true}} + * @example {"setting": "💩", "name": "not-ok.md", "label": "output", "config": {"positionless": true}} * - * 1:1: Invalid emphasis marker `invalid`: use either `'consistent'`, `'*'`, or `'_'` + * 1:1: Incorrect emphasis marker `💩`: use either `'consistent'`, `'*'`, or `'_'` */ 'use strict' @@ -78,7 +78,7 @@ function emphasisMarker(tree, file, pref) { if (markers[pref] !== true) { file.fail( - 'Invalid emphasis marker `' + + 'Incorrect emphasis marker `' + pref + "`: use either `'consistent'`, `'*'`, or `'_'`" ) diff --git a/packages/remark-lint-emphasis-marker/readme.md b/packages/remark-lint-emphasis-marker/readme.md index a635b1af..16417aae 100644 --- a/packages/remark-lint-emphasis-marker/readme.md +++ b/packages/remark-lint-emphasis-marker/readme.md @@ -39,7 +39,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` When configured with `'*'`. @@ -53,7 +53,7 @@ When configured with `'*'`. No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `'*'`. @@ -69,7 +69,7 @@ _foo_ 1:1-1:6: Emphasis should use `*` as a marker ``` -##### `valid.md` +##### `ok.md` When configured with `'_'`. @@ -83,7 +83,7 @@ _foo_ No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `'_'`. @@ -99,7 +99,7 @@ When configured with `'_'`. 1:1-1:6: Emphasis should use `_` as a marker ``` -##### `invalid.md` +##### `not-ok.md` ###### In @@ -114,14 +114,14 @@ _bar_ 2:1-2:6: Emphasis should use `*` as a marker ``` -##### `invalid.md` +##### `not-ok.md` -When configured with `'invalid'`. +When configured with `'💩'`. ###### Out ```text -1:1: Invalid emphasis marker `invalid`: use either `'consistent'`, `'*'`, or `'_'` +1:1: Incorrect emphasis marker `💩`: use either `'consistent'`, `'*'`, or `'_'` ``` ## Install @@ -137,16 +137,16 @@ npm install remark-lint-emphasis-marker You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-emphasis-marker", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -158,15 +158,15 @@ remark -u lint -u lint-emphasis-marker readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-emphasis-marker')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -175,8 +175,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -205,7 +205,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-fenced-code-flag/index.js b/packages/remark-lint-fenced-code-flag/index.js index a5afc175..4423c58d 100644 --- a/packages/remark-lint-fenced-code-flag/index.js +++ b/packages/remark-lint-fenced-code-flag/index.js @@ -10,58 +10,58 @@ * * Providing an array is as passing `{flags: Array}`. * - * The object can have an array of `'flags'` which are deemed valid. - * In addition it can have the property `allowEmpty` (`boolean`, default: - * `false`) which signifies whether or not to warn for fenced code blocks - * without language flags. + * The object can have an array of `'flags'` which are allowed: other flags + * will not be allowed. + * An `allowEmpty` field (`boolean`, default: `false`) can be set to allow + * code blocks without language flags. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * ```alpha * bravo(); * ``` * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * ``` * alpha(); * ``` * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * - * 1:1-3:4: Missing code-language flag + * 1:1-3:4: Missing code language flag * - * @example {"name": "valid.md", "setting": {"allowEmpty": true}} + * @example {"name": "ok.md", "setting": {"allowEmpty": true}} * * ``` * alpha(); * ``` * - * @example {"name": "invalid.md", "setting": {"allowEmpty": false}, "label": "input"} + * @example {"name": "not-ok.md", "setting": {"allowEmpty": false}, "label": "input"} * * ``` * alpha(); * ``` * - * @example {"name": "invalid.md", "setting": {"allowEmpty": false}, "label": "output"} + * @example {"name": "not-ok.md", "setting": {"allowEmpty": false}, "label": "output"} * - * 1:1-3:4: Missing code-language flag + * 1:1-3:4: Missing code language flag * - * @example {"name": "valid.md", "setting": ["alpha"]} + * @example {"name": "ok.md", "setting": ["alpha"]} * * ```alpha * bravo(); * ``` * - * @example {"name": "invalid.md", "setting": ["charlie"], "label": "input"} + * @example {"name": "not-ok.md", "setting": ["charlie"], "label": "input"} * * ```alpha * bravo(); * ``` * - * @example {"name": "invalid.md", "setting": ["charlie"], "label": "output"} + * @example {"name": "not-ok.md", "setting": ["charlie"], "label": "output"} * - * 1:1-3:4: Invalid code-language flag + * 1:1-3:4: Incorrect code language flag */ 'use strict' @@ -77,8 +77,8 @@ var start = position.start var end = position.end var fence = /^ {0,3}([~`])\1{2,}/ -var reasonInvalid = 'Invalid code-language flag' -var reasonMissing = 'Missing code-language flag' +var reasonIncorrect = 'Incorrect code language flag' +var reasonMissing = 'Missing code language flag' function fencedCodeFlag(tree, file, pref) { var contents = String(file) @@ -102,7 +102,7 @@ function fencedCodeFlag(tree, file, pref) { if (!generated(node)) { if (node.lang) { if (flags.length !== 0 && flags.indexOf(node.lang) === -1) { - file.message(reasonInvalid, node) + file.message(reasonIncorrect, node) } } else { value = contents.slice(start(node).offset, end(node).offset) diff --git a/packages/remark-lint-fenced-code-flag/readme.md b/packages/remark-lint-fenced-code-flag/readme.md index 4e2219b9..f9154b97 100644 --- a/packages/remark-lint-fenced-code-flag/readme.md +++ b/packages/remark-lint-fenced-code-flag/readme.md @@ -16,10 +16,10 @@ Options: `Array.` or `Object`, optional. Providing an array is as passing `{flags: Array}`. -The object can have an array of `'flags'` which are deemed valid. -In addition it can have the property `allowEmpty` (`boolean`, default: -`false`) which signifies whether or not to warn for fenced code blocks -without language flags. +The object can have an array of `'flags'` which are allowed: other flags +will not be allowed. +An `allowEmpty` field (`boolean`, default: `false`) can be set to allow +code blocks without language flags. ## Presets @@ -31,7 +31,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -45,7 +45,7 @@ bravo(); No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -58,10 +58,10 @@ alpha(); ###### Out ```text -1:1-3:4: Missing code-language flag +1:1-3:4: Missing code language flag ``` -##### `valid.md` +##### `ok.md` When configured with `{ allowEmpty: true }`. @@ -77,7 +77,7 @@ alpha(); No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `{ allowEmpty: false }`. @@ -92,10 +92,10 @@ alpha(); ###### Out ```text -1:1-3:4: Missing code-language flag +1:1-3:4: Missing code language flag ``` -##### `valid.md` +##### `ok.md` When configured with `[ 'alpha' ]`. @@ -111,7 +111,7 @@ bravo(); No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `[ 'charlie' ]`. @@ -126,7 +126,7 @@ bravo(); ###### Out ```text -1:1-3:4: Invalid code-language flag +1:1-3:4: Incorrect code language flag ``` ## Install @@ -142,16 +142,16 @@ npm install remark-lint-fenced-code-flag You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-fenced-code-flag", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -163,15 +163,15 @@ remark -u lint -u lint-fenced-code-flag readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-fenced-code-flag')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -180,8 +180,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -210,7 +210,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-fenced-code-marker/index.js b/packages/remark-lint-fenced-code-marker/index.js index 0fb0eae7..2bab42b9 100644 --- a/packages/remark-lint-fenced-code-marker/index.js +++ b/packages/remark-lint-fenced-code-marker/index.js @@ -22,13 +22,13 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * Indented code blocks are not affected by this rule: * * bravo(); * - * @example {"name": "valid.md", "setting": "`"} + * @example {"name": "ok.md", "setting": "`"} * * ```alpha * bravo(); @@ -38,7 +38,7 @@ * charlie(); * ``` * - * @example {"name": "valid.md", "setting": "~"} + * @example {"name": "ok.md", "setting": "~"} * * ~~~alpha * bravo(); @@ -48,7 +48,7 @@ * charlie(); * ~~~ * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * ```alpha * bravo(); @@ -58,13 +58,13 @@ * charlie(); * ~~~ * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * - * 5:1-7:4: Fenced code should use ` as a marker + * 5:1-7:4: Fenced code should use `` '`' `` as a marker * - * @example {"name": "invalid.md", "setting": "!", "label": "output", "config": {"positionless": true}} + * @example {"name": "not-ok.md", "setting": "💩", "label": "output", "config": {"positionless": true}} * - * 1:1: Invalid fenced code marker `!`: use either `'consistent'`, `` '`' ``, or `'~'` + * 1:1: Incorrect fenced code marker `💩`: use either `'consistent'`, `` '`' ``, or `'~'` */ 'use strict' @@ -82,15 +82,15 @@ var markers = { null: true } -function fencedCodeMarker(tree, file, pref) { +function fencedCodeMarker(tree, file, option) { var contents = String(file) + var preferred = + typeof option === 'string' && option !== 'consistent' ? option : null - pref = typeof pref === 'string' && pref !== 'consistent' ? pref : null - - if (markers[pref] !== true) { + if (markers[preferred] !== true) { file.fail( - 'Invalid fenced code marker `' + - pref + + 'Incorrect fenced code marker `' + + preferred + "`: use either `'consistent'`, `` '`' ``, or `'~'`" ) } @@ -100,6 +100,7 @@ function fencedCodeMarker(tree, file, pref) { function visitor(node) { var start var marker + var label if (!generated(node)) { start = position.start(node).offset @@ -110,15 +111,16 @@ function fencedCodeMarker(tree, file, pref) { // Ignore unfenced code blocks. if (markers[marker] === true) { - if (pref) { - if (marker !== pref) { + if (preferred) { + if (marker !== preferred) { + label = preferred === '~' ? preferred : "`` '`' ``" file.message( - 'Fenced code should use ' + pref + ' as a marker', + 'Fenced code should use ' + label + ' as a marker', node ) } } else { - pref = marker + preferred = marker } } } diff --git a/packages/remark-lint-fenced-code-marker/readme.md b/packages/remark-lint-fenced-code-marker/readme.md index a634c426..096398c9 100644 --- a/packages/remark-lint-fenced-code-marker/readme.md +++ b/packages/remark-lint-fenced-code-marker/readme.md @@ -39,7 +39,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -53,7 +53,7 @@ Indented code blocks are not affected by this rule: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -70,10 +70,10 @@ charlie(); ###### Out ```text -5:1-7:4: Fenced code should use ` as a marker +5:1-7:4: Fenced code should use `` '`' `` as a marker ``` -##### `valid.md` +##### `ok.md` When configured with ``'`'``. @@ -93,7 +93,7 @@ charlie(); No messages. -##### `valid.md` +##### `ok.md` When configured with `'~'`. @@ -113,14 +113,14 @@ charlie(); No messages. -##### `invalid.md` +##### `not-ok.md` -When configured with `'!'`. +When configured with `'💩'`. ###### Out ```text -1:1: Invalid fenced code marker `!`: use either `'consistent'`, `` '`' ``, or `'~'` +1:1: Incorrect fenced code marker `💩`: use either `'consistent'`, `` '`' ``, or `'~'` ``` ## Install @@ -136,16 +136,16 @@ npm install remark-lint-fenced-code-marker You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-fenced-code-marker", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -157,15 +157,15 @@ remark -u lint -u lint-fenced-code-marker readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-fenced-code-marker')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -174,8 +174,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -204,7 +204,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-file-extension/index.js b/packages/remark-lint-file-extension/index.js index 2a538921..4f2a60c4 100644 --- a/packages/remark-lint-file-extension/index.js +++ b/packages/remark-lint-file-extension/index.js @@ -17,7 +17,7 @@ * * @example {"name": "readme.mkd", "label": "output", "config": {"positionless": true}} * - * 1:1: Invalid extension: use `md` + * 1:1: Incorrect extension: use `md` * * @example {"name": "readme.mkd", "setting": "mkd"} */ @@ -34,6 +34,6 @@ function fileExtension(tree, file, pref) { pref = typeof pref === 'string' ? pref : 'md' if (ext && ext.slice(1) !== pref) { - file.message('Invalid extension: use `' + pref + '`') + file.message('Incorrect extension: use `' + pref + '`') } } diff --git a/packages/remark-lint-file-extension/readme.md b/packages/remark-lint-file-extension/readme.md index d1d708f4..96bfa6fe 100644 --- a/packages/remark-lint-file-extension/readme.md +++ b/packages/remark-lint-file-extension/readme.md @@ -44,7 +44,7 @@ No messages. ###### Out ```text -1:1: Invalid extension: use `md` +1:1: Incorrect extension: use `md` ``` ##### `readme.mkd` @@ -68,16 +68,16 @@ npm install remark-lint-file-extension You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-file-extension", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -89,15 +89,15 @@ remark -u lint -u lint-file-extension readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-file-extension')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -106,8 +106,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -136,7 +136,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-final-definition/index.js b/packages/remark-lint-final-definition/index.js index c9018346..4ea99505 100644 --- a/packages/remark-lint-final-definition/index.js +++ b/packages/remark-lint-final-definition/index.js @@ -7,13 +7,13 @@ * Warn when definitions are placed somewhere other than at the end of * the file. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * Paragraph. * * [example]: http://example.com "Example Domain" * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * Paragraph. * @@ -21,7 +21,7 @@ * * Another paragraph. * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 3:1-3:47: Move definitions to the end of the file (after the node at line `5`) */ diff --git a/packages/remark-lint-final-definition/readme.md b/packages/remark-lint-final-definition/readme.md index 55552d72..259483cc 100644 --- a/packages/remark-lint-final-definition/readme.md +++ b/packages/remark-lint-final-definition/readme.md @@ -23,7 +23,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -37,7 +37,7 @@ Paragraph. No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -68,16 +68,16 @@ npm install remark-lint-final-definition You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-final-definition", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -89,15 +89,15 @@ remark -u lint -u lint-final-definition readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-final-definition')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -106,8 +106,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -136,7 +136,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-final-newline/index.js b/packages/remark-lint-final-newline/index.js index dd674b9d..0e88c925 100644 --- a/packages/remark-lint-final-newline/index.js +++ b/packages/remark-lint-final-newline/index.js @@ -19,7 +19,7 @@ * * ## Example * - * ##### `valid.md` + * ##### `ok.md` * * ###### In * @@ -33,7 +33,7 @@ * * No messages. * - * ##### `invalid.md` + * ##### `not-ok.md` * * ###### In * diff --git a/packages/remark-lint-final-newline/readme.md b/packages/remark-lint-final-newline/readme.md index ce0c2f82..18402121 100644 --- a/packages/remark-lint-final-newline/readme.md +++ b/packages/remark-lint-final-newline/readme.md @@ -25,7 +25,7 @@ on how to automatically fix warnings for this rule. ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -39,7 +39,7 @@ Alpha␊ No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -76,16 +76,16 @@ npm install remark-lint-final-newline You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-final-newline", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -97,15 +97,15 @@ remark -u lint -u lint-final-newline readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-final-newline')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -114,8 +114,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -144,7 +144,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-first-heading-level/index.js b/packages/remark-lint-first-heading-level/index.js index 31548ae8..45f07777 100644 --- a/packages/remark-lint-first-heading-level/index.js +++ b/packages/remark-lint-first-heading-level/index.js @@ -8,15 +8,15 @@ * * Options: `number`, default: `1`. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * # The default is to expect a level one heading * - * @example {"name": "valid-html.md"} + * @example {"name": "ok-html.md"} * *

An HTML heading is also seen by this rule.

* - * @example {"name": "valid-delayed.md"} + * @example {"name": "ok-delayed.md"} * * You can use markdown content before the heading. * @@ -24,55 +24,55 @@ * *

So the first heading, be it HTML or markdown, is checked

* - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * ## Bravo * * Paragraph. * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:1-1:9: First heading level should be `1` * - * @example {"name": "invalid-html.md", "label": "input"} + * @example {"name": "not-ok-html.md", "label": "input"} * *

Charlie

* * Paragraph. * - * @example {"name": "invalid-html.md", "label": "output"} + * @example {"name": "not-ok-html.md", "label": "output"} * * 1:1-1:17: First heading level should be `1` * - * @example {"name": "valid.md", "setting": 2} + * @example {"name": "ok.md", "setting": 2} * * ## Delta * * Paragraph. * - * @example {"name": "valid-html.md", "setting": 2} + * @example {"name": "ok-html.md", "setting": 2} * *

Echo

* * Paragraph. * - * @example {"name": "invalid.md", "setting": 2, "label": "input"} + * @example {"name": "not-ok.md", "setting": 2, "label": "input"} * * # Foxtrot * * Paragraph. * - * @example {"name": "invalid.md", "setting": 2, "label": "output"} + * @example {"name": "not-ok.md", "setting": 2, "label": "output"} * * 1:1-1:10: First heading level should be `2` * - * @example {"name": "invalid-html.md", "setting": 2, "label": "input"} + * @example {"name": "not-ok-html.md", "setting": 2, "label": "input"} * *

Golf

* * Paragraph. * - * @example {"name": "invalid-html.md", "setting": 2, "label": "output"} + * @example {"name": "not-ok-html.md", "setting": 2, "label": "output"} * * 1:1-1:14: First heading level should be `2` */ diff --git a/packages/remark-lint-first-heading-level/readme.md b/packages/remark-lint-first-heading-level/readme.md index ee1da34d..ac8f558d 100644 --- a/packages/remark-lint-first-heading-level/readme.md +++ b/packages/remark-lint-first-heading-level/readme.md @@ -20,7 +20,7 @@ This rule is not included in any default preset ## Example -##### `valid.md` +##### `ok.md` When configured with `2`. @@ -36,7 +36,7 @@ Paragraph. No messages. -##### `valid-html.md` +##### `ok-html.md` When configured with `2`. @@ -52,7 +52,7 @@ Paragraph. No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `2`. @@ -70,7 +70,7 @@ Paragraph. 1:1-1:10: First heading level should be `2` ``` -##### `invalid-html.md` +##### `not-ok-html.md` When configured with `2`. @@ -88,7 +88,7 @@ Paragraph. 1:1-1:14: First heading level should be `2` ``` -##### `valid.md` +##### `ok.md` ###### In @@ -100,7 +100,7 @@ Paragraph. No messages. -##### `valid-html.md` +##### `ok-html.md` ###### In @@ -112,7 +112,7 @@ No messages. No messages. -##### `valid-delayed.md` +##### `ok-delayed.md` ###### In @@ -128,7 +128,7 @@ You can use markdown content before the heading. No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -144,7 +144,7 @@ Paragraph. 1:1-1:9: First heading level should be `1` ``` -##### `invalid-html.md` +##### `not-ok-html.md` ###### In @@ -173,16 +173,16 @@ npm install remark-lint-first-heading-level You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-first-heading-level", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -194,15 +194,15 @@ remark -u lint -u lint-first-heading-level readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-first-heading-level')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -211,8 +211,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -241,7 +241,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-hard-break-spaces/index.js b/packages/remark-lint-hard-break-spaces/index.js index 7d12c139..95f08d1d 100644 --- a/packages/remark-lint-hard-break-spaces/index.js +++ b/packages/remark-lint-hard-break-spaces/index.js @@ -6,17 +6,17 @@ * @fileoverview * Warn when too many spaces are used to create a hard break. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * Lorem ipsum·· * dolor sit amet * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * Lorem ipsum··· * dolor sit amet. * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:12-2:1: Use two spaces for hard line breaks */ diff --git a/packages/remark-lint-hard-break-spaces/readme.md b/packages/remark-lint-hard-break-spaces/readme.md index 9a1d0af7..2e129f2f 100644 --- a/packages/remark-lint-hard-break-spaces/readme.md +++ b/packages/remark-lint-hard-break-spaces/readme.md @@ -23,7 +23,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -38,7 +38,7 @@ dolor sit amet No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -68,16 +68,16 @@ npm install remark-lint-hard-break-spaces You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-hard-break-spaces", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -89,15 +89,15 @@ remark -u lint -u lint-hard-break-spaces readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-hard-break-spaces')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -106,8 +106,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -136,7 +136,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-heading-increment/index.js b/packages/remark-lint-heading-increment/index.js index 084902f0..3872bc68 100644 --- a/packages/remark-lint-heading-increment/index.js +++ b/packages/remark-lint-heading-increment/index.js @@ -6,19 +6,19 @@ * @fileoverview * Warn when headings increment with more than 1 level at a time. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * # Alpha * * ## Bravo * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * # Charlie * * ### Delta * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 3:1-3:10: Heading levels should increment by one level at a time */ diff --git a/packages/remark-lint-heading-increment/readme.md b/packages/remark-lint-heading-increment/readme.md index 806f117f..ccb18df5 100644 --- a/packages/remark-lint-heading-increment/readme.md +++ b/packages/remark-lint-heading-increment/readme.md @@ -22,7 +22,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -36,7 +36,7 @@ This rule is included in the following presets: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -65,16 +65,16 @@ npm install remark-lint-heading-increment You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-heading-increment", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -86,15 +86,15 @@ remark -u lint -u lint-heading-increment readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-heading-increment')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -103,8 +103,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -133,7 +133,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-heading-style/index.js b/packages/remark-lint-heading-style/index.js index dbaa33c0..44c950c8 100644 --- a/packages/remark-lint-heading-style/index.js +++ b/packages/remark-lint-heading-style/index.js @@ -25,7 +25,7 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md", "setting": "atx"} + * @example {"name": "ok.md", "setting": "atx"} * * # Alpha * @@ -33,7 +33,7 @@ * * ### Charlie * - * @example {"name": "valid.md", "setting": "atx-closed"} + * @example {"name": "ok.md", "setting": "atx-closed"} * * # Delta ## * @@ -41,7 +41,7 @@ * * ### Foxtrot ### * - * @example {"name": "valid.md", "setting": "setext"} + * @example {"name": "ok.md", "setting": "setext"} * * Golf * ==== @@ -51,7 +51,7 @@ * * ### India * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * Juliett * ======= @@ -60,7 +60,7 @@ * * ### Lima ### * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 4:1-4:8: Headings should use setext * 6:1-6:13: Headings should use setext diff --git a/packages/remark-lint-heading-style/readme.md b/packages/remark-lint-heading-style/readme.md index 54b93b24..08b18f74 100644 --- a/packages/remark-lint-heading-style/readme.md +++ b/packages/remark-lint-heading-style/readme.md @@ -42,7 +42,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` When configured with `'atx'`. @@ -60,7 +60,7 @@ When configured with `'atx'`. No messages. -##### `valid.md` +##### `ok.md` When configured with `'atx-closed'`. @@ -78,7 +78,7 @@ When configured with `'atx-closed'`. No messages. -##### `valid.md` +##### `ok.md` When configured with `'setext'`. @@ -98,7 +98,7 @@ Hotel No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -131,16 +131,16 @@ npm install remark-lint-heading-style You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-heading-style", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -152,15 +152,15 @@ remark -u lint -u lint-heading-style readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-heading-style')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -169,8 +169,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -199,7 +199,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-linebreak-style/index.js b/packages/remark-lint-linebreak-style/index.js index 44ea2ec8..be51768e 100644 --- a/packages/remark-lint-linebreak-style/index.js +++ b/packages/remark-lint-linebreak-style/index.js @@ -13,34 +13,34 @@ * ## Fix * * [`remark-stringify`](https://github.com/remarkjs/remark/tree/master/packages/remark-stringify) - * always uses unix-style linebreaks. + * always uses unix linebreaks. * * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid-consistent-as-windows.md"} + * @example {"name": "ok-consistent-as-windows.md"} * * Alpha␍␊ * Bravo␍␊ * - * @example {"name": "valid-consistent-as-unix.md"} + * @example {"name": "ok-consistent-as-unix.md"} * * Alpha␊ * Bravo␊ * - * @example {"name": "invalid-unix.md", "label": "input", "setting": "unix", "config": {"positionless": true}} + * @example {"name": "not-ok-unix.md", "label": "input", "setting": "unix", "config": {"positionless": true}} * * Alpha␍␊ * - * @example {"name": "invalid-unix.md", "label": "output", "setting": "unix"} + * @example {"name": "not-ok-unix.md", "label": "output", "setting": "unix"} * * 1:7: Expected linebreaks to be unix (`\n`), not windows (`\r\n`) * - * @example {"name": "invalid-windows.md", "label": "input", "setting": "windows", "config": {"positionless": true}} + * @example {"name": "not-ok-windows.md", "label": "input", "setting": "windows", "config": {"positionless": true}} * * Alpha␊ * - * @example {"name": "invalid-windows.md", "label": "output", "setting": "windows"} + * @example {"name": "not-ok-windows.md", "label": "output", "setting": "windows"} * * 1:6: Expected linebreaks to be windows (`\r\n`), not unix (`\n`) */ diff --git a/packages/remark-lint-linebreak-style/readme.md b/packages/remark-lint-linebreak-style/readme.md index 5a8b9940..338c24df 100644 --- a/packages/remark-lint-linebreak-style/readme.md +++ b/packages/remark-lint-linebreak-style/readme.md @@ -19,7 +19,7 @@ a file). Default: `'consistent'`. ## Fix [`remark-stringify`](https://github.com/remarkjs/remark/tree/master/packages/remark-stringify) -always uses unix-style linebreaks. +always uses unix linebreaks. See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) on how to automatically fix warnings for this rule. @@ -30,7 +30,7 @@ This rule is not included in any default preset ## Example -##### `valid-consistent-as-windows.md` +##### `ok-consistent-as-windows.md` ###### In @@ -45,7 +45,7 @@ Bravo␍␊ No messages. -##### `valid-consistent-as-unix.md` +##### `ok-consistent-as-unix.md` ###### In @@ -60,7 +60,7 @@ Bravo␊ No messages. -##### `invalid-unix.md` +##### `not-ok-unix.md` When configured with `'unix'`. @@ -78,7 +78,7 @@ Alpha␍␊ 1:7: Expected linebreaks to be unix (`\n`), not windows (`\r\n`) ``` -##### `invalid-windows.md` +##### `not-ok-windows.md` When configured with `'windows'`. @@ -109,16 +109,16 @@ npm install remark-lint-linebreak-style You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-linebreak-style", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -130,15 +130,15 @@ remark -u lint -u lint-linebreak-style readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-linebreak-style')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -147,8 +147,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -177,7 +177,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-link-title-style/index.js b/packages/remark-lint-link-title-style/index.js index 2b3f718b..a7095db8 100644 --- a/packages/remark-lint-link-title-style/index.js +++ b/packages/remark-lint-link-title-style/index.js @@ -20,7 +20,7 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md", "setting": "\""} + * @example {"name": "ok.md", "setting": "\""} * * [Example](http://example.com#without-title) * [Example](http://example.com "Example Domain") @@ -32,15 +32,15 @@ * * [Example](#Heading-(optional)) * - * @example {"name": "invalid.md", "label": "input", "setting": "\""} + * @example {"name": "not-ok.md", "label": "input", "setting": "\""} * * [Example]: http://example.com 'Example Domain' * - * @example {"name": "invalid.md", "label": "output", "setting": "\""} + * @example {"name": "not-ok.md", "label": "output", "setting": "\""} * * 1:31-1:47: Titles should use `"` as a quote * - * @example {"name": "valid.md", "setting": "'"} + * @example {"name": "ok.md", "setting": "'"} * * [Example](http://example.com#without-title) * [Example](http://example.com 'Example Domain') @@ -48,15 +48,15 @@ * * [Example]: http://example.com 'Example Domain' * - * @example {"name": "invalid.md", "label": "input", "setting": "'"} + * @example {"name": "not-ok.md", "label": "input", "setting": "'"} * * [Example]: http://example.com "Example Domain" * - * @example {"name": "invalid.md", "label": "output", "setting": "'"} + * @example {"name": "not-ok.md", "label": "output", "setting": "'"} * * 1:31-1:47: Titles should use `'` as a quote * - * @example {"name": "valid.md", "setting": "()"} + * @example {"name": "ok.md", "setting": "()"} * * [Example](http://example.com#without-title) * [Example](http://example.com (Example Domain)) @@ -64,26 +64,26 @@ * * [Example]: http://example.com (Example Domain) * - * @example {"name": "invalid.md", "label": "input", "setting": "()"} + * @example {"name": "not-ok.md", "label": "input", "setting": "()"} * * [Example](http://example.com 'Example Domain') * - * @example {"name": "invalid.md", "label": "output", "setting": "()"} + * @example {"name": "not-ok.md", "label": "output", "setting": "()"} * * 1:30-1:46: Titles should use `()` as a quote * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * [Example](http://example.com "Example Domain") * [Example](http://example.com 'Example Domain') * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 2:30-2:46: Titles should use `"` as a quote * - * @example {"name": "invalid.md", "setting": ".", "label": "output", "config": {"positionless": true}} + * @example {"name": "not-ok.md", "setting": "💩", "label": "output", "config": {"positionless": true}} * - * 1:1: Invalid link title style marker `.`: use either `'consistent'`, `'"'`, `'\''`, or `'()'` + * 1:1: Incorrect link title style marker `💩`: use either `'consistent'`, `'"'`, `'\''`, or `'()'` */ 'use strict' @@ -116,15 +116,15 @@ function linkTitleStyle(tree, file, pref) { if (pref && !own.call(markers, pref)) { file.fail( - 'Invalid link title style marker `' + + 'Incorrect link title style marker `' + pref + "`: use either `'consistent'`, `'\"'`, `'\\''`, or `'()'`" ) } - visit(tree, ['link', 'image', 'definition'], validate) + visit(tree, ['link', 'image', 'definition'], check) - function validate(node) { + function check(node) { var tail var begin var last diff --git a/packages/remark-lint-link-title-style/readme.md b/packages/remark-lint-link-title-style/readme.md index 1f020c09..10de23a8 100644 --- a/packages/remark-lint-link-title-style/readme.md +++ b/packages/remark-lint-link-title-style/readme.md @@ -37,7 +37,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` When configured with `'"'`. @@ -59,7 +59,7 @@ You can use parens in URLs if they’re not a title (see GH-166): No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `'"'`. @@ -75,7 +75,7 @@ When configured with `'"'`. 1:31-1:47: Titles should use `"` as a quote ``` -##### `valid.md` +##### `ok.md` When configured with `"'"`. @@ -93,7 +93,7 @@ When configured with `"'"`. No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `"'"`. @@ -109,7 +109,7 @@ When configured with `"'"`. 1:31-1:47: Titles should use `'` as a quote ``` -##### `valid.md` +##### `ok.md` When configured with `'()'`. @@ -127,7 +127,7 @@ When configured with `'()'`. No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `'()'`. @@ -143,7 +143,7 @@ When configured with `'()'`. 1:30-1:46: Titles should use `()` as a quote ``` -##### `invalid.md` +##### `not-ok.md` ###### In @@ -158,14 +158,14 @@ When configured with `'()'`. 2:30-2:46: Titles should use `"` as a quote ``` -##### `invalid.md` +##### `not-ok.md` -When configured with `'.'`. +When configured with `'💩'`. ###### Out ```text -1:1: Invalid link title style marker `.`: use either `'consistent'`, `'"'`, `'\''`, or `'()'` +1:1: Incorrect link title style marker `💩`: use either `'consistent'`, `'"'`, `'\''`, or `'()'` ``` ## Install @@ -181,16 +181,16 @@ npm install remark-lint-link-title-style You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-link-title-style", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -202,15 +202,15 @@ remark -u lint -u lint-link-title-style readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-link-title-style')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -219,8 +219,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -249,7 +249,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-list-item-bullet-indent/index.js b/packages/remark-lint-list-item-bullet-indent/index.js index 8bf43e4e..f429f90b 100644 --- a/packages/remark-lint-list-item-bullet-indent/index.js +++ b/packages/remark-lint-list-item-bullet-indent/index.js @@ -14,21 +14,21 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * Paragraph. * * * List item * * List item * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * Paragraph. * * ·* List item * ·* List item * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 3:3: Incorrect indentation before bullet: remove 1 space * 4:3: Incorrect indentation before bullet: remove 1 space diff --git a/packages/remark-lint-list-item-bullet-indent/readme.md b/packages/remark-lint-list-item-bullet-indent/readme.md index 9d4eca9c..53ce0308 100644 --- a/packages/remark-lint-list-item-bullet-indent/readme.md +++ b/packages/remark-lint-list-item-bullet-indent/readme.md @@ -30,7 +30,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -45,7 +45,7 @@ Paragraph. No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -78,16 +78,16 @@ npm install remark-lint-list-item-bullet-indent You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-list-item-bullet-indent", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -99,15 +99,15 @@ remark -u lint -u lint-list-item-bullet-indent readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-list-item-bullet-indent')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -116,8 +116,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -146,7 +146,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-list-item-content-indent/index.js b/packages/remark-lint-list-item-content-indent/index.js index fd76d303..2bbb50f7 100644 --- a/packages/remark-lint-list-item-content-indent/index.js +++ b/packages/remark-lint-list-item-content-indent/index.js @@ -6,17 +6,17 @@ * @fileoverview * Warn when the content of a list item has mixed indentation. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * 1.·[x] Alpha * ···1. Bravo * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * 1.·[x] Charlie * ····1. Delta * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 2:5: Don’t use mixed indentation for children, remove 1 space */ diff --git a/packages/remark-lint-list-item-content-indent/readme.md b/packages/remark-lint-list-item-content-indent/readme.md index 1b2b8155..42512616 100644 --- a/packages/remark-lint-list-item-content-indent/readme.md +++ b/packages/remark-lint-list-item-content-indent/readme.md @@ -23,7 +23,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -38,7 +38,7 @@ Note: `·` represents a space. No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -68,16 +68,16 @@ npm install remark-lint-list-item-content-indent You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-list-item-content-indent", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -89,15 +89,15 @@ remark -u lint -u lint-list-item-content-indent readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-list-item-content-indent')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -106,8 +106,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -136,7 +136,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-list-item-indent/index.js b/packages/remark-lint-list-item-indent/index.js index 827a1c70..3dfe1299 100644 --- a/packages/remark-lint-list-item-indent/index.js +++ b/packages/remark-lint-list-item-indent/index.js @@ -22,7 +22,7 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * *···List * ····item. @@ -40,7 +40,7 @@ * *···List * ····item. * - * @example {"name": "valid.md", "setting": "mixed"} + * @example {"name": "ok.md", "setting": "mixed"} * * *·List item. * @@ -56,7 +56,7 @@ * *···List * ····item. * - * @example {"name": "valid.md", "setting": "space"} + * @example {"name": "ok.md", "setting": "space"} * * *·List item. * @@ -72,35 +72,35 @@ * *·List * ··item. * - * @example {"name": "invalid.md", "setting": "space", "label": "input"} + * @example {"name": "not-ok.md", "setting": "space", "label": "input"} * * *···List * ····item. * - * @example {"name": "invalid.md", "setting": "space", "label": "output"} + * @example {"name": "not-ok.md", "setting": "space", "label": "output"} * * 1:5: Incorrect list-item indent: remove 2 spaces * - * @example {"name": "invalid.md", "setting": "tab-size", "label": "input"} + * @example {"name": "not-ok.md", "setting": "tab-size", "label": "input"} * * *·List * ··item. * - * @example {"name": "invalid.md", "setting": "tab-size", "label": "output"} + * @example {"name": "not-ok.md", "setting": "tab-size", "label": "output"} * * 1:3: Incorrect list-item indent: add 2 spaces * - * @example {"name": "invalid.md", "setting": "mixed", "label": "input"} + * @example {"name": "not-ok.md", "setting": "mixed", "label": "input"} * * *···List item. * - * @example {"name": "invalid.md", "setting": "mixed", "label": "output"} + * @example {"name": "not-ok.md", "setting": "mixed", "label": "output"} * * 1:5: Incorrect list-item indent: remove 2 spaces * - * @example {"name": "invalid.md", "setting": "invalid", "label": "output", "config": {"positionless": true}} + * @example {"name": "not-ok.md", "setting": "💩", "label": "output", "config": {"positionless": true}} * - * 1:1: Invalid list-item indent style `invalid`: use either `'tab-size'`, `'space'`, or `'mixed'` + * 1:1: Incorrect list-item indent style `💩`: use either `'tab-size'`, `'space'`, or `'mixed'` */ 'use strict' @@ -124,7 +124,7 @@ function listItemIndent(tree, file, pref) { if (styles[pref] !== true) { file.fail( - 'Invalid list-item indent style `' + + 'Incorrect list-item indent style `' + pref + "`: use either `'tab-size'`, `'space'`, or `'mixed'`" ) diff --git a/packages/remark-lint-list-item-indent/readme.md b/packages/remark-lint-list-item-indent/readme.md index 535b8f9e..ead687f1 100644 --- a/packages/remark-lint-list-item-indent/readme.md +++ b/packages/remark-lint-list-item-indent/readme.md @@ -39,7 +39,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -67,7 +67,7 @@ Paragraph. No messages. -##### `valid.md` +##### `ok.md` When configured with `'mixed'`. @@ -95,7 +95,7 @@ Paragraph. No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `'mixed'`. @@ -113,7 +113,7 @@ Note: `·` represents a space. 1:5: Incorrect list-item indent: remove 2 spaces ``` -##### `valid.md` +##### `ok.md` When configured with `'space'`. @@ -141,7 +141,7 @@ Paragraph. No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `'space'`. @@ -160,7 +160,7 @@ Note: `·` represents a space. 1:5: Incorrect list-item indent: remove 2 spaces ``` -##### `invalid.md` +##### `not-ok.md` When configured with `'tab-size'`. @@ -179,14 +179,14 @@ Note: `·` represents a space. 1:3: Incorrect list-item indent: add 2 spaces ``` -##### `invalid.md` +##### `not-ok.md` -When configured with `'invalid'`. +When configured with `'💩'`. ###### Out ```text -1:1: Invalid list-item indent style `invalid`: use either `'tab-size'`, `'space'`, or `'mixed'` +1:1: Incorrect list-item indent style `💩`: use either `'tab-size'`, `'space'`, or `'mixed'` ``` ## Install @@ -202,16 +202,16 @@ npm install remark-lint-list-item-indent You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-list-item-indent", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -223,15 +223,15 @@ remark -u lint -u lint-list-item-indent readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-list-item-indent')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -240,8 +240,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -270,7 +270,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-list-item-spacing/index.js b/packages/remark-lint-list-item-spacing/index.js index 6c7f08cd..7a92b0b6 100644 --- a/packages/remark-lint-list-item-spacing/index.js +++ b/packages/remark-lint-list-item-spacing/index.js @@ -20,7 +20,7 @@ * items contain blank lines. * Otherwise, the list must be tight. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * A tight list: * @@ -37,7 +37,7 @@ * * - item 3 * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * A tight list: * @@ -54,21 +54,21 @@ * * - item 3 * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 4:9-5:1: Missing new line after list item * 5:11-6:1: Missing new line after list item * 11:1-12:1: Extraneous new line after list item * 13:1-14:1: Extraneous new line after list item * - * @example {"name": "valid.md", "setting": {"checkBlanks": true}} + * @example {"name": "ok.md", "setting": {"checkBlanks": true}} * * A tight list: * * - item 1 * - item 1.A * - item 2 - * > Blockquote + * > Block quote * * A loose list: * @@ -78,9 +78,9 @@ * * - item 2 * - * > Blockquote + * > Block quote * - * @example {"name": "invalid.md", "setting": {"checkBlanks": true}, "label": "input"} + * @example {"name": "not-ok.md", "setting": {"checkBlanks": true}, "label": "input"} * * A tight list: * @@ -89,7 +89,7 @@ * - item 1.A * - item 2 * - * > Blockquote + * > Block quote * - item 3 * * A loose list: @@ -98,12 +98,12 @@ * - item 1.A * * - item 2 - * > Blockquote + * > Block quote * - * @example {"name": "invalid.md", "setting": {"checkBlanks": true}, "label": "output"} + * @example {"name": "not-ok.md", "setting": {"checkBlanks": true}, "label": "output"} * * 5:15-6:1: Missing new line after list item - * 8:17-9:1: Missing new line after list item + * 8:18-9:1: Missing new line after list item * 15:1-16:1: Extraneous new line after list item */ diff --git a/packages/remark-lint-list-item-spacing/readme.md b/packages/remark-lint-list-item-spacing/readme.md index e5b16862..eae66269 100644 --- a/packages/remark-lint-list-item-spacing/readme.md +++ b/packages/remark-lint-list-item-spacing/readme.md @@ -36,7 +36,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -61,7 +61,7 @@ A loose list: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -91,7 +91,7 @@ A loose list: 13:1-14:1: Extraneous new line after list item ``` -##### `valid.md` +##### `ok.md` When configured with `{ checkBlanks: true }`. @@ -103,7 +103,7 @@ A tight list: - item 1 - item 1.A - item 2 - > Blockquote + > Block quote A loose list: @@ -113,14 +113,14 @@ A loose list: - item 2 - > Blockquote + > Block quote ``` ###### Out No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `{ checkBlanks: true }`. @@ -134,7 +134,7 @@ A tight list: - item 1.A - item 2 - > Blockquote + > Block quote - item 3 A loose list: @@ -143,14 +143,14 @@ A loose list: - item 1.A - item 2 - > Blockquote + > Block quote ``` ###### Out ```text 5:15-6:1: Missing new line after list item -8:17-9:1: Missing new line after list item +8:18-9:1: Missing new line after list item 15:1-16:1: Extraneous new line after list item ``` @@ -167,16 +167,16 @@ npm install remark-lint-list-item-spacing You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-list-item-spacing", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -188,15 +188,15 @@ remark -u lint -u lint-list-item-spacing readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-list-item-spacing')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -205,8 +205,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -235,7 +235,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-maximum-heading-length/index.js b/packages/remark-lint-maximum-heading-length/index.js index cad24b2d..2faaa6ef 100644 --- a/packages/remark-lint-maximum-heading-length/index.js +++ b/packages/remark-lint-maximum-heading-length/index.js @@ -10,17 +10,17 @@ * * Ignores Markdown syntax, only checks the plain text content. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * # Alpha bravo charlie delta echo foxtrot golf hotel * * # ![Alpha bravo charlie delta echo foxtrot golf hotel](http://example.com/nato.png) * - * @example {"name": "invalid.md", "setting": 40, "label": "input"} + * @example {"name": "not-ok.md", "setting": 40, "label": "input"} * * # Alpha bravo charlie delta echo foxtrot golf hotel * - * @example {"name": "invalid.md", "setting": 40, "label": "output"} + * @example {"name": "not-ok.md", "setting": 40, "label": "output"} * * 1:1-1:52: Use headings shorter than `40` */ diff --git a/packages/remark-lint-maximum-heading-length/readme.md b/packages/remark-lint-maximum-heading-length/readme.md index c427db08..045ac77b 100644 --- a/packages/remark-lint-maximum-heading-length/readme.md +++ b/packages/remark-lint-maximum-heading-length/readme.md @@ -26,7 +26,7 @@ This rule is included in the following presets: ## Example -##### `invalid.md` +##### `not-ok.md` When configured with `40`. @@ -42,7 +42,7 @@ When configured with `40`. 1:1-1:52: Use headings shorter than `40` ``` -##### `valid.md` +##### `ok.md` ###### In @@ -69,16 +69,16 @@ npm install remark-lint-maximum-heading-length You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-maximum-heading-length", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -90,15 +90,15 @@ remark -u lint -u lint-maximum-heading-length readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-maximum-heading-length')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -107,8 +107,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -137,7 +137,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-maximum-line-length/index.js b/packages/remark-lint-maximum-line-length/index.js index a4a4af8c..c3a5f31b 100644 --- a/packages/remark-lint-maximum-line-length/index.js +++ b/packages/remark-lint-maximum-line-length/index.js @@ -14,7 +14,7 @@ * Ignores images, links, and inline code if they start before the wrap, end * after the wrap, and there’s no whitespace after them. * - * @example {"name": "valid.md", "config": {"positionless": true}} + * @example {"name": "ok.md", "config": {"positionless": true}} * * This line is simply not toooooooooooooooooooooooooooooooooooooooooooo * long. @@ -25,11 +25,11 @@ * * `alphaBravoCharlieDeltaEchoFoxtrotGolfHotelIndiaJuliettKiloLimaMikeNovemberOscarPapaQuebec.romeo()` * - * [foo](http://this-long-url-with-a-long-domain-is-valid.co.uk/a-long-path?query=variables) + * [foo](http://this-long-url-with-a-long-domain-is-ok.co.uk/a-long-path?query=variables) * - * + * * - * ![foo](http://this-long-url-with-a-long-domain-is-valid.co.uk/a-long-path?query=variables) + * ![foo](http://this-long-url-with-a-long-domain-is-ok.co.uk/a-long-path?query=variables) * * | An | exception | is | line | length | in | long | tables | because | those | can’t | just | * | -- | --------- | -- | ---- | ------ | -- | ---- | ------ | ------- | ----- | ----- | ---- | @@ -39,13 +39,13 @@ * * The following is also fine, because there is no whitespace. * - * . + * . * * In addition, definitions are also fine: * - * [foo]: + * [foo]: * - * @example {"name": "invalid.md", "setting": 80, "label": "input", "config": {"positionless": true}} + * @example {"name": "not-ok.md", "setting": 80, "label": "input", "config": {"positionless": true}} * * This line is simply not tooooooooooooooooooooooooooooooooooooooooooooooooooooooo * long. @@ -54,35 +54,35 @@ * * And this one is also very wrong: because the link starts aaaaaaafter the column: * - * and such. + * and such. * * And this one is also very wrong: because the code starts aaaaaaafter the column: `alpha.bravo()` * * `alphaBravoCharlieDeltaEchoFoxtrotGolfHotelIndiaJuliettKiloLimaMikeNovemberOscar.papa()` and such. * - * @example {"name": "invalid.md", "setting": 80, "label": "output", "config": {"positionless": true}} + * @example {"name": "not-ok.md", "setting": 80, "label": "output", "config": {"positionless": true}} * * 4:86: Line must be at most 80 characters * 6:99: Line must be at most 80 characters - * 8:97: Line must be at most 80 characters + * 8:96: Line must be at most 80 characters * 10:97: Line must be at most 80 characters * 12:99: Line must be at most 80 characters * - * @example {"name": "valid-mixed-line-endings.md", "setting": 10, "config": {"positionless": true}} + * @example {"name": "ok-mixed-line-endings.md", "setting": 10, "config": {"positionless": true}} * * 0123456789␍␊ * 0123456789␊ * 01234␍␊ * 01234␊ * - * @example {"name": "invalid-mixed-line-endings.md", "setting": 10, "label": "input", "config": {"positionless": true}} + * @example {"name": "not-ok-mixed-line-endings.md", "setting": 10, "label": "input", "config": {"positionless": true}} * * 012345678901␍␊ * 012345678901␊ * 01234567890␍␊ * 01234567890␊ * - * @example {"name": "invalid-mixed-line-endings.md", "setting": 10, "label": "output", "config": {"positionless": true}} + * @example {"name": "not-ok-mixed-line-endings.md", "setting": 10, "label": "output", "config": {"positionless": true}} * * 1:13: Line must be at most 10 characters * 2:13: Line must be at most 10 characters diff --git a/packages/remark-lint-maximum-line-length/readme.md b/packages/remark-lint-maximum-line-length/readme.md index ffaa2686..8cf2e0da 100644 --- a/packages/remark-lint-maximum-line-length/readme.md +++ b/packages/remark-lint-maximum-line-length/readme.md @@ -30,7 +30,7 @@ This rule is included in the following presets: ## Example -##### `valid-mixed-line-endings.md` +##### `ok-mixed-line-endings.md` When configured with `10`. @@ -51,7 +51,7 @@ Note: `␊` represents a line feed. No messages. -##### `invalid-mixed-line-endings.md` +##### `not-ok-mixed-line-endings.md` When configured with `10`. @@ -77,7 +77,7 @@ Note: `␊` represents a line feed. 4:12: Line must be at most 10 characters ``` -##### `invalid.md` +##### `not-ok.md` When configured with `80`. @@ -91,7 +91,7 @@ Just like thiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiis And this one is also very wrong: because the link starts aaaaaaafter the column: - and such. + and such. And this one is also very wrong: because the code starts aaaaaaafter the column: `alpha.bravo()` @@ -103,12 +103,12 @@ And this one is also very wrong: because the code starts aaaaaaafter the column: ```text 4:86: Line must be at most 80 characters 6:99: Line must be at most 80 characters -8:97: Line must be at most 80 characters +8:96: Line must be at most 80 characters 10:97: Line must be at most 80 characters 12:99: Line must be at most 80 characters ``` -##### `valid.md` +##### `ok.md` ###### In @@ -122,11 +122,11 @@ This is also fine: + -![foo](http://this-long-url-with-a-long-domain-is-valid.co.uk/a-long-path?query=variables) +![foo](http://this-long-url-with-a-long-domain-is-ok.co.uk/a-long-path?query=variables) | An | exception | is | line | length | in | long | tables | because | those | can’t | just | | -- | --------- | -- | ---- | ------ | -- | ---- | ------ | ------- | ----- | ----- | ---- | @@ -136,11 +136,11 @@ This is also fine: . +. In addition, definitions are also fine: -[foo]: +[foo]: ``` ###### Out @@ -160,16 +160,16 @@ npm install remark-lint-maximum-line-length You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-maximum-line-length", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -181,15 +181,15 @@ remark -u lint -u lint-maximum-line-length readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-maximum-line-length')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -198,8 +198,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -228,7 +228,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-auto-link-without-protocol/index.js b/packages/remark-lint-no-auto-link-without-protocol/index.js index 2aafb880..7396c569 100644 --- a/packages/remark-lint-no-auto-link-without-protocol/index.js +++ b/packages/remark-lint-no-auto-link-without-protocol/index.js @@ -5,7 +5,7 @@ * @module no-auto-link-without-protocol * @fileoverview * Warn for autolinks without protocol. - * Autolinks are URLs enclosed in `<` (less-than) and `>` (greater-than) + * Autolinks are URLs enclosed in `<` (less than) and `>` (greater than) * characters. * * ## Fix @@ -16,7 +16,7 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * * @@ -24,11 +24,11 @@ * Most Markdown vendors don’t recognize the following as a link: * * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:1-1:14: All automatic links must start with a protocol */ diff --git a/packages/remark-lint-no-auto-link-without-protocol/package.json b/packages/remark-lint-no-auto-link-without-protocol/package.json index c8d381d0..cd6411ad 100644 --- a/packages/remark-lint-no-auto-link-without-protocol/package.json +++ b/packages/remark-lint-no-auto-link-without-protocol/package.json @@ -1,7 +1,7 @@ { "name": "remark-lint-no-auto-link-without-protocol", "version": "1.0.3", - "description": "remark-lint rule to warn for angle-bracketed links without protocol", + "description": "remark-lint rule to warn for angle bracketed links without protocol", "license": "MIT", "keywords": [ "remark", diff --git a/packages/remark-lint-no-auto-link-without-protocol/readme.md b/packages/remark-lint-no-auto-link-without-protocol/readme.md index 489e7e6a..0996b606 100644 --- a/packages/remark-lint-no-auto-link-without-protocol/readme.md +++ b/packages/remark-lint-no-auto-link-without-protocol/readme.md @@ -11,7 +11,7 @@ [![Chat][chat-badge]][chat] Warn for autolinks without protocol. -Autolinks are URLs enclosed in `<` (less-than) and `>` (greater-than) +Autolinks are URLs enclosed in `<` (less than) and `>` (greater than) characters. ## Fix @@ -33,7 +33,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -49,7 +49,7 @@ Most Markdown vendors don’t recognize the following as a link: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -76,16 +76,16 @@ npm install remark-lint-no-auto-link-without-protocol You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-auto-link-without-protocol", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -97,15 +97,15 @@ remark -u lint -u lint-no-auto-link-without-protocol readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-auto-link-without-protocol')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -114,8 +114,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -144,7 +144,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-blockquote-without-marker/index.js b/packages/remark-lint-no-blockquote-without-marker/index.js index 35898f75..aedd7497 100644 --- a/packages/remark-lint-no-blockquote-without-marker/index.js +++ b/packages/remark-lint-no-blockquote-without-marker/index.js @@ -4,32 +4,32 @@ * @license MIT * @module no-blockquote-without-marker * @fileoverview - * Warn when blank lines without `>` (greater-than) markers are found in a - * blockquote. + * Warn when blank lines without `>` (greater than) markers are found in a + * block quote. * * ## Fix * * [`remark-stringify`](https://github.com/remarkjs/remark/tree/master/packages/remark-stringify) - * adds markers to every line in a blockquote. + * adds markers to every line in a block quote. * * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * > Foo… * > …bar… * > …baz. * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * > Foo… * …bar… * > …baz. * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * - * 2:1: Missing marker in blockquote + * 2:1: Missing marker in block quote */ 'use strict' @@ -45,7 +45,7 @@ module.exports = rule( noBlockquoteWithoutMarker ) -var reason = 'Missing marker in blockquote' +var reason = 'Missing marker in block quote' function noBlockquoteWithoutMarker(tree, file) { var contents = String(file) diff --git a/packages/remark-lint-no-blockquote-without-marker/package.json b/packages/remark-lint-no-blockquote-without-marker/package.json index 4fb2f370..1bff7ad9 100644 --- a/packages/remark-lint-no-blockquote-without-marker/package.json +++ b/packages/remark-lint-no-blockquote-without-marker/package.json @@ -1,7 +1,7 @@ { "name": "remark-lint-no-blockquote-without-marker", "version": "2.0.3", - "description": "remark-lint rule to warn when blank lines without markers (`>`) are found in a blockquote", + "description": "remark-lint rule to warn when blank lines without markers (`>`) are found in a block quote", "license": "MIT", "keywords": [ "remark", diff --git a/packages/remark-lint-no-blockquote-without-marker/readme.md b/packages/remark-lint-no-blockquote-without-marker/readme.md index 76cc3084..e73f0187 100644 --- a/packages/remark-lint-no-blockquote-without-marker/readme.md +++ b/packages/remark-lint-no-blockquote-without-marker/readme.md @@ -10,13 +10,13 @@ [![Backers][backers-badge]][collective] [![Chat][chat-badge]][chat] -Warn when blank lines without `>` (greater-than) markers are found in a -blockquote. +Warn when blank lines without `>` (greater than) markers are found in a +block quote. ## Fix [`remark-stringify`](https://github.com/remarkjs/remark/tree/master/packages/remark-stringify) -adds markers to every line in a blockquote. +adds markers to every line in a block quote. See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) on how to automatically fix warnings for this rule. @@ -32,7 +32,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -46,7 +46,7 @@ This rule is included in the following presets: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -59,7 +59,7 @@ No messages. ###### Out ```text -2:1: Missing marker in blockquote +2:1: Missing marker in block quote ``` ## Install @@ -75,16 +75,16 @@ npm install remark-lint-no-blockquote-without-marker You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-blockquote-without-marker", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -96,15 +96,15 @@ remark -u lint -u lint-no-blockquote-without-marker readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-blockquote-without-marker')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -113,8 +113,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -143,7 +143,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-consecutive-blank-lines/index.js b/packages/remark-lint-no-consecutive-blank-lines/index.js index 19a3a059..2f5e240c 100644 --- a/packages/remark-lint-no-consecutive-blank-lines/index.js +++ b/packages/remark-lint-no-consecutive-blank-lines/index.js @@ -17,13 +17,13 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * - * Foo... + * Foo… * ␊ - * ...Bar. + * …Bar. * - * @example {"name": "valid-for-code.md"} + * @example {"name": "ok-for-code.md"} * * Paragraph. * @@ -34,19 +34,19 @@ * * @example {"name": "empty-document.md"} * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * - * Foo... + * Foo… * ␊ * ␊ - * ...Bar + * …Bar * ␊ * ␊ * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 4:1: Remove 1 line before node - * 4:7: Remove 2 lines after node + * 4:5: Remove 2 lines after node */ 'use strict' diff --git a/packages/remark-lint-no-consecutive-blank-lines/readme.md b/packages/remark-lint-no-consecutive-blank-lines/readme.md index 737ef603..ec7148b6 100644 --- a/packages/remark-lint-no-consecutive-blank-lines/readme.md +++ b/packages/remark-lint-no-consecutive-blank-lines/readme.md @@ -33,23 +33,23 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In Note: `␊` represents a line feed. ```markdown -Foo... +Foo… ␊ -...Bar. +…Bar. ``` ###### Out No messages. -##### `valid-for-code.md` +##### `ok-for-code.md` ###### In @@ -74,17 +74,17 @@ No messages. No messages. -##### `invalid.md` +##### `not-ok.md` ###### In Note: `␊` represents a line feed. ```markdown -Foo... +Foo… ␊ ␊ -...Bar +…Bar ␊ ␊ ``` @@ -93,7 +93,7 @@ Foo... ```text 4:1: Remove 1 line before node -4:7: Remove 2 lines after node +4:5: Remove 2 lines after node ``` ## Install @@ -109,16 +109,16 @@ npm install remark-lint-no-consecutive-blank-lines You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-consecutive-blank-lines", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -130,15 +130,15 @@ remark -u lint -u lint-no-consecutive-blank-lines readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-consecutive-blank-lines')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -147,8 +147,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -177,7 +177,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-duplicate-definitions/index.js b/packages/remark-lint-no-duplicate-definitions/index.js index b5b16632..c788e83b 100644 --- a/packages/remark-lint-no-duplicate-definitions/index.js +++ b/packages/remark-lint-no-duplicate-definitions/index.js @@ -6,17 +6,17 @@ * @fileoverview * Warn when duplicate definitions are found. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * [foo]: bar * [baz]: qux * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * [foo]: bar * [foo]: qux * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 2:1-2:11: Do not use definitions with the same identifier (1:1) */ @@ -39,9 +39,9 @@ var reason = 'Do not use definitions with the same identifier' function noDuplicateDefinitions(tree, file) { var map = {} - visit(tree, ['definition', 'footnoteDefinition'], validate) + visit(tree, ['definition', 'footnoteDefinition'], check) - function validate(node) { + function check(node) { var identifier var duplicate diff --git a/packages/remark-lint-no-duplicate-definitions/readme.md b/packages/remark-lint-no-duplicate-definitions/readme.md index 2fa24cbf..17b4e250 100644 --- a/packages/remark-lint-no-duplicate-definitions/readme.md +++ b/packages/remark-lint-no-duplicate-definitions/readme.md @@ -22,7 +22,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -35,7 +35,7 @@ This rule is included in the following presets: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -63,16 +63,16 @@ npm install remark-lint-no-duplicate-definitions You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-duplicate-definitions", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -84,15 +84,15 @@ remark -u lint -u lint-no-duplicate-definitions readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-duplicate-definitions')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -101,8 +101,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -131,7 +131,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-duplicate-headings-in-section/index.js b/packages/remark-lint-no-duplicate-headings-in-section/index.js index bbdd62ba..11bce819 100644 --- a/packages/remark-lint-no-duplicate-headings-in-section/index.js +++ b/packages/remark-lint-no-duplicate-headings-in-section/index.js @@ -7,7 +7,7 @@ * Warn when duplicate headings are found, but only when on the same level, * “in” the same section. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * ## Alpha * @@ -25,7 +25,7 @@ * * ##### Bravo * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * ## Foxtrot * @@ -33,7 +33,7 @@ * * ### Golf * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 5:1-5:9: Do not use headings with similar content per section (3:1) */ diff --git a/packages/remark-lint-no-duplicate-headings-in-section/readme.md b/packages/remark-lint-no-duplicate-headings-in-section/readme.md index 6b216697..2ade9a88 100644 --- a/packages/remark-lint-no-duplicate-headings-in-section/readme.md +++ b/packages/remark-lint-no-duplicate-headings-in-section/readme.md @@ -19,7 +19,7 @@ This rule is not included in any default preset ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -45,7 +45,7 @@ This rule is not included in any default preset No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -76,16 +76,16 @@ npm install remark-lint-no-duplicate-headings-in-section You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-duplicate-headings-in-section", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -97,15 +97,15 @@ remark -u lint -u lint-no-duplicate-headings-in-section readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-duplicate-headings-in-section')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -114,8 +114,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -144,7 +144,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-duplicate-headings/index.js b/packages/remark-lint-no-duplicate-headings/index.js index 6a2135b4..f1a41f62 100644 --- a/packages/remark-lint-no-duplicate-headings/index.js +++ b/packages/remark-lint-no-duplicate-headings/index.js @@ -6,13 +6,13 @@ * @fileoverview * Warn when duplicate headings are found. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * # Foo * * ## Bar * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * # Foo * @@ -20,7 +20,7 @@ * * ## [Foo](http://foo.com/bar) * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 3:1-3:7: Do not use headings with similar content (1:1) * 5:1-5:29: Do not use headings with similar content (3:1) diff --git a/packages/remark-lint-no-duplicate-headings/readme.md b/packages/remark-lint-no-duplicate-headings/readme.md index 6105119c..801d3b48 100644 --- a/packages/remark-lint-no-duplicate-headings/readme.md +++ b/packages/remark-lint-no-duplicate-headings/readme.md @@ -22,7 +22,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -36,7 +36,7 @@ This rule is included in the following presets: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -68,16 +68,16 @@ npm install remark-lint-no-duplicate-headings You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-duplicate-headings", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -89,15 +89,15 @@ remark -u lint -u lint-no-duplicate-headings readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-duplicate-headings')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -106,8 +106,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -136,7 +136,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-emphasis-as-heading/index.js b/packages/remark-lint-no-emphasis-as-heading/index.js index 557e40ca..97638c93 100644 --- a/packages/remark-lint-no-emphasis-as-heading/index.js +++ b/packages/remark-lint-no-emphasis-as-heading/index.js @@ -7,13 +7,13 @@ * Warn when emphasis (including strong), instead of a heading, introduces * a paragraph. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * # Foo * * Bar. * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * *Foo* * @@ -23,7 +23,7 @@ * * Quux. * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:1-1:6: Don’t use emphasis to introduce a section, use a heading * 5:1-5:8: Don’t use emphasis to introduce a section, use a heading diff --git a/packages/remark-lint-no-emphasis-as-heading/readme.md b/packages/remark-lint-no-emphasis-as-heading/readme.md index 2fa31a35..da524113 100644 --- a/packages/remark-lint-no-emphasis-as-heading/readme.md +++ b/packages/remark-lint-no-emphasis-as-heading/readme.md @@ -23,7 +23,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -37,7 +37,7 @@ Bar. No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -71,16 +71,16 @@ npm install remark-lint-no-emphasis-as-heading You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-emphasis-as-heading", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -92,15 +92,15 @@ remark -u lint -u lint-no-emphasis-as-heading readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-emphasis-as-heading')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -109,8 +109,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -139,7 +139,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-empty-url/index.js b/packages/remark-lint-no-empty-url/index.js index 402d9c19..7a86ca7e 100644 --- a/packages/remark-lint-no-empty-url/index.js +++ b/packages/remark-lint-no-empty-url/index.js @@ -6,19 +6,19 @@ * @fileoverview * Warn for empty URLs in links and images. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * [alpha](http://bravo.com). * * ![charlie](http://delta.com/echo.png "foxtrott"). * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * [golf](). * * ![hotel](). * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:1-1:9: Don’t use links without URL * 3:1-3:11: Don’t use images without URL diff --git a/packages/remark-lint-no-empty-url/readme.md b/packages/remark-lint-no-empty-url/readme.md index 98ee16ca..c59acb3a 100644 --- a/packages/remark-lint-no-empty-url/readme.md +++ b/packages/remark-lint-no-empty-url/readme.md @@ -18,7 +18,7 @@ This rule is not included in any default preset ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -32,7 +32,7 @@ This rule is not included in any default preset No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -62,16 +62,16 @@ npm install remark-lint-no-empty-url You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-empty-url", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -83,15 +83,15 @@ remark -u lint -u lint-no-empty-url readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-empty-url')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -100,8 +100,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -130,7 +130,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-file-name-articles/readme.md b/packages/remark-lint-no-file-name-articles/readme.md index c1684453..10e1ad48 100644 --- a/packages/remark-lint-no-file-name-articles/readme.md +++ b/packages/remark-lint-no-file-name-articles/readme.md @@ -73,16 +73,16 @@ npm install remark-lint-no-file-name-articles You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-file-name-articles", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -94,15 +94,15 @@ remark -u lint -u lint-no-file-name-articles readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-file-name-articles')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -111,8 +111,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -141,7 +141,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-file-name-consecutive-dashes/readme.md b/packages/remark-lint-no-file-name-consecutive-dashes/readme.md index ce9a33e7..efe999c1 100644 --- a/packages/remark-lint-no-file-name-consecutive-dashes/readme.md +++ b/packages/remark-lint-no-file-name-consecutive-dashes/readme.md @@ -49,16 +49,16 @@ npm install remark-lint-no-file-name-consecutive-dashes You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-file-name-consecutive-dashes", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -70,15 +70,15 @@ remark -u lint -u lint-no-file-name-consecutive-dashes readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-file-name-consecutive-dashes')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -87,8 +87,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -117,7 +117,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-file-name-irregular-characters/readme.md b/packages/remark-lint-no-file-name-irregular-characters/readme.md index 0cbb3c32..b94569ae 100644 --- a/packages/remark-lint-no-file-name-irregular-characters/readme.md +++ b/packages/remark-lint-no-file-name-irregular-characters/readme.md @@ -82,16 +82,16 @@ npm install remark-lint-no-file-name-irregular-characters You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-file-name-irregular-characters", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -103,15 +103,15 @@ remark -u lint -u lint-no-file-name-irregular-characters readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-file-name-irregular-characters')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -120,8 +120,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -150,7 +150,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-file-name-mixed-case/readme.md b/packages/remark-lint-no-file-name-mixed-case/readme.md index 22554283..21a67005 100644 --- a/packages/remark-lint-no-file-name-mixed-case/readme.md +++ b/packages/remark-lint-no-file-name-mixed-case/readme.md @@ -55,16 +55,16 @@ npm install remark-lint-no-file-name-mixed-case You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-file-name-mixed-case", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -76,15 +76,15 @@ remark -u lint -u lint-no-file-name-mixed-case readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-file-name-mixed-case')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -93,8 +93,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -123,7 +123,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-file-name-outer-dashes/readme.md b/packages/remark-lint-no-file-name-outer-dashes/readme.md index 9b59ccea..d635f519 100644 --- a/packages/remark-lint-no-file-name-outer-dashes/readme.md +++ b/packages/remark-lint-no-file-name-outer-dashes/readme.md @@ -57,16 +57,16 @@ npm install remark-lint-no-file-name-outer-dashes You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-file-name-outer-dashes", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -78,15 +78,15 @@ remark -u lint -u lint-no-file-name-outer-dashes readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-file-name-outer-dashes')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -95,8 +95,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -125,7 +125,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-heading-content-indent/index.js b/packages/remark-lint-no-heading-content-indent/index.js index 51ee35a8..5379c7d3 100644 --- a/packages/remark-lint-no-heading-content-indent/index.js +++ b/packages/remark-lint-no-heading-content-indent/index.js @@ -14,7 +14,7 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * #·Foo * @@ -27,7 +27,7 @@ * Baz * === * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * #··Foo * @@ -35,7 +35,7 @@ * * ##··Baz * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:4: Remove 1 space before this heading’s content * 3:7: Remove 1 space after this heading’s content @@ -136,8 +136,8 @@ function noHeadingContentIndent(tree, file) { } } - // Closed ATX-heading always must have a space between their content and the - // final hashes, thus, there is no `add x spaces`. + // Closed ATX headings always must have a space between their content and + // the final hashes, thus, there is no `add x spaces`. if (type === 'atx-closed') { final = end(children[children.length - 1]) diff = end(node).column - final.column - 1 - depth diff --git a/packages/remark-lint-no-heading-content-indent/readme.md b/packages/remark-lint-no-heading-content-indent/readme.md index b7428642..9d1047bf 100644 --- a/packages/remark-lint-no-heading-content-indent/readme.md +++ b/packages/remark-lint-no-heading-content-indent/readme.md @@ -30,7 +30,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -53,7 +53,7 @@ Baz No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -121,16 +121,16 @@ npm install remark-lint-no-heading-content-indent You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-heading-content-indent", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -142,15 +142,15 @@ remark -u lint -u lint-no-heading-content-indent readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-heading-content-indent')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -159,8 +159,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -189,7 +189,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-heading-indent/index.js b/packages/remark-lint-no-heading-indent/index.js index 09a4e251..9a233685 100644 --- a/packages/remark-lint-no-heading-indent/index.js +++ b/packages/remark-lint-no-heading-indent/index.js @@ -14,7 +14,7 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * #·Hello world * @@ -26,7 +26,7 @@ * Bar * ===== * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * ···# Hello world * @@ -38,7 +38,7 @@ * ···Bar * ===== * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:4: Remove 3 spaces before this heading * 3:2: Remove 1 space before this heading diff --git a/packages/remark-lint-no-heading-indent/readme.md b/packages/remark-lint-no-heading-indent/readme.md index c41ab673..fe2bd34b 100644 --- a/packages/remark-lint-no-heading-indent/readme.md +++ b/packages/remark-lint-no-heading-indent/readme.md @@ -26,7 +26,7 @@ This rule is not included in any default preset ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -48,7 +48,7 @@ Bar No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -88,16 +88,16 @@ npm install remark-lint-no-heading-indent You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-heading-indent", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -109,15 +109,15 @@ remark -u lint -u lint-no-heading-indent readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-heading-indent')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -126,8 +126,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -156,7 +156,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-heading-like-paragraph/index.js b/packages/remark-lint-no-heading-like-paragraph/index.js index a37287b5..c0b34dcf 100644 --- a/packages/remark-lint-no-heading-like-paragraph/index.js +++ b/packages/remark-lint-no-heading-like-paragraph/index.js @@ -6,19 +6,19 @@ * @fileoverview * Warn for h7+ “headings”. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * ###### Alpha * * Bravo. * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * ####### Charlie * * Delta. * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:1-1:16: This looks like a heading but has too many hashes */ diff --git a/packages/remark-lint-no-heading-like-paragraph/readme.md b/packages/remark-lint-no-heading-like-paragraph/readme.md index edeb4e70..bb9cf63e 100644 --- a/packages/remark-lint-no-heading-like-paragraph/readme.md +++ b/packages/remark-lint-no-heading-like-paragraph/readme.md @@ -18,7 +18,7 @@ This rule is not included in any default preset ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -32,7 +32,7 @@ Bravo. No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -61,16 +61,16 @@ npm install remark-lint-no-heading-like-paragraph You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-heading-like-paragraph", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -82,15 +82,15 @@ remark -u lint -u lint-no-heading-like-paragraph readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-heading-like-paragraph')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -99,8 +99,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -129,7 +129,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-heading-punctuation/index.js b/packages/remark-lint-no-heading-punctuation/index.js index 030b85a3..98c7f97b 100644 --- a/packages/remark-lint-no-heading-punctuation/index.js +++ b/packages/remark-lint-no-heading-punctuation/index.js @@ -11,15 +11,15 @@ * Note: these are added to a regex, in a group (`'[' + char + ']'`), be * careful to escape the string correctly. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * # Hello * - * @example {"name": "valid.md", "setting": ",;:!?"} + * @example {"name": "ok.md", "setting": ",;:!?"} * - * # Hello... + * # Hello… * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * # Hello: * @@ -31,7 +31,7 @@ * * # Hello; * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:1-1:9: Don’t add a trailing `:` to headings * 3:1-3:9: Don’t add a trailing `?` to headings diff --git a/packages/remark-lint-no-heading-punctuation/readme.md b/packages/remark-lint-no-heading-punctuation/readme.md index 1532c3c2..b8a77c7f 100644 --- a/packages/remark-lint-no-heading-punctuation/readme.md +++ b/packages/remark-lint-no-heading-punctuation/readme.md @@ -27,7 +27,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -39,7 +39,7 @@ This rule is included in the following presets: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -65,14 +65,14 @@ No messages. 9:1-9:9: Don’t add a trailing `;` to headings ``` -##### `valid.md` +##### `ok.md` When configured with `',;:!?'`. ###### In ```markdown -# Hello... +# Hello… ``` ###### Out @@ -92,16 +92,16 @@ npm install remark-lint-no-heading-punctuation You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-heading-punctuation", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -113,15 +113,15 @@ remark -u lint -u lint-no-heading-punctuation readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-heading-punctuation')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -130,8 +130,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -160,7 +160,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-html/index.js b/packages/remark-lint-no-html/index.js index 5a5ae925..dbe4d8b7 100644 --- a/packages/remark-lint-no-html/index.js +++ b/packages/remark-lint-no-html/index.js @@ -9,17 +9,17 @@ * Ignores comments, because they are used by `remark`, `remark-lint`, other * Markdown tools, and because Markdown doesn’t have native comments. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * # Hello * * * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * *

Hello

* - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:1-1:15: Do not use HTML in markdown */ diff --git a/packages/remark-lint-no-html/readme.md b/packages/remark-lint-no-html/readme.md index 7bf24f23..1577c033 100644 --- a/packages/remark-lint-no-html/readme.md +++ b/packages/remark-lint-no-html/readme.md @@ -21,7 +21,7 @@ This rule is not included in any default preset ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -35,7 +35,7 @@ This rule is not included in any default preset No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -62,16 +62,16 @@ npm install remark-lint-no-html You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-html", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -83,15 +83,15 @@ remark -u lint -u lint-no-html readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-html')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -100,8 +100,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -130,7 +130,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-inline-padding/index.js b/packages/remark-lint-no-inline-padding/index.js index 777dd692..c29c29ef 100644 --- a/packages/remark-lint-no-inline-padding/index.js +++ b/packages/remark-lint-no-inline-padding/index.js @@ -9,15 +9,15 @@ * * Warns for emphasis, strong, delete, image, and link. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * Alpha, *bravo*, _charlie_, [delta](http://echo.fox/trot) * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * Alpha, * bravo *, _ charlie _, [ delta ](http://echo.fox/trot) * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:8-1:17: Don’t pad `emphasis` with inner spaces * 1:19-1:30: Don’t pad `emphasis` with inner spaces diff --git a/packages/remark-lint-no-inline-padding/readme.md b/packages/remark-lint-no-inline-padding/readme.md index fffbf427..5c70ae27 100644 --- a/packages/remark-lint-no-inline-padding/readme.md +++ b/packages/remark-lint-no-inline-padding/readme.md @@ -26,7 +26,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -38,7 +38,7 @@ Alpha, *bravo*, _charlie_, [delta](http://echo.fox/trot) No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -67,16 +67,16 @@ npm install remark-lint-no-inline-padding You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-inline-padding", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -88,15 +88,15 @@ remark -u lint -u lint-no-inline-padding readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-inline-padding')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -105,8 +105,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -135,7 +135,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-literal-urls/index.js b/packages/remark-lint-no-literal-urls/index.js index bca97dae..f42ae861 100644 --- a/packages/remark-lint-no-literal-urls/index.js +++ b/packages/remark-lint-no-literal-urls/index.js @@ -6,27 +6,27 @@ * @fileoverview * Warn for literal URLs in text. * URLs are treated as links in some Markdown vendors, but not in others. - * To make sure they are always linked, wrap them in `<` (less-than) and `>` - * (greater-than). + * To make sure they are always linked, wrap them in `<` (less than) and `>` + * (greater than). * * ## Fix * * [`remark-stringify`](https://github.com/remarkjs/remark/tree/master/packages/remark-stringify) - * never creates literal URLs and always uses `<` (less-than) and `>` - * (greater-than). + * never creates literal URLs and always uses `<` (less than) and `>` + * (greater than). * * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * http://foo.bar/baz * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:1-1:19: Don’t use literal URLs without angle brackets */ diff --git a/packages/remark-lint-no-literal-urls/package.json b/packages/remark-lint-no-literal-urls/package.json index 9f39eee0..d0a106dd 100644 --- a/packages/remark-lint-no-literal-urls/package.json +++ b/packages/remark-lint-no-literal-urls/package.json @@ -1,7 +1,7 @@ { "name": "remark-lint-no-literal-urls", "version": "1.0.3", - "description": "remark-lint rule to warn when URLs without angle-brackets are used", + "description": "remark-lint rule to warn when URLs without angle brackets are used", "license": "MIT", "keywords": [ "remark", diff --git a/packages/remark-lint-no-literal-urls/readme.md b/packages/remark-lint-no-literal-urls/readme.md index 90e1c103..2d5884e4 100644 --- a/packages/remark-lint-no-literal-urls/readme.md +++ b/packages/remark-lint-no-literal-urls/readme.md @@ -12,14 +12,14 @@ Warn for literal URLs in text. URLs are treated as links in some Markdown vendors, but not in others. -To make sure they are always linked, wrap them in `<` (less-than) and `>` -(greater-than). +To make sure they are always linked, wrap them in `<` (less than) and `>` +(greater than). ## Fix [`remark-stringify`](https://github.com/remarkjs/remark/tree/master/packages/remark-stringify) -never creates literal URLs and always uses `<` (less-than) and `>` -(greater-than). +never creates literal URLs and always uses `<` (less than) and `>` +(greater than). See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) on how to automatically fix warnings for this rule. @@ -35,7 +35,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -47,7 +47,7 @@ This rule is included in the following presets: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -74,16 +74,16 @@ npm install remark-lint-no-literal-urls You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-literal-urls", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -95,15 +95,15 @@ remark -u lint -u lint-no-literal-urls readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-literal-urls')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -112,8 +112,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -142,7 +142,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-missing-blank-lines/index.js b/packages/remark-lint-no-missing-blank-lines/index.js index 633241aa..1d25db39 100644 --- a/packages/remark-lint-no-missing-blank-lines/index.js +++ b/packages/remark-lint-no-missing-blank-lines/index.js @@ -21,7 +21,7 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * # Foo * @@ -33,7 +33,7 @@ * * Paragraph. * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * # Foo * ## Bar @@ -43,7 +43,7 @@ * * Paragraph. * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 2:1-2:7: Missing blank line before block node * 5:3-5:10: Missing blank line before block node diff --git a/packages/remark-lint-no-missing-blank-lines/readme.md b/packages/remark-lint-no-missing-blank-lines/readme.md index a673821e..11235eb9 100644 --- a/packages/remark-lint-no-missing-blank-lines/readme.md +++ b/packages/remark-lint-no-missing-blank-lines/readme.md @@ -33,7 +33,7 @@ This rule is not included in any default preset ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -53,7 +53,7 @@ Paragraph. No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -109,16 +109,16 @@ npm install remark-lint-no-missing-blank-lines You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-missing-blank-lines", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -130,15 +130,15 @@ remark -u lint -u lint-no-missing-blank-lines readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-missing-blank-lines')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -147,8 +147,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -177,7 +177,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-multiple-toplevel-headings/index.js b/packages/remark-lint-no-multiple-toplevel-headings/index.js index 0f3ff0eb..019a1ea8 100644 --- a/packages/remark-lint-no-multiple-toplevel-headings/index.js +++ b/packages/remark-lint-no-multiple-toplevel-headings/index.js @@ -8,19 +8,19 @@ * * Options: `number`, default: `1`. * - * @example {"name": "valid.md", "setting": 1} + * @example {"name": "ok.md", "setting": 1} * * # Foo * * ## Bar * - * @example {"name": "invalid.md", "setting": 1, "label": "input"} + * @example {"name": "not-ok.md", "setting": 1, "label": "input"} * * # Foo * * # Bar * - * @example {"name": "invalid.md", "setting": 1, "label": "output"} + * @example {"name": "not-ok.md", "setting": 1, "label": "output"} * * 3:1-3:6: Don’t use multiple top level headings (1:1) */ diff --git a/packages/remark-lint-no-multiple-toplevel-headings/package.json b/packages/remark-lint-no-multiple-toplevel-headings/package.json index 7b726b92..271cf897 100644 --- a/packages/remark-lint-no-multiple-toplevel-headings/package.json +++ b/packages/remark-lint-no-multiple-toplevel-headings/package.json @@ -1,7 +1,7 @@ { "name": "remark-lint-no-multiple-toplevel-headings", "version": "1.0.4", - "description": "remark-lint rule to warn when multiple top-level headings are used", + "description": "remark-lint rule to warn when multiple top level headings are used", "license": "MIT", "keywords": [ "remark", diff --git a/packages/remark-lint-no-multiple-toplevel-headings/readme.md b/packages/remark-lint-no-multiple-toplevel-headings/readme.md index 53c07214..1e632e9e 100644 --- a/packages/remark-lint-no-multiple-toplevel-headings/readme.md +++ b/packages/remark-lint-no-multiple-toplevel-headings/readme.md @@ -24,7 +24,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` When configured with `1`. @@ -40,7 +40,7 @@ When configured with `1`. No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `1`. @@ -71,16 +71,16 @@ npm install remark-lint-no-multiple-toplevel-headings You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-multiple-toplevel-headings", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -92,15 +92,15 @@ remark -u lint -u lint-no-multiple-toplevel-headings readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-multiple-toplevel-headings')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -109,8 +109,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -139,7 +139,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-paragraph-content-indent/index.js b/packages/remark-lint-no-paragraph-content-indent/index.js index ebe36bd5..05e1bcb2 100644 --- a/packages/remark-lint-no-paragraph-content-indent/index.js +++ b/packages/remark-lint-no-paragraph-content-indent/index.js @@ -6,7 +6,7 @@ * @fileoverview * Warn when the content in paragraphs is indented. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * Alpha * @@ -34,7 +34,7 @@ * * [![][text]][text] * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * ·Alpha * @@ -60,7 +60,7 @@ * * [![ ][text]][text] * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:1: Expected no indentation in paragraph content * 4:1: Expected no indentation in paragraph content diff --git a/packages/remark-lint-no-paragraph-content-indent/readme.md b/packages/remark-lint-no-paragraph-content-indent/readme.md index 2455bbdd..05751102 100644 --- a/packages/remark-lint-no-paragraph-content-indent/readme.md +++ b/packages/remark-lint-no-paragraph-content-indent/readme.md @@ -18,7 +18,7 @@ This rule is not included in any default preset ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -54,7 +54,7 @@ juliett. No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -114,16 +114,16 @@ npm install remark-lint-no-paragraph-content-indent You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-paragraph-content-indent", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -135,15 +135,15 @@ remark -u lint -u lint-no-paragraph-content-indent readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-paragraph-content-indent')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -152,8 +152,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -182,7 +182,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-reference-like-url/index.js b/packages/remark-lint-no-reference-like-url/index.js index 96adaeab..2e574611 100644 --- a/packages/remark-lint-no-reference-like-url/index.js +++ b/packages/remark-lint-no-reference-like-url/index.js @@ -6,19 +6,19 @@ * @fileoverview * Warn when URLs are also defined identifiers. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * [Alpha](http://example.com). * * [bravo]: https://example.com * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * [Charlie](delta). * * [delta]: https://example.com * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:1-1:17: Did you mean to use `[delta]` instead of `(delta)`, a reference? */ diff --git a/packages/remark-lint-no-reference-like-url/readme.md b/packages/remark-lint-no-reference-like-url/readme.md index c177f017..5edbff68 100644 --- a/packages/remark-lint-no-reference-like-url/readme.md +++ b/packages/remark-lint-no-reference-like-url/readme.md @@ -18,7 +18,7 @@ This rule is not included in any default preset ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -32,7 +32,7 @@ This rule is not included in any default preset No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -61,16 +61,16 @@ npm install remark-lint-no-reference-like-url You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-reference-like-url", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -82,15 +82,15 @@ remark -u lint -u lint-no-reference-like-url readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-reference-like-url')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -99,8 +99,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -129,7 +129,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-shell-dollars/index.js b/packages/remark-lint-no-shell-dollars/index.js index 8da7986a..50bce1b3 100644 --- a/packages/remark-lint-no-shell-dollars/index.js +++ b/packages/remark-lint-no-shell-dollars/index.js @@ -8,7 +8,7 @@ * * Ignores indented code blocks and fenced code blocks without language flag. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * ```sh * echo a @@ -32,16 +32,16 @@ * $('div').remove(); * ``` * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * ```bash * $ echo a * $ echo a > file * ``` * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * - * 1:1-4:4: Do not use dollar signs before shell-commands + * 1:1-4:4: Do not use dollar signs before shell commands */ 'use strict' @@ -52,7 +52,7 @@ var generated = require('unist-util-generated') module.exports = rule('remark-lint:no-shell-dollars', noShellDollars) -var reason = 'Do not use dollar signs before shell-commands' +var reason = 'Do not use dollar signs before shell commands' // List of shell script file extensions (also used as code flags for syntax // highlighting on GitHub): diff --git a/packages/remark-lint-no-shell-dollars/readme.md b/packages/remark-lint-no-shell-dollars/readme.md index 86862fb5..793e2c9a 100644 --- a/packages/remark-lint-no-shell-dollars/readme.md +++ b/packages/remark-lint-no-shell-dollars/readme.md @@ -24,7 +24,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -56,7 +56,7 @@ $('div').remove(); No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -70,7 +70,7 @@ $ echo a > file ###### Out ```text -1:1-4:4: Do not use dollar signs before shell-commands +1:1-4:4: Do not use dollar signs before shell commands ``` ## Install @@ -86,16 +86,16 @@ npm install remark-lint-no-shell-dollars You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-shell-dollars", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -107,15 +107,15 @@ remark -u lint -u lint-no-shell-dollars readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-shell-dollars')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -124,8 +124,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -154,7 +154,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-shortcut-reference-image/index.js b/packages/remark-lint-no-shortcut-reference-image/index.js index 217503b0..e9e56f34 100644 --- a/packages/remark-lint-no-shortcut-reference-image/index.js +++ b/packages/remark-lint-no-shortcut-reference-image/index.js @@ -12,19 +12,19 @@ * rule still warns anyway. * In that case, you can escape the reference like so: `!\[foo]`. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * ![foo][] * * [foo]: http://foo.bar/baz.png * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * ![foo] * * [foo]: http://foo.bar/baz.png * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:1-1:7: Use the trailing [] on reference images */ diff --git a/packages/remark-lint-no-shortcut-reference-image/readme.md b/packages/remark-lint-no-shortcut-reference-image/readme.md index e2a804a3..88b34865 100644 --- a/packages/remark-lint-no-shortcut-reference-image/readme.md +++ b/packages/remark-lint-no-shortcut-reference-image/readme.md @@ -29,7 +29,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -43,7 +43,7 @@ This rule is included in the following presets: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -72,16 +72,16 @@ npm install remark-lint-no-shortcut-reference-image You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-shortcut-reference-image", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -93,15 +93,15 @@ remark -u lint -u lint-no-shortcut-reference-image readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-shortcut-reference-image')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -110,8 +110,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -140,7 +140,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-shortcut-reference-link/index.js b/packages/remark-lint-no-shortcut-reference-link/index.js index ebfbd44b..3b31604c 100644 --- a/packages/remark-lint-no-shortcut-reference-link/index.js +++ b/packages/remark-lint-no-shortcut-reference-link/index.js @@ -12,21 +12,21 @@ * rule still warns anyway. * In that case, you can escape the reference like so: `\[foo]`. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * [foo][] * * [foo]: http://foo.bar/baz * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * [foo] * * [foo]: http://foo.bar/baz * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * - * 1:1-1:6: Use the trailing [] on reference links + * 1:1-1:6: Use the trailing `[]` on reference links */ 'use strict' @@ -40,7 +40,7 @@ module.exports = rule( noShortcutReferenceLink ) -var reason = 'Use the trailing [] on reference links' +var reason = 'Use the trailing `[]` on reference links' function noShortcutReferenceLink(tree, file) { visit(tree, 'linkReference', visitor) diff --git a/packages/remark-lint-no-shortcut-reference-link/readme.md b/packages/remark-lint-no-shortcut-reference-link/readme.md index c3537a9f..4fe09ab2 100644 --- a/packages/remark-lint-no-shortcut-reference-link/readme.md +++ b/packages/remark-lint-no-shortcut-reference-link/readme.md @@ -29,7 +29,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -43,7 +43,7 @@ This rule is included in the following presets: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -56,7 +56,7 @@ No messages. ###### Out ```text -1:1-1:6: Use the trailing [] on reference links +1:1-1:6: Use the trailing `[]` on reference links ``` ## Install @@ -72,16 +72,16 @@ npm install remark-lint-no-shortcut-reference-link You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-shortcut-reference-link", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -93,15 +93,15 @@ remark -u lint -u lint-no-shortcut-reference-link readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-shortcut-reference-link')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -110,8 +110,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -140,7 +140,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-table-indentation/index.js b/packages/remark-lint-no-table-indentation/index.js index 5a01215d..ba7cff42 100644 --- a/packages/remark-lint-no-table-indentation/index.js +++ b/packages/remark-lint-no-table-indentation/index.js @@ -14,7 +14,7 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * Paragraph. * @@ -22,7 +22,7 @@ * | ----- | ----- | * | Alpha | Bravo | * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * Paragraph. * @@ -30,7 +30,7 @@ * ···| ----- | ----- | * ···| Alpha | Bravo | * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 3:1-3:21: Do not indent table rows * 5:1-5:21: Do not indent table rows diff --git a/packages/remark-lint-no-table-indentation/readme.md b/packages/remark-lint-no-table-indentation/readme.md index 3845404f..007a3a4a 100644 --- a/packages/remark-lint-no-table-indentation/readme.md +++ b/packages/remark-lint-no-table-indentation/readme.md @@ -30,7 +30,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -46,7 +46,7 @@ Paragraph. No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -80,16 +80,16 @@ npm install remark-lint-no-table-indentation You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-table-indentation", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -101,15 +101,15 @@ remark -u lint -u lint-no-table-indentation readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-table-indentation')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -118,8 +118,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -148,7 +148,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-tabs/index.js b/packages/remark-lint-no-tabs/index.js index 0bc99c20..87e46f1a 100644 --- a/packages/remark-lint-no-tabs/index.js +++ b/packages/remark-lint-no-tabs/index.js @@ -15,13 +15,13 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * Foo Bar * * ····Foo * - * @example {"name": "invalid.md", "label": "input", "config": {"positionless": true}} + * @example {"name": "not-ok.md", "label": "input", "config": {"positionless": true}} * * »Here's one before a code block. * @@ -31,23 +31,23 @@ * * >»This is in a block quote. * - * *»And... + * *»And… * * »1.»in a list. * * And this is a tab as the last character.» * - * @example {"name": "invalid.md", "label": "output"} - * - * 1:1: Use spaces instead of hard-tabs - * 3:14: Use spaces instead of hard-tabs - * 3:37: Use spaces instead of hard-tabs - * 5:23: Use spaces instead of hard-tabs - * 7:2: Use spaces instead of hard-tabs - * 9:2: Use spaces instead of hard-tabs - * 11:1: Use spaces instead of hard-tabs - * 11:4: Use spaces instead of hard-tabs - * 13:41: Use spaces instead of hard-tabs + * @example {"name": "not-ok.md", "label": "output"} + * + * 1:1: Use spaces instead of tabs + * 3:14: Use spaces instead of tabs + * 3:37: Use spaces instead of tabs + * 5:23: Use spaces instead of tabs + * 7:2: Use spaces instead of tabs + * 9:2: Use spaces instead of tabs + * 11:1: Use spaces instead of tabs + * 11:4: Use spaces instead of tabs + * 13:41: Use spaces instead of tabs */ 'use strict' @@ -57,7 +57,7 @@ var location = require('vfile-location') module.exports = rule('remark-lint:no-tabs', noTabs) -var reason = 'Use spaces instead of hard-tabs' +var reason = 'Use spaces instead of tabs' function noTabs(tree, file) { var content = String(file) diff --git a/packages/remark-lint-no-tabs/readme.md b/packages/remark-lint-no-tabs/readme.md index 113f3a8e..e891558d 100644 --- a/packages/remark-lint-no-tabs/readme.md +++ b/packages/remark-lint-no-tabs/readme.md @@ -27,7 +27,7 @@ This rule is not included in any default preset ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -43,7 +43,7 @@ Foo Bar No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -58,7 +58,7 @@ And this is in `inline»code`. >»This is in a block quote. -*»And... +*»And… »1.»in a list. @@ -68,15 +68,15 @@ And this is a tab as the last character.» ###### Out ```text -1:1: Use spaces instead of hard-tabs -3:14: Use spaces instead of hard-tabs -3:37: Use spaces instead of hard-tabs -5:23: Use spaces instead of hard-tabs -7:2: Use spaces instead of hard-tabs -9:2: Use spaces instead of hard-tabs -11:1: Use spaces instead of hard-tabs -11:4: Use spaces instead of hard-tabs -13:41: Use spaces instead of hard-tabs +1:1: Use spaces instead of tabs +3:14: Use spaces instead of tabs +3:37: Use spaces instead of tabs +5:23: Use spaces instead of tabs +7:2: Use spaces instead of tabs +9:2: Use spaces instead of tabs +11:1: Use spaces instead of tabs +11:4: Use spaces instead of tabs +13:41: Use spaces instead of tabs ``` ## Install @@ -92,16 +92,16 @@ npm install remark-lint-no-tabs You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-tabs", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -113,15 +113,15 @@ remark -u lint -u lint-no-tabs readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-tabs')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -130,8 +130,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -160,7 +160,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-undefined-references/index.js b/packages/remark-lint-no-undefined-references/index.js index 22b21fe7..35464f94 100644 --- a/packages/remark-lint-no-undefined-references/index.js +++ b/packages/remark-lint-no-undefined-references/index.js @@ -8,27 +8,27 @@ * * Options: `Object`, optional. * - * The object can have an `allow` property, an array of strings that may - * appear between `[` and `]` but that should not be treated as link + * The object can have an `allow` field, set to an array of strings that may + * appear between `[` and `]`, but that should not be treated as link * identifiers. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * [foo][] * * [foo]: https://example.com * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "ok-allow.md", "setting": {"allow": ["...", "…"]}} * - * [bar][] + * > Eliding a portion of a quoted passage […] is acceptable. * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "input"} * - * 1:1-1:8: Found reference to undefined definition + * [bar][] * - * @example {"name": "valid-allow.md", "setting": {"allow": ["..."]}} + * @example {"name": "not-ok.md", "label": "output"} * - * > Eliding a portion of a quoted passage [...] is acceptable. + * 1:1-1:8: Found reference to undefined definition */ 'use strict' @@ -45,9 +45,10 @@ module.exports = rule( var reason = 'Found reference to undefined definition' -// The identifier is upcased to avoid naming collisions with properties -// inherited from `Object.prototype`. Were `Object.create(null)` to be -// used in place of `{}`, downcasing would work equally well. +// The identifier is upcased to avoid naming collisions with fields inherited +// from `Object.prototype`. +// If `Object.create(null)` was used in place of `{}`, downcasing would work +// equally well. function normalize(s) { return collapseWhiteSpace(s.toUpperCase()) } diff --git a/packages/remark-lint-no-undefined-references/readme.md b/packages/remark-lint-no-undefined-references/readme.md index cb0dd417..d3f3eb0a 100644 --- a/packages/remark-lint-no-undefined-references/readme.md +++ b/packages/remark-lint-no-undefined-references/readme.md @@ -14,8 +14,8 @@ Warn when references to undefined definitions are found. Options: `Object`, optional. -The object can have an `allow` property, an array of strings that may -appear between `[` and `]` but that should not be treated as link +The object can have an `allow` field, set to an array of strings that may +appear between `[` and `]`, but that should not be treated as link identifiers. ## Presets @@ -28,7 +28,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -42,7 +42,7 @@ This rule is included in the following presets: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -56,14 +56,14 @@ No messages. 1:1-1:8: Found reference to undefined definition ``` -##### `valid-allow.md` +##### `ok-allow.md` -When configured with `{ allow: [ '...' ] }`. +When configured with `{ allow: [ '...', '…' ] }`. ###### In ```markdown -> Eliding a portion of a quoted passage [...] is acceptable. +> Eliding a portion of a quoted passage […] is acceptable. ``` ###### Out @@ -83,16 +83,16 @@ npm install remark-lint-no-undefined-references You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-undefined-references", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -104,15 +104,15 @@ remark -u lint -u lint-no-undefined-references readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-undefined-references')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -121,8 +121,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -151,7 +151,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-unneeded-full-reference-image/index.js b/packages/remark-lint-no-unneeded-full-reference-image/index.js index 83311099..bc576fb5 100644 --- a/packages/remark-lint-no-unneeded-full-reference-image/index.js +++ b/packages/remark-lint-no-unneeded-full-reference-image/index.js @@ -10,19 +10,19 @@ * collapsed reference (`[Remark][]`) if normalising the reference text yields * the label. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * ![alpha][] * ![Bravo][] * ![Charlie][delta] * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * ![alpha][alpha] * ![Bravo][bravo] * ![charlie][Charlie] * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:1-1:16: Remove the image label as it matches the reference text * 2:1-2:16: Remove the image label as it matches the reference text diff --git a/packages/remark-lint-no-unneeded-full-reference-image/readme.md b/packages/remark-lint-no-unneeded-full-reference-image/readme.md index f7180233..d591c291 100644 --- a/packages/remark-lint-no-unneeded-full-reference-image/readme.md +++ b/packages/remark-lint-no-unneeded-full-reference-image/readme.md @@ -22,7 +22,7 @@ This rule is not included in any default preset ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -36,7 +36,7 @@ This rule is not included in any default preset No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -67,16 +67,16 @@ npm install remark-lint-no-unneeded-full-reference-image You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-unneeded-full-reference-image", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -88,15 +88,15 @@ remark -u lint -u lint-no-unneeded-full-reference-image readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-unneeded-full-reference-image')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -105,8 +105,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -135,7 +135,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-unneeded-full-reference-link/index.js b/packages/remark-lint-no-unneeded-full-reference-link/index.js index d0d4125c..4aba8dc2 100644 --- a/packages/remark-lint-no-unneeded-full-reference-link/index.js +++ b/packages/remark-lint-no-unneeded-full-reference-link/index.js @@ -10,7 +10,7 @@ * collapsed reference (`[Remark][]`) if normalising the reference text yields * the label. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * [alpha][] * [Bravo][] @@ -20,13 +20,13 @@ * [`echo`][] * [*foxtrot*][] * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * [alpha][alpha] * [Bravo][bravo] * [charlie][Charlie] * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:1-1:15: Remove the link label as it matches the reference text * 2:1-2:15: Remove the link label as it matches the reference text diff --git a/packages/remark-lint-no-unneeded-full-reference-link/readme.md b/packages/remark-lint-no-unneeded-full-reference-link/readme.md index 8607ed9c..35ae5078 100644 --- a/packages/remark-lint-no-unneeded-full-reference-link/readme.md +++ b/packages/remark-lint-no-unneeded-full-reference-link/readme.md @@ -22,7 +22,7 @@ This rule is not included in any default preset ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -40,7 +40,7 @@ This only works if the link text is a `text` node: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -71,16 +71,16 @@ npm install remark-lint-no-unneeded-full-reference-link You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-unneeded-full-reference-link", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -92,15 +92,15 @@ remark -u lint -u lint-no-unneeded-full-reference-link readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-unneeded-full-reference-link')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -109,8 +109,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -139,7 +139,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-no-unused-definitions/index.js b/packages/remark-lint-no-unused-definitions/index.js index 61139cb6..5614bb5c 100644 --- a/packages/remark-lint-no-unused-definitions/index.js +++ b/packages/remark-lint-no-unused-definitions/index.js @@ -6,17 +6,17 @@ * @fileoverview * Warn when unused definitions are found. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * [foo][] * * [foo]: https://example.com * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * [bar]: https://example.com * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:1-1:27: Found unused definition */ diff --git a/packages/remark-lint-no-unused-definitions/readme.md b/packages/remark-lint-no-unused-definitions/readme.md index 5ab9d5d2..75ddd52b 100644 --- a/packages/remark-lint-no-unused-definitions/readme.md +++ b/packages/remark-lint-no-unused-definitions/readme.md @@ -22,7 +22,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -36,7 +36,7 @@ This rule is included in the following presets: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -63,16 +63,16 @@ npm install remark-lint-no-unused-definitions You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-no-unused-definitions", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -84,15 +84,15 @@ remark -u lint -u lint-no-unused-definitions readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-no-unused-definitions')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -101,8 +101,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -131,7 +131,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-ordered-list-marker-style/index.js b/packages/remark-lint-ordered-list-marker-style/index.js index 1605f77c..68fc398a 100644 --- a/packages/remark-lint-ordered-list-marker-style/index.js +++ b/packages/remark-lint-ordered-list-marker-style/index.js @@ -13,7 +13,7 @@ * * Note: `)` is only supported in CommonMark. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * 1. Foo * @@ -24,13 +24,13 @@ * * * Foo * - * @example {"name": "valid.md", "setting": "."} + * @example {"name": "ok.md", "setting": "."} * * 1. Foo * * 2. Bar * - * @example {"name": "valid.md", "setting": ")", "config": {"commonmark": true}} + * @example {"name": "ok.md", "setting": ")", "config": {"commonmark": true}} * * * @@ -38,19 +38,19 @@ * * 2) Bar * - * @example {"name": "invalid.md", "label": "input", "config": {"commonmark": true}} + * @example {"name": "not-ok.md", "label": "input", "config": {"commonmark": true}} * * 1. Foo * * 2) Bar * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 3:1-3:8: Marker style should be `.` * - * @example {"name": "invalid.md", "label": "output", "setting": "!", "config": {"positionless": true}} + * @example {"name": "not-ok.md", "label": "output", "setting": "💩", "config": {"positionless": true}} * - * 1:1: Invalid ordered list-item marker style `!`: use either `'.'` or `')'` + * 1:1: Incorrect ordered list item marker style `💩`: use either `'.'` or `')'` */ 'use strict' @@ -80,7 +80,7 @@ function orderedListMarkerStyle(tree, file, pref) { if (styles[pref] !== true) { file.fail( - 'Invalid ordered list-item marker style `' + + 'Incorrect ordered list item marker style `' + pref + "`: use either `'.'` or `')'`" ) diff --git a/packages/remark-lint-ordered-list-marker-style/readme.md b/packages/remark-lint-ordered-list-marker-style/readme.md index 43dd501d..ff9d5255 100644 --- a/packages/remark-lint-ordered-list-marker-style/readme.md +++ b/packages/remark-lint-ordered-list-marker-style/readme.md @@ -31,7 +31,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -50,7 +50,7 @@ Unordered lists are not affected by this rule. No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -66,7 +66,7 @@ No messages. 3:1-3:8: Marker style should be `.` ``` -##### `valid.md` +##### `ok.md` When configured with `'.'`. @@ -82,7 +82,7 @@ When configured with `'.'`. No messages. -##### `valid.md` +##### `ok.md` When configured with `')'`. @@ -100,14 +100,14 @@ When configured with `')'`. No messages. -##### `invalid.md` +##### `not-ok.md` -When configured with `'!'`. +When configured with `'💩'`. ###### Out ```text -1:1: Invalid ordered list-item marker style `!`: use either `'.'` or `')'` +1:1: Incorrect ordered list item marker style `💩`: use either `'.'` or `')'` ``` ## Install @@ -123,16 +123,16 @@ npm install remark-lint-ordered-list-marker-style You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-ordered-list-marker-style", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -144,15 +144,15 @@ remark -u lint -u lint-ordered-list-marker-style readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-ordered-list-marker-style')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -161,8 +161,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -191,7 +191,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-ordered-list-marker-value/index.js b/packages/remark-lint-ordered-list-marker-value/index.js index 61a3d5df..0fb3f8ca 100644 --- a/packages/remark-lint-ordered-list-marker-value/index.js +++ b/packages/remark-lint-ordered-list-marker-value/index.js @@ -27,7 +27,7 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * The default value is `ordered`, so unless changed, the below * is OK. @@ -46,7 +46,7 @@ * * * Anton * - * @example {"name": "valid.md", "setting": "one"} + * @example {"name": "ok.md", "setting": "one"} * * 1. Foo * 1. Bar @@ -58,7 +58,7 @@ * 1. Bravo * 1. Charlie * - * @example {"name": "valid.md", "setting": "single"} + * @example {"name": "ok.md", "setting": "single"} * * 1. Foo * 1. Bar @@ -76,7 +76,7 @@ * 0. Echo * 0. Foxtrot * - * @example {"name": "valid.md", "setting": "ordered"} + * @example {"name": "ok.md", "setting": "ordered"} * * 1. Foo * 2. Bar @@ -94,36 +94,36 @@ * 1. Echo * 2. Foxtrot * - * @example {"name": "invalid.md", "setting": "one", "label": "input"} + * @example {"name": "not-ok.md", "setting": "one", "label": "input"} * * 1. Foo * 2. Bar * - * @example {"name": "invalid.md", "setting": "one", "label": "output"} + * @example {"name": "not-ok.md", "setting": "one", "label": "output"} * * 2:1-2:8: Marker should be `1`, was `2` * - * @example {"name": "also-invalid.md", "setting": "one", "label": "input"} + * @example {"name": "also-not-ok.md", "setting": "one", "label": "input"} * * 2. Foo * 1. Bar * - * @example {"name": "also-invalid.md", "setting": "one", "label": "output"} + * @example {"name": "also-not-ok.md", "setting": "one", "label": "output"} * * 1:1-1:8: Marker should be `1`, was `2` * - * @example {"name": "invalid.md", "setting": "ordered", "label": "input"} + * @example {"name": "not-ok.md", "setting": "ordered", "label": "input"} * * 1. Foo * 1. Bar * - * @example {"name": "invalid.md", "setting": "ordered", "label": "output"} + * @example {"name": "not-ok.md", "setting": "ordered", "label": "output"} * * 2:1-2:8: Marker should be `2`, was `1` * - * @example {"name": "invalid.md", "setting": "invalid", "label": "output", "config": {"positionless": true}} + * @example {"name": "not-ok.md", "setting": "💩", "label": "output", "config": {"positionless": true}} * - * 1:1: Invalid ordered list-item marker value `invalid`: use either `'ordered'` or `'one'` + * 1:1: Incorrect ordered list item marker value `💩`: use either `'ordered'` or `'one'` */ 'use strict' @@ -149,7 +149,7 @@ function orderedListMarkerValue(tree, file, pref) { if (styles[pref] !== true) { file.fail( - 'Invalid ordered list-item marker value `' + + 'Incorrect ordered list item marker value `' + pref + "`: use either `'ordered'` or `'one'`" ) diff --git a/packages/remark-lint-ordered-list-marker-value/readme.md b/packages/remark-lint-ordered-list-marker-value/readme.md index 7ea92e2d..01a220dd 100644 --- a/packages/remark-lint-ordered-list-marker-value/readme.md +++ b/packages/remark-lint-ordered-list-marker-value/readme.md @@ -43,7 +43,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -70,7 +70,7 @@ Unordered lists are not affected by this rule. No messages. -##### `valid.md` +##### `ok.md` When configured with `'one'`. @@ -92,7 +92,7 @@ Paragraph. No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `'one'`. @@ -109,7 +109,7 @@ When configured with `'one'`. 2:1-2:8: Marker should be `1`, was `2` ``` -##### `also-invalid.md` +##### `also-not-ok.md` When configured with `'one'`. @@ -126,7 +126,7 @@ When configured with `'one'`. 1:1-1:8: Marker should be `1`, was `2` ``` -##### `valid.md` +##### `ok.md` When configured with `'single'`. @@ -154,7 +154,7 @@ Paragraph. No messages. -##### `valid.md` +##### `ok.md` When configured with `'ordered'`. @@ -182,7 +182,7 @@ Paragraph. No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `'ordered'`. @@ -199,14 +199,14 @@ When configured with `'ordered'`. 2:1-2:8: Marker should be `2`, was `1` ``` -##### `invalid.md` +##### `not-ok.md` -When configured with `'invalid'`. +When configured with `'💩'`. ###### Out ```text -1:1: Invalid ordered list-item marker value `invalid`: use either `'ordered'` or `'one'` +1:1: Incorrect ordered list item marker value `💩`: use either `'ordered'` or `'one'` ``` ## Install @@ -222,16 +222,16 @@ npm install remark-lint-ordered-list-marker-value You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-ordered-list-marker-value", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -243,15 +243,15 @@ remark -u lint -u lint-ordered-list-marker-value readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-ordered-list-marker-value')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -260,8 +260,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -290,7 +290,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-rule-style/index.js b/packages/remark-lint-rule-style/index.js index 9a321614..75c98959 100644 --- a/packages/remark-lint-rule-style/index.js +++ b/packages/remark-lint-rule-style/index.js @@ -7,8 +7,8 @@ * Warn when the thematic breaks (horizontal rules) violate a given or * detected style. * - * Options: `string`, either a valid thematic breaks, or `'consistent'`, - * default: `'consistent'`. + * Options: `string`, either a corect thematic breaks such as `***`, or + * `'consistent'`, default: `'consistent'`. * * `'consistent'` detects the first used thematic break style and warns when * subsequent rules use different styles. @@ -28,31 +28,31 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md", "setting": "* * *"} + * @example {"name": "ok.md", "setting": "* * *"} * * * * * * * * * * * - * @example {"name": "valid.md", "setting": "_______"} + * @example {"name": "ok.md", "setting": "_______"} * * _______ * * _______ * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * *** * * * * * * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 3:1-3:6: Rules should use `***` * - * @example {"name": "invalid.md", "label": "output", "setting": "!!!", "config": {"positionless": true}} + * @example {"name": "not-ok.md", "label": "output", "setting": "💩", "config": {"positionless": true}} * - * 1:1: Invalid preferred rule-style: provide a valid markdown rule, or `'consistent'` + * 1:1: Incorrect preferred rule style: provide a correct markdown rule or `'consistent'` */ 'use strict' @@ -74,7 +74,7 @@ function ruleStyle(tree, file, pref) { if (pref !== null && /[^-_* ]/.test(pref)) { file.fail( - "Invalid preferred rule-style: provide a valid markdown rule, or `'consistent'`" + "Incorrect preferred rule style: provide a correct markdown rule or `'consistent'`" ) } diff --git a/packages/remark-lint-rule-style/readme.md b/packages/remark-lint-rule-style/readme.md index e7be7c79..0439f9b8 100644 --- a/packages/remark-lint-rule-style/readme.md +++ b/packages/remark-lint-rule-style/readme.md @@ -13,8 +13,8 @@ Warn when the thematic breaks (horizontal rules) violate a given or detected style. -Options: `string`, either a valid thematic breaks, or `'consistent'`, -default: `'consistent'`. +Options: `string`, either a corect thematic breaks such as `***`, or +`'consistent'`, default: `'consistent'`. `'consistent'` detects the first used thematic break style and warns when subsequent rules use different styles. @@ -45,7 +45,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` When configured with `'* * *'`. @@ -61,7 +61,7 @@ When configured with `'* * *'`. No messages. -##### `valid.md` +##### `ok.md` When configured with `'_______'`. @@ -77,7 +77,7 @@ _______ No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -93,14 +93,14 @@ No messages. 3:1-3:6: Rules should use `***` ``` -##### `invalid.md` +##### `not-ok.md` -When configured with `'!!!'`. +When configured with `'💩'`. ###### Out ```text -1:1: Invalid preferred rule-style: provide a valid markdown rule, or `'consistent'` +1:1: Incorrect preferred rule style: provide a correct markdown rule or `'consistent'` ``` ## Install @@ -116,16 +116,16 @@ npm install remark-lint-rule-style You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-rule-style", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -137,15 +137,15 @@ remark -u lint -u lint-rule-style readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-rule-style')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -154,8 +154,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -184,7 +184,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-strong-marker/index.js b/packages/remark-lint-strong-marker/index.js index 70aa94c8..91f6ccc2 100644 --- a/packages/remark-lint-strong-marker/index.js +++ b/packages/remark-lint-strong-marker/index.js @@ -22,33 +22,33 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * **foo** and **bar**. * - * @example {"name": "also-valid.md"} + * @example {"name": "also-ok.md"} * * __foo__ and __bar__. * - * @example {"name": "valid.md", "setting": "*"} + * @example {"name": "ok.md", "setting": "*"} * * **foo**. * - * @example {"name": "valid.md", "setting": "_"} + * @example {"name": "ok.md", "setting": "_"} * * __foo__. * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * **foo** and __bar__. * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:13-1:20: Strong should use `*` as a marker * - * @example {"name": "invalid.md", "label": "output", "setting": "!", "config": {"positionless": true}} + * @example {"name": "not-ok.md", "label": "output", "setting": "💩", "config": {"positionless": true}} * - * 1:1: Invalid strong marker `!`: use either `'consistent'`, `'*'`, or `'_'` + * 1:1: Incorrect strong marker `💩`: use either `'consistent'`, `'*'`, or `'_'` */ 'use strict' @@ -69,7 +69,7 @@ function strongMarker(tree, file, pref) { if (markers[pref] !== true) { file.fail( - 'Invalid strong marker `' + + 'Incorrect strong marker `' + pref + "`: use either `'consistent'`, `'*'`, or `'_'`" ) diff --git a/packages/remark-lint-strong-marker/readme.md b/packages/remark-lint-strong-marker/readme.md index 38670755..23881c34 100644 --- a/packages/remark-lint-strong-marker/readme.md +++ b/packages/remark-lint-strong-marker/readme.md @@ -39,7 +39,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -51,7 +51,7 @@ This rule is included in the following presets: No messages. -##### `also-valid.md` +##### `also-ok.md` ###### In @@ -63,7 +63,7 @@ __foo__ and __bar__. No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -77,7 +77,7 @@ No messages. 1:13-1:20: Strong should use `*` as a marker ``` -##### `valid.md` +##### `ok.md` When configured with `'*'`. @@ -91,7 +91,7 @@ When configured with `'*'`. No messages. -##### `valid.md` +##### `ok.md` When configured with `'_'`. @@ -105,14 +105,14 @@ __foo__. No messages. -##### `invalid.md` +##### `not-ok.md` -When configured with `'!'`. +When configured with `'💩'`. ###### Out ```text -1:1: Invalid strong marker `!`: use either `'consistent'`, `'*'`, or `'_'` +1:1: Incorrect strong marker `💩`: use either `'consistent'`, `'*'`, or `'_'` ``` ## Install @@ -128,16 +128,16 @@ npm install remark-lint-strong-marker You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-strong-marker", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -149,15 +149,15 @@ remark -u lint -u lint-strong-marker readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-strong-marker')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -166,8 +166,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -196,7 +196,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-table-cell-padding/index.js b/packages/remark-lint-table-cell-padding/index.js index 05ca181b..55c42577 100644 --- a/packages/remark-lint-table-cell-padding/index.js +++ b/packages/remark-lint-table-cell-padding/index.js @@ -22,13 +22,13 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md", "setting": "padded"} + * @example {"name": "ok.md", "setting": "padded"} * * | A | B | * | ----- | ----- | * | Alpha | Bravo | * - * @example {"name": "invalid.md", "label": "input", "setting": "padded"} + * @example {"name": "not-ok.md", "label": "input", "setting": "padded"} * * | A | B | * | :----|----: | @@ -44,7 +44,7 @@ * | :---- | -------- | :----: | -----: | * | Echo | Foxtrot | Golf | Hotel | * - * @example {"name": "invalid.md", "label": "output", "setting": "padded"} + * @example {"name": "not-ok.md", "label": "output", "setting": "padded"} * * 3:8: Cell should be padded * 3:9: Cell should be padded @@ -53,13 +53,13 @@ * 13:23: Cell should be padded with 1 space, not 2 * 13:32: Cell should be padded with 1 space, not 2 * - * @example {"name": "valid.md", "setting": "compact"} + * @example {"name": "ok.md", "setting": "compact"} * * |A |B | * |-----|-----| * |Alpha|Bravo| * - * @example {"name": "invalid.md", "label": "input", "setting": "compact"} + * @example {"name": "not-ok.md", "label": "input", "setting": "compact"} * * | A | B | * | -----| -----| @@ -69,13 +69,13 @@ * |:------|-----:| * |Charlie|Delta | * - * @example {"name": "invalid.md", "label": "output", "setting": "compact"} + * @example {"name": "not-ok.md", "label": "output", "setting": "compact"} * * 3:5: Cell should be compact * 3:12: Cell should be compact * 7:15: Cell should be compact * - * @example {"name": "valid-padded.md", "setting": "consistent"} + * @example {"name": "ok-padded.md", "setting": "consistent"} * * | A | B | * | ----- | ----- | @@ -85,7 +85,7 @@ * | ------- | ----- | * | Charlie | Delta | * - * @example {"name": "invalid-padded.md", "label": "input", "setting": "consistent"} + * @example {"name": "not-ok-padded.md", "label": "input", "setting": "consistent"} * * | A | B | * | ----- | ----- | @@ -95,11 +95,11 @@ * | :----- | ----: | * |Charlie | Delta | * - * @example {"name": "invalid-padded.md", "label": "output", "setting": "consistent"} + * @example {"name": "not-ok-padded.md", "label": "output", "setting": "consistent"} * * 7:2: Cell should be padded * - * @example {"name": "valid-compact.md", "setting": "consistent"} + * @example {"name": "ok-compact.md", "setting": "consistent"} * * |A |B | * |-----|-----| @@ -109,7 +109,7 @@ * |-------|-----| * |Charlie|Delta| * - * @example {"name": "invalid-compact.md", "label": "input", "setting": "consistent"} + * @example {"name": "not-ok-compact.md", "label": "input", "setting": "consistent"} * * |A |B | * |-----|-----| @@ -119,13 +119,13 @@ * |:------|-----:| * |Charlie|Delta | * - * @example {"name": "invalid-compact.md", "label": "output", "setting": "consistent"} + * @example {"name": "not-ok-compact.md", "label": "output", "setting": "consistent"} * * 7:15: Cell should be compact * - * @example {"name": "invalid.md", "label": "output", "setting": "invalid", "config": {"positionless": true}} + * @example {"name": "not-ok.md", "label": "output", "setting": "💩", "config": {"positionless": true}} * - * 1:1: Invalid table-cell-padding style `invalid` + * 1:1: Incorrect table cell padding style `💩`, expected `'padded'`, `'compact'`, or `'consistent'` * * @example {"name": "empty.md", "label": "input", "setting": "padded"} * @@ -171,7 +171,11 @@ function tableCellPadding(tree, file, pref) { pref = typeof pref === 'string' && pref !== 'consistent' ? pref : null if (styles[pref] !== true) { - file.fail('Invalid table-cell-padding style `' + pref + '`') + file.fail( + 'Incorrect table cell padding style `' + + pref + + "`, expected `'padded'`, `'compact'`, or `'consistent'`" + ) } visit(tree, 'table', visitor) diff --git a/packages/remark-lint-table-cell-padding/readme.md b/packages/remark-lint-table-cell-padding/readme.md index 2cb76fea..669bcd47 100644 --- a/packages/remark-lint-table-cell-padding/readme.md +++ b/packages/remark-lint-table-cell-padding/readme.md @@ -39,7 +39,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` When configured with `'padded'`. @@ -55,7 +55,7 @@ When configured with `'padded'`. No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `'padded'`. @@ -129,7 +129,7 @@ When configured with `'padded'`. No messages. -##### `valid.md` +##### `ok.md` When configured with `'compact'`. @@ -145,7 +145,7 @@ When configured with `'compact'`. No messages. -##### `invalid.md` +##### `not-ok.md` When configured with `'compact'`. @@ -169,7 +169,7 @@ When configured with `'compact'`. 7:15: Cell should be compact ``` -##### `valid-padded.md` +##### `ok-padded.md` When configured with `'consistent'`. @@ -189,7 +189,7 @@ When configured with `'consistent'`. No messages. -##### `invalid-padded.md` +##### `not-ok-padded.md` When configured with `'consistent'`. @@ -211,7 +211,7 @@ When configured with `'consistent'`. 7:2: Cell should be padded ``` -##### `valid-compact.md` +##### `ok-compact.md` When configured with `'consistent'`. @@ -231,7 +231,7 @@ When configured with `'consistent'`. No messages. -##### `invalid-compact.md` +##### `not-ok-compact.md` When configured with `'consistent'`. @@ -253,14 +253,14 @@ When configured with `'consistent'`. 7:15: Cell should be compact ``` -##### `invalid.md` +##### `not-ok.md` -When configured with `'invalid'`. +When configured with `'💩'`. ###### Out ```text -1:1: Invalid table-cell-padding style `invalid` +1:1: Incorrect table cell padding style `💩`, expected `'padded'`, `'compact'`, or `'consistent'` ``` ## Install @@ -276,16 +276,16 @@ npm install remark-lint-table-cell-padding You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-table-cell-padding", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -297,15 +297,15 @@ remark -u lint -u lint-table-cell-padding readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-table-cell-padding')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -314,8 +314,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -344,7 +344,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-table-pipe-alignment/index.js b/packages/remark-lint-table-pipe-alignment/index.js index 92d4ff67..0f0c7741 100644 --- a/packages/remark-lint-table-pipe-alignment/index.js +++ b/packages/remark-lint-table-pipe-alignment/index.js @@ -25,19 +25,19 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * | A | B | * | ----- | ----- | * | Alpha | Bravo | * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * | A | B | * | -- | -- | * | Alpha | Bravo | * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 3:9-3:10: Misaligned table fence * 3:17-3:18: Misaligned table fence diff --git a/packages/remark-lint-table-pipe-alignment/readme.md b/packages/remark-lint-table-pipe-alignment/readme.md index a3982caf..7bf6fb16 100644 --- a/packages/remark-lint-table-pipe-alignment/readme.md +++ b/packages/remark-lint-table-pipe-alignment/readme.md @@ -41,7 +41,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -55,7 +55,7 @@ This rule is included in the following presets: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -85,16 +85,16 @@ npm install remark-lint-table-pipe-alignment You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-table-pipe-alignment", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -106,15 +106,15 @@ remark -u lint -u lint-table-pipe-alignment readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-table-pipe-alignment')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -123,8 +123,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -153,7 +153,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-table-pipes/index.js b/packages/remark-lint-table-pipes/index.js index 4335d20a..6b44b802 100644 --- a/packages/remark-lint-table-pipes/index.js +++ b/packages/remark-lint-table-pipes/index.js @@ -17,19 +17,19 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * | A | B | * | ----- | ----- | * | Alpha | Bravo | * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * A | B * ----- | ----- * Alpha | Bravo * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 1:1: Missing initial pipe in table fence * 1:10: Missing final pipe in table fence diff --git a/packages/remark-lint-table-pipes/readme.md b/packages/remark-lint-table-pipes/readme.md index 0d2d3787..9dd873e0 100644 --- a/packages/remark-lint-table-pipes/readme.md +++ b/packages/remark-lint-table-pipes/readme.md @@ -33,7 +33,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -47,7 +47,7 @@ This rule is included in the following presets: No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -79,16 +79,16 @@ npm install remark-lint-table-pipes You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-table-pipes", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -100,15 +100,15 @@ remark -u lint -u lint-table-pipes readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-table-pipes')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -117,8 +117,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -147,7 +147,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint-unordered-list-marker-style/index.js b/packages/remark-lint-unordered-list-marker-style/index.js index 5640843f..8979e86f 100644 --- a/packages/remark-lint-unordered-list-marker-style/index.js +++ b/packages/remark-lint-unordered-list-marker-style/index.js @@ -23,7 +23,7 @@ * See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown) * on how to automatically fix warnings for this rule. * - * @example {"name": "valid.md"} + * @example {"name": "ok.md"} * * By default (`'consistent'`), if the file uses only one marker, * that’s OK. @@ -38,32 +38,32 @@ * 2. Bar * 3. Baz * - * @example {"name": "valid.md", "setting": "*"} + * @example {"name": "ok.md", "setting": "*"} * * * Foo * - * @example {"name": "valid.md", "setting": "-"} + * @example {"name": "ok.md", "setting": "-"} * * - Foo * - * @example {"name": "valid.md", "setting": "+"} + * @example {"name": "ok.md", "setting": "+"} * * + Foo * - * @example {"name": "invalid.md", "label": "input"} + * @example {"name": "not-ok.md", "label": "input"} * * * Foo * - Bar * + Baz * - * @example {"name": "invalid.md", "label": "output"} + * @example {"name": "not-ok.md", "label": "output"} * * 2:1-2:6: Marker style should be `*` * 3:1-3:6: Marker style should be `*` * - * @example {"name": "invalid.md", "label": "output", "setting": "!", "config": {"positionless": true}} + * @example {"name": "not-ok.md", "label": "output", "setting": "💩", "config": {"positionless": true}} * - * 1:1: Invalid unordered list-item marker style `!`: use either `'-'`, `'*'`, or `'+'` + * 1:1: Incorrect unordered list item marker style `💩`: use either `'-'`, `'*'`, or `'+'` */ 'use strict' @@ -94,7 +94,7 @@ function unorderedListMarkerStyle(tree, file, pref) { if (styles[pref] !== true) { file.fail( - 'Invalid unordered list-item marker style `' + + 'Incorrect unordered list item marker style `' + pref + "`: use either `'-'`, `'*'`, or `'+'`" ) diff --git a/packages/remark-lint-unordered-list-marker-style/readme.md b/packages/remark-lint-unordered-list-marker-style/readme.md index f27c9a9b..5f6f61b7 100644 --- a/packages/remark-lint-unordered-list-marker-style/readme.md +++ b/packages/remark-lint-unordered-list-marker-style/readme.md @@ -39,7 +39,7 @@ This rule is included in the following presets: ## Example -##### `valid.md` +##### `ok.md` ###### In @@ -62,7 +62,7 @@ Ordered lists are not affected. No messages. -##### `invalid.md` +##### `not-ok.md` ###### In @@ -79,7 +79,7 @@ No messages. 3:1-3:6: Marker style should be `*` ``` -##### `valid.md` +##### `ok.md` When configured with `'*'`. @@ -93,7 +93,7 @@ When configured with `'*'`. No messages. -##### `valid.md` +##### `ok.md` When configured with `'-'`. @@ -107,7 +107,7 @@ When configured with `'-'`. No messages. -##### `valid.md` +##### `ok.md` When configured with `'+'`. @@ -121,14 +121,14 @@ When configured with `'+'`. No messages. -##### `invalid.md` +##### `not-ok.md` -When configured with `'!'`. +When configured with `'💩'`. ###### Out ```text -1:1: Invalid unordered list-item marker style `!`: use either `'-'`, `'*'`, or `'+'` +1:1: Incorrect unordered list item marker style `💩`: use either `'-'`, `'*'`, or `'+'` ``` ## Install @@ -144,16 +144,16 @@ npm install remark-lint-unordered-list-marker-style You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … "lint", + "lint-unordered-list-marker-style", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -165,15 +165,15 @@ remark -u lint -u lint-unordered-list-marker-style readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() .use(require('remark-lint')) + .use(require('remark-lint-unordered-list-marker-style')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -182,8 +182,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -212,7 +212,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-lint/readme.md b/packages/remark-lint/readme.md index 69f614b2..b3c98e7d 100644 --- a/packages/remark-lint/readme.md +++ b/packages/remark-lint/readme.md @@ -31,15 +31,15 @@ npm install remark-lint You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { "plugins": [ - ... + … + "lint", - ... + … ] } - ... + … ``` Or use it on the CLI directly @@ -51,13 +51,13 @@ remark -u lint readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() + .use(require('remark-lint')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); + console.error(report(err || file)) }); ``` @@ -67,8 +67,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -99,7 +99,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-preset-lint-consistent/readme.md b/packages/remark-preset-lint-consistent/readme.md index ae50a675..32ed4e44 100644 --- a/packages/remark-preset-lint-consistent/readme.md +++ b/packages/remark-preset-lint-consistent/readme.md @@ -45,11 +45,11 @@ npm install remark-preset-lint-consistent You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { + "plugins": ["preset-lint-consistent"] } - ... + … ``` Or use it on the CLI directly @@ -61,14 +61,14 @@ remark -u preset-lint-consistent readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() + .use(require('remark-preset-lint-consistent')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -77,8 +77,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -107,7 +107,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-preset-lint-markdown-style-guide/index.js b/packages/remark-preset-lint-markdown-style-guide/index.js index b73fda7f..7a2c0d18 100644 --- a/packages/remark-preset-lint-markdown-style-guide/index.js +++ b/packages/remark-preset-lint-markdown-style-guide/index.js @@ -28,10 +28,10 @@ * * ```diff * "plugins": [ - * ... + * … * "preset-lint-markdown-style-guide", * + ["lint-maximum-line-length", false] - * ... + * … * ] * ``` * @@ -43,10 +43,10 @@ * * ```diff * "plugins": [ - * ... + * … * "preset-lint-markdown-style-guide", * + ["lint-heading-style", "setext"] - * ... + * … * ] * ``` * @@ -58,10 +58,10 @@ * * ```diff * "plugins": [ - * ... + * … * "preset-lint-markdown-style-guide", * + ["lint-unordered-list-marker-style", "*"] - * ... + * … * ] * ``` * @@ -73,10 +73,10 @@ * * ```diff * "plugins": [ - * ... + * … * "preset-lint-markdown-style-guide", * + ["lint-list-item-indent", "space"] - * ... + * … * ] * ``` * @@ -88,10 +88,10 @@ * * ```diff * "plugins": [ - * ... + * … * "preset-lint-markdown-style-guide", * + ["lint-code-block-style", "indented"] - * ... + * … * ] * ``` */ diff --git a/packages/remark-preset-lint-markdown-style-guide/readme.md b/packages/remark-preset-lint-markdown-style-guide/readme.md index 9c28cfa7..7dbcd5b0 100644 --- a/packages/remark-preset-lint-markdown-style-guide/readme.md +++ b/packages/remark-preset-lint-markdown-style-guide/readme.md @@ -38,10 +38,10 @@ To use `wrap:no`, turn off `remark-lint-maximum-line-length` like so: ```diff "plugins": [ - ... + … "preset-lint-markdown-style-guide", + ["lint-maximum-line-length", false] - ... + … ] ``` @@ -53,10 +53,10 @@ like so: ```diff "plugins": [ - ... + … "preset-lint-markdown-style-guide", + ["lint-heading-style", "setext"] - ... + … ] ``` @@ -68,10 +68,10 @@ For `list-marker:asterisk` or `list-marker:plus`, change the setting for ```diff "plugins": [ - ... + … "preset-lint-markdown-style-guide", + ["lint-unordered-list-marker-style", "*"] - ... + … ] ``` @@ -83,10 +83,10 @@ like so: ```diff "plugins": [ - ... + … "preset-lint-markdown-style-guide", + ["lint-list-item-indent", "space"] - ... + … ] ``` @@ -98,10 +98,10 @@ like so: ```diff "plugins": [ - ... + … "preset-lint-markdown-style-guide", + ["lint-code-block-style", "indented"] - ... + … ] ``` @@ -169,11 +169,11 @@ npm install remark-preset-lint-markdown-style-guide You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { + "plugins": ["preset-lint-markdown-style-guide"] } - ... + … ``` Or use it on the CLI directly @@ -185,14 +185,14 @@ remark -u preset-lint-markdown-style-guide readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() + .use(require('remark-preset-lint-markdown-style-guide')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -201,8 +201,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -231,7 +231,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/remark-preset-lint-recommended/readme.md b/packages/remark-preset-lint-recommended/readme.md index f0528487..b969de2f 100644 --- a/packages/remark-preset-lint-recommended/readme.md +++ b/packages/remark-preset-lint-recommended/readme.md @@ -48,11 +48,11 @@ npm install remark-preset-lint-recommended You probably want to use it on the CLI through a config file: ```diff - ... + … "remarkConfig": { + "plugins": ["preset-lint-recommended"] } - ... + … ``` Or use it on the CLI directly @@ -64,14 +64,14 @@ remark -u preset-lint-recommended readme.md Or use this on the API: ```diff - var remark = require('remark'); - var report = require('vfile-reporter'); + var remark = require('remark') + var report = require('vfile-reporter') remark() + .use(require('remark-preset-lint-recommended')) .process('_Emphasis_ and **importance**', function (err, file) { - console.error(report(err || file)); - }); + console.error(report(err || file)) + }) ``` ## Contribute @@ -80,8 +80,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -110,7 +110,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/packages/unified-lint-rule/index.js b/packages/unified-lint-rule/index.js index eff7dee9..fee90b34 100644 --- a/packages/unified-lint-rule/index.js +++ b/packages/unified-lint-rule/index.js @@ -101,7 +101,7 @@ function coerce(name, value) { if (level < 0 || level > 2) { throw new Error( - 'Invalid severity `' + + 'Incorrect severity `' + level + '` for `' + name + diff --git a/packages/unified-lint-rule/readme.md b/packages/unified-lint-rule/readme.md index aee0ed8a..9b84fbcb 100644 --- a/packages/unified-lint-rule/readme.md +++ b/packages/unified-lint-rule/readme.md @@ -27,13 +27,12 @@ var rule = require('unified-lint-rule') module.exports = rule('remark-lint:file-extension', fileExtension) -function fileExtension(tree, file, pref) { +function fileExtension(tree, file, option) { var ext = file.extname + var preferred = typeof option === 'string' ? option : 'md' - pref = typeof pref === 'string' ? pref : 'md' - - if (ext && ext.slice(1) !== pref) { - file.message('Invalid extension: use `' + pref + '`') + if (ext && ext.slice(1) !== preferred) { + file.message('Incorrect extension: use `' + preferred + '`') } } ``` @@ -44,8 +43,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -74,7 +73,7 @@ abide by its terms. [collective]: https://opencollective.com/unified -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/readme.md b/readme.md index d10f71bc..3adb52c4 100644 --- a/readme.md +++ b/readme.md @@ -21,17 +21,17 @@ That’s up to you, but there are sensible [presets][]. `remark-lint` is built on [**remark**][remark], a powerful Markdown processor powered by [plugins][remark-plugins] (such as these). -## Table of Contents +## Contents * [Install](#install) * [CLI](#cli) * [API](#api) -* [Configuring remark-lint](#configuring-remark-lint) +* [Configuring `remark-lint`](#configuring-remark-lint) * [Using remark to fix your Markdown](#using-remark-to-fix-your-markdown) * [Integrations](#integrations) * [Rules](#rules) -* [List of Presets](#list-of-presets) -* [List of External Rules](#list-of-external-rules) +* [List of presets](#list-of-presets) +* [List of external rules](#list-of-external-rules) * [Security](#security) * [Related](#related) * [Contribute](#contribute) @@ -47,7 +47,7 @@ npm install remark-lint ## CLI -![Example of how remark-lint looks on screen][screenshot] +![][screenshot] Use `remark-lint` with [`remark-cli`][cli] through a [preset][preset-recommended]. @@ -59,15 +59,15 @@ npm install --save remark-cli remark-preset-lint-recommended Then, configure **remark** in your `package.json`: ```js - // ... + // … "scripts": { "lint-md": "remark ." }, - // ... + // … "remarkConfig": { "plugins": ["remark-preset-lint-recommended"] } - // ... + // … ``` Let’s say there’s an `example.md` that looks as follows: @@ -120,7 +120,7 @@ Now, running `node example.js` yields: ⚠ 1 warning ``` -## Configuring remark-lint +## Configuring `remark-lint` `remark-lint` is a **remark** plugin and when used on the CLI supports configuration through its [configuration files][cli]. @@ -174,7 +174,7 @@ The following file will warn twice for the duplicate headings: ``` The following file will warn once (the second heading is ignored, but the third -is re-enabled): +is enabled again): ```markdown # Hello @@ -269,8 +269,8 @@ previous example. If you’re using [`remark-cli`][cli], [`remark-stringify`][remark-stringify] is included unless an output format other than markdown (such as HTML) is defined. In this case you can configure `remark-stringify` settings using the [`-s, ---settings`][cli-settings] flag or a `"settings"` property in [remark -configuration files][cli-config]. +--settings`][cli-settings] flag or a `"settings"` field in [remark configuration +files][cli-config]. Say we have the following file, `example.md`: @@ -281,7 +281,7 @@ _Hello_, __world__! And our `package.json` looks as follows: ```js - // ... + // … "remarkConfig": { "settings": { "emphasis": "*", @@ -292,7 +292,7 @@ And our `package.json` looks as follows: "remark-lint-strong-marker" ] } - // ... + // … ``` Now, running `remark example.md` yields warnings and a formatted file: @@ -314,9 +314,9 @@ example.md ## Integrations -* [linter-markdown][] ([Atom][]) — use remark-lint from Atom +* [linter-markdown][] ([Atom][]) — use `remark-lint` from Atom * [linter-remark][] ([Atom][]) — use all of remark from Atom -* [SublimeLinter-contrib-remark-lint][] ([Sublime][]) — use remark-lint from Sublime Text +* [SublimeLinter-contrib-remark-lint][] ([Sublime][]) — use `remark-lint` from Sublime Text * [ale][] ([Vim][]) — use remark-lint from Vim * [gulp-remark][] ([Gulp][]) — use all of remark with Gulp * [grunt-remark][] ([Grunt][]) — use all of remark with Grunt @@ -329,7 +329,7 @@ Let us know if we can help. [`doc/rules.md`][rules] lists all available official rules. -## List of Presets +## List of presets Presets can be loaded just like other plugins. @@ -341,7 +341,7 @@ Presets can be loaded just like other plugins. -## List of External Rules +## List of external rules External rules can be loaded just like normal rules. @@ -353,7 +353,7 @@ This list is ordered based on the name without prefix, so excluding * [`remark-lint-alphabetize-lists`](https://github.com/vhf/remark-lint-alphabetize-lists) — Ensure list items are in alphabetical order * [`remark-lint-appropriate-heading`](https://github.com/RichardLitt/remark-lint-appropriate-heading) - — Check that the top-level heading matches the directory name + — Check that the top level heading matches the directory name * [`remark-lint-blank-lines-1-0-2`](https://github.com/vhf/remark-lint-blank-lines-1-0-2) — Ensure a specific number of lines between blocks * [`remark-lint-books-links`](https://github.com/vhf/remark-lint-books-links) @@ -364,7 +364,7 @@ This list is ordered based on the name without prefix, so excluding * [`remark-lint-match-punctuation`](https://github.com/laysent/remark-lint-plugins/tree/master/packages/remark-lint-match-punctuation) — Ensures punctuations are used in pairs if necessary. * [`remark-lint-mdash-style`](https://github.com/alexandrtovmach/remark-lint-mdash-style) - — Ensure mdash style follows a standard format + — Ensure em-dash (`—`) style follows a standard format * [`remark-lint-no-chinese-punctuation-in-number`](https://github.com/laysent/remark-lint-plugins/tree/master/packages/remark-lint-no-chinese-punctuation-in-number) — Ensures that Chinese punctuation will not be used in number, such as 1,000 or 12:34. * [`remark-lint-no-dead-urls`](https://github.com/davidtheclark/remark-lint-no-dead-urls) @@ -390,7 +390,7 @@ This list is ordered based on the name without prefix, so excluding * [`remark-lint-no-url-trailing-slash`](https://github.com/vhf/remark-lint-no-url-trailing-slash) — Ensure that the `href` of links has no trailing slash * [`remark-lint-write-good`](https://github.com/zerok/remark-lint-write-good) - — Wrapper for write-good + — Wrapper for `write-good` ## Security @@ -410,8 +410,8 @@ See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. -This project has a [Code of Conduct][coc]. -By interacting with this repository, organisation, or community you agree to +This project has a [code of conduct][coc]. +By interacting with this repository, organization, or community you agree to abide by its terms. ## License @@ -432,7 +432,7 @@ abide by its terms. [downloads]: https://www.npmjs.com/package/remark-lint -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg [chat]: https://spectrum.chat/unified/remark diff --git a/script/build-presets.js b/script/build-presets.js index 4f6b908e..c41f3f81 100644 --- a/script/build-presets.js +++ b/script/build-presets.js @@ -128,11 +128,11 @@ presets(root).forEach(function (basename) { 'code', {lang: 'diff'}, [ - ' ...', + ' …', ' "remarkConfig": {', '+ "plugins": ["' + short + '"]', ' }', - ' ...' + ' …' ].join('\n') ), u('paragraph', [u('text', 'Or use it on the CLI directly')]), @@ -142,14 +142,14 @@ presets(root).forEach(function (basename) { 'code', {lang: 'diff'}, [ - " var remark = require('remark');", - " var report = require('vfile-reporter');", + " var remark = require('remark')", + " var report = require('vfile-reporter')", '', ' remark()', "+ .use(require('" + basename + "'))", " .process('_Emphasis_ and **importance**', function (err, file) {", - ' console.error(report(err || file));', - ' });' + ' console.error(report(err || file))', + ' })' ].join('\n') ), u('heading', {depth: 2}, [u('text', 'Contribute')]), @@ -170,10 +170,10 @@ presets(root).forEach(function (basename) { ]), u('paragraph', [ u('text', 'This project has a '), - u('linkReference', {identifier: 'coc'}, [u('text', 'Code of Conduct')]), + u('linkReference', {identifier: 'coc'}, [u('text', 'code of conduct')]), u( 'text', - '.\nBy interacting with this repository, organisation, or community you agree to\nabide by its terms.' + '.\nBy interacting with this repository, organization, or community you agree to\nabide by its terms.' ) ]), u('heading', {depth: 2}, [u('text', 'License')]), @@ -228,8 +228,7 @@ presets(root).forEach(function (basename) { }), u('definition', { identifier: 'chat-badge', - url: - 'https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg' + url: 'https://img.shields.io/badge/chat-spectrum.svg' }), u('definition', { identifier: 'chat', diff --git a/script/build-rules.js b/script/build-rules.js index aa813dad..108ff2aa 100644 --- a/script/build-rules.js +++ b/script/build-rules.js @@ -208,16 +208,16 @@ rules(root).forEach(function (basename) { 'code', {lang: 'diff'}, [ - ' ...', + ' …', ' "remarkConfig": {', ' "plugins": [', - ' ...', + ' …', ' "lint",', '+ "' + short + '",', - ' ...', + ' …', ' ]', ' }', - ' ...' + ' …' ].join('\n') ), u('paragraph', [u('text', 'Or use it on the CLI directly')]), @@ -227,15 +227,15 @@ rules(root).forEach(function (basename) { 'code', {lang: 'diff'}, [ - " var remark = require('remark');", - " var report = require('vfile-reporter');", + " var remark = require('remark')", + " var report = require('vfile-reporter')", '', ' remark()', " .use(require('remark-lint'))", "+ .use(require('" + basename + "'))", " .process('_Emphasis_ and **importance**', function (err, file) {", - ' console.error(report(err || file));', - ' });' + ' console.error(report(err || file))', + ' })' ].join('\n') ), u('heading', {depth: 2}, [u('text', 'Contribute')]), @@ -256,10 +256,10 @@ rules(root).forEach(function (basename) { ]), u('paragraph', [ u('text', 'This project has a '), - u('linkReference', {identifier: 'coc'}, [u('text', 'Code of Conduct')]), + u('linkReference', {identifier: 'coc'}, [u('text', 'code of conduct')]), u( 'text', - '.\nBy interacting with this repository, organisation, or community you agree to\nabide by its terms.' + '.\nBy interacting with this repository, organization, or community you agree to\nabide by its terms.' ) ]), u('heading', {depth: 2}, [u('text', 'License')]), @@ -314,8 +314,7 @@ rules(root).forEach(function (basename) { }), u('definition', { identifier: 'chat-badge', - url: - 'https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg' + url: 'https://img.shields.io/badge/chat-spectrum.svg' }), u('definition', { identifier: 'chat', diff --git a/script/util/rule.js b/script/util/rule.js index cd029cfe..fe09358b 100755 --- a/script/util/rule.js +++ b/script/util/rule.js @@ -27,7 +27,7 @@ function ruleSync(filePath) { /* istanbul ignore if */ if (name !== ruleId) { - throw new Error(ruleId + ' has an invalid `@module`: ' + name) + throw new Error(ruleId + ' has an incorrect `@module`: ' + name) } /* istanbul ignore if */ diff --git a/test.js b/test.js index 19627726..eccfda0c 100644 --- a/test.js +++ b/test.js @@ -234,12 +234,12 @@ test('core', function (t) { }) }) - t.test('should fail on invalid severities', function (st) { + t.test('should fail on incorrect severities', function (st) { st.throws( function () { remark().use(finalNewline, [3]).freeze() }, - /^Error: Invalid severity `3` for `final-newline`, expected 0, 1, or 2$/, + /^Error: Incorrect severity `3` for `final-newline`, expected 0, 1, or 2$/, 'should throw when too high' ) @@ -247,7 +247,7 @@ test('core', function (t) { function () { remark().use(finalNewline, [-1]).freeze() }, - /^Error: Invalid severity `-1` for `final-newline`, expected 0, 1, or 2$/, + /^Error: Incorrect severity `-1` for `final-newline`, expected 0, 1, or 2$/, 'should throw too low' )