Rename correct-link-syntax -> correct-media-syntax

remarkjs · Jan 14, 2025 · 38632d3 · 38632d3
1 parent 86226a4
commit 38632d3
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 30 deletions.
diff --git a/package.json b/package.json
@@ -42,7 +42,7 @@
     "packages/remark-lint-checkbox-character-style/",
     "packages/remark-lint-checkbox-content-indent/",
     "packages/remark-lint-code-block-style/",
-    "packages/remark-lint-correct-link-syntax/",
+    "packages/remark-lint-correct-media-syntax/",
     "packages/remark-lint-definition-case/",
     "packages/remark-lint-definition-sort/",
     "packages/remark-lint-definition-spacing/",

diff --git a/...es/remark-lint-correct-link-syntax/.npmrc → ...s/remark-lint-correct-media-syntax/.npmrc b/...es/remark-lint-correct-link-syntax/.npmrc → ...s/remark-lint-correct-media-syntax/.npmrc
diff --git a/.../remark-lint-correct-link-syntax/index.js → ...remark-lint-correct-media-syntax/index.js b/.../remark-lint-correct-link-syntax/index.js → ...remark-lint-correct-media-syntax/index.js
@@ -14,7 +14,7 @@
  *
  * ## API
  *
- * ### `unified().use(remarkLintCorrectLinkSyntax)`
+ * ### `unified().use(remarkLintCorrectMediaSyntax)`
  *
  * Warn for accidental bracket and paren mixup for images and links.
  *
@@ -26,10 +26,10 @@
  *
  * Transform ([`Transformer` from `unified`][github-unified-transformer]).
  *
- * [api-remark-lint-correct-link-syntax]: #unifieduseremarklintcorrectlinksyntax
+ * [api-remark-lint-correct-media-syntax]: #unifieduseremarklintcorrectmediasyntax
  * [github-unified-transformer]: https://github.com/unifiedjs/unified#transformer
  *
- * @module correct-link-syntax
+ * @module correct-media-syntax
  * @author Titus Wormer
  * @copyright 2025 Titus Wormer
  * @license MIT
@@ -61,10 +61,10 @@ import {pointEnd, pointStart} from 'unist-util-position'
 import {visitParents} from 'unist-util-visit-parents'
 import {location} from 'vfile-location'
 
