From 2bd4676d11c9b6d17690735be44db11921fc7ee6 Mon Sep 17 00:00:00 2001 From: Masafumi Koba <473530+ybiquitous@users.noreply.github.com> Date: Tue, 11 Jun 2024 14:00:48 +0900 Subject: [PATCH 1/4] feat: allow Alerts in GFM for `remark-lint-no-undefined-references` (#233) See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts --- README.md | 3 ++- index.js | 11 +++++++---- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index aabfc09d..b8377ffd 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,8 @@ This package is a personal [remark](https://remark.js.org) preset for [ybiquitou It includes some lint rules, plugins, and so on. See [`index.js`](./index.js) for details. -Note: This package supports only **ESM**. remark 14+ required. +> [!NOTE] +> This package supports only **ESM**. remark 14+ required. ## Usage diff --git a/index.js b/index.js index d442fb99..3030aacf 100644 --- a/index.js +++ b/index.js @@ -7,10 +7,8 @@ import lintFinalNewline from "remark-lint-final-newline"; import lintFirstHeadingLevel from "remark-lint-first-heading-level"; import lintHeadingIncrement from "remark-lint-heading-increment"; import lintLinebreakStyle from "remark-lint-linebreak-style"; -// eslint-disable-next-line import/no-extraneous-dependencies -import lintListItemBulletIndent from "remark-lint-list-item-bullet-indent"; -// eslint-disable-next-line import/no-extraneous-dependencies -import lintListItemIndent from "remark-lint-list-item-indent"; +import lintListItemBulletIndent from "remark-lint-list-item-bullet-indent"; // eslint-disable-line import/no-extraneous-dependencies +import lintListItemIndent from "remark-lint-list-item-indent"; // eslint-disable-line import/no-extraneous-dependencies import lintNoConsecutiveBlankLines from "remark-lint-no-consecutive-blank-lines"; import lintNoDuplicateDefinedUrls from "remark-lint-no-duplicate-defined-urls"; import lintNoDuplicateHeadings from "remark-lint-no-duplicate-headings"; @@ -30,6 +28,7 @@ import lintNoReferenceLikeUrl from "remark-lint-no-reference-like-url"; import lintNoShellDollars from "remark-lint-no-shell-dollars"; import lintNoTableIndentation from "remark-lint-no-table-indentation"; import lintNoTabs from "remark-lint-no-tabs"; +import lintNoUndefinedReferences from "remark-lint-no-undefined-references"; // eslint-disable-line import/no-extraneous-dependencies import lintNoUnneededFullReferenceImage from "remark-lint-no-unneeded-full-reference-image"; import lintNoUnneededFullReferenceLink from "remark-lint-no-unneeded-full-reference-link"; import lintStrikethroughMarker from "remark-lint-strikethrough-marker"; @@ -77,6 +76,10 @@ export default { lintNoShellDollars, lintNoTableIndentation, lintNoTabs, + + // Allow Alerts. See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts + [lintNoUndefinedReferences, { allow: [/^!(?:NOTE|TIP|IMPORTANT|WARNING|CAUTION)$/u] }], + lintNoUnneededFullReferenceImage, lintNoUnneededFullReferenceLink, [lintStrikethroughMarker, "~~"], From b265443c20a43332c1bada7064280c1be405435c Mon Sep 17 00:00:00 2001 From: Masafumi Koba <473530+ybiquitous@users.noreply.github.com> Date: Tue, 11 Jun 2024 14:07:17 +0900 Subject: [PATCH 2/4] docs: add link to remark v14 (#234) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b8377ffd..db1468fb 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This package is a personal [remark](https://remark.js.org) preset for [ybiquitou It includes some lint rules, plugins, and so on. See [`index.js`](./index.js) for details. > [!NOTE] -> This package supports only **ESM**. remark 14+ required. +> This package supports only **ESM**. [remark v14](https://github.com/remarkjs/remark/releases/tag/14.0.0) or later is required. ## Usage From c80515adb9b5f5eac5136a5a15ba9f74b114bd81 Mon Sep 17 00:00:00 2001 From: Masafumi Koba <473530+ybiquitous@users.noreply.github.com> Date: Tue, 11 Jun 2024 14:11:27 +0900 Subject: [PATCH 3/4] docs: clarify file extension for `.remarkrc` (#235) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index db1468fb..a4d5bf88 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ First, install the package: npm install remark-preset-ybiquitous ``` -Next, add it to your remark configuration (e.g. `.remarkrc`): +Next, add it to your remark configuration (e.g. `.remarkrc.json`): ```json { From 043181fc0792fe87016ace548981c99d00e9ca57 Mon Sep 17 00:00:00 2001 From: Masafumi Koba <473530+ybiquitous@users.noreply.github.com> Date: Tue, 11 Jun 2024 14:15:04 +0900 Subject: [PATCH 4/4] chore(release): 0.4.4 --- CHANGELOG.md | 6 ++++++ package-lock.json | 4 ++-- package.json | 2 +- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1a69a42d..311c3038 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +### [0.4.4](https://github.com/ybiquitous/remark-preset-ybiquitous/compare/v0.4.3...v0.4.4) (2024-06-11) + +### Features + +- allow Alerts in GFM for `remark-lint-no-undefined-references` ([#233](https://github.com/ybiquitous/remark-preset-ybiquitous/issues/233)) ([2bd4676](https://github.com/ybiquitous/remark-preset-ybiquitous/commit/2bd4676d11c9b6d17690735be44db11921fc7ee6)) + ### [0.4.3](https://github.com/ybiquitous/remark-preset-ybiquitous/compare/v0.4.2...v0.4.3) (2024-05-01) ### Features diff --git a/package-lock.json b/package-lock.json index 4bf5ff1c..8e5066e2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "remark-preset-ybiquitous", - "version": "0.4.3", + "version": "0.4.4", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "remark-preset-ybiquitous", - "version": "0.4.3", + "version": "0.4.4", "license": "MIT", "dependencies": { "remark-frontmatter": "^5.0.0", diff --git a/package.json b/package.json index df81eabb..fad1757e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "remark-preset-ybiquitous", - "version": "0.4.3", + "version": "0.4.4", "description": "Remark preset for ybiquitous", "author": "Masafumi Koba", "license": "MIT",