-const remarkLintCorrectLinkSyntax = lintRule(
+const remarkLintCorrectMediaSyntax = lintRule(
   {
-    origin: 'remark-lint:correct-link-syntax',
-    url: 'https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-correct-link-syntax#readme'
+    origin: 'remark-lint:correct-media-syntax',
+    url: 'https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-correct-media-syntax#readme'
   },
   /**
    * @param {Root} tree
@@ -112,4 +112,4 @@ const remarkLintCorrectLinkSyntax = lintRule(
   }
 )
 
-export default remarkLintCorrectLinkSyntax
+export default remarkLintCorrectMediaSyntax
diff --git a/...ark-lint-correct-link-syntax/package.json → ...rk-lint-correct-media-syntax/package.json b/...ark-lint-correct-link-syntax/package.json → ...rk-lint-correct-media-syntax/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "remark-lint-correct-link-syntax",
+  "name": "remark-lint-correct-media-syntax",
   "version": "0.0.0",
   "description": "remark-lint rule to check for accidental bracket and paren mixup for images and links",
   "license": "MIT",
@@ -8,6 +8,7 @@
     "image",
     "link",
     "lint",
+    "media",
     "parenthesis",
     "reference",
     "remark",
@@ -17,15 +18,15 @@
     "rule",
     "syntax"
   ],
-  "repository": "https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-correct-link-syntax",
+  "repository": "https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-correct-media-syntax",
   "bugs": "https://github.com/remarkjs/remark-lint/issues",
   "funding": {
     "type": "opencollective",
     "url": "https://opencollective.com/unified"
   },
   "author": "Titus Wormer <[email protected]> (https://wooorm.com)",
   "contributors": [
-    "Titus Wormer <[email protected]>"
+    "Titus Wormer <[email protected]> (https://wooorm.com)"
   ],
   "sideEffects": false,
   "type": "module",

diff --git a/...remark-lint-correct-link-syntax/readme.md → ...emark-lint-correct-media-syntax/readme.md b/...remark-lint-correct-link-syntax/readme.md → ...emark-lint-correct-media-syntax/readme.md
@@ -1,6 +1,6 @@
 <!--This file is generated-->
 
-# remark-lint-correct-link-syntax
+# remark-lint-correct-media-syntax
 
 [![Build][badge-build-image]][badge-build-url]
 [![Coverage][badge-coverage-image]][badge-coverage-url]
@@ -21,7 +21,7 @@ mixup for images and links.
 * [Install](#install)
 * [Use](#use)
 * [API](#api)
-  * [`unified().use(remarkLintCorrectLinkSyntax)`](#unifieduseremarklintcorrectlinksyntax)
+  * [`unified().use(remarkLintCorrectMediaSyntax)`](#unifieduseremarklintcorrectmediasyntax)
 * [Examples](#examples)
 * [Compatibility](#compatibility)
 * [Contribute](#contribute)
@@ -48,20 +48,20 @@ In Node.js (version 16+),
 install with [npm][npm-install]:
 
 ```sh
-npm install remark-lint-correct-link-syntax
+npm install remark-lint-correct-media-syntax
 ```
 
 In Deno with [`esm.sh`][esm-sh]:
 
 ```js
-import remarkLintCorrectLinkSyntax from 'https://esm.sh/remark-lint-correct-link-syntax@0'
+import remarkLintCorrectMediaSyntax from 'https://esm.sh/remark-lint-correct-media-syntax@0'
 ```
 
 In browsers with [`esm.sh`][esm-sh]:
 
 ```html
 <script type="module">
-  import remarkLintCorrectLinkSyntax from 'https://esm.sh/remark-lint-correct-link-syntax@0?bundle'
+  import remarkLintCorrectMediaSyntax from 'https://esm.sh/remark-lint-correct-media-syntax@0?bundle'
 </script>
 ```
 
@@ -71,7 +71,7 @@ On the API:
 
 ```js
 import remarkLint from 'remark-lint'
-import remarkLintCorrectLinkSyntax from 'remark-lint-correct-link-syntax'
+import remarkLintCorrectMediaSyntax from 'remark-lint-correct-media-syntax'
 import remarkParse from 'remark-parse'
 import remarkStringify from 'remark-stringify'
 import {read} from 'to-vfile'
@@ -83,7 +83,7 @@ const file = await read('example.md')
 await unified()
   .use(remarkParse)
   .use(remarkLint)
-  .use(remarkLintCorrectLinkSyntax)
+  .use(remarkLintCorrectMediaSyntax)
   .use(remarkStringify)
   .process(file)
 
@@ -93,7 +93,7 @@ console.error(reporter(file))
 On the CLI:
 
 ```sh
-remark --frail --use remark-lint --use remark-lint-correct-link-syntax .
+remark --frail --use remark-lint --use remark-lint-correct-media-syntax .
 ```
 
 On the CLI in a config file (here a `package.json`):
@@ -104,7 +104,7 @@ On the CLI in a config file (here a `package.json`):
    "plugins": [
      …
      "remark-lint",
-+    "remark-lint-correct-link-syntax",
++    "remark-lint-correct-media-syntax",
      …
    ]
  }
@@ -116,9 +116,9 @@ On the CLI in a config file (here a `package.json`):
 This package exports no identifiers.
 It exports no additional [TypeScript][typescript] types.
 The default export is
-[`remarkLintCorrectLinkSyntax`][api-remark-lint-correct-link-syntax].
+[`remarkLintCorrectMediaSyntax`][api-remark-lint-correct-media-syntax].
 
-### `unified().use(remarkLintCorrectLinkSyntax)`
+### `unified().use(remarkLintCorrectMediaSyntax)`
 
 Warn for accidental bracket and paren mixup for images and links.
 
@@ -169,7 +169,7 @@ versions of Node.js.
 When we cut a new major release, we drop support for unmaintained versions of
 Node.
 This means we try to keep the current release line,
-`remark-lint-correct-link-syntax@0`,
+`remark-lint-correct-media-syntax@0`,
 compatible with Node.js 16.
 
 ## Contribute
@@ -186,7 +186,7 @@ abide by its terms.
 
 [MIT][file-license] © [Titus Wormer][author]
 
-[api-remark-lint-correct-link-syntax]: #unifieduseremarklintcorrectlinksyntax
+[api-remark-lint-correct-media-syntax]: #unifieduseremarklintcorrectmediasyntax
 
 [author]: https://wooorm.com
 
@@ -202,19 +202,19 @@ abide by its terms.
 
 [badge-coverage-url]: https://codecov.io/github/remarkjs/remark-lint
 
-[badge-downloads-image]: https://img.shields.io/npm/dm/remark-lint-correct-link-syntax.svg
+[badge-downloads-image]: https://img.shields.io/npm/dm/remark-lint-correct-media-syntax.svg
 
-[badge-downloads-url]: https://www.npmjs.com/package/remark-lint-correct-link-syntax
+[badge-downloads-url]: https://www.npmjs.com/package/remark-lint-correct-media-syntax
 
 [badge-funding-backers-image]: https://opencollective.com/unified/backers/badge.svg
 
 [badge-funding-sponsors-image]: https://opencollective.com/unified/sponsors/badge.svg
 
 [badge-funding-url]: https://opencollective.com/unified
 
-[badge-size-image]: https://img.shields.io/bundlejs/size/remark-lint-correct-link-syntax
+[badge-size-image]: https://img.shields.io/bundlejs/size/remark-lint-correct-media-syntax
 
-[badge-size-url]: https://bundlejs.com/?q=remark-lint-correct-link-syntax
+[badge-size-url]: https://bundlejs.com/?q=remark-lint-correct-media-syntax
 
 [esm-sh]: https://esm.sh
 

diff --git a/...rk-lint-correct-link-syntax/tsconfig.json → ...k-lint-correct-media-syntax/tsconfig.json b/...rk-lint-correct-link-syntax/tsconfig.json → ...k-lint-correct-media-syntax/tsconfig.json
diff --git a/packages/remark-lint-media-style/package.json b/packages/remark-lint-media-style/package.json
@@ -24,7 +24,7 @@
   },
   "author": "Titus Wormer <[email protected]> (https://wooorm.com)",
   "contributors": [
-    "Titus Wormer <[email protected]> (https://wooorm.com)"
+    "Titus Wormer <[email protected]>"
   ],
   "sideEffects": false,
   "type": "module",

diff --git a/readme.md b/readme.md
@@ -108,7 +108,7 @@ The rules that are maintained here:
 * [`remark-lint-checkbox-character-style`](https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-checkbox-character-style) — warn when list item checkboxes violate a given style
 * [`remark-lint-checkbox-content-indent`](https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-checkbox-content-indent) — warn when list item checkboxes are followed by too much whitespace
 * [`remark-lint-code-block-style`](https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-code-block-style) — warn when code blocks do not adhere to a given style
-* [`remark-lint-correct-link-syntax`](https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-correct-link-syntax) — check for accidental bracket and paren mixup for images and links
+* [`remark-lint-correct-media-syntax`](https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-correct-media-syntax) — check for accidental bracket and paren mixup for images and links
 * [`remark-lint-definition-case`](https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-definition-case) — warn when definition labels are not lowercase
 * [`remark-lint-definition-sort`](https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-definition-sort) — check definition order
 * [`remark-lint-definition-spacing`](https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-definition-spacing) — warn when consecutive whitespace is used in a definition